Mercurial > vim
annotate runtime/doc/eval.txt @ 16517:9484fc00ac6b v8.1.1262
patch 8.1.1262: cannot simulate a mouse click in a test
commit https://github.com/vim/vim/commit/bb8476be871811e40ddc88c598d9e553aba7fb79
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat May 4 15:47:48 2019 +0200
patch 8.1.1262: cannot simulate a mouse click in a test
Problem: Cannot simulate a mouse click in a test.
Solution: Add test_setmouse().
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sat, 04 May 2019 16:00:05 +0200 |
| parents | 42910f306377 |
| children | 5412fcd03ecb |
| rev | line source |
|---|---|
|
16411
5b5c5daf57de
patch 8.1.1210: support for user commands is spread out
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
1 *eval.txt* For Vim version 8.1. Last change: 2019 Apr 27 |
| 1621 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 7 | 5 |
| 6 | |
| 7 Expression evaluation *expression* *expr* *E15* *eval* | |
| 8 | |
| 9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|. | |
| 10 | |
| 11 Note: Expression evaluation can be disabled at compile time. If this has been | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12 done, the features in this document are not available. See |+eval| and |
| 99 | 13 |no-eval-feature|. |
| 7 | 14 |
| 85 | 15 1. Variables |variables| |
| 16 1.1 Variable types | |
| 87 | 17 1.2 Function references |Funcref| |
| 161 | 18 1.3 Lists |Lists| |
| 99 | 19 1.4 Dictionaries |Dictionaries| |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
20 1.5 Blobs |Blobs| |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
21 1.6 More about variables |more-variables| |
| 85 | 22 2. Expression syntax |expression-syntax| |
| 23 3. Internal variable |internal-variables| | |
| 24 4. Builtin Functions |functions| | |
| 25 5. Defining functions |user-functions| | |
| 26 6. Curly braces names |curly-braces-names| | |
| 27 7. Commands |expression-commands| | |
| 28 8. Exception handling |exception-handling| | |
| 29 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
|
30 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
|
31 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
|
32 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
|
33 13. Textlock |textlock| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
34 14. Testing |testing| |
| 7 | 35 |
| 36 {Vi does not have any of these commands} | |
| 37 | |
| 38 ============================================================================== | |
| 39 1. Variables *variables* | |
| 40 | |
| 85 | 41 1.1 Variable types ~ |
|
15579
391ac26c9412
patch 8.1.0797: error E898 is used twice
Bram Moolenaar <Bram@vim.org>
parents:
15571
diff
changeset
|
42 *E712* *E896* *E897* *E899* |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
43 There are nine types of variables: |
| 1621 | 44 |
| 3082 | 45 Number A 32 or 64 bit signed number. |expr-number| *Number* |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
46 64-bit Numbers are available only when compiled with the |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
47 |+num64| feature. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
48 Examples: -123 0x10 0177 0b1011 |
| 99 | 49 |
| 1621 | 50 Float A floating point number. |floating-point-format| *Float* |
| 51 {only when compiled with the |+float| feature} | |
| 52 Examples: 123.456 1.15e-6 -1.1e3 | |
| 53 | |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
54 *E928* |
| 99 | 55 String A NUL terminated string of 8-bit unsigned characters (bytes). |
| 1621 | 56 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
| 99 | 57 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
58 List An ordered sequence of items, see |List| for details. |
| 99 | 59 Example: [1, 2, ['a', 'b']] |
| 55 | 60 |
| 370 | 61 Dictionary An associative, unordered array: Each entry has a key and a |
| 62 value. |Dictionary| | |
| 63 Example: {'blue': "#0000ff", 'red': "#ff0000"} | |
| 64 | |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
65 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
|
66 Example: function("strlen") |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
67 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
|
68 like a Partial. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
69 Example: function("Callback", [arg], myDict) |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
70 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
71 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
|
72 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
73 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
|
74 |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
75 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
|
76 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
77 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
|
78 for details |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
79 Example: 0zFF00ED015DAF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
80 0z is an empty Blob. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
81 |
| 55 | 82 The Number and String types are converted automatically, depending on how they |
| 83 are used. | |
| 7 | 84 |
| 85 Conversion from a Number to a String is by making the ASCII representation of | |
| 2581 | 86 the Number. Examples: |
| 87 Number 123 --> String "123" ~ | |
| 88 Number 0 --> String "0" ~ | |
| 89 Number -1 --> String "-1" ~ | |
| 2152 | 90 *octal* |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
91 Conversion from a String to a Number is done by converting the first digits to |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
92 a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
93 recognized. If the String doesn't start with digits, the result is zero. |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
94 Examples: |
| 2581 | 95 String "456" --> Number 456 ~ |
| 96 String "6bar" --> Number 6 ~ | |
| 97 String "foo" --> Number 0 ~ | |
| 98 String "0xf1" --> Number 241 ~ | |
| 99 String "0100" --> Number 64 ~ | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
100 String "0b101" --> Number 5 ~ |
| 2581 | 101 String "-8" --> Number -8 ~ |
| 102 String "+8" --> Number 0 ~ | |
| 7 | 103 |
| 104 To force conversion from String to Number, add zero to it: > | |
| 105 :echo "0100" + 0 | |
| 782 | 106 < 64 ~ |
| 107 | |
| 108 To avoid a leading zero to cause octal conversion, or for using a different | |
| 109 base, use |str2nr()|. | |
| 7 | 110 |
| 15512 | 111 *TRUE* *FALSE* *Boolean* |
| 7 | 112 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
|
113 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
|
114 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
|
115 |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
116 Note that in the command: > |
| 7 | 117 :if "foo" |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
118 :" NOT executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
119 "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
|
120 non-zero number it means TRUE: > |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
121 :if "8foo" |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
122 :" executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
123 To test for a non-empty string, use empty(): > |
| 3893 | 124 :if !empty("foo") |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
125 < |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
126 *non-zero-arg* |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
127 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
|
128 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
|
129 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
|
130 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
|
131 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
|
132 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
133 *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
|
134 *E974* *E975* *E976* |
| 15512 | 135 |List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not |
| 136 automatically converted. | |
| 85 | 137 |
| 1621 | 138 *E805* *E806* *E808* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
139 When mixing Number and Float the Number is converted to Float. Otherwise |
| 1621 | 140 there is no automatic conversion of Float. You can use str2float() for String |
| 141 to Float, printf() for Float to String and float2nr() for Float to Number. | |
| 142 | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
143 *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
|
144 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
|
145 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
146 *no-type-checking* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
147 You will not get an error if you try to change the type of a variable. |
| 85 | 148 |
| 149 | |
| 87 | 150 1.2 Function references ~ |
| 153 | 151 *Funcref* *E695* *E718* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
152 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
|
153 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
|
154 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
|
155 around the arguments, to invoke the function it refers to. Example: > |
| 55 | 156 |
| 157 :let Fn = function("MyFunc") | |
| 158 :echo Fn() | |
| 114 | 159 < *E704* *E705* *E707* |
| 819 | 160 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
| 5340 | 161 can use "g:" but the following name must still start with a capital. You |
| 819 | 162 cannot have both a Funcref variable and a function with the same name. |
| 85 | 163 |
| 114 | 164 A special case is defining a function and directly assigning its Funcref to a |
| 165 Dictionary entry. Example: > | |
| 166 :function dict.init() dict | |
| 167 : let self.val = 0 | |
| 168 :endfunction | |
| 169 | |
| 170 The key of the Dictionary can start with a lower case letter. The actual | |
| 171 function name is not used here. Also see |numbered-function|. | |
| 172 | |
| 173 A Funcref can also be used with the |:call| command: > | |
| 174 :call Fn() | |
| 175 :call dict.init() | |
| 85 | 176 |
| 177 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 178 :let func = string(Fn) |
| 85 | 179 |
| 180 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 181 arguments: > | |
| 119 | 182 :let r = call(Fn, mylist) |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
183 < |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
184 *Partial* |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
185 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
|
186 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
|
187 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
|
188 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
|
189 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
190 let Cb = function('Callback', ['foo'], myDict) |
| 14999 | 191 call Cb('bar') |
|
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 This will invoke the function as if using: > |
| 14999 | 194 call myDict.Callback('foo', 'bar') |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
195 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
196 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
|
197 |ch_open()|. |
|
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 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
|
200 a member of the Dictionary: > |
|
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 let myDict.myFunction = MyFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
203 call myDict.myFunction() |
|
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 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
|
206 "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
|
207 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
|
208 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
209 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
210 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
211 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
212 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
|
213 this won't happen: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
214 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
215 let myDict.myFunction = function(MyFunction, myDict) |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
216 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
217 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
218 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
219 Here "self" will be "myDict", because it was bound explicitly. |
| 85 | 220 |
| 221 | |
| 87 | 222 1.3 Lists ~ |
| 5814 | 223 *list* *List* *Lists* *E686* |
| 55 | 224 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
|
225 can be accessed by their index number. Items can be added and removed at any |
| 55 | 226 position in the sequence. |
| 227 | |
| 85 | 228 |
| 229 List creation ~ | |
| 230 *E696* *E697* | |
| 55 | 231 A List is created with a comma separated list of items in square brackets. |
| 85 | 232 Examples: > |
| 233 :let mylist = [1, two, 3, "four"] | |
| 234 :let emptylist = [] | |
| 55 | 235 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
236 An item can be any expression. Using a List for an item creates a |
| 842 | 237 List of Lists: > |
| 85 | 238 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 239 |
| 240 An extra comma after the last item is ignored. | |
| 241 | |
| 85 | 242 |
| 243 List index ~ | |
| 244 *list-index* *E684* | |
| 55 | 245 An item in the List can be accessed by putting the index in square brackets |
| 85 | 246 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 247 :let item = mylist[0] " get the first item: 1 | |
| 55 | 248 :let item = mylist[2] " get the third item: 3 |
| 85 | 249 |
| 87 | 250 When the resulting item is a list this can be repeated: > |
| 85 | 251 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 252 < |
| 85 | 253 A negative index is counted from the end. Index -1 refers to the last item in |
| 254 the List, -2 to the last but one item, etc. > | |
| 55 | 255 :let last = mylist[-1] " get the last item: "four" |
| 256 | |
| 85 | 257 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 258 is not available it returns zero or the default value you specify: > |
| 85 | 259 :echo get(mylist, idx) |
| 260 :echo get(mylist, idx, "NONE") | |
| 261 | |
| 262 | |
| 263 List concatenation ~ | |
| 264 | |
| 265 Two lists can be concatenated with the "+" operator: > | |
| 266 :let longlist = mylist + [5, 6] | |
| 119 | 267 :let mylist += [7, 8] |
| 85 | 268 |
| 269 To prepend or append an item turn the item into a list by putting [] around | |
| 270 it. To change a list in-place see |list-modification| below. | |
| 271 | |
| 272 | |
| 273 Sublist ~ | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
274 *sublist* |
| 55 | 275 A part of the List can be obtained by specifying the first and last index, |
| 276 separated by a colon in square brackets: > | |
| 85 | 277 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 278 |
| 279 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 280 similar to -1. > |
| 90 | 281 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 282 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 283 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 284 |
| 842 | 285 If the first index is beyond the last item of the List or the second item is |
| 286 before the first item, the result is an empty list. There is no error | |
| 287 message. | |
| 288 | |
| 289 If the second index is equal to or greater than the length of the list the | |
| 290 length minus one is used: > | |
| 829 | 291 :let mylist = [0, 1, 2, 3] |
| 292 :echo mylist[2:8] " result: [2, 3] | |
| 293 | |
| 270 | 294 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
|
295 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 296 mylist[s : e]. |
| 297 | |
| 85 | 298 |
| 299 List identity ~ | |
| 99 | 300 *list-identity* |
| 85 | 301 When variable "aa" is a list and you assign it to another variable "bb", both |
| 302 variables refer to the same list. Thus changing the list "aa" will also | |
| 303 change "bb": > | |
| 304 :let aa = [1, 2, 3] | |
| 305 :let bb = aa | |
| 306 :call add(aa, 4) | |
| 307 :echo bb | |
| 114 | 308 < [1, 2, 3, 4] |
| 85 | 309 |
| 310 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 311 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 312 a list item in the list will also change the item in the copied list: > |
| 85 | 313 :let aa = [[1, 'a'], 2, 3] |
| 314 :let bb = copy(aa) | |
| 114 | 315 :call add(aa, 4) |
| 85 | 316 :let aa[0][1] = 'aaa' |
| 317 :echo aa | |
| 114 | 318 < [[1, aaa], 2, 3, 4] > |
| 85 | 319 :echo bb |
| 114 | 320 < [[1, aaa], 2, 3] |
| 85 | 321 |
| 87 | 322 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 323 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 324 |
| 325 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 326 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 327 the same value. > |
| 328 :let alist = [1, 2, 3] | |
| 329 :let blist = [1, 2, 3] | |
| 330 :echo alist is blist | |
| 114 | 331 < 0 > |
| 87 | 332 :echo alist == blist |
| 114 | 333 < 1 |
| 85 | 334 |
| 323 | 335 Note about comparing lists: Two lists are considered equal if they have the |
| 336 same length and all items compare equal, as with using "==". There is one | |
| 388 | 337 exception: When comparing a number with a string they are considered |
| 338 different. There is no automatic type conversion, as with using "==" on | |
| 339 variables. Example: > | |
| 340 echo 4 == "4" | |
| 323 | 341 < 1 > |
| 388 | 342 echo [4] == ["4"] |
| 323 | 343 < 0 |
| 344 | |
| 388 | 345 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 346 can compare simple values this way too by putting them in a list: > |
| 388 | 347 |
| 348 :let a = 5 | |
| 349 :let b = "5" | |
| 1621 | 350 :echo a == b |
| 388 | 351 < 1 > |
| 1621 | 352 :echo [a] == [b] |
| 388 | 353 < 0 |
| 323 | 354 |
| 85 | 355 |
| 356 List unpack ~ | |
| 357 | |
| 358 To unpack the items in a list to individual variables, put the variables in | |
| 359 square brackets, like list items: > | |
| 360 :let [var1, var2] = mylist | |
| 361 | |
| 362 When the number of variables does not match the number of items in the list | |
| 363 this produces an error. To handle any extra items from the list append ";" | |
| 364 and a variable name: > | |
| 365 :let [var1, var2; rest] = mylist | |
| 366 | |
| 367 This works like: > | |
| 368 :let var1 = mylist[0] | |
| 369 :let var2 = mylist[1] | |
| 95 | 370 :let rest = mylist[2:] |
| 85 | 371 |
| 372 Except that there is no error if there are only two items. "rest" will be an | |
| 373 empty list then. | |
| 374 | |
| 375 | |
| 376 List modification ~ | |
| 377 *list-modification* | |
| 87 | 378 To change a specific item of a list use |:let| this way: > |
| 85 | 379 :let list[4] = "four" |
| 380 :let listlist[0][3] = item | |
| 381 | |
| 87 | 382 To change part of a list you can specify the first and last item to be |
| 114 | 383 modified. The value must at least have the number of items in the range: > |
| 87 | 384 :let list[3:5] = [3, 4, 5] |
| 385 | |
| 85 | 386 Adding and removing items from a list is done with functions. Here are a few |
| 387 examples: > | |
| 388 :call insert(list, 'a') " prepend item 'a' | |
| 389 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 390 :call add(list, "new") " append String item | |
| 114 | 391 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 392 :call extend(list, [1, 2]) " extend the list with two more items |
| 393 :let i = remove(list, 3) " remove item 3 | |
| 108 | 394 :unlet list[3] " idem |
| 85 | 395 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 396 :unlet list[3 : ] " idem |
| 114 | 397 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 398 | |
| 399 Changing the order of items in a list: > | |
| 87 | 400 :call sort(list) " sort a list alphabetically |
| 401 :call reverse(list) " reverse the order of items | |
| 5747 | 402 :call uniq(sort(list)) " sort and remove duplicates |
| 87 | 403 |
| 85 | 404 |
| 405 For loop ~ | |
| 406 | |
| 87 | 407 The |:for| loop executes commands for each item in a list. A variable is set |
| 408 to each item in the list in sequence. Example: > | |
| 114 | 409 :for item in mylist |
| 410 : call Doit(item) | |
| 85 | 411 :endfor |
| 412 | |
| 413 This works like: > | |
| 414 :let index = 0 | |
| 415 :while index < len(mylist) | |
| 114 | 416 : let item = mylist[index] |
| 417 : :call Doit(item) | |
| 85 | 418 : let index = index + 1 |
| 419 :endwhile | |
| 420 | |
| 95 | 421 If all you want to do is modify each item in the list then the |map()| |
| 114 | 422 function will be a simpler method than a for loop. |
| 95 | 423 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
424 Just like the |:let| command, |:for| also accepts a list of variables. This |
| 85 | 425 requires the argument to be a list of lists. > |
| 426 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
| 427 : call Doit(lnum, col) | |
| 428 :endfor | |
| 429 | |
| 430 This works like a |:let| command is done for each list item. Again, the types | |
| 431 must remain the same to avoid an error. | |
| 432 | |
| 114 | 433 It is also possible to put remaining items in a List variable: > |
| 85 | 434 :for [i, j; rest] in listlist |
| 435 : call Doit(i, j) | |
| 436 : if !empty(rest) | |
| 437 : echo "remainder: " . string(rest) | |
| 438 : endif | |
| 439 :endfor | |
| 440 | |
| 441 | |
| 442 List functions ~ | |
| 114 | 443 *E714* |
| 85 | 444 Functions that are useful with a List: > |
| 87 | 445 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 446 :if empty(list) " check if list is empty |
| 102 | 447 :let l = len(list) " number of items in list |
| 448 :let big = max(list) " maximum value in list | |
| 449 :let small = min(list) " minimum value in list | |
| 87 | 450 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 451 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 452 :let lines = getline(1, 10) " get ten text lines from buffer |
| 453 :call append('$', lines) " append text lines in buffer | |
| 95 | 454 :let list = split("a b c") " create list from items in a string |
| 455 :let string = join(list, ', ') " create string from list items | |
| 102 | 456 :let s = string(list) " String representation of list |
| 457 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 458 |
| 258 | 459 Don't forget that a combination of features can make things simple. For |
| 460 example, to add up all the numbers in a list: > | |
| 461 :exe 'let sum = ' . join(nrlist, '+') | |
| 462 | |
| 99 | 463 |
| 464 1.4 Dictionaries ~ | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
465 *dict* *Dict* *Dictionaries* *Dictionary* |
| 99 | 466 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 467 entry can be located with the key. The entries are stored without a specific |
| 468 ordering. | |
| 99 | 469 |
| 470 | |
| 471 Dictionary creation ~ | |
| 114 | 472 *E720* *E721* *E722* *E723* |
| 99 | 473 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 474 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 475 only appear once. Examples: > | |
| 99 | 476 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 477 :let emptydict = {} | |
| 114 | 478 < *E713* *E716* *E717* |
| 99 | 479 A key is always a String. You can use a Number, it will be converted to a |
| 480 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
|
481 entry. Note that the String '04' and the Number 04 are different, since the |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
482 Number will be converted to the String '4'. The empty string can be used as a |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
483 key. |
| 114 | 484 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
485 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 486 nested Dictionary: > |
| 487 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 488 | |
| 489 An extra comma after the last entry is ignored. | |
| 490 | |
| 491 | |
| 492 Accessing entries ~ | |
| 493 | |
| 494 The normal way to access an entry is by putting the key in square brackets: > | |
| 495 :let val = mydict["one"] | |
| 496 :let mydict["four"] = 4 | |
| 497 | |
| 114 | 498 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 499 |
| 500 For keys that consist entirely of letters, digits and underscore the following | |
| 501 form can be used |expr-entry|: > | |
| 502 :let val = mydict.one | |
| 503 :let mydict.four = 4 | |
| 504 | |
| 505 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 506 key lookup can be repeated: > | |
| 114 | 507 :echo dict.key[idx].key |
| 99 | 508 |
| 509 | |
| 510 Dictionary to List conversion ~ | |
| 511 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
512 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 513 turn the Dictionary into a List and pass it to |:for|. |
| 514 | |
| 515 Most often you want to loop over the keys, using the |keys()| function: > | |
| 516 :for key in keys(mydict) | |
| 517 : echo key . ': ' . mydict[key] | |
| 518 :endfor | |
| 519 | |
| 520 The List of keys is unsorted. You may want to sort them first: > | |
| 521 :for key in sort(keys(mydict)) | |
| 522 | |
| 523 To loop over the values use the |values()| function: > | |
| 524 :for v in values(mydict) | |
| 525 : echo "value: " . v | |
| 526 :endfor | |
| 527 | |
| 528 If you want both the key and the value use the |items()| function. It returns | |
| 15131 | 529 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 530 :for [key, value] in items(mydict) |
| 531 : echo key . ': ' . value | |
| 99 | 532 :endfor |
| 533 | |
| 534 | |
| 535 Dictionary identity ~ | |
| 161 | 536 *dict-identity* |
| 99 | 537 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 538 Dictionary. Otherwise, assignment results in referring to the same | |
| 539 Dictionary: > | |
| 540 :let onedict = {'a': 1, 'b': 2} | |
| 541 :let adict = onedict | |
| 542 :let adict['a'] = 11 | |
| 543 :echo onedict['a'] | |
| 544 11 | |
| 545 | |
| 327 | 546 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 547 more info see |list-identity|. | |
| 99 | 548 |
| 549 | |
| 550 Dictionary modification ~ | |
| 551 *dict-modification* | |
| 552 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 553 use |:let| this way: > | |
| 554 :let dict[4] = "four" | |
| 555 :let dict['one'] = item | |
| 556 | |
| 108 | 557 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 558 Three ways to remove the entry with key "aaa" from dict: > | |
| 559 :let i = remove(dict, 'aaa') | |
| 560 :unlet dict.aaa | |
| 561 :unlet dict['aaa'] | |
| 99 | 562 |
| 563 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 564 :call extend(adict, bdict) |
| 565 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 566 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 567 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 568 expect ":echo adict" to show the items from bdict after the older entries in | |
| 569 adict. | |
| 99 | 570 |
| 571 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 572 :call filter(dict, 'v:val =~ "x"') |
| 114 | 573 This removes all entries from "dict" with a value not matching 'x'. |
| 102 | 574 |
| 575 | |
| 576 Dictionary function ~ | |
| 4159 | 577 *Dictionary-function* *self* *E725* *E862* |
| 102 | 578 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
|
579 special way with a dictionary. Example: > |
| 102 | 580 :function Mylen() dict |
| 114 | 581 : return len(self.data) |
| 102 | 582 :endfunction |
| 114 | 583 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 584 :echo mydict.len() | |
| 102 | 585 |
| 586 This is like a method in object oriented programming. The entry in the | |
| 587 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 588 the function was invoked from. | |
| 589 | |
| 114 | 590 It is also possible to add a function without the "dict" attribute as a |
| 591 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 592 | |
| 819 | 593 *numbered-function* *anonymous-function* |
| 102 | 594 To avoid the extra name for the function it can be defined and directly |
| 595 assigned to a Dictionary in this way: > | |
| 114 | 596 :let mydict = {'data': [0, 1, 2, 3]} |
| 6741 | 597 :function mydict.len() |
| 114 | 598 : return len(self.data) |
| 102 | 599 :endfunction |
| 114 | 600 :echo mydict.len() |
| 601 | |
| 602 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
|
603 that references this function. The function can only be used through a |
| 114 | 604 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 605 remaining that refers to it. | |
| 606 | |
| 607 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 608 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
609 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
|
610 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
|
611 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
612 |
| 102 | 613 |
| 614 Functions for Dictionaries ~ | |
| 114 | 615 *E715* |
| 616 Functions that can be used with a Dictionary: > | |
| 102 | 617 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 618 :if empty(dict) " TRUE if dict is empty | |
| 619 :let l = len(dict) " number of items in dict | |
| 620 :let big = max(dict) " maximum value in dict | |
| 621 :let small = min(dict) " minimum value in dict | |
| 622 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 623 :let s = string(dict) " String representation of dict | |
| 624 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 625 |
| 626 | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
627 1.5 Blobs ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
628 *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
|
629 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
|
630 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
|
631 |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
632 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
|
633 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
|
634 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
635 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
636 Blob creation ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
637 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
638 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
|
639 :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
|
640 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
|
641 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
|
642 :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
|
643 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
644 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
|
645 set to "B", for example: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
646 :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
|
647 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
648 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
|
649 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
650 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
651 Blob index ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
652 *blob-index* *E979* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
653 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
|
654 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
|
655 :let myblob = 0z00112233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
656 :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
|
657 :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
|
658 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
659 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
|
660 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
|
661 :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
|
662 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
663 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
|
664 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
|
665 :echo get(myblob, idx) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
666 :echo get(myblob, idx, 999) |
|
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 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
669 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
|
670 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
671 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
|
672 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
|
673 :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
|
674 : 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
|
675 :endfor |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
676 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
|
677 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
678 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
679 Blob concatenation ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
680 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
681 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
|
682 :let longblob = myblob + 0z4455 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
683 :let myblob += 0z6677 |
|
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 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
|
686 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
687 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
688 Part of a blob ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
689 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
690 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
|
691 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
|
692 :let myblob = 0z00112233 |
| 15512 | 693 :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
|
694 :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
|
695 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
696 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
|
697 similar to -1. > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
698 :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
|
699 :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
|
700 :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
|
701 |
| 15512 | 702 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
|
703 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
|
704 message. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
705 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
706 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
|
707 length minus one is used: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
708 :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
|
709 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
710 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
711 Blob modification ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
712 *blob-modification* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
713 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
|
714 :let blob[4] = 0x44 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
715 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
716 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
|
717 higher index is an error. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
718 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
719 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
|
720 let blob[1:3] = 0z445566 |
| 15512 | 721 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
|
722 provided. *E972* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
723 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
724 To change part of a blob you can specify the first and last byte to be |
| 15512 | 725 modified. The value must have the same number of bytes in the range: > |
| 726 :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
|
727 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
728 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
|
729 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
730 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
731 Blob identity ~ |
|
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 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
|
734 if blob == 0z001122 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
735 And for equal identity: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
736 if blob is otherblob |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
737 < *blob-identity* *E977* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
738 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
|
739 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
|
740 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
741 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
|
742 identity is different: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
743 :let blob = 0z112233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
744 :let blob2 = blob |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
745 :echo blob == blob2 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
746 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
747 :echo blob is blob2 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
748 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
749 :let blob3 = blob[:] |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
750 :echo blob == blob3 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
751 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
752 :echo blob is blob3 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
753 < 0 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
754 |
| 15512 | 755 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
|
756 works, as explained above. |
|
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 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
759 1.6 More about variables ~ |
| 85 | 760 *more-variables* |
| 7 | 761 If you need to know the type of a variable or expression, use the |type()| |
| 762 function. | |
| 763 | |
| 764 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 765 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 766 stored in the viminfo file |viminfo-file|. | |
| 767 | |
| 768 When the 'sessionoptions' option contains "global", global variables that | |
| 769 start with an uppercase letter and contain at least one lowercase letter are | |
| 770 stored in the session file |session-file|. | |
| 771 | |
| 772 variable name can be stored where ~ | |
| 773 my_var_6 not | |
| 774 My_Var_6 session file | |
| 775 MY_VAR_6 viminfo file | |
| 776 | |
| 777 | |
| 778 It's possible to form a variable name with curly braces, see | |
| 779 |curly-braces-names|. | |
| 780 | |
| 781 ============================================================================== | |
| 782 2. Expression syntax *expression-syntax* | |
| 783 | |
| 784 Expression syntax summary, from least to most significant: | |
| 785 | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
786 |expr1| expr2 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
787 expr2 ? expr1 : expr1 if-then-else |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
788 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
789 |expr2| expr3 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
790 expr3 || expr3 ... logical OR |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
791 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
792 |expr3| expr4 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
793 expr4 && expr4 ... logical AND |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
794 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
795 |expr4| expr5 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
796 expr5 == expr5 equal |
| 7 | 797 expr5 != expr5 not equal |
| 798 expr5 > expr5 greater than | |
| 799 expr5 >= expr5 greater than or equal | |
| 800 expr5 < expr5 smaller than | |
| 801 expr5 <= expr5 smaller than or equal | |
| 802 expr5 =~ expr5 regexp matches | |
| 803 expr5 !~ expr5 regexp doesn't match | |
| 804 | |
| 805 expr5 ==? expr5 equal, ignoring case | |
| 806 expr5 ==# expr5 equal, match case | |
| 807 etc. As above, append ? for ignoring case, # for | |
| 808 matching case | |
| 809 | |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
810 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
|
811 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
|
812 instance |
| 79 | 813 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
814 |expr5| expr6 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
815 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
|
816 expr6 - expr6 ... number subtraction |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
817 expr6 . expr6 ... string concatenation |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
818 expr6 .. expr6 ... string concatenation |
| 7 | 819 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
820 |expr6| expr7 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
821 expr7 * expr7 ... number multiplication |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
822 expr7 / expr7 ... number division |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
823 expr7 % expr7 ... number modulo |
| 7 | 824 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
825 |expr7| expr8 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
826 ! expr7 logical NOT |
| 7 | 827 - expr7 unary minus |
| 828 + expr7 unary plus | |
| 102 | 829 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
830 |expr8| expr9 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
831 expr8[expr1] byte of a String or item of a |List| |
| 685 | 832 expr8[expr1 : expr1] substring of a String or sublist of a |List| |
| 833 expr8.name entry in a |Dictionary| | |
| 834 expr8(expr1, ...) function call with |Funcref| variable | |
| 102 | 835 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
836 |expr9| number number constant |
| 26 | 837 "string" string constant, backslash is special |
| 99 | 838 'string' string constant, ' is doubled |
| 685 | 839 [expr1, ...] |List| |
| 840 {expr1: expr1, ...} |Dictionary| | |
| 7 | 841 &option option value |
| 842 (expr1) nested expression | |
| 843 variable internal variable | |
| 844 va{ria}ble internal variable with curly braces | |
| 845 $VAR environment variable | |
| 846 @r contents of register 'r' | |
| 847 function(expr1, ...) function call | |
| 848 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
|
849 {args -> expr1} lambda expression |
| 7 | 850 |
| 851 | |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
852 "..." indicates that the operations in this level can be concatenated. |
| 7 | 853 Example: > |
| 854 &nu || &list && &shell == "csh" | |
| 855 | |
| 856 All expressions within one level are parsed from left to right. | |
| 857 | |
| 858 | |
| 859 expr1 *expr1* *E109* | |
| 860 ----- | |
| 861 | |
| 862 expr2 ? expr1 : expr1 | |
| 863 | |
| 864 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
|
865 |TRUE|, the result is the value of the expression between the '?' and ':', |
| 7 | 866 otherwise the result is the value of the expression after the ':'. |
| 867 Example: > | |
| 868 :echo lnum == 1 ? "top" : lnum | |
| 869 | |
| 870 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 871 other two expressions can, thus allow for recursive use of ?:. | |
| 872 Example: > | |
| 873 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 874 | |
| 875 To keep this readable, using |line-continuation| is suggested: > | |
| 876 :echo lnum == 1 | |
| 877 :\ ? "top" | |
| 878 :\ : lnum == 1000 | |
| 879 :\ ? "last" | |
| 880 :\ : lnum | |
| 881 | |
| 1156 | 882 You should always put a space before the ':', otherwise it can be mistaken for |
| 883 use in a variable such as "a:1". | |
| 884 | |
| 7 | 885 |
| 886 expr2 and expr3 *expr2* *expr3* | |
| 887 --------------- | |
| 888 | |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
889 expr3 || expr3 .. logical OR *expr-barbar* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
890 expr4 && expr4 .. logical AND *expr-&&* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
891 |
| 7 | 892 The "||" and "&&" operators take one argument on each side. The arguments |
| 893 are (converted to) Numbers. The result is: | |
| 894 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
895 input output ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
896 n1 n2 n1 || n2 n1 && n2 ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
897 |FALSE| |FALSE| |FALSE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
898 |FALSE| |TRUE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
899 |TRUE| |FALSE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
900 |TRUE| |TRUE| |TRUE| |TRUE| |
| 7 | 901 |
| 902 The operators can be concatenated, for example: > | |
| 903 | |
| 904 &nu || &list && &shell == "csh" | |
| 905 | |
| 906 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 907 | |
| 908 &nu || (&list && &shell == "csh") | |
| 909 | |
| 910 Once the result is known, the expression "short-circuits", that is, further | |
| 911 arguments are not evaluated. This is like what happens in C. For example: > | |
| 912 | |
| 913 let a = 1 | |
| 914 echo a || b | |
| 915 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
916 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
|
917 so the result must be |TRUE|. Similarly below: > |
| 7 | 918 |
| 919 echo exists("b") && b == "yes" | |
| 920 | |
| 921 This is valid whether "b" has been defined or not. The second clause will | |
| 922 only be evaluated if "b" has been defined. | |
| 923 | |
| 924 | |
| 925 expr4 *expr4* | |
| 926 ----- | |
| 927 | |
| 928 expr5 {cmp} expr5 | |
| 929 | |
| 930 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 931 if it evaluates to true. | |
| 932 | |
| 1621 | 933 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 934 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 935 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 936 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 937 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 938 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 2908 | 939 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
| 940 *expr-is?* *expr-isnot?* | |
| 7 | 941 use 'ignorecase' match case ignore case ~ |
| 942 equal == ==# ==? | |
| 943 not equal != !=# !=? | |
| 944 greater than > ># >? | |
| 945 greater than or equal >= >=# >=? | |
| 946 smaller than < <# <? | |
| 947 smaller than or equal <= <=# <=? | |
| 948 regexp matches =~ =~# =~? | |
| 949 regexp doesn't match !~ !~# !~? | |
| 2908 | 950 same instance is is# is? |
| 951 different instance isnot isnot# isnot? | |
| 7 | 952 |
| 953 Examples: | |
| 954 "abc" ==# "Abc" evaluates to 0 | |
| 955 "abc" ==? "Abc" evaluates to 1 | |
| 956 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 957 | |
| 85 | 958 *E691* *E692* |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
959 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
|
960 "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
|
961 recursively. Ignoring case means case is ignored when comparing item values. |
| 79 | 962 |
| 114 | 963 *E735* *E736* |
| 685 | 964 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
|
965 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
|
966 |Dictionary| recursively. Ignoring case means case is ignored when comparing |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
967 item values. |
| 114 | 968 |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
969 *E694* |
|
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
970 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
|
971 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
|
972 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
|
973 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
|
974 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
|
975 |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
976 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
|
977 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
|
978 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
|
979 " Part1 and Part2 refer to the same function |
| 685 | 980 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
981 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
|
982 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
|
983 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
|
984 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
|
985 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
|
986 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
|
987 echo 4 == '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
988 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
989 echo 4 is '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
990 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
991 echo 0 is [] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
992 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
993 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
| 79 | 994 |
| 7 | 995 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
|
996 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
|
997 echo 0 == 'x' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
998 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
999 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
|
1000 echo [0] == ['x'] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1001 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1002 Inside a List or Dictionary this conversion is not used. |
| 7 | 1003 |
| 1004 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 1005 results in the mathematical difference (comparing byte values), not | |
| 1006 necessarily the alphabetical difference in the local language. | |
| 1007 | |
| 1621 | 1008 When using the operators with a trailing '#', or the short version and |
| 1156 | 1009 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 1010 |
| 1011 When using the operators with a trailing '?', or the short version and | |
| 1156 | 1012 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 1013 | |
| 1014 'smartcase' is not used. | |
| 7 | 1015 |
| 1016 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 1017 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 1018 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 1019 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 1020 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 1021 single-quote string, see |literal-string|. | |
| 1022 Since a string is considered to be a single line, a multi-line pattern | |
| 1023 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 1024 can be matched like an ordinary character. Examples: | |
| 1025 "foo\nbar" =~ "\n" evaluates to 1 | |
| 1026 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 1027 | |
| 1028 | |
| 1029 expr5 and expr6 *expr5* *expr6* | |
| 1030 --------------- | |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1031 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
|
1032 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
|
1033 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
|
1034 expr6 .. expr6 String concatenation *expr-..* |
| 79 | 1035 |
| 692 | 1036 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 1037 result is a new list with the two lists Concatenated. |
| 79 | 1038 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1039 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
|
1040 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
|
1041 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
|
1042 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1043 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
|
1044 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
|
1045 expr7 % expr7 Number modulo *expr-%* |
| 7 | 1046 |
| 16267 | 1047 For all, except "." and "..", Strings are converted to Numbers. |
| 3214 | 1048 For bitwise operators see |and()|, |or()| and |xor()|. |
| 7 | 1049 |
| 1050 Note the difference between "+" and ".": | |
| 1051 "123" + "456" = 579 | |
| 1052 "123" . "456" = "123456" | |
| 1053 | |
| 1621 | 1054 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 1055 1 . 90 + 90.0 | |
| 1056 As: > | |
| 1057 (1 . 90) + 90.0 | |
| 1058 That works, since the String "190" is automatically converted to the Number | |
| 1059 190, which can be added to the Float 90.0. However: > | |
| 1060 1 . 90 * 90.0 | |
| 1061 Should be read as: > | |
| 1062 1 . (90 * 90.0) | |
| 1063 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 1064 attempts to concatenate a Float and a String. | |
| 1065 | |
| 1066 When dividing a Number by zero the result depends on the value: | |
| 1067 0 / 0 = -0x80000000 (like NaN for Float) | |
| 1068 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 1069 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 1070 (before Vim 7.2 it was always 0x7fffffff) | |
| 1071 | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1072 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
|
1073 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
|
1074 >0 / 0 = 0x7fffffffffffffff (like positive infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1075 <0 / 0 = -0x7fffffffffffffff (like negative infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1076 |
| 7 | 1077 When the righthand side of '%' is zero, the result is 0. |
| 1078 | |
| 685 | 1079 None of these work for |Funcref|s. |
| 79 | 1080 |
| 1621 | 1081 . and % do not work for Float. *E804* |
| 1082 | |
| 7 | 1083 |
| 1084 expr7 *expr7* | |
| 1085 ----- | |
| 1086 ! expr7 logical NOT *expr-!* | |
| 1087 - expr7 unary minus *expr-unary--* | |
| 1088 + expr7 unary plus *expr-unary-+* | |
| 1089 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
1090 For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one). |
| 7 | 1091 For '-' the sign of the number is changed. |
| 1092 For '+' the number is unchanged. | |
| 1093 | |
| 1094 A String will be converted to a Number first. | |
| 1095 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1096 These three can be repeated and mixed. Examples: |
| 7 | 1097 !-1 == 0 |
| 1098 !!8 == 1 | |
| 1099 --9 == 9 | |
| 1100 | |
| 1101 | |
| 1102 expr8 *expr8* | |
| 1103 ----- | |
| 14637 | 1104 This expression is either |expr9| or a sequence of the alternatives below, |
| 1105 in any order. E.g., these are all possible: | |
| 1106 expr9[expr1].name | |
| 1107 expr9.name[expr1] | |
| 1108 expr9(expr1, ...)[expr1].name | |
| 1109 | |
| 1110 | |
| 685 | 1111 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
|
1112 *E909* *subscript* |
| 102 | 1113 If expr8 is a Number or String this results in a String that contains the |
| 1114 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
|
1115 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
|
1116 an alternative, or use `split()` to turn the string into a list of characters. |
| 55 | 1117 |
|
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
1118 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
|
1119 text column numbers start with one! Example, to get the byte under the |
| 55 | 1120 cursor: > |
| 823 | 1121 :let c = getline(".")[col(".") - 1] |
| 7 | 1122 |
| 1123 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
|
1124 String. A negative index always results in an empty string (reason: backward |
| 55 | 1125 compatibility). Use [-1:] to get the last byte. |
| 1126 | |
| 685 | 1127 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 1128 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
|
1129 error. Example: > |
| 55 | 1130 :let item = mylist[-1] " get last item |
| 1131 | |
| 685 | 1132 Generally, if a |List| index is equal to or higher than the length of the |
| 1133 |List|, or more negative than the length of the |List|, this results in an | |
| 1134 error. | |
| 55 | 1135 |
| 99 | 1136 |
| 102 | 1137 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 1138 | |
| 1139 If expr8 is a Number or String this results in the substring with the bytes | |
| 1140 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
|
1141 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
|
1142 |byteidx()| for computing the indexes. |
| 55 | 1143 |
| 1144 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
| 1145 string minus one is used. | |
| 1146 | |
| 1147 A negative number can be used to measure from the end of the string. -1 is | |
| 1148 the last character, -2 the last but one, etc. | |
| 1149 | |
| 1150 If an index goes out of range for the string characters are omitted. If | |
| 1151 expr1b is smaller than expr1a the result is an empty string. | |
| 1152 | |
| 1153 Examples: > | |
| 1154 :let c = name[-1:] " last byte of a string | |
| 1155 :let c = name[-2:-2] " last but one byte of a string | |
| 1156 :let s = line(".")[4:] " from the fifth byte to the end | |
| 1157 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1158 < |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
1159 *slice* |
| 685 | 1160 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
|
1161 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
|
1162 just above. Also see |sublist| below. Examples: > |
| 55 | 1163 :let l = mylist[:3] " first four items |
| 1164 :let l = mylist[4:4] " List with one item | |
| 1165 :let l = mylist[:] " shallow copy of a List | |
| 1166 | |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1167 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
|
1168 indexes expr1a and expr1b, inclusive. Examples: > |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1169 :let b = 0zDEADBEEF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1170 :let bs = b[1:2] " 0zADBE |
| 15512 | 1171 :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
|
1172 |
| 685 | 1173 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 1174 error. | |
| 1175 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1176 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
|
1177 for a sublist: > |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1178 mylist[n:] " uses variable n |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1179 mylist[s:] " uses namespace s:, error! |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1180 |
| 685 | 1181 |
| 1182 expr8.name entry in a |Dictionary| *expr-entry* | |
| 1183 | |
| 1184 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 1185 name will be used as a key in the |Dictionary|. This is just like: | |
| 1186 expr8[name]. | |
| 99 | 1187 |
| 1188 The name must consist of alphanumeric characters, just like a variable name, | |
| 1189 but it may start with a number. Curly braces cannot be used. | |
| 1190 | |
| 1191 There must not be white space before or after the dot. | |
| 1192 | |
| 1193 Examples: > | |
| 1194 :let dict = {"one": 1, 2: "two"} | |
| 1195 :echo dict.one | |
| 1196 :echo dict .2 | |
| 1197 | |
| 1198 Note that the dot is also used for String concatenation. To avoid confusion | |
| 1199 always put spaces around the dot for String concatenation. | |
| 1200 | |
| 1201 | |
| 685 | 1202 expr8(expr1, ...) |Funcref| function call |
| 102 | 1203 |
| 1204 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 1205 | |
| 1206 | |
| 1207 | |
| 1208 *expr9* | |
| 7 | 1209 number |
| 1210 ------ | |
| 12785 | 1211 number number constant *expr-number* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1212 *hex-number* *octal-number* *binary-number* |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1213 |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1214 Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B) |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1215 and Octal (starting with 0). |
| 7 | 1216 |
| 1621 | 1217 *floating-point-format* |
| 1218 Floating point numbers can be written in two forms: | |
| 1219 | |
| 1220 [-+]{N}.{M} | |
| 6530 | 1221 [-+]{N}.{M}[eE][-+]{exp} |
| 1621 | 1222 |
| 1223 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 1224 contain digits. | |
| 1225 [-+] means there is an optional plus or minus sign. | |
| 1226 {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
|
1227 Only a decimal point is accepted, not a comma. No matter what the current |
| 1621 | 1228 locale is. |
| 1229 {only when compiled with the |+float| feature} | |
| 1230 | |
| 1231 Examples: | |
| 1232 123.456 | |
| 1233 +0.0001 | |
| 1234 55.0 | |
| 1235 -0.123 | |
| 1236 1.234e03 | |
| 1237 1.0E-6 | |
| 1238 -3.1416e+88 | |
| 1239 | |
| 1240 These are INVALID: | |
| 1241 3. empty {M} | |
| 1242 1e40 missing .{M} | |
| 1243 | |
| 1244 Rationale: | |
| 1245 Before floating point was introduced, the text "123.456" was interpreted as | |
| 1246 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 1247 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 1248 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 1249 incompatibility was accepted in favor of being able to use the normal notation |
| 1250 for floating point numbers. | |
| 1251 | |
| 15131 | 1252 *float-pi* *float-e* |
| 1253 A few useful values to copy&paste: > | |
| 1254 :let pi = 3.14159265359 | |
| 1255 :let e = 2.71828182846 | |
| 1256 Or, if you don't want to write them in as floating-point literals, you can | |
| 1257 also use functions, like the following: > | |
| 1258 :let pi = acos(-1.0) | |
| 1259 :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
|
1260 < |
| 1621 | 1261 *floating-point-precision* |
| 1262 The precision and range of floating points numbers depends on what "double" | |
| 1263 means in the library Vim was compiled with. There is no way to change this at | |
| 1264 runtime. | |
| 1265 | |
| 1266 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 1267 printf("%g", f). You can select something else when using the |printf()| | |
| 1268 function. Example: > | |
| 1269 :echo printf('%.15e', atan(1)) | |
| 1270 < 7.853981633974483e-01 | |
| 1271 | |
| 1272 | |
| 7 | 1273 |
| 6884 | 1274 string *string* *String* *expr-string* *E114* |
| 7 | 1275 ------ |
| 1276 "string" string constant *expr-quote* | |
| 1277 | |
| 1278 Note that double quotes are used. | |
| 1279 | |
| 1280 A string constant accepts these special characters: | |
| 1281 \... three-digit octal number (e.g., "\316") | |
| 1282 \.. two-digit octal number (must be followed by non-digit) | |
| 1283 \. one-digit octal number (must be followed by non-digit) | |
| 1284 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1285 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1286 \X.. same as \x.. | |
| 1287 \X. same as \x. | |
| 1621 | 1288 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1289 current value of 'encoding' (e.g., "\u02a4") |
| 6840 | 1290 \U.... same as \u but allows up to 8 hex numbers. |
| 7 | 1291 \b backspace <BS> |
| 1292 \e escape <Esc> | |
| 1293 \f formfeed <FF> | |
| 1294 \n newline <NL> | |
| 1295 \r return <CR> | |
| 1296 \t tab <Tab> | |
| 1297 \\ backslash | |
| 1298 \" double quote | |
| 2152 | 1299 \<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
|
1300 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
|
1301 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
|
1302 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
|
1303 mentioned above. |
| 7 | 1304 |
| 1156 | 1305 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1306 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1307 of 'encoding'. | |
| 1308 | |
| 7 | 1309 Note that "\000" and "\x00" force the end of the string. |
| 1310 | |
| 1311 | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
1312 blob-literal *blob-literal* *E973* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1313 ------------ |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1314 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1315 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
|
1316 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
|
1317 :let b = 0zFF00ED015DAF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1318 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1319 |
| 7 | 1320 literal-string *literal-string* *E115* |
| 1321 --------------- | |
| 26 | 1322 'string' string constant *expr-'* |
| 7 | 1323 |
| 1324 Note that single quotes are used. | |
| 1325 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1326 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1327 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1328 |
| 1329 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
|
1330 to be doubled. These two commands are equivalent: > |
| 26 | 1331 if a =~ "\\s*" |
| 1332 if a =~ '\s*' | |
| 7 | 1333 |
| 1334 | |
| 1335 option *expr-option* *E112* *E113* | |
| 1336 ------ | |
| 1337 &option option value, local value if possible | |
| 1338 &g:option global option value | |
| 1339 &l:option local option value | |
| 1340 | |
| 1341 Examples: > | |
| 1342 echo "tabstop is " . &tabstop | |
| 1343 if &insertmode | |
| 1344 | |
| 1345 Any option name can be used here. See |options|. When using the local value | |
| 1346 and there is no buffer-local or window-local value, the global value is used | |
| 1347 anyway. | |
| 1348 | |
| 1349 | |
| 1156 | 1350 register *expr-register* *@r* |
| 7 | 1351 -------- |
| 1352 @r contents of register 'r' | |
| 1353 | |
| 1354 The result is the contents of the named register, as a single string. | |
| 1355 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
|
1356 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1357 registers. |
| 1358 | |
| 1359 When using the '=' register you get the expression itself, not what it | |
| 1360 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1361 |
| 1362 | |
| 1363 nesting *expr-nesting* *E110* | |
| 1364 ------- | |
| 1365 (expr1) nested expression | |
| 1366 | |
| 1367 | |
| 1368 environment variable *expr-env* | |
| 1369 -------------------- | |
| 1370 $VAR environment variable | |
| 1371 | |
| 1372 The String value of any environment variable. When it is not defined, the | |
| 1373 result is an empty string. | |
| 1374 *expr-env-expand* | |
| 1375 Note that there is a difference between using $VAR directly and using | |
| 1376 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1377 are known inside the current Vim session. Using expand() will first try using | |
| 1378 the environment variables known inside the current Vim session. If that | |
| 1379 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1380 does expand all variables that the shell knows about. Example: > | |
| 6180 | 1381 :echo $shell |
| 1382 :echo expand("$shell") | |
| 1383 The first one probably doesn't echo anything, the second echoes the $shell | |
| 7 | 1384 variable (if your shell supports it). |
| 1385 | |
| 1386 | |
| 1387 internal variable *expr-variable* | |
| 1388 ----------------- | |
| 1389 variable internal variable | |
| 1390 See below |internal-variables|. | |
| 1391 | |
| 1392 | |
| 170 | 1393 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1394 ------------- |
| 1395 function(expr1, ...) function call | |
| 1396 See below |functions|. | |
| 1397 | |
| 1398 | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1399 lambda expression *expr-lambda* *lambda* |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1400 ----------------- |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1401 {args -> expr1} lambda expression |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1402 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1403 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
|
1404 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
|
1405 the following ways: |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1406 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1407 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
|
1408 commands. |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1409 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
|
1410 :let F = {arg1, arg2 -> arg1 - arg2} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1411 :echo F(5, 2) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1412 < 3 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1413 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1414 The arguments are optional. Example: > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1415 :let F = {-> 'error function'} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1416 :echo F() |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1417 < error function |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1418 *closure* |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1419 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
|
1420 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
|
1421 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
|
1422 the function returns: > |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1423 :function Foo(arg) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1424 : let i = 3 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1425 : return {x -> x + i - a:arg} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1426 :endfunction |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1427 :let Bar = Foo(4) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1428 :echo Bar(6) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1429 < 5 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1430 |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1431 Note that the variables must exist in the outer scope before the lamba is |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1432 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
|
1433 |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1434 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
|
1435 if has('lambda') |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1436 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1437 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
|
1438 :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
|
1439 < [2, 3, 4] > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1440 :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
|
1441 < [1, 2, 3, 4, 7] |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1442 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1443 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
|
1444 :let timer = timer_start(500, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1445 \ {-> execute("echo 'Handler called'", "")}, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1446 \ {'repeat': 3}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1447 < Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1448 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1449 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1450 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1451 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
|
1452 |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1453 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1454 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
|
1455 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
|
1456 :function {'<lambda>42'} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1457 See also: |numbered-function| |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1458 |
| 7 | 1459 ============================================================================== |
| 2596 | 1460 3. Internal variable *internal-variables* *E461* |
| 1461 | |
| 7 | 1462 An internal variable name can be made up of letters, digits and '_'. But it |
| 1463 cannot start with a digit. It's also possible to use curly braces, see | |
| 1464 |curly-braces-names|. | |
| 1465 | |
| 1466 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1467 An internal variable is explicitly destroyed with the ":unlet" command |
| 1468 |:unlet|. | |
| 1469 Using a name that is not an internal variable or refers to a variable that has | |
| 1470 been destroyed results in an error. | |
| 7 | 1471 |
| 1472 There are several name spaces for variables. Which one is to be used is | |
| 1473 specified by what is prepended: | |
| 1474 | |
| 1475 (nothing) In a function: local to a function; otherwise: global | |
| 1476 |buffer-variable| b: Local to the current buffer. | |
| 1477 |window-variable| w: Local to the current window. | |
| 819 | 1478 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1479 |global-variable| g: Global. |
| 1480 |local-variable| l: Local to a function. | |
| 1481 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1482 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1483 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1484 |
| 685 | 1485 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1486 delete all script-local variables: > | |
| 133 | 1487 :for k in keys(s:) |
| 1488 : unlet s:[k] | |
| 1489 :endfor | |
| 1490 < | |
| 4358 | 1491 *buffer-variable* *b:var* *b:* |
| 7 | 1492 A variable name that is preceded with "b:" is local to the current buffer. |
| 1493 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1494 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1495 |:bdelete|. | |
| 1496 | |
| 1497 One local buffer variable is predefined: | |
| 4264 | 1498 *b:changedtick* *changetick* |
| 7 | 1499 b:changedtick The total number of changes to the current buffer. It is |
| 1500 incremented for each change. An undo command is also a change | |
| 1501 in this case. This can be used to perform an action only when | |
| 1502 the buffer has changed. Example: > | |
| 1503 :if my_changedtick != b:changedtick | |
| 1621 | 1504 : let my_changedtick = b:changedtick |
| 1505 : call My_Update() | |
| 7 | 1506 :endif |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1507 < You cannot change or delete the b:changedtick variable. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1508 |
| 4358 | 1509 *window-variable* *w:var* *w:* |
| 7 | 1510 A variable name that is preceded with "w:" is local to the current window. It |
| 1511 is deleted when the window is closed. | |
| 1512 | |
| 4437 | 1513 *tabpage-variable* *t:var* *t:* |
| 819 | 1514 A variable name that is preceded with "t:" is local to the current tab page, |
| 1515 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
|
1516 without the |+windows| feature} |
| 819 | 1517 |
| 4358 | 1518 *global-variable* *g:var* *g:* |
| 7 | 1519 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
|
1520 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1521 place if you like. |
| 1522 | |
| 4358 | 1523 *local-variable* *l:var* *l:* |
| 7 | 1524 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1525 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1526 you may run into reserved variable names. For example "count". By itself it | |
| 1527 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1528 same name. | |
| 7 | 1529 |
| 1530 *script-variable* *s:var* | |
| 1531 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1532 accessed from outside of the scripts, thus are local to the script. | |
| 1533 | |
| 1534 They can be used in: | |
| 1535 - commands executed while the script is sourced | |
| 1536 - functions defined in the script | |
| 1537 - autocommands defined in the script | |
| 1538 - functions and autocommands defined in functions and autocommands which were | |
| 1539 defined in the script (recursively) | |
| 1540 - user defined commands defined in the script | |
| 1541 Thus not in: | |
| 1542 - other scripts sourced from this one | |
| 1543 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1544 - menus |
| 7 | 1545 - etc. |
| 1546 | |
| 1156 | 1547 Script variables can be used to avoid conflicts with global variable names. |
| 1548 Take this example: > | |
| 7 | 1549 |
| 1550 let s:counter = 0 | |
| 1551 function MyCounter() | |
| 1552 let s:counter = s:counter + 1 | |
| 1553 echo s:counter | |
| 1554 endfunction | |
| 1555 command Tick call MyCounter() | |
| 1556 | |
| 1557 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1558 that script will not be changed, only the "s:counter" in the script where | |
| 1559 "Tick" was defined is used. | |
| 1560 | |
| 1561 Another example that does the same: > | |
| 1562 | |
| 1563 let s:counter = 0 | |
| 1564 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1565 | |
| 1566 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1567 script variables is set to the script where the function or command was |
| 7 | 1568 defined. |
| 1569 | |
| 1570 The script variables are also available when a function is defined inside a | |
| 1571 function that is defined in a script. Example: > | |
| 1572 | |
| 1573 let s:counter = 0 | |
| 1574 function StartCounting(incr) | |
| 1575 if a:incr | |
| 1576 function MyCounter() | |
| 1577 let s:counter = s:counter + 1 | |
| 1578 endfunction | |
| 1579 else | |
| 1580 function MyCounter() | |
| 1581 let s:counter = s:counter - 1 | |
| 1582 endfunction | |
| 1583 endif | |
| 1584 endfunction | |
| 1585 | |
| 1586 This defines the MyCounter() function either for counting up or counting down | |
| 1587 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1588 called, the s:counter variable will be accessible in MyCounter(). | |
| 1589 | |
| 1590 When the same script is sourced again it will use the same script variables. | |
| 1591 They will remain valid as long as Vim is running. This can be used to | |
| 1592 maintain a counter: > | |
| 1593 | |
| 1594 if !exists("s:counter") | |
| 1595 let s:counter = 1 | |
| 1596 echo "script executed for the first time" | |
| 1597 else | |
| 1598 let s:counter = s:counter + 1 | |
| 1599 echo "script executed " . s:counter . " times now" | |
| 1600 endif | |
| 1601 | |
| 1602 Note that this means that filetype plugins don't get a different set of script | |
| 1603 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1604 | |
| 1605 | |
| 15131 | 1606 PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:* |
| 1607 *E963* | |
| 1608 Some variables can be set by the user, but the type cannot be changed. | |
| 7 | 1609 |
| 189 | 1610 *v:beval_col* *beval_col-variable* |
| 1611 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1612 This is the byte index in the |v:beval_lnum| line. | |
| 1613 Only valid while evaluating the 'balloonexpr' option. | |
| 1614 | |
| 1615 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1616 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1617 valid while evaluating the 'balloonexpr' option. | |
| 1618 | |
| 1619 *v:beval_lnum* *beval_lnum-variable* | |
| 1620 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1621 valid while evaluating the 'balloonexpr' option. | |
| 1622 | |
| 1623 *v:beval_text* *beval_text-variable* | |
| 374 | 1624 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1625 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1626 but a dot and "->" before the position is included. When on a | |
| 1627 ']' the text before it is used, including the matching '[' and | |
| 189 | 1628 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
|
1629 highlighted text is used. Also see |<cexpr>|. |
| 189 | 1630 Only valid while evaluating the 'balloonexpr' option. |
| 1631 | |
| 1632 *v:beval_winnr* *beval_winnr-variable* | |
| 1633 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1634 valid while evaluating the 'balloonexpr' option. The first |
| 1635 window has number zero (unlike most other places where a | |
| 1636 window gets a number). | |
| 189 | 1637 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1638 *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
|
1639 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
|
1640 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
|
1641 |
| 844 | 1642 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1643 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
|
1644 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
|
1645 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1646 |
| 7 | 1647 *v:charconvert_from* *charconvert_from-variable* |
| 1648 v:charconvert_from | |
| 1649 The name of the character encoding of a file to be converted. | |
| 1650 Only valid while evaluating the 'charconvert' option. | |
| 1651 | |
| 1652 *v:charconvert_to* *charconvert_to-variable* | |
| 1653 v:charconvert_to | |
| 1654 The name of the character encoding of a file after conversion. | |
| 1655 Only valid while evaluating the 'charconvert' option. | |
| 1656 | |
| 1657 *v:cmdarg* *cmdarg-variable* | |
| 1658 v:cmdarg This variable is used for two purposes: | |
| 1659 1. The extra arguments given to a file read/write command. | |
| 1660 Currently these are "++enc=" and "++ff=". This variable is | |
| 1661 set before an autocommand event for a file read/write | |
| 1662 command is triggered. There is a leading space to make it | |
| 1663 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
|
1664 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1665 included here, because it will be executed anyway. |
| 1666 2. When printing a PostScript file with ":hardcopy" this is | |
| 1667 the argument for the ":hardcopy" command. This can be used | |
| 1668 in 'printexpr'. | |
| 1669 | |
| 1670 *v:cmdbang* *cmdbang-variable* | |
| 1671 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1672 was used the value is 1, otherwise it is 0. Note that this | |
| 1673 can only be used in autocommands. For user commands |<bang>| | |
| 1674 can be used. | |
| 1675 | |
| 6909 | 1676 *v:completed_item* *completed_item-variable* |
| 1677 v:completed_item | |
| 1678 |Dictionary| containing the |complete-items| for the most | |
| 1679 recently completed word after |CompleteDone|. The | |
| 1680 |Dictionary| is empty if the completion failed. | |
| 1681 | |
| 7 | 1682 *v:count* *count-variable* |
| 1683 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
|
1684 to get the count before a mapping. Read-only. Example: > |
| 7 | 1685 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1686 < Note: The <C-U> is required to remove the line range that you | |
| 1687 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1688 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1689 just like what happens in the command, "d6w" for the example. |
| 667 | 1690 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
|
1691 "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
|
1692 |scriptversion| is 3 or higher. |
| 7 | 1693 |
| 1694 *v:count1* *count1-variable* | |
| 1695 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1696 used. | |
| 1697 | |
| 1698 *v:ctype* *ctype-variable* | |
| 1699 v:ctype The current locale setting for characters of the runtime | |
| 1700 environment. This allows Vim scripts to be aware of the | |
| 1701 current locale encoding. Technical: it's the value of | |
| 1702 LC_CTYPE. When not using a locale the value is "C". | |
| 1703 This variable can not be set directly, use the |:language| | |
| 1704 command. | |
| 1705 See |multi-lang|. | |
| 1706 | |
| 1707 *v:dying* *dying-variable* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1708 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1709 one. When multiple signals are caught the number increases. |
| 1710 Can be used in an autocommand to check if Vim didn't | |
| 1711 terminate normally. {only works on Unix} | |
| 1712 Example: > | |
| 1713 :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
|
1714 < 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
|
1715 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
|
1716 |
| 7 | 1717 *v:errmsg* *errmsg-variable* |
| 1718 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1719 Example: > | |
| 1720 :let v:errmsg = "" | |
| 1721 :silent! next | |
| 1722 :if v:errmsg != "" | |
| 1723 : ... 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
|
1724 < "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
|
1725 |scriptversion| is 3 or higher. |
| 7 | 1726 |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
1727 *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
|
1728 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
|
1729 This is a list of strings. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1730 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
|
1731 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
|
1732 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
|
1733 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
|
1734 :let v:errors = [] |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1735 < 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
|
1736 list by the assert function. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1737 |
|
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1738 *v:event* *event-variable* |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1739 v:event Dictionary containing information about the current |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1740 |autocommand|. The dictionary is emptied when the |autocommand| |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1741 finishes, please refer to |dict-identity| for how to get an |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1742 independent copy of it. |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1743 |
| 7 | 1744 *v:exception* *exception-variable* |
| 1745 v:exception The value of the exception most recently caught and not | |
| 1746 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1747 Example: > | |
| 1748 :try | |
| 1749 : throw "oops" | |
| 1750 :catch /.*/ | |
| 1751 : echo "caught" v:exception | |
| 1752 :endtry | |
| 1753 < Output: "caught oops". | |
| 1754 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1755 *v:false* *false-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1756 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
|
1757 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1758 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
|
1759 echo v:false |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1760 < v:false ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1761 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
|
1762 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1763 |
| 179 | 1764 *v:fcs_reason* *fcs_reason-variable* |
| 1765 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1766 Can be used in an autocommand to decide what to do and/or what | |
| 1767 to set v:fcs_choice to. Possible values: | |
| 1768 deleted file no longer exists | |
| 1769 conflict file contents, mode or timestamp was | |
| 1770 changed and buffer is modified | |
| 1771 changed file contents has changed | |
| 1772 mode mode of file changed | |
| 1773 time only file timestamp changed | |
| 1774 | |
| 1775 *v:fcs_choice* *fcs_choice-variable* | |
| 1776 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1777 triggered. Can be used in an autocommand to tell Vim what to | |
| 1778 do with the affected buffer: | |
| 1779 reload Reload the buffer (does not work if | |
| 1780 the file was deleted). | |
| 1781 ask Ask the user what to do, as if there | |
| 1782 was no autocommand. Except that when | |
| 1783 only the timestamp changed nothing | |
| 1784 will happen. | |
| 1785 <empty> Nothing, the autocommand should do | |
| 1786 everything that needs to be done. | |
| 1787 The default is empty. If another (invalid) value is used then | |
| 1788 Vim behaves like it is empty, there is no warning message. | |
| 1789 | |
| 7 | 1790 *v:fname_in* *fname_in-variable* |
| 579 | 1791 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1792 option used for ~ |
| 1793 'charconvert' file to be converted | |
| 1794 'diffexpr' original file | |
| 1795 'patchexpr' original file | |
| 1796 'printexpr' file to be printed | |
| 593 | 1797 And set to the swap file name for |SwapExists|. |
| 7 | 1798 |
| 1799 *v:fname_out* *fname_out-variable* | |
| 1800 v:fname_out The name of the output file. Only valid while | |
| 1801 evaluating: | |
| 1802 option used for ~ | |
| 1803 'charconvert' resulting converted file (*) | |
| 1804 'diffexpr' output of diff | |
| 1805 'patchexpr' resulting patched file | |
| 1806 (*) 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
|
1807 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1808 for a read command (e.g., ":e file") it will be a temporary |
| 1809 file and different from v:fname_in. | |
| 1810 | |
| 1811 *v:fname_new* *fname_new-variable* | |
| 1812 v:fname_new The name of the new version of the file. Only valid while | |
| 1813 evaluating 'diffexpr'. | |
| 1814 | |
| 1815 *v:fname_diff* *fname_diff-variable* | |
| 1816 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1817 evaluating 'patchexpr'. | |
| 1818 | |
| 1819 *v:folddashes* *folddashes-variable* | |
| 1820 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1821 fold. | |
| 29 | 1822 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1823 |
| 1824 *v:foldlevel* *foldlevel-variable* | |
| 1825 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1826 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1827 |
| 1828 *v:foldend* *foldend-variable* | |
| 1829 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1830 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1831 |
| 1832 *v:foldstart* *foldstart-variable* | |
| 1833 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1834 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1835 |
| 5460 | 1836 *v:hlsearch* *hlsearch-variable* |
| 12785 | 1837 v:hlsearch Variable that indicates whether search highlighting is on. |
| 6413 | 1838 Setting it makes sense only if 'hlsearch' is enabled which |
| 1839 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
|
1840 like the |:nohlsearch| command, setting it to one acts like > |
| 5460 | 1841 let &hlsearch = &hlsearch |
| 6918 | 1842 < Note that the value is restored when returning from a |
| 1843 function. |function-search-undo|. | |
| 1844 | |
| 11 | 1845 *v:insertmode* *insertmode-variable* |
| 1846 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1847 events. Values: | |
| 1848 i Insert mode | |
| 1849 r Replace mode | |
| 1850 v Virtual Replace mode | |
| 1851 | |
| 102 | 1852 *v:key* *key-variable* |
| 685 | 1853 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1854 evaluating the expression used with |map()| and |filter()|. |
| 1855 Read-only. | |
| 1856 | |
| 7 | 1857 *v:lang* *lang-variable* |
| 1858 v:lang The current locale setting for messages of the runtime | |
| 1859 environment. This allows Vim scripts to be aware of the | |
| 1860 current language. Technical: it's the value of LC_MESSAGES. | |
| 1861 The value is system dependent. | |
| 1862 This variable can not be set directly, use the |:language| | |
| 1863 command. | |
| 1864 It can be different from |v:ctype| when messages are desired | |
| 1865 in a different language than what is used for character | |
| 1866 encoding. See |multi-lang|. | |
| 1867 | |
| 1868 *v:lc_time* *lc_time-variable* | |
| 1869 v:lc_time The current locale setting for time messages of the runtime | |
| 1870 environment. This allows Vim scripts to be aware of the | |
| 1871 current language. Technical: it's the value of LC_TIME. | |
| 1872 This variable can not be set directly, use the |:language| | |
| 1873 command. See |multi-lang|. | |
| 1874 | |
| 1875 *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
|
1876 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
|
1877 '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
|
1878 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
|
1879 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
|
1880 |sandbox|. |
| 7 | 1881 |
| 1029 | 1882 *v:mouse_win* *mouse_win-variable* |
| 1883 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1884 First window has number 1, like with |winnr()|. The value is | |
| 1885 zero when there was no mouse button click. | |
| 1886 | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1887 *v:mouse_winid* *mouse_winid-variable* |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1888 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
|
1889 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
|
1890 |
| 1029 | 1891 *v:mouse_lnum* *mouse_lnum-variable* |
| 1892 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1893 This is the text line number, not the screen line number. The | |
| 1894 value is zero when there was no mouse button click. | |
| 1895 | |
| 1896 *v:mouse_col* *mouse_col-variable* | |
| 1897 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1898 This is the screen column number, like with |virtcol()|. The | |
| 1899 value is zero when there was no mouse button click. | |
| 1900 | |
| 15512 | 1901 *v:none* *none-variable* *None* |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1902 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
|
1903 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1904 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
|
1905 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
|
1906 echo v:none |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1907 < v:none ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1908 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
|
1909 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1910 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1911 *v:null* *null-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1912 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
|
1913 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1914 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
|
1915 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
|
1916 echo v:null |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1917 < v:null ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1918 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
|
1919 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1920 |
| 1733 | 1921 *v:oldfiles* *oldfiles-variable* |
| 1922 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 1923 startup. These are the files that Vim remembers marks for. | |
| 1924 The length of the List is limited by the ' argument of the | |
| 1925 'viminfo' option (default is 100). | |
| 5618 | 1926 When the |viminfo| file is not used the List is empty. |
| 1733 | 1927 Also see |:oldfiles| and |c_#<|. |
| 1928 The List can be modified, but this has no effect on what is | |
| 1929 stored in the |viminfo| file later. If you use values other | |
| 1930 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
|
1931 {only when compiled with the |+viminfo| feature} |
| 1733 | 1932 |
| 6935 | 1933 *v:option_new* |
| 1934 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 1935 autocommand. | |
| 1936 *v:option_old* | |
| 1937 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
| 1938 autocommand. | |
| 1939 *v:option_type* | |
| 1940 v:option_type Scope of the set command. Valid while executing an | |
| 1941 |OptionSet| autocommand. Can be either "global" or "local" | |
| 1490 | 1942 *v:operator* *operator-variable* |
| 1943 v:operator The last operator given in Normal mode. This is a single | |
| 1944 character except for commands starting with <g> or <z>, | |
| 1945 in which case it is two characters. Best used alongside | |
| 1946 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 1947 Operator-pending mode and then use the operator, e.g.: > | |
| 1948 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 1949 < The value remains set until another operator is entered, thus | |
| 1950 don't expect it to be empty. | |
| 1951 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 1952 commands. | |
| 1953 Read-only. | |
| 1954 | |
| 7 | 1955 *v:prevcount* *prevcount-variable* |
| 1956 v:prevcount The count given for the last but one Normal mode command. | |
| 1957 This is the v:count value of the previous command. Useful if | |
| 1490 | 1958 you want to cancel Visual or Operator-pending mode and then |
| 1959 use the count, e.g.: > | |
| 7 | 1960 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 1961 < Read-only. | |
| 1962 | |
| 170 | 1963 *v:profiling* *profiling-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1964 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 1965 See |profiling|. |
| 1966 | |
| 7 | 1967 *v:progname* *progname-variable* |
| 1968 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 1969 invoked. Allows you to do special initialisations for |view|, |
| 1970 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 1971 Read-only. |
| 1972 | |
| 5780 | 1973 *v:progpath* *progpath-variable* |
| 1974 v:progpath Contains the command with which Vim was invoked, including the | |
| 1975 path. Useful if you want to message a Vim server using a | |
| 1976 |--remote-expr|. | |
| 5782 | 1977 To get the full path use: > |
| 1978 echo exepath(v:progpath) | |
|
11032
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
1979 < If the path is relative it will be expanded to the full path, |
|
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
1980 so that it still works after `:cd`. Thus starting "./vim" |
|
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
1981 results in "/home/user/path/to/vim/src/vim". |
|
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
1982 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
|
1983 ".exe" is not added to v:progpath. |
| 5780 | 1984 Read-only. |
| 1985 | |
| 7 | 1986 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1987 v:register The name of the register in effect for the current normal mode |
| 3492 | 1988 command (regardless of whether that command actually used a |
| 1989 register). Or for the currently executing normal mode mapping | |
| 1990 (use this in custom commands that take a register). | |
| 1991 If none is supplied it is the default register '"', unless | |
| 1992 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 1993 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1994 Also see |getreg()| and |setreg()| |
| 7 | 1995 |
| 540 | 1996 *v:scrollstart* *scrollstart-variable* |
| 1997 v:scrollstart String describing the script or function that caused the | |
| 1998 screen to scroll up. It's only set when it is empty, thus the | |
| 1999 first reason is remembered. It is set to "Unknown" for a | |
| 2000 typed command. | |
| 2001 This can be used to find out why your script causes the | |
| 2002 hit-enter prompt. | |
| 2003 | |
| 7 | 2004 *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
|
2005 v:servername The resulting registered |client-server-name| if any. |
| 7 | 2006 Read-only. |
| 2007 | |
| 12785 | 2008 |
| 1621 | 2009 v:searchforward *v:searchforward* *searchforward-variable* |
| 2010 Search direction: 1 after a forward search, 0 after a | |
| 2011 backward search. It is reset to forward when directly setting | |
| 2012 the last search pattern, see |quote/|. | |
| 2013 Note that the value is restored when returning from a | |
| 2014 function. |function-search-undo|. | |
| 2015 Read-write. | |
| 2016 | |
| 7 | 2017 *v:shell_error* *shell_error-variable* |
| 2018 v:shell_error Result of the last shell command. When non-zero, the last | |
| 2019 shell command had an error. When zero, there was no problem. | |
| 2020 This only works when the shell returns the error code to Vim. | |
| 2021 The value -1 is often used when the command could not be | |
| 2022 executed. Read-only. | |
| 2023 Example: > | |
| 2024 :!mv foo bar | |
| 2025 :if v:shell_error | |
| 2026 : echo 'could not rename "foo" to "bar"!' | |
| 2027 :endif | |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2028 < "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
|
2029 |scriptversion| is 3 or higher. |
| 7 | 2030 |
| 2031 *v:statusmsg* *statusmsg-variable* | |
| 2032 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 2033 | |
| 579 | 2034 *v:swapname* *swapname-variable* |
| 2035 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 2036 the swap file found. Read-only. | |
| 2037 | |
| 2038 *v:swapchoice* *swapchoice-variable* | |
| 2039 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 2040 for handling an existing swap file: | |
| 2041 'o' Open read-only | |
| 2042 'e' Edit anyway | |
| 2043 'r' Recover | |
| 2044 'd' Delete swapfile | |
| 2045 'q' Quit | |
| 2046 'a' Abort | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2047 The value should be a single-character string. An empty value |
| 579 | 2048 results in the user being asked, as would happen when there is |
| 2049 no SwapExists autocommand. The default is empty. | |
| 2050 | |
| 590 | 2051 *v:swapcommand* *swapcommand-variable* |
| 625 | 2052 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 2053 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
|
2054 another Vim open the file and jump to the right place. For |
| 590 | 2055 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 2056 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 2057 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2058 *v:t_TYPE* *v:t_bool* *t_bool-variable* |
| 15512 | 2059 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
|
2060 *v:t_channel* *t_channel-variable* |
| 15512 | 2061 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
|
2062 *v:t_dict* *t_dict-variable* |
| 15512 | 2063 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
|
2064 *v:t_float* *t_float-variable* |
| 15512 | 2065 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
|
2066 *v:t_func* *t_func-variable* |
| 15512 | 2067 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
|
2068 *v:t_job* *t_job-variable* |
| 15512 | 2069 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
|
2070 *v:t_list* *t_list-variable* |
| 15512 | 2071 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
|
2072 *v:t_none* *t_none-variable* |
| 15512 | 2073 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
|
2074 *v:t_number* *t_number-variable* |
| 15512 | 2075 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
|
2076 *v:t_string* *t_string-variable* |
| 15512 | 2077 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
|
2078 *v:t_blob* *t_blob-variable* |
| 15512 | 2079 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
|
2080 |
| 7 | 2081 *v:termresponse* *termresponse-variable* |
| 2082 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
|
2083 termcap entry. It is set when Vim receives an escape sequence |
| 7 | 2084 that starts with ESC [ or CSI and ends in a 'c', with only |
| 2085 digits, ';' and '.' in between. | |
| 2086 When this option is set, the TermResponse autocommand event is | |
| 2087 fired, so that you can react to the response from the | |
| 2088 terminal. | |
| 2089 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
| 2090 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
| 2091 patch level (since this was introduced in patch 95, it's | |
| 2092 always 95 or bigger). Pc is always zero. | |
| 2093 {only when compiled with |+termresponse| feature} | |
| 2094 | |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2095 *v:termblinkresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2096 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
|
2097 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
|
2098 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
|
2099 |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2100 *v:termstyleresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2101 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
|
2102 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
|
2103 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
|
2104 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2105 *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
|
2106 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
|
2107 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
|
2108 background color is, see 'background'. |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2109 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2110 *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
|
2111 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
|
2112 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
|
2113 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
|
2114 |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2115 *v:termu7resp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2116 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
|
2117 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
|
2118 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
|
2119 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
2120 *v:testing* *testing-variable* |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2121 v:testing Must be set before using `test_garbagecollect_now()`. |
| 11160 | 2122 Also, when set certain error messages won't be shown for 2 |
| 12785 | 2123 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
|
2124 |
| 7 | 2125 *v:this_session* *this_session-variable* |
| 2126 v:this_session Full filename of the last loaded or saved session file. See | |
| 2127 |:mksession|. It is allowed to set this variable. When no | |
| 2128 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
|
2129 "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
|
2130 |scriptversion| is 3 or higher |
| 7 | 2131 |
| 2132 *v:throwpoint* *throwpoint-variable* | |
| 2133 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
|
2134 finished was thrown. Not set when commands are typed. See |
| 7 | 2135 also |v:exception| and |throw-variables|. |
| 2136 Example: > | |
| 2137 :try | |
| 2138 : throw "oops" | |
| 2139 :catch /.*/ | |
| 2140 : echo "Exception from" v:throwpoint | |
| 2141 :endtry | |
| 2142 < Output: "Exception from test.vim, line 2" | |
| 2143 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2144 *v:true* *true-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2145 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
|
2146 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2147 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
|
2148 echo v:true |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2149 < v:true ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2150 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
|
2151 value. Read-only. |
| 102 | 2152 *v:val* *val-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2153 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 2154 valid while evaluating the expression used with |map()| and |
| 102 | 2155 |filter()|. Read-only. |
| 2156 | |
| 7 | 2157 *v:version* *version-variable* |
| 2158 v:version Version number of Vim: Major version number times 100 plus | |
| 2159 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
| 2160 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
|
2161 compatibility, unless |scriptversion| is 3 or higher. |
| 7 | 2162 Use |has()| to check if a certain patch was included, e.g.: > |
| 5786 | 2163 if has("patch-7.4.123") |
| 7 | 2164 < Note that patch numbers are specific to the version, thus both |
| 2165 version 5.0 and 5.1 may have a patch 123, but these are | |
| 2166 completely different. | |
| 2167 | |
|
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2168 *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
|
2169 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
|
2170 before |VimEnter| autocommands are triggered. |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2171 |
| 7 | 2172 *v:warningmsg* *warningmsg-variable* |
| 2173 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 2174 | |
| 2609 | 2175 *v:windowid* *windowid-variable* |
| 2176 v:windowid When any X11 based GUI is running or when running in a | |
| 2177 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 2178 set to the window ID. |
| 2179 When an MS-Windows GUI is running this will be set to the | |
| 2180 window handle. | |
| 2181 Otherwise the value is zero. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2182 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
|
2183 see |window-ID|. |
| 2609 | 2184 |
| 7 | 2185 ============================================================================== |
| 2186 4. Builtin Functions *functions* | |
| 2187 | |
| 2188 See |function-list| for a list grouped by what the function is used for. | |
| 2189 | |
| 236 | 2190 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 2191 |
| 2192 USAGE RESULT DESCRIPTION ~ | |
| 2193 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2194 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
|
2195 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
|
2196 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
|
2197 and({expr}, {expr}) Number bitwise AND |
| 14864 | 2198 append({lnum}, {text}) Number append {text} below line {lnum} |
| 2199 appendbufline({expr}, {lnum}, {text}) | |
| 2200 Number append {text} below line {lnum} | |
| 2201 in buffer {expr} | |
| 15033 | 2202 argc([{winid}]) Number number of files in the argument list |
| 55 | 2203 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
|
2204 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
|
2205 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
|
2206 argv([-1, {winid}]) List the argument list |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2207 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
|
2208 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
|
2209 Number assert {exp} is equal to {act} |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2210 assert_equalfile({fname-one}, {fname-two}) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2211 Number assert file contents is equal |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2212 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
|
2213 Number assert {error} is in v:exception |
| 14945 | 2214 assert_fails({cmd} [, {error} [, {msg}]]) |
| 2215 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
|
2216 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
|
2217 Number assert {actual} is false |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2218 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
|
2219 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
|
2220 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
|
2221 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
|
2222 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
|
2223 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
|
2224 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
|
2225 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
|
2226 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
|
2227 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
|
2228 asin({expr}) Float arc sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2229 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
|
2230 atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2} |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
2231 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
|
2232 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
|
2233 browse({save}, {title}, {initdir}, {default}) |
| 7 | 2234 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
|
2235 browsedir({title}, {initdir}) String put up a directory requester |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2236 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
|
2237 buflisted({expr}) Number |TRUE| if buffer {expr} is listed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2238 bufloaded({expr}) Number |TRUE| if buffer {expr} is loaded |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2239 bufname({expr}) String Name of the buffer {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2240 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
|
2241 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
|
2242 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
|
2243 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
|
2244 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
|
2245 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
|
2246 call({func}, {arglist} [, {dict}]) |
| 102 | 2247 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
|
2248 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
|
2249 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
|
2250 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
|
2251 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
|
2252 ch_evalexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2253 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
|
2254 ch_evalraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2255 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
|
2256 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
|
2257 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
|
2258 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
|
2259 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
|
2260 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
|
2261 ch_open({address} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2262 Channel open a channel to {address} |
|
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2263 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
|
2264 ch_readblob({handle} [, {options}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2265 Blob read Blob from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2266 ch_readraw({handle} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2267 String read raw from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2268 ch_sendexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2269 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
|
2270 ch_sendraw({handle}, {expr} [, {options}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2271 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
|
2272 ch_setoptions({handle}, {options}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2273 none set options for {handle} |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2274 ch_status({handle} [, {options}]) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2275 String status of channel {handle} |
| 1621 | 2276 changenr() Number current change number |
| 12785 | 2277 char2nr({expr} [, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2278 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
|
2279 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
|
2280 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
|
2281 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
|
2282 complete_add({expr}) Number add completion match |
| 1621 | 2283 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
|
2284 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
|
2285 confirm({msg} [, {choices} [, {default} [, {type}]]]) |
| 7 | 2286 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
|
2287 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
|
2288 cos({expr}) Float cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2289 cosh({expr}) Float hyperbolic cosine of {expr} |
| 14864 | 2290 count({comp}, {expr} [, {ic} [, {start}]]) |
| 2291 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
|
2292 cscope_connection([{num}, {dbpath} [, {prepend}]]) |
| 7 | 2293 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
|
2294 cursor({lnum}, {col} [, {off}]) |
| 6385 | 2295 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
|
2296 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
|
2297 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
|
2298 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
|
2299 delete({fname} [, {flags}]) Number delete the file or directory {fname} |
| 14519 | 2300 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
|
2301 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
|
2302 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
|
2303 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
|
2304 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2305 empty({expr}) Number |TRUE| if {expr} is empty |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2306 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
|
2307 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
|
2308 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
|
2309 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
|
2310 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
|
2311 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
|
2312 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
|
2313 extend({expr1}, {expr2} [, {expr3}]) |
| 824 | 2314 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
|
2315 exp({expr}) Float exponential of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2316 expand({expr} [, {nosuf} [, {list}]]) |
| 3398 | 2317 any expand special keywords in {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2318 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
|
2319 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
|
2320 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
|
2321 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
|
2322 {expr2} is 0 |
| 12785 | 2323 finddir({name} [, {path} [, {count}]]) |
| 824 | 2324 String find directory {name} in {path} |
| 12785 | 2325 findfile({name} [, {path} [, {count}]]) |
| 824 | 2326 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
|
2327 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
|
2328 floor({expr}) Float round {expr} down |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2329 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
|
2330 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
|
2331 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
|
2332 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
|
2333 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
|
2334 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
|
2335 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
|
2336 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
|
2337 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
|
2338 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2339 Funcref reference to function {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2340 function({name} [, {arglist}] [, {dict}]) |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2341 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
|
2342 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
|
2343 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
|
2344 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
|
2345 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
|
2346 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
|
2347 getbufline({expr}, {lnum} [, {end}]) |
| 435 | 2348 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
|
2349 getbufvar({expr}, {varname} [, {def}]) |
| 4157 | 2350 any variable {varname} in buffer {expr} |
|
13280
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
2351 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
|
2352 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
|
2353 getcharmod() Number modifiers for the last typed character |
| 7013 | 2354 getcharsearch() Dict last character search |
| 7 | 2355 getcmdline() String return the current command-line |
| 2356 getcmdpos() Number return cursor position in command-line | |
| 6153 | 2357 getcmdtype() String return current command-line type |
| 2358 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
|
2359 getcompletion({pat}, {type} [, {filtered}]) |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
2360 List list of cmdline completion matches |
| 5944 | 2361 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
|
2362 getcwd([{winnr} [, {tabnr}]]) String get the current working directory |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2363 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
|
2364 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
|
2365 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
|
2366 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
|
2367 getftype({fname}) String description of type of file {fname} |
|
13246
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
2368 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
|
2369 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
|
2370 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
|
2371 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer |
| 12785 | 2372 getloclist({nr} [, {what}]) List list of location list items |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2373 getmatches([{win}]) List list of current matches |
| 1548 | 2374 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
|
2375 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
|
2376 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
|
2377 getreg([{regname} [, 1 [, {list}]]]) |
| 5796 | 2378 String or List contents of register |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2379 getregtype([{regname}]) String type of register |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2380 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
|
2381 gettabvar({nr}, {varname} [, {def}]) |
| 4157 | 2382 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
|
2383 gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) |
| 831 | 2384 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
|
2385 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
|
2386 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
|
2387 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
|
2388 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
|
2389 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
|
2390 getwinvar({nr}, {varname} [, {def}]) |
| 4157 | 2391 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
|
2392 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 2393 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
|
2394 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
|
2395 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 2396 String do glob({expr}) for all dirs in {path} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2397 has({feature}) Number |TRUE| if feature {feature} supported |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2398 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
|
2399 haslocaldir([{winnr} [, {tabnr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2400 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
|
2401 or |:tcd| |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2402 hasmapto({what} [, {mode} [, {abbr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2403 Number |TRUE| if mapping to {what} exists |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2404 histadd({history}, {item}) String add an item to a history |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2405 histdel({history} [, {item}]) String remove an item from a history |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2406 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
|
2407 histnr({history}) Number highest index of a history |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2408 hlexists({name}) Number |TRUE| if highlight group {name} exists |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2409 hlID({name}) Number syntax ID of highlight group {name} |
| 7 | 2410 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
|
2411 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
|
2412 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
|
2413 index({object}, {expr} [, {start} [, {ic}]]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2414 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
|
2415 input({prompt} [, {text} [, {completion}]]) |
| 531 | 2416 String get input from the user |
|
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
2417 inputdialog({prompt} [, {text} [, {completion}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2418 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
|
2419 inputlist({textlist}) Number let the user pick from a choice list |
| 55 | 2420 inputrestore() Number restore typeahead |
| 2421 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
|
2422 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
|
2423 insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}] |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2424 invert({expr}) Number bitwise invert |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2425 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
|
2426 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
|
2427 (positive or negative) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2428 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
|
2429 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
|
2430 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
|
2431 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
|
2432 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
|
2433 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
|
2434 job_start({command} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2435 Job start a job |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2436 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
|
2437 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
|
2438 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
|
2439 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
|
2440 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
|
2441 json_decode({string}) any decode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2442 json_encode({expr}) String encode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2443 keys({dict}) List keys in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2444 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
|
2445 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
|
2446 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2447 line({expr}) Number line nr of cursor, last line or mark |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2448 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
|
2449 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
|
2450 list2str({list} [, {utf8}]) String turn numbers in {list} into a String |
| 7 | 2451 localtime() Number current time |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2452 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
|
2453 log10({expr}) Float logarithm of Float {expr} to base 10 |
| 12785 | 2454 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
|
2455 map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr} |
| 12785 | 2456 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 2457 String or Dict |
| 2458 rhs of mapping {name} in mode {mode} | |
| 12785 | 2459 mapcheck({name} [, {mode} [, {abbr}]]) |
| 782 | 2460 String check for mappings matching {name} |
| 12785 | 2461 match({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2462 Number position where {pat} matches in {expr} |
| 12785 | 2463 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 2464 Number highlight {pattern} with {group} |
| 12785 | 2465 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 2466 Number highlight positions with {group} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2467 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
|
2468 matchdelete({id} [, {win}]) Number delete match identified by {id} |
| 12785 | 2469 matchend({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2470 Number position where {pat} ends in {expr} |
| 12785 | 2471 matchlist({expr}, {pat} [, {start} [, {count}]]) |
| 158 | 2472 List match and submatches of {pat} in {expr} |
| 12785 | 2473 matchstr({expr}, {pat} [, {start} [, {count}]]) |
| 19 | 2474 String {count}'th match of {pat} in {expr} |
| 12785 | 2475 matchstrpos({expr}, {pat} [, {start} [, {count}]]) |
|
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
2476 List {count}'th match of {pat} in {expr} |
| 10734 | 2477 max({expr}) Number maximum value of items in {expr} |
| 2478 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
|
2479 mkdir({name} [, {path} [, {prot}]]) |
| 168 | 2480 Number create directory {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2481 mode([expr]) String current editing mode |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2482 mzeval({expr}) any evaluate |MzScheme| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2483 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} |
| 12785 | 2484 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
|
2485 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
|
2486 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
|
2487 perleval({expr}) any evaluate |Perl| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2488 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
|
2489 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
|
2490 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
|
2491 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
|
2492 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
|
2493 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
|
2494 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
|
2495 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
|
2496 none remove all text properties |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2497 prop_find({props} [, {direction}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2498 Dict search for a text property |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
2499 prop_list({lnum} [, {props}) List text properties in {lnum} |
| 15281 | 2500 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
|
2501 Number remove a text property |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2502 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
|
2503 prop_type_change({name}, {props}) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2504 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
|
2505 prop_type_delete({name} [, {props}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2506 none delete a property type |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2507 prop_type_get([{name} [, {props}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2508 Dict get property type values |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2509 prop_type_list([{props}]) List get list of property types |
| 1621 | 2510 pumvisible() Number whether popup menu is visible |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2511 pyeval({expr}) any evaluate |Python| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2512 py3eval({expr}) any evaluate |python3| expression |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
2513 pyxeval({expr}) any evaluate |python_x| expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2514 range({expr} [, {max} [, {stride}]]) |
| 99 | 2515 List items from {expr} to {max} |
| 16267 | 2516 readdir({dir} [, {expr}]) List file names in {dir} selected by {expr} |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2517 readfile({fname} [, {type} [, {max}]]) |
| 168 | 2518 List get list of lines from file {fname} |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
2519 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
|
2520 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
|
2521 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
|
2522 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
|
2523 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
|
2524 remote_expr({server}, {string} [, {idvar} [, {timeout}]]) |
| 7 | 2525 String send expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2526 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
|
2527 remote_peek({serverid} [, {retvar}]) |
| 7 | 2528 Number check for reply string |
|
11229
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2529 remote_read({serverid} [, {timeout}]) |
|
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2530 String read reply string |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2531 remote_send({server}, {string} [, {idvar}]) |
| 7 | 2532 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
|
2533 remote_startserver({name}) none become server {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
|
2534 remove({list}, {idx} [, {end}]) any/List |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
2535 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
|
2536 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
|
2537 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
|
2538 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
|
2539 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
|
2540 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
|
2541 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
|
2542 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
|
2543 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
|
2544 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
|
2545 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
|
2546 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
|
2547 screenchars({row}, {col}) List List of characters at screen position |
| 3986 | 2548 screencol() Number current cursor column |
| 2549 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
|
2550 screenstring({row}, {col}) String characters at screen position |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2551 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 1496 | 2552 Number search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2553 searchdecl({name} [, {global} [, {thisblock}]]) |
| 1621 | 2554 Number search for variable declaration |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2555 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 2556 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
|
2557 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 2558 List search for other end of start/end pair |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2559 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 667 | 2560 List search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2561 server2client({clientid}, {string}) |
| 7 | 2562 Number send reply string |
| 2563 serverlist() String get a list of available servers | |
| 14864 | 2564 setbufline({expr}, {lnum}, {text}) |
| 2565 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
|
2566 {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2567 setbufvar({expr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2568 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
|
2569 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
|
2570 setcmdpos({pos}) Number set cursor position in command-line |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2571 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
|
2572 setline({lnum}, {line}) Number set line {lnum} to {line} |
| 12785 | 2573 setloclist({nr}, {list} [, {action} [, {what}]]) |
| 647 | 2574 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
|
2575 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
|
2576 setpos({expr}, {list}) Number set the {expr} position to {list} |
| 12785 | 2577 setqflist({list} [, {action} [, {what}]]) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2578 Number modify quickfix list using {list} |
| 12785 | 2579 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
|
2580 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
|
2581 settabwinvar({tabnr}, {winnr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2582 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
|
2583 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
|
2584 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
|
2585 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
|
2586 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
|
2587 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
|
2588 shellescape({string} [, {special}]) |
| 1661 | 2589 String escape {string} for use as shell |
| 985 | 2590 command argument |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
2591 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
|
2592 sign_define({name} [, {dict}]) Number define or update a sign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2593 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
|
2594 sign_getplaced([{expr} [, {dict}]]) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2595 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
|
2596 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
|
2597 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
|
2598 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
|
2599 Number place a sign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2600 sign_undefine([{name}]) Number undefine a sign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2601 sign_unplace({group} [, {dict}]) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2602 Number unplace a sign |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2603 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
|
2604 sin({expr}) Float sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2605 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
|
2606 sort({list} [, {func} [, {dict}]]) |
| 2902 | 2607 List sort {list}, using {func} to compare |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2608 soundfold({word}) String sound-fold {word} |
| 344 | 2609 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
|
2610 spellsuggest({word} [, {max} [, {capital}]]) |
| 537 | 2611 List spelling suggestions |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2612 split({expr} [, {pat} [, {keepempty}]]) |
| 685 | 2613 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
|
2614 sqrt({expr}) Float square root of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2615 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
|
2616 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
|
2617 ASCII/UTF8 value |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2618 str2nr({expr} [, {base}]) Number convert String to Number |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2619 strchars({expr} [, {skipcc}]) Number character length of the String {expr} |
| 12785 | 2620 strcharpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2621 String {len} characters of {str} at {start} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2622 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} |
| 12785 | 2623 strftime({format} [, {time}]) String time in specified format |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2624 strgetchar({str}, {index}) Number get char {index} from {str} |
| 12785 | 2625 stridx({haystack}, {needle} [, {start}]) |
| 133 | 2626 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
|
2627 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
|
2628 strlen({expr}) Number length of the String {expr} |
| 12785 | 2629 strpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2630 String {len} characters of {str} at {start} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2631 strridx({haystack}, {needle} [, {start}]) |
| 140 | 2632 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
|
2633 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
|
2634 strwidth({expr}) Number display cell length of the String {expr} |
| 12785 | 2635 submatch({nr} [, {list}]) String or List |
| 5794 | 2636 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
|
2637 substitute({expr}, {pat}, {sub}, {flags}) |
| 7 | 2638 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
|
2639 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
|
2640 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
|
2641 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
|
2642 synIDattr({synID}, {what} [, {mode}]) |
| 7 | 2643 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
|
2644 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
|
2645 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
|
2646 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
|
2647 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
|
2648 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
|
2649 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
|
2650 tabpagenr([{arg}]) Number number of current or last tab page |
| 12785 | 2651 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page |
| 2652 taglist({expr} [, {filename}]) List list of tags matching {expr} | |
| 1621 | 2653 tagfiles() List tags files used |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2654 tan({expr}) Float tangent of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2655 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
|
2656 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
|
2657 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
|
2658 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
|
2659 term_dumpload({filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2660 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
|
2661 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
|
2662 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
|
2663 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
|
2664 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
|
2665 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
|
2666 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
|
2667 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
|
2668 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
|
2669 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
|
2670 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
|
2671 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
|
2672 term_gettitle({buf}) String get the title of a terminal |
| 12785 | 2673 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
|
2674 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
|
2675 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
|
2676 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
|
2677 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
|
2678 none set ANSI palette in GUI color mode |
| 13735 | 2679 term_setkill({buf}, {how}) none set signal to stop job in terminal |
| 13437 | 2680 term_setrestore({buf}, {command}) none set command to restore terminal |
| 13735 | 2681 term_setsize({buf}, {rows}, {cols}) |
| 2682 none set the size of a terminal | |
| 16380 | 2683 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
|
2684 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
|
2685 test_alloc_fail({id}, {countdown}, {repeat}) |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2686 none make memory allocation fail |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
2687 test_autochdir() none enable 'autochdir' during startup |
| 14864 | 2688 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
|
2689 test_garbagecollect_now() none free memory right now for testing |
|
11006
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
2690 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
|
2691 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
|
2692 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
|
2693 test_null_dict() Dict null value for testing |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2694 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
|
2695 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
|
2696 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
|
2697 test_null_string() String null value for testing |
| 14945 | 2698 test_option_not_set({name}) none reset flag indicating option was set |
| 2699 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
|
2700 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
|
2701 test_scrollbar({which}, {value}, {dragging}) |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
2702 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
|
2703 test_setmouse({row}, {col}) none set the mouse position for testing |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2704 test_settime({expr}) none set current time for testing |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
2705 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
|
2706 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
|
2707 timer_start({time}, {callback} [, {options}]) |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2708 Number create a timer |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2709 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
|
2710 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
|
2711 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
|
2712 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
|
2713 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 15 | 2714 to chars in {tostr} |
| 14519 | 2715 trim({text} [, {mask}]) String trim characters in {mask} from {text} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2716 trunc({expr}) Float truncate Float {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2717 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
|
2718 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
|
2719 undotree() List undo file tree |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2720 uniq({list} [, {func} [, {dict}]]) |
| 5747 | 2721 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
|
2722 values({dict}) List values in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2723 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
|
2724 visualmode([expr]) String last visual mode used |
| 4151 | 2725 wildmenumode() Number whether 'wildmenu' mode is active |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2726 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
|
2727 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2728 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
|
2729 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
|
2730 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
|
2731 win_screenpos({nr}) List get screen position of window {nr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2732 winbufnr({nr}) Number buffer number of window {nr} |
| 7 | 2733 wincol() Number window column of the cursor |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2734 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
|
2735 winlayout([{tabnr}]) List layout of windows in tab {tabnr} |
| 7 | 2736 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
|
2737 winnr([{expr}]) Number number of current window |
| 55 | 2738 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
|
2739 winrestview({dict}) none restore view of current window |
| 712 | 2740 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
|
2741 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
|
2742 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
|
2743 writefile({object}, {fname} [, {flags}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2744 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
|
2745 xor({expr}, {expr}) Number bitwise XOR |
| 7 | 2746 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
2747 |
| 1621 | 2748 abs({expr}) *abs()* |
| 2749 Return the absolute value of {expr}. When {expr} evaluates to | |
| 2750 a |Float| abs() returns a |Float|. When {expr} can be | |
| 2751 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 2752 abs() gives an error message and returns -1. | |
| 2753 Examples: > | |
| 2754 echo abs(1.456) | |
| 2755 < 1.456 > | |
| 2756 echo abs(-5.456) | |
| 2757 < 5.456 > | |
| 2758 echo abs(-4) | |
| 2759 < 4 | |
| 2760 {only available when compiled with the |+float| feature} | |
| 2761 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2762 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2763 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2764 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
|
2765 |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
|
2766 {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
|
2767 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2768 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2769 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2770 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2771 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2772 < 2.094395 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2773 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2774 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2775 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
2776 add({object}, {expr}) *add()* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
2777 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
|
2778 the resulting |List| or |Blob|. Examples: > |
| 82 | 2779 :let alist = add([1, 2, 3], item) |
| 2780 :call add(mylist, "woodstock") | |
| 685 | 2781 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2782 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
|
2783 When {object} is a |Blob| then {expr} must be a number. |
| 85 | 2784 Use |insert()| to add an item at another position. |
| 55 | 2785 |
| 82 | 2786 |
| 3214 | 2787 and({expr}, {expr}) *and()* |
| 2788 Bitwise AND on the two arguments. The arguments are converted | |
| 2789 to a number. A List, Dict or Float argument causes an error. | |
| 2790 Example: > | |
| 2791 :let flag = and(bits, 0x80) | |
| 2792 | |
| 2793 | |
| 14864 | 2794 append({lnum}, {text}) *append()* |
| 2795 When {text} is a |List|: Append each item of the |List| as a | |
| 685 | 2796 text line below line {lnum} in the current buffer. |
| 14864 | 2797 Otherwise append {text} as one text line below line {lnum} in |
| 153 | 2798 the current buffer. |
| 2799 {lnum} can be zero to insert a line before the first one. | |
| 82 | 2800 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
|
2801 0 for success. Example: > |
| 55 | 2802 :let failed = append(line('$'), "# THE END") |
| 82 | 2803 :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
|
2804 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
2805 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
|
2806 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
|
2807 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
2808 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
|
2809 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
2810 {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
|
2811 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
|
2812 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
|
2813 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
2814 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
|
2815 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
2816 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
|
2817 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
|
2818 :let failed = appendbufline(13, 0, "# THE START") |
| 55 | 2819 < |
| 7 | 2820 *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
|
2821 argc([{winid}]) |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
2822 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
|
2823 |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
|
2824 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
|
2825 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
|
2826 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
|
2827 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
|
2828 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
|
2829 Returns -1 if the {winid} argument is invalid. |
| 7 | 2830 |
| 2831 *argidx()* | |
| 2832 argidx() The result is the current index in the argument list. 0 is | |
| 2833 the first file. argc() - 1 is the last one. See |arglist|. | |
| 2834 | |
| 5942 | 2835 *arglistid()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2836 arglistid([{winnr} [, {tabnr}]]) |
| 5942 | 2837 Return the argument list ID. This is a number which |
| 2838 identifies the argument list being used. Zero is used for the | |
| 6153 | 2839 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
|
2840 Returns -1 if the arguments are invalid. |
| 5942 | 2841 |
| 2842 Without arguments use the current window. | |
| 2843 With {winnr} only use this window in the current tab page. | |
| 2844 With {winnr} and {tabnr} use the window in the specified tab | |
| 2845 page. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2846 {winnr} can be the window number or the |window-ID|. |
| 5942 | 2847 |
| 7 | 2848 *argv()* |
|
14964
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
2849 argv([{nr} [, {winid}]) |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
2850 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
|
2851 |arglist|. "argv(0)" is the first one. Example: > |
| 7 | 2852 :let i = 0 |
| 2853 :while i < argc() | |
| 1621 | 2854 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 2855 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 2856 : let i = i + 1 | |
| 2857 :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
|
2858 < 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
|
2859 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
|
2860 |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
2861 The {winid} argument specifies the window ID, see |argc()|. |
| 818 | 2862 |
|
13272
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2863 assert_beeps({cmd}) *assert_beeps()* |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2864 Run {cmd} and add an error message to |v:errors| if it does |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2865 NOT produce a beep or visual bell. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2866 Also see |assert_fails()| and |assert-return|. |
|
13272
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2867 |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2868 *assert_equal()* |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2869 assert_equal({expected}, {actual} [, {msg}]) |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2870 When {expected} and {actual} are not equal an error message is |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2871 added to |v:errors| and 1 is returned. Otherwise zero is |
|
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2872 returned |assert-return|. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2873 There is no automatic conversion, the String "4" is different |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2874 from the Number 4. And the number 4 is different from the |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2875 Float 4.0. The value of 'ignorecase' is not used here, case |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2876 always matters. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2877 When {msg} is omitted an error in the form "Expected |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2878 {expected} but got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2879 Example: > |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2880 assert_equal('foo', 'bar') |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2881 < Will result in a string to be added to |v:errors|: |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2882 test.vim line 12: Expected 'foo' but got 'bar' ~ |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2883 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2884 *assert_equalfile()* |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2885 assert_equalfile({fname-one}, {fname-two}) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2886 When the files {fname-one} and {fname-two} do not contain |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2887 exactly the same text an error message is added to |v:errors|. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2888 Also see |assert-return|. |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2889 When {fname-one} or {fname-two} does not exist the error will |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2890 mention that. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2891 Mainly useful with |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2892 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2893 assert_exception({error} [, {msg}]) *assert_exception()* |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2894 When v:exception does not contain the string {error} an error |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2895 message is added to |v:errors|. Also see |assert-return|. |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2896 This can be used to assert that a command throws an exception. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2897 Using the error number, followed by a colon, avoids problems |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2898 with translations: > |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2899 try |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2900 commandthatfails |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2901 call assert_false(1, 'command should have failed') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2902 catch |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2903 call assert_exception('E492:') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2904 endtry |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2905 |
| 14945 | 2906 assert_fails({cmd} [, {error} [, {msg}]]) *assert_fails()* |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2907 Run {cmd} and add an error message to |v:errors| if it does |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2908 NOT produce an error. Also see |assert-return|. |
|
10348
c78513465e6e
commit https://github.com/vim/vim/commit/25de4c232d580583feadae11ab34e3cc6333c350
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
2909 When {error} is given it must match in |v:errmsg|. |
|
13272
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2910 Note that beeping is not considered an error, and some failing |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2911 commands only beep. Use |assert_beeps()| for those. |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2912 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2913 assert_false({actual} [, {msg}]) *assert_false()* |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2914 When {actual} is not false an error message is added to |
| 15194 | 2915 |v:errors|, like with |assert_equal()|. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2916 Also see |assert-return|. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2917 A value is false when it is zero. When {actual} is not a |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2918 number the assert fails. |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2919 When {msg} is omitted an error in the form |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2920 "Expected False but got {actual}" is produced. |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2921 |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2922 assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()* |
| 15932 | 2923 This asserts number and |Float| values. When {actual} is lower |
| 2924 than {lower} or higher than {upper} an error message is added | |
| 2925 to |v:errors|. Also see |assert-return|. | |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2926 When {msg} is omitted an error in the form |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2927 "Expected range {lower} - {upper}, but got {actual}" is |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2928 produced. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2929 |
|
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2930 *assert_match()* |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2931 assert_match({pattern}, {actual} [, {msg}]) |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2932 When {pattern} does not match {actual} an error message is |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2933 added to |v:errors|. Also see |assert-return|. |
|
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2934 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2935 {pattern} is used as with |=~|: The matching is always done |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2936 like 'magic' was set and 'cpoptions' is empty, no matter what |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2937 the actual value of 'magic' or 'cpoptions' is. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2938 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2939 {actual} is used as a string, automatic conversion applies. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2940 Use "^" and "$" to match with the start and end of the text. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2941 Use both to match the whole text. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2942 |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2943 When {msg} is omitted an error in the form |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2944 "Pattern {pattern} does not match {actual}" is produced. |
|
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2945 Example: > |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2946 assert_match('^f.*o$', 'foobar') |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2947 < Will result in a string to be added to |v:errors|: |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2948 test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~ |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2949 |
|
8831
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2950 *assert_notequal()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2951 assert_notequal({expected}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2952 The opposite of `assert_equal()`: add an error message to |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2953 |v:errors| when {expected} and {actual} are equal. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2954 Also see |assert-return|. |
|
8831
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2955 |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2956 *assert_notmatch()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2957 assert_notmatch({pattern}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2958 The opposite of `assert_match()`: add an error message to |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2959 |v:errors| when {pattern} matches {actual}. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2960 Also see |assert-return|. |
|
8831
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2961 |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2962 assert_report({msg}) *assert_report()* |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2963 Report a test failure directly, using {msg}. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2964 Always returns one. |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2965 |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2966 assert_true({actual} [, {msg}]) *assert_true()* |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2967 When {actual} is not true an error message is added to |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2968 |v:errors|, like with |assert_equal()|. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2969 Also see |assert-return|. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2970 A value is TRUE when it is a non-zero number. When {actual} |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2971 is not a number the assert fails. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2972 When {msg} is omitted an error in the form "Expected True but |
|
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2973 got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2974 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2975 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2976 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
|
2977 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
|
2978 {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
|
2979 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2980 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2981 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2982 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2983 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2984 < -0.523599 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
2985 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2986 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2987 |
| 1621 | 2988 atan({expr}) *atan()* |
| 2989 Return the principal value of the arc tangent of {expr}, in | |
| 2990 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 2991 {expr} must evaluate to a |Float| or a |Number|. | |
| 2992 Examples: > | |
| 2993 :echo atan(100) | |
| 2994 < 1.560797 > | |
| 2995 :echo atan(-4.01) | |
| 2996 < -1.326405 | |
| 2997 {only available when compiled with the |+float| feature} | |
| 2998 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2999 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3000 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3001 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
|
3002 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
|
3003 {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
|
3004 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3005 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3006 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3007 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3008 < 2.356194 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3009 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3010 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3011 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
|
3012 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
|
3013 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
|
3014 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
|
3015 split with |balloon_split()|. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3016 |
| 11062 | 3017 Example: > |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3018 func GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3019 " initiate getting the content |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3020 return '' |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3021 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3022 set balloonexpr=GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3023 |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3024 func BalloonCallback(result) |
| 11062 | 3025 call balloon_show(a:result) |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3026 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3027 < |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3028 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
|
3029 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
|
3030 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
|
3031 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
|
3032 empty string or a placeholder. |
| 11062 | 3033 |
| 3034 When showing a balloon is not possible nothing happens, no | |
| 3035 error message. | |
| 14864 | 3036 {only available when compiled with the |+balloon_eval| or |
| 3037 |+balloon_eval_term| feature} | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3038 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3039 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
|
3040 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
|
3041 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
|
3042 show debugger output. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3043 Returns a |List| with the split lines. |
| 14864 | 3044 {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
|
3045 feature} |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3046 |
| 7 | 3047 *browse()* |
| 3048 browse({save}, {title}, {initdir}, {default}) | |
| 3049 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
|
3050 returns |TRUE| (only in some GUI versions). |
| 7 | 3051 The input fields are: |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3052 {save} when |TRUE|, select file to write |
| 7 | 3053 {title} title for the requester |
| 3054 {initdir} directory to start browsing in | |
| 3055 {default} default file name | |
| 3056 When the "Cancel" button is hit, something went wrong, or | |
| 3057 browsing is not possible, an empty string is returned. | |
| 3058 | |
| 29 | 3059 *browsedir()* |
| 3060 browsedir({title}, {initdir}) | |
| 3061 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
|
3062 "has("browse")" returns |TRUE| (only in some GUI versions). |
| 29 | 3063 On systems where a directory browser is not supported a file |
| 3064 browser is used. In that case: select a file in the directory | |
| 3065 to be used. | |
| 3066 The input fields are: | |
| 3067 {title} title for the requester | |
| 3068 {initdir} directory to start browsing in | |
| 3069 When the "Cancel" button is hit, something went wrong, or | |
| 3070 browsing is not possible, an empty string is returned. | |
| 3071 | |
| 7 | 3072 bufexists({expr}) *bufexists()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3073 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3074 {expr} exists. |
| 9 | 3075 If the {expr} argument is a number, buffer numbers are used. |
| 12909 | 3076 Number zero is the alternate buffer for the current window. |
| 3077 | |
| 7 | 3078 If the {expr} argument is a string it must match a buffer name |
| 9 | 3079 exactly. The name can be: |
| 3080 - Relative to the current directory. | |
| 3081 - A full path. | |
| 1621 | 3082 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 3083 - A URL name. |
| 7 | 3084 Unlisted buffers will be found. |
| 3085 Note that help files are listed by their short name in the | |
| 3086 output of |:buffers|, but bufexists() requires using their | |
| 3087 long name to be able to find them. | |
| 1621 | 3088 bufexists() may report a buffer exists, but to use the name |
| 3089 with a |:buffer| command you may need to use |expand()|. Esp | |
| 3090 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 3091 Use "bufexists(0)" to test for the existence of an alternate |
| 3092 file name. | |
| 3093 *buffer_exists()* | |
| 3094 Obsolete name: buffer_exists(). | |
| 3095 | |
| 3096 buflisted({expr}) *buflisted()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3097 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3098 {expr} exists and is listed (has the 'buflisted' option set). |
| 9 | 3099 The {expr} argument is used like with |bufexists()|. |
| 7 | 3100 |
| 3101 bufloaded({expr}) *bufloaded()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3102 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3103 {expr} exists and is loaded (shown in a window or hidden). |
| 9 | 3104 The {expr} argument is used like with |bufexists()|. |
| 7 | 3105 |
| 3106 bufname({expr}) *bufname()* | |
| 3107 The result is the name of a buffer, as it is displayed by the | |
| 3108 ":ls" command. | |
| 3109 If {expr} is a Number, that buffer number's name is given. | |
| 3110 Number zero is the alternate buffer for the current window. | |
| 3111 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
|
3112 with the buffer names. This is always done like 'magic' is |
| 7 | 3113 set and 'cpoptions' is empty. When there is more than one |
| 3114 match an empty string is returned. | |
| 3115 "" or "%" can be used for the current buffer, "#" for the | |
| 3116 alternate buffer. | |
| 3117 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 3118 or middle of the buffer name is accepted. If you only want a |
| 3119 full match then put "^" at the start and "$" at the end of the | |
| 3120 pattern. | |
| 7 | 3121 Listed buffers are found first. If there is a single match |
| 3122 with a listed buffer, that one is returned. Next unlisted | |
| 3123 buffers are searched for. | |
| 3124 If the {expr} is a String, but you want to use it as a buffer | |
| 3125 number, force it to be a Number by adding zero to it: > | |
| 3126 :echo bufname("3" + 0) | |
| 3127 < If the buffer doesn't exist, or doesn't have a name, an empty | |
| 3128 string is returned. > | |
| 3129 bufname("#") alternate buffer name | |
| 3130 bufname(3) name of buffer 3 | |
| 3131 bufname("%") name of current buffer | |
| 3132 bufname("file2") name of buffer where "file2" matches. | |
| 3133 < *buffer_name()* | |
| 3134 Obsolete name: buffer_name(). | |
| 3135 | |
| 3136 *bufnr()* | |
| 707 | 3137 bufnr({expr} [, {create}]) |
| 3138 The result is the number of a buffer, as it is displayed by | |
| 7 | 3139 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 3140 above. |
| 3141 If the buffer doesn't exist, -1 is returned. Or, if the | |
| 3142 {create} argument is present and not zero, a new, unlisted, | |
| 3143 buffer is created and its number is returned. | |
| 7 | 3144 bufnr("$") is the last buffer: > |
| 3145 :let last_buffer = bufnr("$") | |
| 3146 < The result is a Number, which is the highest buffer number | |
| 3147 of existing buffers. Note that not all buffers with a smaller | |
| 3148 number necessarily exist, because ":bwipeout" may have removed | |
| 3149 them. Use bufexists() to test for the existence of a buffer. | |
| 3150 *buffer_number()* | |
| 3151 Obsolete name: buffer_number(). | |
| 3152 *last_buffer_nr()* | |
| 3153 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 3154 | |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3155 bufwinid({expr}) *bufwinid()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3156 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
|
3157 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
|
3158 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
|
3159 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
|
3160 |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3161 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
|
3162 < |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3163 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
|
3164 |
| 7 | 3165 bufwinnr({expr}) *bufwinnr()* |
| 3166 The result is a Number, which is the number of the first | |
| 3167 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
|
3168 see |bufname()| above. If buffer {expr} doesn't exist or |
| 7 | 3169 there is no such window, -1 is returned. Example: > |
| 3170 | |
| 3171 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 3172 | |
| 3173 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 3174 |:wincmd|. | |
| 1156 | 3175 Only deals with the current tab page. |
| 7 | 3176 |
| 3177 byte2line({byte}) *byte2line()* | |
| 3178 Return the line number that contains the character at byte | |
| 3179 count {byte} in the current buffer. This includes the | |
| 3180 end-of-line character, depending on the 'fileformat' option | |
| 3181 for the current buffer. The first character has byte count | |
| 3182 one. | |
| 3183 Also see |line2byte()|, |go| and |:goto|. | |
| 3184 {not available when compiled without the |+byte_offset| | |
| 3185 feature} | |
| 3186 | |
| 18 | 3187 byteidx({expr}, {nr}) *byteidx()* |
| 3188 Return byte index of the {nr}'th character in the string | |
| 3189 {expr}. Use zero for the first character, it returns zero. | |
| 3190 This function is only useful when there are multibyte | |
| 3191 characters, otherwise the returned value is equal to {nr}. | |
| 5413 | 3192 Composing characters are not counted separately, their byte |
| 3193 length is added to the preceding base character. See | |
| 3194 |byteidxcomp()| below for counting composing characters | |
| 3195 separately. | |
| 18 | 3196 Example : > |
| 3197 echo matchstr(str, ".", byteidx(str, 3)) | |
| 3198 < will display the fourth character. Another way to do the | |
| 3199 same: > | |
| 3200 let s = strpart(str, byteidx(str, 3)) | |
| 3201 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
|
3202 < Also see |strgetchar()| and |strcharpart()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3203 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3204 If there are less than {nr} characters -1 is returned. |
| 18 | 3205 If there are exactly {nr} characters the length of the string |
| 5413 | 3206 in bytes is returned. |
| 3207 | |
| 3208 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
| 3209 Like byteidx(), except that a composing character is counted | |
| 3210 as a separate character. Example: > | |
| 3211 let s = 'e' . nr2char(0x301) | |
| 3212 echo byteidx(s, 1) | |
| 3213 echo byteidxcomp(s, 1) | |
| 3214 echo byteidxcomp(s, 2) | |
| 3215 < The first and third echo result in 3 ('e' plus composing | |
| 3216 character is 3 bytes), the second echo results in 1 ('e' is | |
| 3217 one byte). | |
| 3218 Only works different from byteidx() when 'encoding' is set to | |
| 3219 a Unicode encoding. | |
| 18 | 3220 |
| 102 | 3221 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 3222 Call function {func} with the items in |List| {arglist} as |
| 79 | 3223 arguments. |
| 685 | 3224 {func} can either be a |Funcref| or the name of a function. |
| 79 | 3225 a:firstline and a:lastline are set to the cursor line. |
| 3226 Returns the return value of the called function. | |
| 102 | 3227 {dict} is for functions with the "dict" attribute. It will be |
| 3228 used to set the local variable "self". |Dictionary-function| | |
| 79 | 3229 |
| 1621 | 3230 ceil({expr}) *ceil()* |
| 3231 Return the smallest integral value greater than or equal to | |
| 3232 {expr} as a |Float| (round up). | |
| 3233 {expr} must evaluate to a |Float| or a |Number|. | |
| 3234 Examples: > | |
| 3235 echo ceil(1.456) | |
| 3236 < 2.0 > | |
| 3237 echo ceil(-5.456) | |
| 3238 < -5.0 > | |
| 3239 echo ceil(4.0) | |
| 3240 < 4.0 | |
| 3241 {only available when compiled with the |+float| feature} | |
| 3242 | |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3243 ch_canread({handle}) *ch_canread()* |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3244 Return non-zero when there is something to read from {handle}. |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3245 {handle} can be a Channel or a Job that has a Channel. |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3246 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3247 This is useful to read from a channel at a convenient time, |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3248 e.g. from a timer. |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3249 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3250 Note that messages are dropped when the channel does not have |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3251 a callback. Add a close callback to avoid that. |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3252 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3253 {only available when compiled with the |+channel| feature} |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3254 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3255 ch_close({handle}) *ch_close()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3256 Close {handle}. See |channel-close|. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3257 {handle} can be a Channel or a Job that has a Channel. |
|
10054
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
3258 A close callback is not invoked. |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
3259 |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
3260 {only available when compiled with the |+channel| feature} |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
3261 |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
3262 ch_close_in({handle}) *ch_close_in()* |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
3263 Close the "in" part of {handle}. See |channel-close-in|. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3264 {handle} can be a Channel or a Job that has a Channel. |
|
10054
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
3265 A close callback is not invoked. |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
3266 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3267 {only available when compiled with the |+channel| feature} |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3268 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3269 ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3270 Send {expr} over {handle}. The {expr} is encoded |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3271 according to the type of channel. The function cannot be used |
|
8303
88207f4b861a
commit https://github.com/vim/vim/commit/dae8d21dd291df6a6679a00be64e18bca0156576
Christian Brabandt <cb@256bit.org>
parents:
8291
diff
changeset
|
3272 with a raw channel. See |channel-use|. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3273 {handle} can be a Channel or a Job that has a Channel. |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3274 *E917* |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3275 {options} must be a Dictionary. It must not have a "callback" |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3276 entry. It can have a "timeout" entry to specify the timeout |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3277 for this specific request. |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3278 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3279 ch_evalexpr() waits for a response and returns the decoded |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3280 expression. When there is an error or timeout it returns an |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3281 empty string. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3282 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3283 {only available when compiled with the |+channel| feature} |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3284 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3285 ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3286 Send {string} over {handle}. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3287 {handle} can be a Channel or a Job that has a Channel. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3288 |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3289 Works like |ch_evalexpr()|, but does not encode the request or |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3290 decode the response. The caller is responsible for the |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3291 correct contents. Also does not add a newline for a channel |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3292 in NL mode, the caller must do that. The NL in the response |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3293 is removed. |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
3294 Note that Vim does not know when the text received on a raw |
| 12785 | 3295 channel is complete, it may only return the first part and you |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
3296 need to use |ch_readraw()| to fetch the rest. |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3297 See |channel-use|. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3298 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3299 {only available when compiled with the |+channel| feature} |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3300 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3301 ch_getbufnr({handle}, {what}) *ch_getbufnr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3302 Get the buffer number that {handle} is using for {what}. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3303 {handle} can be a Channel or a Job that has a Channel. |
|
8291
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3304 {what} can be "err" for stderr, "out" for stdout or empty for |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3305 socket output. |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3306 Returns -1 when there is no buffer. |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3307 {only available when compiled with the |+channel| feature} |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3308 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3309 ch_getjob({channel}) *ch_getjob()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3310 Get the Job associated with {channel}. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3311 If there is no job calling |job_status()| on the returned Job |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3312 will result in "fail". |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3313 |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3314 {only available when compiled with the |+channel| and |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3315 |+job| features} |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3316 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3317 ch_info({handle}) *ch_info()* |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3318 Returns a Dictionary with information about {handle}. The |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3319 items are: |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3320 "id" number of the channel |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3321 "status" "open", "buffered" or "closed", like |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3322 ch_status() |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3323 When opened with ch_open(): |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3324 "hostname" the hostname of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3325 "port" the port of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3326 "sock_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3327 "sock_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3328 "sock_io" "socket" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3329 "sock_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3330 When opened with job_start(): |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3331 "out_status" "open", "buffered" or "closed" |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3332 "out_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3333 "out_io" "null", "pipe", "file" or "buffer" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3334 "out_timeout" timeout in msec |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3335 "err_status" "open", "buffered" or "closed" |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3336 "err_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3337 "err_io" "out", "null", "pipe", "file" or "buffer" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3338 "err_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3339 "in_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3340 "in_mode" "NL", "RAW", "JSON" or "JS" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3341 "in_io" "null", "pipe", "file" or "buffer" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3342 "in_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3343 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3344 ch_log({msg} [, {handle}]) *ch_log()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3345 Write {msg} in the channel log file, if it was opened with |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3346 |ch_logfile()|. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3347 When {handle} is passed the channel number is used for the |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3348 message. |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10422
diff
changeset
|
3349 {handle} can be a Channel or a Job that has a Channel. The |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10237
diff
changeset
|
3350 Channel must be open for the channel number to be used. |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3351 |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3352 ch_logfile({fname} [, {mode}]) *ch_logfile()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3353 Start logging channel activity to {fname}. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3354 When {fname} is an empty string: stop logging. |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3355 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3356 When {mode} is omitted or "a" append to the file. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3357 When {mode} is "w" start with an empty file. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3358 |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
3359 Use |ch_log()| to write log messages. The file is flushed |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
3360 after every message, on Unix you can use "tail -f" to see what |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
3361 is going on in real time. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3362 |
|
12025
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
3363 This function is not available in the |sandbox|. |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
3364 NOTE: the channel communication is stored in the file, be |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
3365 aware that this may contain confidential and privacy sensitive |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
3366 information, e.g. a password you type in a terminal window. |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
3367 |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
3368 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3369 ch_open({address} [, {options}]) *ch_open()* |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3370 Open a channel to {address}. See |channel|. |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3371 Returns a Channel. Use |ch_status()| to check for failure. |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3372 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3373 {address} has the form "hostname:port", e.g., |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3374 "localhost:8765". |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3375 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3376 If {options} is given it must be a |Dictionary|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3377 See |channel-open-options|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3378 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3379 {only available when compiled with the |+channel| feature} |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3380 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3381 ch_read({handle} [, {options}]) *ch_read()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3382 Read from {handle} and return the received message. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3383 {handle} can be a Channel or a Job that has a Channel. |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
3384 For a NL channel this waits for a NL to arrive, except when |
|
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
3385 there is nothing more to read (channel was closed). |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3386 See |channel-more|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3387 {only available when compiled with the |+channel| feature} |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3388 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3389 ch_readblob({handle} [, {options}]) *ch_readblob()* |
| 15512 | 3390 Like ch_read() but reads binary data and returns a |Blob|. |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3391 See |channel-more|. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3392 {only available when compiled with the |+channel| feature} |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3393 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3394 ch_readraw({handle} [, {options}]) *ch_readraw()* |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3395 Like ch_read() but for a JS and JSON channel does not decode |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
3396 the message. For a NL channel it does not block waiting for |
|
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
3397 the NL to arrive, but otherwise works like ch_read(). |
|
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
3398 See |channel-more|. |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3399 {only available when compiled with the |+channel| feature} |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3400 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3401 ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3402 Send {expr} over {handle}. The {expr} is encoded |
|
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3403 according to the type of channel. The function cannot be used |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3404 with a raw channel. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3405 See |channel-use|. *E912* |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3406 {handle} can be a Channel or a Job that has a Channel. |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3407 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3408 {only available when compiled with the |+channel| feature} |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3409 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3410 ch_sendraw({handle}, {expr} [, {options}]) *ch_sendraw()* |
| 15512 | 3411 Send |String| or |Blob| {expr} over {handle}. |
|
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3412 Works like |ch_sendexpr()|, but does not encode the request or |
|
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3413 decode the response. The caller is responsible for the |
|
8094
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3414 correct contents. Also does not add a newline for a channel |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3415 in NL mode, the caller must do that. The NL in the response |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3416 is removed. |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3417 See |channel-use|. |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3418 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3419 {only available when compiled with the |+channel| feature} |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3420 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3421 ch_setoptions({handle}, {options}) *ch_setoptions()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3422 Set options on {handle}: |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3423 "callback" the channel callback |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3424 "timeout" default read timeout in msec |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3425 "mode" mode for the whole channel |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3426 See |ch_open()| for more explanation. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3427 {handle} can be a Channel or a Job that has a Channel. |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3428 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3429 Note that changing the mode may cause queued messages to be |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3430 lost. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3431 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3432 These options cannot be changed: |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3433 "waittime" only applies to |ch_open()| |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3434 |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3435 ch_status({handle} [, {options}]) *ch_status()* |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3436 Return the status of {handle}: |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3437 "fail" failed to open the channel |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3438 "open" channel can be used |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3439 "buffered" channel can be read, not written to |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3440 "closed" channel can not be used |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3441 {handle} can be a Channel or a Job that has a Channel. |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3442 "buffered" is used when the channel was closed but there is |
|
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3443 still data that can be obtained with |ch_read()|. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3444 |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3445 If {options} is given it can contain a "part" entry to specify |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3446 the part of the channel to return the status for: "out" or |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3447 "err". For example, to get the error status: > |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3448 ch_status(job, {"part": "err"}) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3449 < |
| 11062 | 3450 changenr() *changenr()* |
| 3451 Return the number of the most recent change. This is the same | |
| 3452 number as what is displayed with |:undolist| and can be used | |
| 3453 with the |:undo| command. | |
| 3454 When a change was made it is the number of that change. After | |
| 3455 redo it is the number of the redone change. After undo it is | |
| 3456 one less than the number of the undone change. | |
| 3457 | |
| 12785 | 3458 char2nr({expr} [, {utf8}]) *char2nr()* |
| 11062 | 3459 Return number value of the first char in {expr}. Examples: > |
| 3460 char2nr(" ") returns 32 | |
| 3461 char2nr("ABC") returns 65 | |
| 3462 < When {utf8} is omitted or zero, the current 'encoding' is used. | |
| 3463 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
|
3464 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
|
3465 char2nr("á"[0]) returns 195 |
| 11062 | 3466 < With {utf8} set to 1, always treat as utf-8 characters. |
| 3467 A combining character is a separate character. | |
| 3468 |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
|
3469 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
|
3470 let str = "ABC" |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3471 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
|
3472 < Result: [65, 66, 67] |
| 11062 | 3473 |
| 3474 cindent({lnum}) *cindent()* | |
| 3475 Get the amount of indent for line {lnum} according the C | |
| 3476 indenting rules, as with 'cindent'. | |
| 3477 The indent is counted in spaces, the value of 'tabstop' is | |
| 3478 relevant. {lnum} is used just like in |getline()|. | |
| 3479 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 3480 feature, -1 is returned. | |
| 3481 See |C-indenting|. | |
| 3482 | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3483 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
|
3484 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
|
3485 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
|
3486 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
|
3487 window ID instead of the current window. |
| 11062 | 3488 |
| 3489 *col()* | |
| 3490 col({expr}) The result is a Number, which is the byte index of the column | |
| 3491 position given with {expr}. The accepted positions are: | |
| 3492 . the cursor position | |
| 3493 $ the end of the cursor line (the result is the | |
| 3494 number of bytes in the cursor line plus one) | |
| 3495 'x position of mark x (if the mark is not set, 0 is | |
| 3496 returned) | |
| 3497 v In Visual mode: the start of the Visual area (the | |
| 3498 cursor is the end). When not in Visual mode | |
| 3499 returns the cursor position. Differs from |'<| in | |
| 3500 that it's updated right away. | |
| 3501 Additionally {expr} can be [lnum, col]: a |List| with the line | |
| 3502 and column number. Most useful when the column is "$", to get | |
| 3503 the last column of a specific line. When "lnum" or "col" is | |
| 3504 out of range then col() returns zero. | |
| 3505 To get the line number use |line()|. To get both use | |
| 3506 |getpos()|. | |
| 3507 For the screen column position use |virtcol()|. | |
| 3508 Note that only marks in the current file can be used. | |
| 3509 Examples: > | |
| 3510 col(".") column of cursor | |
| 3511 col("$") length of cursor line plus one | |
| 3512 col("'t") column of mark t | |
| 3513 col("'" . markname) column of mark markname | |
| 3514 < The first column is 1. 0 is returned for an error. | |
| 3515 For an uppercase mark the column may actually be in another | |
| 3516 buffer. | |
| 3517 For the cursor position, when 'virtualedit' is active, the | |
| 3518 column is one higher if the cursor is after the end of the | |
| 3519 line. This can be used to obtain the column in Insert mode: > | |
| 3520 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 3521 \<C-O>:set ve=all<CR> | |
| 3522 \<C-O>:echo col(".") . "\n" <Bar> | |
| 3523 \let &ve = save_ve<CR> | |
| 3524 < | |
| 3525 | |
| 3526 complete({startcol}, {matches}) *complete()* *E785* | |
| 3527 Set the matches for Insert mode completion. | |
| 3528 Can only be used in Insert mode. You need to use a mapping | |
| 3529 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O | |
| 3530 or with an expression mapping. | |
| 3531 {startcol} is the byte offset in the line where the completed | |
| 3532 text start. The text up to the cursor is the original text | |
| 3533 that will be replaced by the matches. Use col('.') for an | |
| 3534 empty string. "col('.') - 1" will replace one character by a | |
| 3535 match. | |
| 3536 {matches} must be a |List|. Each |List| item is one match. | |
| 3537 See |complete-items| for the kind of items that are possible. | |
| 3538 Note that the after calling this function you need to avoid | |
| 3539 inserting anything that would cause completion to stop. | |
| 3540 The match can be selected with CTRL-N and CTRL-P as usual with | |
| 3541 Insert mode completion. The popup menu will appear if | |
| 3542 specified, see |ins-completion-menu|. | |
| 3543 Example: > | |
| 3544 inoremap <F5> <C-R>=ListMonths()<CR> | |
| 3545 | |
| 3546 func! ListMonths() | |
| 3547 call complete(col('.'), ['January', 'February', 'March', | |
| 3548 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 3549 \ 'October', 'November', 'December']) | |
| 3550 return '' | |
| 3551 endfunc | |
| 3552 < This isn't very useful, but it shows how it works. Note that | |
| 3553 an empty string is returned to avoid a zero being inserted. | |
| 3554 | |
| 3555 complete_add({expr}) *complete_add()* | |
| 3556 Add {expr} to the list of matches. Only to be used by the | |
| 3557 function specified with the 'completefunc' option. | |
| 3558 Returns 0 for failure (empty string or out of memory), | |
| 3559 1 when the match was added, 2 when the match was already in | |
| 3560 the list. | |
| 3561 See |complete-functions| for an explanation of {expr}. It is | |
| 3562 the same as one item in the list that 'omnifunc' would return. | |
| 3563 | |
| 3564 complete_check() *complete_check()* | |
| 3565 Check for a key typed while looking for completion matches. | |
| 3566 This is to be used when looking for matches takes some time. | |
| 3567 Returns |TRUE| when searching for matches is to be aborted, | |
| 3568 zero otherwise. | |
| 3569 Only to be used by the function specified with the | |
| 3570 'completefunc' option. | |
| 3571 | |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3572 *complete_info()* |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3573 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
|
3574 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
|
3575 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
|
3576 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
|
3577 mode Current completion mode name string. |
| 16208 | 3578 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
|
3579 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
|
3580 See |pumvisible()|. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3581 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
|
3582 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
|
3583 "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
|
3584 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
|
3585 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
|
3586 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
|
3587 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
|
3588 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
|
3589 |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3590 *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
|
3591 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
|
3592 "" 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
|
3593 "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
|
3594 "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
|
3595 "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
|
3596 "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
|
3597 "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
|
3598 "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
|
3599 "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
|
3600 "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
|
3601 "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
|
3602 "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
|
3603 "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
|
3604 "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
|
3605 "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
|
3606 "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
|
3607 "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
|
3608 |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3609 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
|
3610 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
|
3611 {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
|
3612 |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3613 Examples: > |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3614 " 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
|
3615 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
|
3616 " 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
|
3617 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
|
3618 " 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
|
3619 call complete_info(['mode', 'pum_visible']) |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3620 < |
| 11062 | 3621 *confirm()* |
| 3622 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
|
3623 confirm() offers the user a dialog, from which a choice can be |
| 11062 | 3624 made. It returns the number of the choice. For the first |
| 3625 choice this is 1. | |
| 3626 Note: confirm() is only supported when compiled with dialog | |
| 3627 support, see |+dialog_con| and |+dialog_gui|. | |
| 3628 | |
| 3629 {msg} is displayed in a |dialog| with {choices} as the | |
| 3630 alternatives. When {choices} is missing or empty, "&OK" is | |
| 3631 used (and translated). | |
| 3632 {msg} is a String, use '\n' to include a newline. Only on | |
| 3633 some systems the string is wrapped when it doesn't fit. | |
| 3634 | |
| 3635 {choices} is a String, with the individual choices separated | |
| 3636 by '\n', e.g. > | |
| 3637 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 3638 < The letter after the '&' is the shortcut key for that choice. | |
| 3639 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 3640 not need to be the first letter: > | |
| 3641 confirm("file has been modified", "&Save\nSave &All") | |
| 3642 < For the console, the first letter of each choice is used as | |
| 3643 the default shortcut key. | |
| 3644 | |
| 3645 The optional {default} argument is the number of the choice | |
| 3646 that is made if the user hits <CR>. Use 1 to make the first | |
| 3647 choice the default one. Use 0 to not set a default. If | |
| 3648 {default} is omitted, 1 is used. | |
| 3649 | |
| 3650 The optional {type} argument gives the type of dialog. This | |
| 3651 is only used for the icon of the GTK, Mac, Motif and Win32 | |
| 3652 GUI. It can be one of these values: "Error", "Question", | |
| 3653 "Info", "Warning" or "Generic". Only the first character is | |
| 3654 relevant. When {type} is omitted, "Generic" is used. | |
| 3655 | |
| 3656 If the user aborts the dialog by pressing <Esc>, CTRL-C, | |
| 3657 or another valid interrupt key, confirm() returns 0. | |
| 3658 | |
| 3659 An example: > | |
| 3660 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 3661 :if choice == 0 | |
| 3662 : echo "make up your mind!" | |
| 3663 :elseif choice == 3 | |
| 3664 : echo "tasteful" | |
| 3665 :else | |
| 3666 : echo "I prefer bananas myself." | |
| 3667 :endif | |
| 3668 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 3669 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 3670 the buttons are always put vertically. Otherwise, confirm() | |
| 3671 tries to put the buttons in one horizontal line. If they | |
| 3672 don't fit, a vertical layout is used anyway. For some systems | |
| 3673 the horizontal layout is always used. | |
| 3674 | |
| 55 | 3675 *copy()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3676 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3677 different from using {expr} directly. |
| 685 | 3678 When {expr} is a |List| a shallow copy is created. This means |
| 3679 that the original |List| can be changed without changing the | |
| 1621 | 3680 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
|
3681 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
|
3682 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
|
3683 Also see |deepcopy()|. |
| 55 | 3684 |
| 1621 | 3685 cos({expr}) *cos()* |
| 3686 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 3687 {expr} must evaluate to a |Float| or a |Number|. | |
| 3688 Examples: > | |
| 3689 :echo cos(100) | |
| 3690 < 0.862319 > | |
| 3691 :echo cos(-4.01) | |
| 3692 < -0.646043 | |
| 3693 {only available when compiled with the |+float| feature} | |
| 3694 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3695 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3696 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3697 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
|
3698 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3699 {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
|
3700 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3701 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3702 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3703 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3704 < -1.127626 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3705 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3706 |
| 12785 | 3707 |
| 102 | 3708 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 3709 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
|
3710 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
|
3711 |
| 102 | 3712 If {start} is given then start with the item with this index. |
| 685 | 3713 {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
|
3714 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3715 When {ic} is given and it's |TRUE| then case is ignored. |
| 79 | 3716 |
|
11828
5a07a3ff56c1
patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents:
11763
diff
changeset
|
3717 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
|
3718 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
|
3719 {expr} is an empty string. |
| 79 | 3720 |
| 7 | 3721 *cscope_connection()* |
| 3722 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 3723 Checks for the existence of a |cscope| connection. If no | |
| 3724 parameters are specified, then the function returns: | |
| 3725 0, if cscope was not available (not compiled in), or | |
| 3726 if there are no cscope connections; | |
| 3727 1, if there is at least one cscope connection. | |
| 3728 | |
| 3729 If parameters are specified, then the value of {num} | |
| 3730 determines how existence of a cscope connection is checked: | |
| 3731 | |
| 3732 {num} Description of existence check | |
| 3733 ----- ------------------------------ | |
| 3734 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 3735 1 Ignore {prepend}, and use partial string matches for | |
| 3736 {dbpath}. | |
| 3737 2 Ignore {prepend}, and use exact string matches for | |
| 3738 {dbpath}. | |
| 3739 3 Use {prepend}, use partial string matches for both | |
| 3740 {dbpath} and {prepend}. | |
| 3741 4 Use {prepend}, use exact string matches for both | |
| 3742 {dbpath} and {prepend}. | |
| 3743 | |
| 3744 Note: All string comparisons are case sensitive! | |
| 3745 | |
| 3746 Examples. Suppose we had the following (from ":cs show"): > | |
| 3747 | |
| 3748 # pid database name prepend path | |
| 3749 0 27664 cscope.out /usr/local | |
| 3750 < | |
| 3751 Invocation Return Val ~ | |
| 3752 ---------- ---------- > | |
| 3753 cscope_connection() 1 | |
| 3754 cscope_connection(1, "out") 1 | |
| 3755 cscope_connection(2, "out") 0 | |
| 3756 cscope_connection(3, "out") 0 | |
| 3757 cscope_connection(3, "out", "local") 1 | |
| 3758 cscope_connection(4, "out") 0 | |
| 3759 cscope_connection(4, "out", "local") 0 | |
| 3760 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 3761 < | |
| 703 | 3762 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 3763 cursor({list}) | |
| 1156 | 3764 Positions the cursor at the column (byte count) {col} in the |
| 3765 line {lnum}. The first column is one. | |
| 5938 | 3766 |
| 703 | 3767 When there is one argument {list} this is used as a |List| |
| 5938 | 3768 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
|
3769 [{lnum}, {col}] |
| 5938 | 3770 [{lnum}, {col}, {off}] |
| 3771 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 3772 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 3773 but without the first item. |
| 5938 | 3774 |
| 7 | 3775 Does not change the jumplist. |
| 3776 If {lnum} is greater than the number of lines in the buffer, | |
| 3777 the cursor will be positioned at the last line in the buffer. | |
| 3778 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 3779 If {col} is greater than the number of bytes in the line, |
| 7 | 3780 the cursor will be positioned at the last character in the |
| 3781 line. | |
| 3782 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 3783 If {curswant} is given it is used to set the preferred column |
| 6180 | 3784 for vertical movement. Otherwise {col} is used. |
| 6385 | 3785 |
| 703 | 3786 When 'virtualedit' is used {off} specifies the offset in |
| 3787 screen columns from the start of the character. E.g., a | |
| 1266 | 3788 position within a <Tab> or after the last character. |
| 1851 | 3789 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 3790 |
|
14147
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
3791 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
|
3792 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
|
3793 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
|
3794 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
|
3795 {only available on MS-Windows} |
| 55 | 3796 |
| 12785 | 3797 deepcopy({expr} [, {noref}]) *deepcopy()* *E698* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3798 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3799 different from using {expr} directly. |
| 685 | 3800 When {expr} is a |List| a full copy is created. This means |
| 3801 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
|
3802 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
|
3803 |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
|
3804 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
|
3805 the original |List|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3806 A |Dictionary| is copied in a similar way as a |List|. |
| 685 | 3807 When {noref} is omitted or zero a contained |List| or |
| 3808 |Dictionary| is only copied once. All references point to | |
| 3809 this single copy. With {noref} set to 1 every occurrence of a | |
| 3810 |List| or |Dictionary| results in a new copy. This also means | |
| 3811 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 3812 *E724* |
| 3813 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 3814 that refers back to a higher level making a deep copy with |
| 3815 {noref} set to 1 will fail. | |
| 55 | 3816 Also see |copy()|. |
| 3817 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3818 delete({fname} [, {flags}]) *delete()* |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3819 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
|
3820 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
|
3821 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3822 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
|
3823 {fname}. This fails when directory {fname} is not empty. |
| 12785 | 3824 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3825 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
|
3826 {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
|
3827 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
|
3828 that is being used. |
|
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
10000
diff
changeset
|
3829 |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3830 A symbolic link itself is deleted, not what it points to. |
| 12785 | 3831 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3832 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
|
3833 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
|
3834 |
| 685 | 3835 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
|
3836 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
|
3837 |deletebufline()|. |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
3838 |
| 14519 | 3839 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
|
3840 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
|
3841 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
|
3842 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
|
3843 |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
3844 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
|
3845 |
| 14864 | 3846 {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
|
3847 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
|
3848 to refer to the last line in buffer {expr}. |
| 7 | 3849 |
| 3850 *did_filetype()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3851 did_filetype() Returns |TRUE| when autocommands are being executed and the |
| 7 | 3852 FileType event has been triggered at least once. Can be used |
| 3853 to avoid triggering the FileType event again in the scripts | |
| 3854 that detect the file type. |FileType| | |
| 11473 | 3855 Returns |FALSE| when `:setf FALLBACK` was used. |
| 7 | 3856 When editing another file, the counter is reset, thus this |
| 3857 really checks if the FileType event has been triggered for the | |
| 3858 current buffer. This allows an autocommand that starts | |
| 3859 editing another buffer to set 'filetype' and load a syntax | |
| 3860 file. | |
| 3861 | |
| 32 | 3862 diff_filler({lnum}) *diff_filler()* |
| 3863 Returns the number of filler lines above line {lnum}. | |
| 3864 These are the lines that were inserted at this point in | |
| 3865 another diff'ed window. These filler lines are shown in the | |
| 3866 display but don't exist in the buffer. | |
| 3867 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3868 line, "'m" mark m, etc. | |
| 3869 Returns 0 if the current window is not in diff mode. | |
| 3870 | |
| 3871 diff_hlID({lnum}, {col}) *diff_hlID()* | |
| 3872 Returns the highlight ID for diff mode at line {lnum} column | |
| 3873 {col} (byte index). When the current line does not have a | |
| 3874 diff change zero is returned. | |
| 3875 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3876 line, "'m" mark m, etc. | |
| 3877 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 3878 line. | |
| 3879 The highlight ID can be used with |synIDattr()| to obtain | |
| 3880 syntax information about the highlighting. | |
| 3881 | |
| 85 | 3882 empty({expr}) *empty()* |
| 3883 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
|
3884 - 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
|
3885 items. |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
3886 - 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
|
3887 - 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
|
3888 - |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
|
3889 - 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
|
3890 - A |Channel| is empty when it is closed. |
| 15512 | 3891 - 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
|
3892 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3893 For a long |List| this is much faster than comparing the |
| 685 | 3894 length with zero. |
| 85 | 3895 |
| 7 | 3896 escape({string}, {chars}) *escape()* |
| 3897 Escape the characters in {chars} that occur in {string} with a | |
| 3898 backslash. Example: > | |
| 3899 :echo escape('c:\program files\vim', ' \') | |
| 3900 < results in: > | |
| 3901 c:\\program\ files\\vim | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
3902 < Also see |shellescape()| and |fnameescape()|. |
| 1621 | 3903 |
| 3904 *eval()* | |
| 95 | 3905 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 3906 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
|
3907 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
|
3908 of them. Also works for |Funcref|s that refer to existing |
| 1621 | 3909 functions. |
| 95 | 3910 |
| 7 | 3911 eventhandler() *eventhandler()* |
| 3912 Returns 1 when inside an event handler. That is that Vim got | |
| 3913 interrupted while waiting for the user to type a character, | |
| 3914 e.g., when dropping a file on Vim. This means interactive | |
| 3915 commands cannot be used. Otherwise zero is returned. | |
| 3916 | |
| 3917 executable({expr}) *executable()* | |
| 3918 This function checks if an executable with the name {expr} | |
| 3919 exists. {expr} must be the name of the program without any | |
| 10 | 3920 arguments. |
| 3921 executable() uses the value of $PATH and/or the normal | |
| 3922 searchpath for programs. *PATHEXT* | |
| 3923 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
| 3924 optionally be included. Then the extensions in $PATHEXT are | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3925 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3926 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is |
| 10 | 3927 used. A dot by itself can be used in $PATHEXT to try using |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3928 the name without an extension. When 'shell' looks like a |
| 10 | 3929 Unix shell, then the name is also tried without adding an |
| 3930 extension. | |
| 3931 On MS-DOS and MS-Windows it only checks if the file exists and | |
| 3932 is not a directory, not if it's really executable. | |
| 819 | 3933 On MS-Windows an executable in the same directory as Vim is |
| 3934 always found. Since this directory is added to $PATH it | |
| 3935 should also work to execute it |win32-PATH|. | |
| 7 | 3936 The result is a Number: |
| 3937 1 exists | |
| 3938 0 does not exist | |
| 3939 -1 not implemented on this system | |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14193
diff
changeset
|
3940 |exepath()| can be used to get the full path of an executable. |
| 7 | 3941 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3942 execute({command} [, {silent}]) *execute()* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3943 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
|
3944 string. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3945 {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
|
3946 lines are executed one by one. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3947 This is equivalent to: > |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3948 redir => var |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3949 {command} |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3950 redir END |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3951 < |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3952 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
|
3953 "" no `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3954 "silent" `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3955 "silent!" `:silent!` used |
| 11062 | 3956 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
|
3957 `: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
|
3958 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
|
3959 *E930* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3960 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
|
3961 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3962 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
|
3963 split(execute('args'), "\n") |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3964 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3965 < When used recursively the output of the recursive call is not |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3966 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
|
3967 |
| 5782 | 3968 exepath({expr}) *exepath()* |
| 3969 If {expr} is an executable and is either an absolute path, a | |
| 3970 relative path or found in $PATH, return the full path. | |
| 3971 Note that the current directory is used when {expr} starts | |
| 3972 with "./", which may be a problem for Vim: > | |
| 3973 echo exepath(v:progpath) | |
| 5814 | 3974 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 3975 an empty string is returned. |
| 3976 | |
| 7 | 3977 *exists()* |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3978 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
|
3979 zero otherwise. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3980 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3981 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
|
3982 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
|
3983 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3984 The {expr} argument is a string, which contains one of these: |
| 7 | 3985 &option-name Vim option (only checks if it exists, |
| 3986 not if it really works) | |
| 3987 +option-name Vim option that works. | |
| 3988 $ENVNAME environment variable (could also be | |
| 3989 done by comparing with an empty | |
| 3990 string) | |
| 3991 *funcname built-in function (see |functions|) | |
| 3992 or user defined function (see | |
| 5862 | 3993 |user-functions|). Also works for a |
| 3994 variable that is a Funcref. | |
| 7 | 3995 varname internal variable (see |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3996 |internal-variables|). Also works |
| 685 | 3997 for |curly-braces-names|, |Dictionary| |
| 3998 entries, |List| items, etc. Beware | |
| 1668 | 3999 that evaluating an index may cause an |
| 4000 error message for an invalid | |
| 4001 expression. E.g.: > | |
| 4002 :let l = [1, 2, 3] | |
| 4003 :echo exists("l[5]") | |
| 4004 < 0 > | |
| 4005 :echo exists("l[xx]") | |
| 4006 < E121: Undefined variable: xx | |
| 4007 0 | |
| 7 | 4008 :cmdname Ex command: built-in command, user |
| 4009 command or command modifier |:command|. | |
| 4010 Returns: | |
| 4011 1 for match with start of a command | |
| 4012 2 full match with a command | |
| 4013 3 matches several user commands | |
| 4014 To check for a supported command | |
| 4015 always check the return value to be 2. | |
| 864 | 4016 :2match The |:2match| command. |
| 4017 :3match The |:3match| command. | |
| 7 | 4018 #event autocommand defined for this event |
| 4019 #event#pattern autocommand defined for this event and | |
| 4020 pattern (the pattern is taken | |
| 4021 literally and compared to the | |
| 4022 autocommand patterns character by | |
| 4023 character) | |
| 613 | 4024 #group autocommand group exists |
| 4025 #group#event autocommand defined for this group and | |
| 4026 event. | |
| 4027 #group#event#pattern | |
| 856 | 4028 autocommand defined for this group, |
| 613 | 4029 event and pattern. |
| 615 | 4030 ##event autocommand for this event is |
| 4031 supported. | |
| 7 | 4032 |
| 4033 Examples: > | |
| 4034 exists("&shortname") | |
| 4035 exists("$HOSTNAME") | |
| 4036 exists("*strftime") | |
| 4037 exists("*s:MyFunc") | |
| 4038 exists("bufcount") | |
| 4039 exists(":Make") | |
| 613 | 4040 exists("#CursorHold") |
| 7 | 4041 exists("#BufReadPre#*.gz") |
| 613 | 4042 exists("#filetypeindent") |
| 4043 exists("#filetypeindent#FileType") | |
| 4044 exists("#filetypeindent#FileType#*") | |
| 615 | 4045 exists("##ColorScheme") |
| 7 | 4046 < There must be no space between the symbol (&/$/*/#) and the |
| 4047 name. | |
| 867 | 4048 There must be no extra characters after the name, although in |
| 4049 a few cases this is ignored. That may become more strict in | |
| 4050 the future, thus don't count on it! | |
| 4051 Working example: > | |
| 4052 exists(":make") | |
| 4053 < NOT working example: > | |
| 4054 exists(":make install") | |
| 859 | 4055 |
| 4056 < Note that the argument must be a string, not the name of the | |
| 4057 variable itself. For example: > | |
| 7 | 4058 exists(bufcount) |
| 4059 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 4060 but gets the value of "bufcount", and checks if that exists. |
| 7 | 4061 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4062 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4063 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
|
4064 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4065 {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
|
4066 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4067 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4068 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4069 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4070 < 0.367879 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4071 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4072 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4073 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4074 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 4075 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
|
4076 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4077 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4078 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
|
4079 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
|
4080 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
|
4081 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
|
4082 file name contains a space] |
| 7 | 4083 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4084 If the expansion fails, the result is an empty string. A name |
| 4869 | 4085 for a non-existing file is not included, unless {expr} does |
| 4086 not start with '%', '#' or '<', see below. | |
| 7 | 4087 |
| 4088 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 4089 like for the |cmdline-special| variables with their associated | |
| 4090 modifiers. Here is a short overview: | |
| 4091 | |
| 4092 % current file name | |
| 4093 # alternate file name | |
| 4094 #n alternate file name n | |
| 4095 <cfile> file name under the cursor | |
| 4096 <afile> autocmd file name | |
| 4097 <abuf> autocmd buffer number (as a String!) | |
| 4098 <amatch> autocmd matched name | |
| 5734 | 4099 <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
|
4100 <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
|
4101 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
|
4102 <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
|
4103 a function |
| 7 | 4104 <cword> word under the cursor |
| 4105 <cWORD> WORD under the cursor | |
| 4106 <client> the {clientid} of the last received | |
| 4107 message |server2client()| | |
| 4108 Modifiers: | |
| 4109 :p expand to full path | |
| 4110 :h head (last path component removed) | |
| 4111 :t tail (last path component only) | |
| 4112 :r root (one extension removed) | |
| 4113 :e extension only | |
| 4114 | |
| 4115 Example: > | |
| 4116 :let &tags = expand("%:p:h") . "/tags" | |
| 4117 < Note that when expanding a string that starts with '%', '#' or | |
| 4118 '<', any following text is ignored. This does NOT work: > | |
| 4119 :let doesntwork = expand("%:h.bak") | |
| 4120 < Use this: > | |
| 4121 :let doeswork = expand("%:h") . ".bak" | |
| 4122 < Also note that expanding "<cfile>" and others only returns the | |
| 4123 referenced file name without further expansion. If "<cfile>" | |
| 4124 is "~/.cshrc", you need to do another expand() to have the | |
| 4125 "~/" expanded into the path of the home directory: > | |
| 4126 :echo expand(expand("<cfile>")) | |
| 4127 < | |
| 4128 There cannot be white space between the variables and the | |
| 4129 following modifier. The |fnamemodify()| function can be used | |
| 4130 to modify normal file names. | |
| 4131 | |
| 4132 When using '%' or '#', and the current or alternate file name | |
| 4133 is not defined, an empty string is used. Using "%:p" in a | |
| 4134 buffer with no name, results in the current directory, with a | |
| 4135 '/' added. | |
| 4136 | |
| 4137 When {expr} does not start with '%', '#' or '<', it is | |
| 4138 expanded like a file name is expanded on the command line. | |
| 4139 '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
|
4140 {nosuf} argument is given and it is |TRUE|. |
| 3398 | 4141 Names for non-existing files are included. The "**" item can |
| 4142 be used to search in a directory tree. For example, to find | |
| 4143 all "README" files in the current directory and below: > | |
| 444 | 4144 :echo expand("**/README") |
| 4145 < | |
|
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
|
4146 expand() can also be used to expand variables and environment |
| 7 | 4147 variables that are only known in a shell. But this can be |
| 6180 | 4148 slow, because a shell may be used to do the expansion. See |
| 4149 |expr-env-expand|. | |
| 7 | 4150 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
|
4151 names. When an environment variable cannot be expanded, it is |
| 7 | 4152 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 4153 "$FOOBAR". | |
| 4154 | |
| 4155 See |glob()| for finding existing files. See |system()| for | |
| 4156 getting the raw output of an external command. | |
| 4157 | |
| 102 | 4158 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 4159 {expr1} and {expr2} must be both |Lists| or both |
| 4160 |Dictionaries|. | |
| 4161 | |
| 4162 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 4163 If {expr3} is given insert the items of {expr2} before item |
| 4164 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 4165 first item. When {expr3} is equal to len({expr1}) then | |
| 4166 {expr2} is appended. | |
| 79 | 4167 Examples: > |
| 4168 :echo sort(extend(mylist, [7, 5])) | |
| 4169 :call extend(mylist, [2, 3], 1) | |
| 1699 | 4170 < When {expr1} is the same List as {expr2} then the number of |
| 4171 items copied is equal to the original length of the List. | |
| 4172 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 4173 (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
|
4174 Use |add()| to concatenate one item to a list. To concatenate |
| 82 | 4175 two lists into a new list use the + operator: > |
| 79 | 4176 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 4177 < |
| 692 | 4178 If they are |Dictionaries|: |
| 102 | 4179 Add all entries from {expr2} to {expr1}. |
| 4180 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 4181 used to decide what to do: | |
| 4182 {expr3} = "keep": keep the value of {expr1} | |
| 4183 {expr3} = "force": use the value of {expr2} | |
| 856 | 4184 {expr3} = "error": give an error message *E737* |
| 102 | 4185 When {expr3} is omitted then "force" is assumed. |
| 4186 | |
| 4187 {expr1} is changed when {expr2} is not empty. If necessary | |
| 4188 make a copy of {expr1} first. | |
| 4189 {expr2} remains unchanged. | |
| 6823 | 4190 When {expr1} is locked and {expr2} is not empty the operation |
| 4191 fails. | |
| 102 | 4192 Returns {expr1}. |
| 4193 | |
| 79 | 4194 |
| 842 | 4195 feedkeys({string} [, {mode}]) *feedkeys()* |
| 4196 Characters in {string} are queued for processing as if they | |
| 6549 | 4197 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
|
4198 |
| 6549 | 4199 By default the string is added to the end of the typeahead |
| 4200 buffer, thus if a mapping is still being executed the | |
| 4201 characters come after them. Use the 'i' flag to insert before | |
| 4202 other characters, they will be executed next, before any | |
| 4203 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
|
4204 |
| 842 | 4205 The function does not wait for processing of keys contained in |
| 4206 {string}. | |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4207 |
| 842 | 4208 To include special keys into {string}, use double-quotes |
| 4209 and "\..." notation |expr-quote|. For example, | |
| 1215 | 4210 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 4211 feedkeys('\<CR>') pushes 5 characters. |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4212 |
| 842 | 4213 {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
|
4214 '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
|
4215 keys are remapped. |
| 843 | 4216 'n' Do not remap keys. |
| 4217 't' Handle keys as if typed; otherwise they are handled as | |
| 4218 if coming from a mapping. This matters for undo, | |
| 4219 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
|
4220 '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
|
4221 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
|
4222 terminal. Other flags are not used. *E980* |
| 6549 | 4223 '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
|
4224 '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
|
4225 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
|
4226 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
|
4227 (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
|
4228 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
|
4229 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
|
4230 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
|
4231 script continues. |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4232 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
|
4233 executing commands, thus calling it recursively, then |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4234 all typehead will be consumed by the last call. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4235 '!' 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
|
4236 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
|
4237 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
|
4238 |
| 842 | 4239 Return value is always 0. |
| 4240 | |
| 7 | 4241 filereadable({file}) *filereadable()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4242 The result is a Number, which is |TRUE| when a file with the |
| 7 | 4243 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
|
4244 or is a directory, the result is |FALSE|. {file} is any |
| 7 | 4245 expression, which is used as a String. |
| 1156 | 4246 If you don't care about the file being readable you can use |
| 4247 |glob()|. | |
| 7 | 4248 *file_readable()* |
| 4249 Obsolete name: file_readable(). | |
| 4250 | |
| 95 | 4251 |
| 1156 | 4252 filewritable({file}) *filewritable()* |
| 4253 The result is a Number, which is 1 when a file with the | |
| 4254 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 4255 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 4256 directory, and we can write to it, the result is 2. |
| 4257 | |
| 4258 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4259 filter({expr1}, {expr2}) *filter()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4260 {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
|
4261 For each item in {expr1} evaluate {expr2} and when the result |
| 685 | 4262 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
|
4263 {expr2} must be a |string| or |Funcref|. |
| 12785 | 4264 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
4265 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
|
4266 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
|
4267 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
|
4268 the current item. |
| 102 | 4269 Examples: > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4270 call filter(mylist, 'v:val !~ "OLD"') |
| 102 | 4271 < 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
|
4272 call filter(mydict, 'v:key >= 8') |
| 102 | 4273 < 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
|
4274 call filter(var, 0) |
| 685 | 4275 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 4276 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4277 Note that {expr2} is the result of expression and is then |
| 102 | 4278 used as an expression again. Often it is good to use a |
| 4279 |literal-string| to avoid having to double backslashes. | |
| 4280 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4281 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
|
4282 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
|
4283 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
|
4284 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
|
4285 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
|
4286 func Odd(idx, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4287 return a:idx % 2 == 1 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4288 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4289 call filter(mylist, function('Odd')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
4290 < 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
|
4291 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
|
4292 < 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
|
4293 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
|
4294 < |
| 685 | 4295 The operation is done in-place. If you want a |List| or |
| 4296 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 4297 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 4298 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4299 < 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
|
4300 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
|
4301 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
|
4302 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
|
4303 defined with the "abort" flag. |
| 95 | 4304 |
| 4305 | |
| 12785 | 4306 finddir({name} [, {path} [, {count}]]) *finddir()* |
| 1095 | 4307 Find directory {name} in {path}. Supports both downwards and |
| 4308 upwards recursive directory searches. See |file-searching| | |
| 4309 for the syntax of {path}. | |
| 4310 Returns the path of the first found match. When the found | |
| 4311 directory is below the current directory a relative path is | |
| 4312 returned. Otherwise a full path is returned. | |
| 19 | 4313 If {path} is omitted or empty then 'path' is used. |
| 4314 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 4315 {name} in {path} instead of the first one. |
| 809 | 4316 When {count} is negative return all the matches in a |List|. |
| 19 | 4317 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
|
4318 {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
|
4319 feature} |
| 794 | 4320 |
| 12785 | 4321 findfile({name} [, {path} [, {count}]]) *findfile()* |
| 794 | 4322 Just like |finddir()|, but find a file instead of a directory. |
| 4323 Uses 'suffixesadd'. | |
| 19 | 4324 Example: > |
| 4325 :echo findfile("tags.vim", ".;") | |
| 1156 | 4326 < Searches from the directory of the current file upwards until |
| 4327 it finds the file "tags.vim". | |
| 7 | 4328 |
| 1621 | 4329 float2nr({expr}) *float2nr()* |
| 4330 Convert {expr} to a Number by omitting the part after the | |
| 4331 decimal point. | |
| 4332 {expr} must evaluate to a |Float| or a Number. | |
| 4333 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
|
4334 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
|
4335 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
|
4336 -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
|
4337 64-bit Number support is enabled, -0x8000000000000000). |
| 1621 | 4338 Examples: > |
| 4339 echo float2nr(3.95) | |
| 4340 < 3 > | |
| 4341 echo float2nr(-23.45) | |
| 4342 < -23 > | |
| 4343 echo float2nr(1.0e100) | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
4344 < 2147483647 (or 9223372036854775807) > |
| 1621 | 4345 echo float2nr(-1.0e150) |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
4346 < -2147483647 (or -9223372036854775807) > |
| 1621 | 4347 echo float2nr(1.0e-100) |
| 4348 < 0 | |
| 4349 {only available when compiled with the |+float| feature} | |
| 4350 | |
| 4351 | |
| 4352 floor({expr}) *floor()* | |
| 4353 Return the largest integral value less than or equal to | |
| 4354 {expr} as a |Float| (round down). | |
| 4355 {expr} must evaluate to a |Float| or a |Number|. | |
| 4356 Examples: > | |
| 4357 echo floor(1.856) | |
| 4358 < 1.0 > | |
| 4359 echo floor(-5.456) | |
| 4360 < -6.0 > | |
| 4361 echo floor(4.0) | |
| 4362 < 4.0 | |
| 4363 {only available when compiled with the |+float| feature} | |
| 12785 | 4364 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4365 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4366 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4367 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4368 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4369 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
|
4370 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
|
4371 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
|
4372 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
|
4373 {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
|
4374 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4375 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4376 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4377 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4378 < -0.13 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4379 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4380 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4381 |
| 1586 | 4382 fnameescape({string}) *fnameescape()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4383 Escape {string} for use as file name command argument. All |
| 1586 | 4384 characters that have a special meaning, such as '%' and '|' |
| 4385 are escaped with a backslash. | |
| 1621 | 4386 For most systems the characters escaped are |
| 4387 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 4388 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 4389 A leading '+' and '>' is also escaped (special after |:edit| |
| 4390 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 4391 Example: > |
| 1700 | 4392 :let fname = '+some str%nge|name' |
| 1586 | 4393 :exe "edit " . fnameescape(fname) |
| 4394 < results in executing: > | |
| 1700 | 4395 edit \+some\ str\%nge\|name |
| 1586 | 4396 |
| 7 | 4397 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 4398 Modify file name {fname} according to {mods}. {mods} is a | |
| 4399 string of characters like it is used for file names on the | |
| 4400 command line. See |filename-modifiers|. | |
| 4401 Example: > | |
| 4402 :echo fnamemodify("main.c", ":p:h") | |
| 4403 < results in: > | |
| 4404 /home/mool/vim/vim/src | |
| 1621 | 4405 < Note: Environment variables don't work in {fname}, use |
| 7 | 4406 |expand()| first then. |
| 4407 | |
| 4408 foldclosed({lnum}) *foldclosed()* | |
| 4409 The result is a Number. If the line {lnum} is in a closed | |
| 4410 fold, the result is the number of the first line in that fold. | |
| 4411 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4412 | |
| 4413 foldclosedend({lnum}) *foldclosedend()* | |
| 4414 The result is a Number. If the line {lnum} is in a closed | |
| 4415 fold, the result is the number of the last line in that fold. | |
| 4416 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4417 | |
| 4418 foldlevel({lnum}) *foldlevel()* | |
| 4419 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
|
4420 in the current buffer. For nested folds the deepest level is |
| 7 | 4421 returned. If there is no fold at line {lnum}, zero is |
| 4422 returned. It doesn't matter if the folds are open or closed. | |
| 4423 When used while updating folds (from 'foldexpr') -1 is | |
| 4424 returned for lines where folds are still to be updated and the | |
| 4425 foldlevel is unknown. As a special case the level of the | |
| 4426 previous line is usually available. | |
| 4427 | |
| 4428 *foldtext()* | |
| 4429 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 4430 the default function used for the 'foldtext' option and should | |
| 4431 only be called from evaluating 'foldtext'. It uses the | |
| 4432 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 4433 The returned string looks like this: > | |
| 4434 +-- 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
|
4435 < 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
|
4436 "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
|
4437 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
|
4438 "//" 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
|
4439 '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
|
4440 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
|
4441 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
|
4442 setting. |
| 7 | 4443 {not available when compiled without the |+folding| feature} |
| 4444 | |
| 29 | 4445 foldtextresult({lnum}) *foldtextresult()* |
| 4446 Returns the text that is displayed for the closed fold at line | |
| 4447 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 4448 When there is no closed fold at {lnum} an empty string is | |
| 4449 returned. | |
| 4450 {lnum} is used like with |getline()|. Thus "." is the current | |
| 4451 line, "'m" mark m, etc. | |
| 4452 Useful when exporting folded text, e.g., to HTML. | |
| 4453 {not available when compiled without the |+folding| feature} | |
| 4454 | |
| 7 | 4455 *foreground()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4456 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 4457 a client to a Vim server. |remote_send()| |
| 4458 On Win32 systems this might not work, the OS does not always | |
| 4459 allow a window to bring itself to the foreground. Use | |
| 4460 |remote_foreground()| instead. | |
| 4461 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 4462 Win32 console version} | |
| 4463 | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4464 *funcref()* |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4465 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4466 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
|
4467 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
|
4468 function {name} is redefined later. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4469 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4470 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
|
4471 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
|
4472 function. |
| 82 | 4473 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4474 *function()* *E700* *E922* *E923* |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4475 function({name} [, {arglist}] [, {dict}]) |
| 685 | 4476 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
|
4477 {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
|
4478 internal function. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4479 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4480 {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
|
4481 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
|
4482 argument is not allowed. E.g.: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4483 let FuncWithArg = function(dict.Func, [arg]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4484 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
|
4485 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4486 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
|
4487 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
|
4488 same function. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4489 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4490 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
|
4491 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
|
4492 the Funcref and will be used when the Funcref is called. |
| 12785 | 4493 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4494 The arguments are passed to the function in front of other |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4495 arguments. Example: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4496 func Callback(arg1, arg2, name) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4497 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4498 let Func = function('Callback', ['one', 'two']) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4499 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4500 call Func('name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4501 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4502 call Callback('one', 'two', 'name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4503 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4504 < 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
|
4505 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
|
4506 arguments. Example: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4507 func Callback(arg1, arg2, name) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4508 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4509 let Func = function('Callback', ['one']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4510 let Func2 = function(Func, ['two']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4511 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4512 call Func2('name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4513 < Invokes the function as with: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4514 call Callback('one', 'two', 'name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4515 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4516 < 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
|
4517 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
|
4518 function Callback() dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4519 echo "called for " . self.name |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4520 endfunction |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4521 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4522 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4523 let Func = function('Callback', context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4524 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4525 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
|
4526 < 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
|
4527 arguments, these two are equivalent: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4528 let Func = function('Callback', context) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4529 let Func = context.Callback |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4530 |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4531 < 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
|
4532 function Callback(arg1, count) dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4533 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4534 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4535 let Func = function('Callback', ['one'], context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4536 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4537 call Func(500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4538 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4539 call context.Callback('one', 500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4540 |
| 82 | 4541 |
| 3224 | 4542 garbagecollect([{atexit}]) *garbagecollect()* |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4543 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
|
4544 that have circular references. |
| 12785 | 4545 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4546 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
|
4547 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
|
4548 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
|
4549 circular references are always freed when they become unused. |
| 685 | 4550 This is useful if you have deleted a very big |List| and/or |
| 4551 |Dictionary| with circular references in a script that runs | |
| 4552 for a long time. | |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4553 |
| 3224 | 4554 When the optional {atexit} argument is one, garbage |
| 1405 | 4555 collection will also be done when exiting Vim, if it wasn't |
| 4556 done before. This is useful when checking for memory leaks. | |
| 370 | 4557 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
4558 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
|
4559 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
|
4560 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
|
4561 |test_garbagecollect_now()|. |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4562 |
| 140 | 4563 get({list}, {idx} [, {default}]) *get()* |
| 685 | 4564 Get item {idx} from |List| {list}. When this item is not |
| 82 | 4565 available return {default}. Return zero when {default} is |
| 4566 omitted. | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4567 get({blob}, {idx} [, {default}]) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4568 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
|
4569 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
|
4570 omitted. |
| 102 | 4571 get({dict}, {key} [, {default}]) |
| 685 | 4572 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 4573 item is not available return {default}. Return zero when |
| 4574 {default} is omitted. | |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4575 get({func}, {what}) |
|
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4576 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
|
4577 {what} are: |
| 11062 | 4578 "name" The function name |
| 4579 "func" The function | |
| 4580 "dict" The dictionary | |
| 4581 "args" The list with arguments | |
| 102 | 4582 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4583 *getbufinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4584 getbufinfo([{expr}]) |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4585 getbufinfo([{dict}]) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4586 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
|
4587 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4588 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
|
4589 returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4590 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4591 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
|
4592 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
|
4593 be specified in {dict}: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4594 buflisted include only listed buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4595 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
|
4596 bufmodified include only modified buffers. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4597 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4598 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
|
4599 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
|
4600 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
|
4601 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
|
4602 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4603 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
|
4604 entries: |
|
9904
24900147aa44
commit https://github.com/vim/vim/commit/339288377072f66ec88e21903e75a82d23ffbf4f
Christian Brabandt <cb@256bit.org>
parents:
9894
diff
changeset
|
4605 bufnr buffer number. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4606 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
|
4607 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
|
4608 hidden TRUE if the buffer is hidden. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4609 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
|
4610 lnum current line number in buffer. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4611 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
|
4612 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
|
4613 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
|
4614 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
|
4615 the following fields: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4616 id sign identifier |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4617 lnum line number |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4618 name sign name |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4619 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
|
4620 buffer-local variables. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4621 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
|
4622 buffer |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4623 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4624 Examples: > |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4625 for buf in getbufinfo() |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4626 echo buf.name |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4627 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4628 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
|
4629 if buf.changed |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4630 .... |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4631 endif |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4632 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4633 < |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4634 To get buffer-local options use: > |
| 14519 | 4635 getbufvar({bufnr}, '&option_name') |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4636 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4637 < |
| 435 | 4638 *getbufline()* |
| 4639 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 4640 Return a |List| with the lines starting from {lnum} to {end} |
| 4641 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 4642 |List| with only the line {lnum} is returned. | |
| 435 | 4643 |
| 4644 For the use of {expr}, see |bufname()| above. | |
| 4645 | |
| 448 | 4646 For {lnum} and {end} "$" can be used for the last line of the |
| 4647 buffer. Otherwise a number must be used. | |
| 435 | 4648 |
| 4649 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 4650 lines in the buffer, an empty |List| is returned. |
| 435 | 4651 |
| 4652 When {end} is greater than the number of lines in the buffer, | |
| 4653 it is treated as {end} is set to the number of lines in the | |
| 685 | 4654 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 4655 returned. |
| 4656 | |
| 448 | 4657 This function works only for loaded buffers. For unloaded and |
| 685 | 4658 non-existing buffers, an empty |List| is returned. |
| 435 | 4659 |
| 4660 Example: > | |
| 4661 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 4662 |
| 4157 | 4663 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 4664 The result is the value of option or local buffer variable |
| 4665 {varname} in buffer {expr}. Note that the name without "b:" | |
| 4666 must be used. | |
| 1668 | 4667 When {varname} is empty returns a dictionary with all the |
| 4668 buffer-local variables. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4669 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
|
4670 the buffer-local options. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4671 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
|
4672 a buffer-local option. |
| 216 | 4673 This also works for a global or buffer-local option, but it |
| 4674 doesn't work for a global variable, window-local variable or | |
| 4675 window-local option. | |
| 82 | 4676 For the use of {expr}, see |bufname()| above. |
| 4157 | 4677 When the buffer or variable doesn't exist {def} or an empty |
| 4678 string is returned, there is no error message. | |
| 82 | 4679 Examples: > |
| 4680 :let bufmodified = getbufvar(1, "&mod") | |
| 4681 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
| 4682 < | |
|
13280
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4683 getchangelist({expr}) *getchangelist()* |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4684 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
|
4685 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
|
4686 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
|
4687 |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4688 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
|
4689 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
|
4690 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
|
4691 entries: |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4692 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
|
4693 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
|
4694 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
|
4695 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
|
4696 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
|
4697 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
|
4698 |
| 7 | 4699 getchar([expr]) *getchar()* |
| 867 | 4700 Get a single character from the user or input stream. |
| 7 | 4701 If [expr] is omitted, wait until a character is available. |
| 4702 If [expr] is 0, only get a character when one is available. | |
| 867 | 4703 Return zero otherwise. |
| 7 | 4704 If [expr] is 1, only check if a character is available, it is |
| 867 | 4705 not consumed. Return zero if no character available. |
| 4706 | |
| 5555 | 4707 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
|
4708 special key is returned. If it is a single character, the |
| 867 | 4709 result is a number. Use nr2char() to convert it to a String. |
| 4710 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
|
4711 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
|
4712 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
|
4713 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
|
4714 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
|
4715 that is not included in the character. |
| 867 | 4716 |
| 5968 | 4717 When [expr] is 0 and Esc is typed, there will be a short delay |
| 4718 while Vim waits to see if this is the start of an escape | |
| 4719 sequence. | |
| 4720 | |
| 5555 | 4721 When [expr] is 1 only the first byte is returned. For a |
| 872 | 4722 one-byte character it is the character itself as a number. |
| 4723 Use nr2char() to convert it to a String. | |
| 867 | 4724 |
| 3224 | 4725 Use getcharmod() to obtain any additional modifiers. |
| 4726 | |
| 1029 | 4727 When the user clicks a mouse button, the mouse event will be |
| 4728 returned. The position can then be found in |v:mouse_col|, | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
4729 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. This |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
4730 example positions the mouse as it would normally happen: > |
| 1029 | 4731 let c = getchar() |
| 1621 | 4732 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 4733 exe v:mouse_win . "wincmd w" |
| 4734 exe v:mouse_lnum | |
| 4735 exe "normal " . v:mouse_col . "|" | |
| 4736 endif | |
| 4737 < | |
| 10734 | 4738 When using bracketed paste only the first character is |
| 4739 returned, the rest of the pasted text is dropped. | |
| 4740 |xterm-bracketed-paste|. | |
| 4741 | |
| 7 | 4742 There is no prompt, you will somehow have to make clear to the |
| 4743 user that a character has to be typed. | |
| 4744 There is no mapping for the character. | |
| 4745 Key codes are replaced, thus when the user presses the <Del> | |
| 4746 key you get the code for the <Del> key, not the raw character | |
| 4747 sequence. Examples: > | |
| 4748 getchar() == "\<Del>" | |
| 4749 getchar() == "\<S-Left>" | |
| 4750 < This example redefines "f" to ignore case: > | |
| 4751 :nmap f :call FindChar()<CR> | |
| 4752 :function FindChar() | |
| 4753 : let c = nr2char(getchar()) | |
| 4754 : while col('.') < col('$') - 1 | |
| 4755 : normal l | |
| 4756 : if getline('.')[col('.') - 1] ==? c | |
| 4757 : break | |
| 4758 : endif | |
| 4759 : endwhile | |
| 4760 :endfunction | |
| 6421 | 4761 < |
| 6647 | 4762 You may also receive synthetic characters, such as |
| 6421 | 4763 |<CursorHold>|. Often you will want to ignore this and get |
| 4764 another character: > | |
| 4765 :function GetKey() | |
| 4766 : let c = getchar() | |
| 4767 : while c == "\<CursorHold>" | |
| 4768 : let c = getchar() | |
| 4769 : endwhile | |
| 4770 : return c | |
| 4771 :endfunction | |
| 7 | 4772 |
| 4773 getcharmod() *getcharmod()* | |
| 4774 The result is a Number which is the state of the modifiers for | |
| 4775 the last obtained character with getchar() or in another way. | |
| 4776 These values are added together: | |
| 4777 2 shift | |
| 4778 4 control | |
| 4779 8 alt (meta) | |
| 3224 | 4780 16 meta (when it's different from ALT) |
| 4781 32 mouse double click | |
| 4782 64 mouse triple click | |
| 4783 96 mouse quadruple click (== 32 + 64) | |
| 4784 128 command (Macintosh only) | |
| 7 | 4785 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
|
4786 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4787 without a modifier. |
| 7 | 4788 |
| 6991 | 4789 getcharsearch() *getcharsearch()* |
| 4790 Return the current character search information as a {dict} | |
| 4791 with the following entries: | |
| 4792 | |
| 4793 char character previously used for a character | |
| 4794 search (|t|, |f|, |T|, or |F|); empty string | |
| 4795 if no character search has been performed | |
| 4796 forward direction of character search; 1 for forward, | |
| 4797 0 for backward | |
| 4798 until type of character search; 1 for a |t| or |T| | |
| 4799 character search, 0 for an |f| or |F| | |
| 4800 character search | |
| 4801 | |
| 4802 This can be useful to always have |;| and |,| search | |
| 4803 forward/backward regardless of the direction of the previous | |
| 4804 character search: > | |
| 4805 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 4806 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 4807 < Also see |setcharsearch()|. | |
| 4808 | |
| 7 | 4809 getcmdline() *getcmdline()* |
| 4810 Return the current command-line. Only works when the command | |
| 4811 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 4812 |c_CTRL-R_=|. | |
| 4813 Example: > | |
| 4814 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 4815 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 14864 | 4816 Returns an empty string when entering a password or using |
| 4817 |inputsecret()|. | |
| 7 | 4818 |
| 95 | 4819 getcmdpos() *getcmdpos()* |
| 7 | 4820 Return the position of the cursor in the command line as a |
| 4821 byte count. The first column is 1. | |
| 4822 Only works when editing the command line, thus requires use of | |
| 3456 | 4823 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4824 Returns 0 otherwise. | |
| 531 | 4825 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 4826 | |
| 4827 getcmdtype() *getcmdtype()* | |
| 4828 Return the current command-line type. Possible return values | |
| 4829 are: | |
| 532 | 4830 : normal Ex command |
| 4831 > debug mode command |debug-mode| | |
| 4832 / forward search command | |
| 4833 ? backward search command | |
| 4834 @ |input()| command | |
| 4835 - |:insert| or |:append| command | |
| 6213 | 4836 = |i_CTRL-R_=| |
| 531 | 4837 Only works when editing the command line, thus requires use of |
| 3456 | 4838 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4839 Returns an empty string otherwise. | |
| 531 | 4840 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 4841 |
| 6153 | 4842 getcmdwintype() *getcmdwintype()* |
| 4843 Return the current |command-line-window| type. Possible return | |
| 4844 values are the same as |getcmdtype()|. Returns an empty string | |
| 4845 when not in the command-line window. | |
| 4846 | |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4847 getcompletion({pat}, {type} [, {filtered}]) *getcompletion()* |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4848 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
|
4849 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
|
4850 supported: |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4851 |
|
13551
1fd0f8392946
patch 8.0.1649: no completion for argument list commands
Christian Brabandt <cb@256bit.org>
parents:
13513
diff
changeset
|
4852 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
|
4853 augroup autocmd groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4854 buffer buffer names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4855 behave :behave suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4856 color color schemes |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4857 command Ex command (and arguments) |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4858 compiler compilers |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4859 cscope |:cscope| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4860 dir directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4861 environment environment variable names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4862 event autocommand events |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4863 expression Vim expression |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4864 file file and directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4865 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
|
4866 filetype filetype names |'filetype'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4867 function function name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4868 help help subjects |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4869 highlight highlight groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4870 history :history suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4871 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
|
4872 mapclear buffer argument |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4873 mapping mapping name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4874 menu menus |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
4875 messages |:messages| suboptions |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4876 option options |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
4877 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
|
4878 shellcmd Shell command |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4879 sign |:sign| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4880 syntax syntax file names |'syntax'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4881 syntime |:syntime| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4882 tag tags |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4883 tag_listfiles tags, file names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4884 user user names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4885 var user variables |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4886 |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4887 If {pat} is an empty string, then all the matches are returned. |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4888 Otherwise only items matching {pat} are returned. See |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4889 |wildcards| for the use of special characters in {pat}. |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4890 |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4891 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
|
4892 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
|
4893 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
|
4894 |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4895 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
|
4896 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
|
4897 |
| 5944 | 4898 *getcurpos()* |
| 4899 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
| 4900 includes an extra item in the list: | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7593
diff
changeset
|
4901 [bufnum, lnum, col, off, curswant] ~ |
| 5944 | 4902 The "curswant" number is the preferred column when moving the |
| 11347 | 4903 cursor vertically. Also see |getpos()|. |
| 4904 | |
| 5944 | 4905 This can be used to save and restore the cursor position: > |
| 4906 let save_cursor = getcurpos() | |
| 4907 MoveTheCursorAround | |
| 4908 call setpos('.', save_cursor) | |
| 11347 | 4909 < Note that this only works within the window. See |
| 4910 |winrestview()| for restoring more state. | |
| 7 | 4911 *getcwd()* |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4912 getcwd([{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4913 The result is a String, which is the name of the current |
| 7 | 4914 working directory. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4915 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4916 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
|
4917 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
|
4918 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
|
4919 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
|
4920 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
|
4921 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4922 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
|
4923 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
|
4924 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
|
4925 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
|
4926 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
|
4927 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
|
4928 current window. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4929 Return an empty string if the arguments are invalid. |
| 7 | 4930 |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
4931 Examples: > |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
4932 " 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
|
4933 :echo getcwd() |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
4934 :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
|
4935 :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
|
4936 " 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
|
4937 :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
|
4938 " 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
|
4939 :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
|
4940 " 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
|
4941 :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
|
4942 " 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
|
4943 :echo getcwd(-1, 0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
4944 < |
| 7 | 4945 getfsize({fname}) *getfsize()* |
| 4946 The result is a Number, which is the size in bytes of the | |
| 4947 given file {fname}. | |
| 4948 If {fname} is a directory, 0 is returned. | |
| 4949 If the file {fname} can't be found, -1 is returned. | |
| 1293 | 4950 If the size of {fname} is too big to fit in a Number then -2 |
| 4951 is returned. | |
| 7 | 4952 |
| 37 | 4953 getfontname([{name}]) *getfontname()* |
| 4954 Without an argument returns the name of the normal font being | |
| 4955 used. Like what is used for the Normal highlight group | |
| 4956 |hl-Normal|. | |
| 4957 With an argument a check is done whether {name} is a valid | |
| 4958 font name. If not then an empty string is returned. | |
| 4959 Otherwise the actual font name is returned, or {name} if the | |
| 4960 GUI does not support obtaining the real name. | |
| 824 | 4961 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 4962 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 4963 function just after the GUI has started. | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
4964 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
|
4965 a valid name does not work. |
| 37 | 4966 |
| 20 | 4967 getfperm({fname}) *getfperm()* |
| 4968 The result is a String, which is the read, write, and execute | |
| 4969 permissions of the given file {fname}. | |
| 4970 If {fname} does not exist or its directory cannot be read, an | |
| 4971 empty string is returned. | |
| 4972 The result is of the form "rwxrwxrwx", where each group of | |
| 4973 "rwx" flags represent, in turn, the permissions of the owner | |
| 4974 of the file, the group the file belongs to, and other users. | |
| 4975 If a user does not have a given permission the flag for this | |
| 3750 | 4976 is replaced with the string "-". Examples: > |
| 20 | 4977 :echo getfperm("/etc/passwd") |
| 3750 | 4978 :echo getfperm(expand("~/.vimrc")) |
| 20 | 4979 < This will hopefully (from a security point of view) display |
| 4980 the string "rw-r--r--" or even "rw-------". | |
| 205 | 4981 |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10237
diff
changeset
|
4982 For setting permissions use |setfperm()|. |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
4983 |
| 7 | 4984 getftime({fname}) *getftime()* |
| 4985 The result is a Number, which is the last modification time of | |
| 4986 the given file {fname}. The value is measured as seconds | |
| 4987 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 4988 |localtime()| and |strftime()|. | |
| 4989 If the file {fname} can't be found -1 is returned. | |
| 4990 | |
| 20 | 4991 getftype({fname}) *getftype()* |
| 4992 The result is a String, which is a description of the kind of | |
| 4993 file of the given file {fname}. | |
| 4994 If {fname} does not exist an empty string is returned. | |
| 4995 Here is a table over different kinds of files and their | |
| 4996 results: | |
| 4997 Normal file "file" | |
| 4998 Directory "dir" | |
| 4999 Symbolic link "link" | |
| 5000 Block device "bdev" | |
| 5001 Character device "cdev" | |
| 5002 Socket "socket" | |
| 5003 FIFO "fifo" | |
| 5004 All other "other" | |
| 5005 Example: > | |
| 5006 getftype("/home") | |
| 5007 < Note that a type such as "link" will only be returned on | |
| 5008 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
|
5009 "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
|
5010 directory returns "dir" instead of "link". |
| 20 | 5011 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
5012 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
|
5013 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
|
5014 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5015 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
|
5016 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
|
5017 {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
|
5018 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
|
5019 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
|
5020 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5021 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
|
5022 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
|
5023 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
|
5024 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
|
5025 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
|
5026 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
|
5027 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
|
5028 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
|
5029 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
|
5030 |
| 7 | 5031 *getline()* |
| 82 | 5032 getline({lnum} [, {end}]) |
| 5033 Without {end} the result is a String, which is line {lnum} | |
| 5034 from the current buffer. Example: > | |
| 7 | 5035 getline(1) |
| 5036 < 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
|
5037 digit, |line()| is called to translate the String into a Number. |
| 7 | 5038 To get the line under the cursor: > |
| 5039 getline(".") | |
| 5040 < When {lnum} is smaller than 1 or bigger than the number of | |
| 5041 lines in the buffer, an empty string is returned. | |
| 5042 | |
| 685 | 5043 When {end} is given the result is a |List| where each item is |
| 5044 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 5045 including line {end}. |
| 5046 {end} is used in the same way as {lnum}. | |
| 5047 Non-existing lines are silently omitted. | |
| 685 | 5048 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 5049 Example: > |
| 5050 :let start = line('.') | |
| 5051 :let end = search("^$") - 1 | |
| 5052 :let lines = getline(start, end) | |
| 5053 | |
| 1156 | 5054 < To get lines from another buffer see |getbufline()| |
| 5055 | |
| 12785 | 5056 getloclist({nr} [, {what}]) *getloclist()* |
| 647 | 5057 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
|
5058 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
|
5059 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
|
5060 |
| 647 | 5061 For a location list window, the displayed location list is |
| 648 | 5062 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
|
5063 returned. Otherwise, same as |getqflist()|. |
| 82 | 5064 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5065 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
|
5066 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
|
5067 |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
|
5068 |
|
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
|
5069 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
|
5070 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
|
5071 |
|
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
|
5072 filewinid id of the window used to display files |
|
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
|
5073 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
|
5074 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
|
5075 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
|
5076 |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
|
5077 details. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5078 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
5079 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
|
5080 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
|
5081 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
|
5082 |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
|
5083 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
|
5084 |getmatches()|. |
| 1326 | 5085 Example: > |
| 5086 :echo getmatches() | |
| 5087 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 5088 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 5089 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 5090 :let m = getmatches() | |
| 5091 :call clearmatches() | |
| 5092 :echo getmatches() | |
| 5093 < [] > | |
| 5094 :call setmatches(m) | |
| 5095 :echo getmatches() | |
| 5096 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 5097 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 5098 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 5099 :unlet m | |
| 5100 < | |
| 5968 | 5101 *getpid()* |
| 5102 getpid() Return a Number which is the process ID of the Vim process. | |
| 5103 On Unix and MS-Windows this is a unique number, until Vim | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5104 exits. On MS-DOS it's always zero. |
| 5968 | 5105 |
| 5106 *getpos()* | |
| 5107 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 5108 see |line()|. For getting the cursor position see | |
| 5109 |getcurpos()|. | |
| 5110 The result is a |List| with four numbers: | |
| 5111 [bufnum, lnum, col, off] | |
| 5112 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 5113 is the buffer number of the mark. | |
| 5114 "lnum" and "col" are the position in the buffer. The first | |
| 5115 column is 1. | |
| 5116 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 5117 it is the offset in screen columns from the start of the | |
| 5118 character. E.g., a position within a <Tab> or after the last | |
| 5119 character. | |
| 5120 Note that for '< and '> Visual mode matters: when it is "V" | |
| 5121 (visual line mode) the column of '< is zero and the column of | |
| 5122 '> is a large number. | |
| 5123 This can be used to save and restore the position of a mark: > | |
| 5124 let save_a_mark = getpos("'a") | |
| 5125 ... | |
| 6421 | 5126 call setpos("'a", save_a_mark) |
| 5968 | 5127 < Also see |getcurpos()| and |setpos()|. |
| 5128 | |
| 1326 | 5129 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5130 getqflist([{what}]) *getqflist()* |
| 230 | 5131 Returns a list with all the current quickfix errors. Each |
| 5132 list item is a dictionary with these entries: | |
| 5133 bufnr number of buffer that has the file name, use | |
| 5134 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
|
5135 module module name |
| 230 | 5136 lnum line number in the buffer (first line is 1) |
| 5137 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
|
5138 vcol |TRUE|: "col" is visual column |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5139 |FALSE|: "col" is byte index |
| 230 | 5140 nr error number |
| 1065 | 5141 pattern search pattern used to locate the error |
| 230 | 5142 text description of the error |
| 5143 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
|
5144 valid |TRUE|: recognized error message |
| 230 | 5145 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5146 When there is no error list or it's empty, an empty list is |
| 1065 | 5147 returned. Quickfix list entries with non-existing buffer |
| 5148 number are returned with "bufnr" set to zero. | |
| 515 | 5149 |
| 230 | 5150 Useful application: Find pattern matches in multiple files and |
| 5151 do something with them: > | |
| 5152 :vimgrep /theword/jg *.c | |
| 5153 :for d in getqflist() | |
| 5154 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 5155 :endfor | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5156 < |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5157 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
|
5158 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
|
5159 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
|
5160 changedtick get the total number of changes made |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5161 to the list |quickfix-changedtick| |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5162 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
|
5163 efm errorformat to use when parsing "lines". If |
| 12968 | 5164 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
|
5165 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
|
5166 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
|
5167 |quickfix-ID|; zero means the id for the |
| 12968 | 5168 current list or the list specified by "nr" |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
5169 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
|
5170 list specified by 'id' or 'nr'. |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
5171 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
|
5172 items quickfix list entries |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5173 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
|
5174 the resulting entries. Only a |List| type is |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5175 accepted. The current quickfix list is not |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5176 modified. See |quickfix-parse|. |
|
10237
197795e3530d
commit https://github.com/vim/vim/commit/890680ca6364386fabb271c85e0755bcaa6a33c1
Christian Brabandt <cb@256bit.org>
parents:
10233
diff
changeset
|
5177 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
|
5178 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
|
5179 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
|
5180 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
|
5181 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
|
5182 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
|
5183 size number of entries in the quickfix list |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5184 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
|
5185 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
|
5186 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
|
5187 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
|
5188 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
|
5189 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
|
5190 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
|
5191 specified by "id" is used. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
5192 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
|
5193 "$" 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
|
5194 contains the quickfix stack size. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
5195 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
|
5196 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
|
5197 "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
|
5198 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5199 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
|
5200 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
|
5201 list |quickfix-changedtick| |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5202 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
|
5203 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
|
5204 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
|
5205 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
|
5206 idx index of the current entry in the list. If not |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5207 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
|
5208 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
|
5209 an empty list. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5210 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
|
5211 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
|
5212 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
|
5213 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
|
5214 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
|
5215 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
|
5216 to "". |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
5217 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
|
5218 |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5219 Examples (See also |getqflist-examples|): > |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5220 :echo getqflist({'all': 1}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5221 :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
|
5222 :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
|
5223 < |
| 5796 | 5224 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 5225 The result is a String, which is the contents of register |
| 236 | 5226 {regname}. Example: > |
| 7 | 5227 :let cliptext = getreg('*') |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
5228 < 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
|
5229 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
5230 getreg('=') returns the last evaluated value of the expression |
| 236 | 5231 register. (For use in maps.) |
| 282 | 5232 getreg('=', 1) returns the expression itself, so that it can |
| 5233 be restored with |setreg()|. For other registers the extra | |
| 5234 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
|
5235 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5236 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
|
5237 to |List|. Each list item is one text line. Use it if you care |
| 5796 | 5238 about zero bytes possibly present inside register: without |
| 5239 third argument both NLs and zero bytes are represented as NLs | |
| 5240 (see |NL-used-for-Nul|). | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
5241 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
|
5242 |
| 7 | 5243 If {regname} is not specified, |v:register| is used. |
| 5244 | |
| 82 | 5245 |
| 7 | 5246 getregtype([{regname}]) *getregtype()* |
| 5247 The result is a String, which is type of register {regname}. | |
| 5248 The value will be one of: | |
| 5249 "v" for |characterwise| text | |
| 5250 "V" for |linewise| text | |
| 5251 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 5252 "" for an empty or unknown register |
| 7 | 5253 <CTRL-V> is one character with value 0x16. |
| 5254 If {regname} is not specified, |v:register| is used. | |
| 5255 | |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5256 gettabinfo([{arg}]) *gettabinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5257 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
|
5258 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
|
5259 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
|
5260 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
|
5261 empty List is returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5262 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5263 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
|
5264 tabnr tab page number. |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5265 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
|
5266 tabpage-local variables |
| 15932 | 5267 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
|
5268 |
| 4157 | 5269 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5270 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
|
5271 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5272 Tabs are numbered starting with one. |
| 6197 | 5273 When {varname} is empty a dictionary with all tab-local |
| 5274 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5275 Note that the name without "t:" must be used. |
| 4157 | 5276 When the tab or variable doesn't exist {def} or an empty |
| 5277 string is returned, there is no error message. | |
| 5278 | |
| 5279 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
| 1156 | 5280 Get the value of window-local variable {varname} in window |
| 5281 {winnr} in tab page {tabnr}. | |
| 4157 | 5282 When {varname} is empty a dictionary with all window-local |
| 5283 variables is returned. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5284 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
|
5285 window-local options in a Dictionary. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5286 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
|
5287 window-local option. |
| 4157 | 5288 Note that {varname} must be the name without "w:". |
| 831 | 5289 Tabs are numbered starting with one. For the current tabpage |
| 5290 use |getwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5291 {winnr} can be the window number or the |window-ID|. |
| 831 | 5292 When {winnr} is zero the current window is used. |
| 5293 This also works for a global option, buffer-local option and | |
| 5294 window-local option, but it doesn't work for a global variable | |
| 5295 or buffer-local variable. | |
| 4157 | 5296 When the tab, window or variable doesn't exist {def} or an |
| 5297 empty string is returned, there is no error message. | |
| 831 | 5298 Examples: > |
| 5299 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 5300 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 5301 < |
| 14347 | 5302 To obtain all window-local variables use: > |
| 5303 gettabwinvar({tabnr}, {winnr}, '&') | |
| 5304 | |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5305 gettagstack([{nr}]) *gettagstack()* |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5306 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
|
5307 {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
|
5308 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
|
5309 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
|
5310 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5311 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
|
5312 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
|
5313 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
|
5314 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
|
5315 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
|
5316 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
|
5317 entries described below. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5318 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
|
5319 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5320 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
|
5321 entries: |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5322 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
|
5323 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
|
5324 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
|
5325 returned list. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5326 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
|
5327 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
|
5328 name. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5329 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
|
5330 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
5331 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
|
5332 |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5333 getwininfo([{winid}]) *getwininfo()* |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5334 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
|
5335 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5336 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
|
5337 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
|
5338 empty list. |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5339 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5340 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
|
5341 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
|
5342 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5343 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
|
5344 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
|
5345 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
|
5346 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
|
5347 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
|
5348 {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
|
5349 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
|
5350 {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
|
5351 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
|
5352 {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
|
5353 tabnr tab page number |
|
15977
7fbdceabad64
patch 8.1.0994: relative cursor position is not calculated correctly
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
5354 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
|
5355 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
|
5356 window-local variables |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5357 width window width |
| 14347 | 5358 winbar 1 if the window has a toolbar, 0 |
| 5359 otherwise | |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5360 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
|
5361 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
|
5362 winid |window-ID| |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5363 winnr window number |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
5364 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
|
5365 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
|
5366 |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
5367 getwinpos([{timeout}]) *getwinpos()* |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
5368 The result is a list with two numbers, the result of |
| 15194 | 5369 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
|
5370 [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
|
5371 {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
|
5372 a response from the terminal. When omitted 100 msec is used. |
| 13437 | 5373 Use a longer time for a remote terminal. |
| 5374 When using a value less than 10 and no response is received | |
| 5375 within that time, a previously reported position is returned, | |
| 5376 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
|
5377 do some work in the meantime: > |
| 13437 | 5378 while 1 |
| 5379 let res = getwinpos(1) | |
| 5380 if res[0] >= 0 | |
| 5381 break | |
| 5382 endif | |
| 5383 " Do some work here | |
| 5384 endwhile | |
| 5385 < | |
| 7 | 5386 *getwinposx()* |
| 5387 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 11347 | 5388 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
|
5389 xterm (uses a timeout of 100 msec). |
| 11347 | 5390 The result will be -1 if the information is not available. |
| 5391 The value can be used with `:winpos`. | |
| 7 | 5392 |
| 5393 *getwinposy()* | |
| 5394 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
|
5395 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
|
5396 a timeout of 100 msec). |
| 11347 | 5397 The result will be -1 if the information is not available. |
| 5398 The value can be used with `:winpos`. | |
| 7 | 5399 |
| 4157 | 5400 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 5401 Like |gettabwinvar()| for the current tabpage. |
| 7 | 5402 Examples: > |
| 5403 :let list_is_on = getwinvar(2, '&list') | |
| 5404 :echo "myvar = " . getwinvar(1, 'myvar') | |
| 5405 < | |
| 6663 | 5406 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 5407 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 5408 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5409 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5410 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 5411 the 'suffixes' and 'wildignore' options apply: Names matching |
| 5412 one of the patterns in 'wildignore' will be skipped and | |
| 5413 'suffixes' affect the ordering of matches. | |
| 2662 | 5414 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5415 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5416 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
|
5417 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
|
5418 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5419 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
|
5420 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5421 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
5422 If the expansion fails, the result is an empty String or List. |
| 6663 | 5423 |
| 16267 | 5424 You can also use |readdir()| if you need to do complicated |
| 5425 things, such as limiting the number of matches. | |
| 5426 | |
| 3445 | 5427 A name for a non-existing file is not included. A symbolic |
| 5428 link is only included if it points to an existing file. | |
| 6663 | 5429 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
|
5430 |TRUE| then all symbolic links are included. |
| 7 | 5431 |
| 5432 For most systems backticks can be used to get files names from | |
| 5433 any external command. Example: > | |
| 5434 :let tagfiles = glob("`find . -name tags -print`") | |
| 5435 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 5436 < 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
|
5437 item per line. Spaces inside an item are allowed. |
| 7 | 5438 |
| 5439 See |expand()| for expanding special Vim variables. See | |
| 5440 |system()| for getting the raw output of an external command. | |
| 5441 | |
| 6697 | 5442 glob2regpat({expr}) *glob2regpat()* |
| 5443 Convert a file pattern, as used by glob(), into a search | |
| 5444 pattern. The result can be used to match with a string that | |
| 5445 is a file name. E.g. > | |
| 5446 if filename =~ glob2regpat('Make*.mak') | |
| 5447 < This is equivalent to: > | |
| 5448 if filename =~ '^Make.*\.mak$' | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5449 < 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
|
5450 empty string. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5451 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
|
5452 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
|
5453 |
| 6663 | 5454 *globpath()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5455 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 7 | 5456 Perform glob() on all directories in {path} and concatenate |
| 5457 the results. Example: > | |
| 5458 :echo globpath(&rtp, "syntax/c.vim") | |
| 5873 | 5459 < |
| 5460 {path} is a comma-separated list of directory names. Each | |
| 7 | 5461 directory name is prepended to {expr} and expanded like with |
| 1754 | 5462 |glob()|. A path separator is inserted when needed. |
| 7 | 5463 To add a comma inside a directory name escape it with a |
| 5464 backslash. Note that on MS-Windows a directory may have a | |
| 5465 trailing backslash, remove it if you put a comma after it. | |
| 5466 If the expansion fails for one of the directories, there is no | |
| 5467 error message. | |
| 5873 | 5468 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5469 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 5470 the 'suffixes' and 'wildignore' options apply: Names matching |
| 5471 one of the patterns in 'wildignore' will be skipped and | |
| 5472 'suffixes' affect the ordering of matches. | |
| 7 | 5473 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5474 When {list} is present and it is |TRUE| the result is a List |
| 5873 | 5475 with all matching files. The advantage of using a List is, you |
| 5476 also get filenames containing newlines correctly. Otherwise | |
| 5477 the result is a String and when there are several matches, | |
| 5478 they are separated by <NL> characters. Example: > | |
| 5479 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 5480 < | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5481 {alllinks} is used as with |glob()|. |
| 6663 | 5482 |
| 444 | 5483 The "**" item can be used to search in a directory tree. |
| 5484 For example, to find all "README.txt" files in the directories | |
| 5485 in 'runtimepath' and below: > | |
| 5486 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 5487 < Upwards search and limiting the depth of "**" is not |
| 5488 supported, thus using 'path' will not always work properly. | |
| 5489 | |
| 7 | 5490 *has()* |
| 5491 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
| 5492 supported, zero otherwise. The {feature} argument is a | |
| 5493 string. See |feature-list| below. | |
| 5494 Also see |exists()|. | |
| 5495 | |
| 102 | 5496 |
| 5497 has_key({dict}, {key}) *has_key()* | |
| 685 | 5498 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 5499 an entry with key {key}. Zero otherwise. | |
| 102 | 5500 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5501 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
|
5502 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
|
5503 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
|
5504 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
|
5505 0 otherwise. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5506 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5507 Without arguments use the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5508 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
|
5509 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
|
5510 page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5511 {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
|
5512 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
|
5513 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
|
5514 Examples: > |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5515 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
|
5516 " 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
|
5517 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
|
5518 " 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
|
5519 else |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5520 " 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
|
5521 endif |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5522 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5523 " current window |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5524 :echo haslocaldir() |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5525 :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
|
5526 :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
|
5527 " 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
|
5528 :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
|
5529 :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
|
5530 " 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
|
5531 :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
|
5532 " 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
|
5533 :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
|
5534 < |
| 782 | 5535 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 5536 The result is a Number, which is 1 if there is a mapping that |
| 5537 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 5538 and this mapping exists in one of the modes indicated by | |
| 5539 {mode}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5540 When {abbr} is there and it is |TRUE| use abbreviations |
| 786 | 5541 instead of mappings. Don't forget to specify Insert and/or |
| 5542 Command-line mode. | |
| 7 | 5543 Both the global mappings and the mappings local to the current |
| 5544 buffer are checked for a match. | |
| 5545 If no matching mapping is found 0 is returned. | |
| 5546 The following characters are recognized in {mode}: | |
| 5547 n Normal mode | |
| 5548 v Visual mode | |
| 5549 o Operator-pending mode | |
| 5550 i Insert mode | |
| 5551 l Language-Argument ("r", "f", "t", etc.) | |
| 5552 c Command-line mode | |
| 5553 When {mode} is omitted, "nvo" is used. | |
| 5554 | |
| 5555 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
|
5556 to a function in a Vim script. Example: > |
| 7 | 5557 :if !hasmapto('\ABCdoit') |
| 5558 : map <Leader>d \ABCdoit | |
| 5559 :endif | |
| 5560 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 5561 already a mapping to "\ABCdoit". | |
| 5562 | |
| 5563 histadd({history}, {item}) *histadd()* | |
| 5564 Add the String {item} to the history {history} which can be | |
| 5565 one of: *hist-names* | |
| 5566 "cmd" or ":" command line history | |
| 5567 "search" or "/" search pattern history | |
| 1621 | 5568 "expr" or "=" typed expression history |
| 7 | 5569 "input" or "@" input line history |
| 3682 | 5570 "debug" or ">" debug command history |
|
10228
8a1481e59d64
commit https://github.com/vim/vim/commit/3e496b0ea31996b665824f45664dee1fdd73c4d0
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
5571 empty the current or last used history |
| 3682 | 5572 The {history} string does not need to be the whole name, one |
| 5573 character is sufficient. | |
| 7 | 5574 If {item} does already exist in the history, it will be |
| 5575 shifted to become the newest entry. | |
| 5576 The result is a Number: 1 if the operation was successful, | |
| 5577 otherwise 0 is returned. | |
| 5578 | |
| 5579 Example: > | |
| 5580 :call histadd("input", strftime("%Y %b %d")) | |
| 5581 :let date=input("Enter date: ") | |
| 5582 < This function is not available in the |sandbox|. | |
| 5583 | |
| 5584 histdel({history} [, {item}]) *histdel()* | |
| 236 | 5585 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 5586 for the possible values of {history}. |
| 5587 | |
| 1668 | 5588 If the parameter {item} evaluates to a String, it is used as a |
| 5589 regular expression. All entries matching that expression will | |
| 5590 be removed from the history (if there are any). | |
| 7 | 5591 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 5592 If {item} evaluates to a Number, it will be interpreted as |
| 5593 an index, see |:history-indexing|. The respective entry will | |
| 5594 be removed if it exists. | |
| 7 | 5595 |
| 5596 The result is a Number: 1 for a successful operation, | |
| 5597 otherwise 0 is returned. | |
| 5598 | |
| 5599 Examples: | |
| 5600 Clear expression register history: > | |
| 5601 :call histdel("expr") | |
| 5602 < | |
| 5603 Remove all entries starting with "*" from the search history: > | |
| 5604 :call histdel("/", '^\*') | |
| 5605 < | |
| 5606 The following three are equivalent: > | |
| 5607 :call histdel("search", histnr("search")) | |
| 5608 :call histdel("search", -1) | |
| 5609 :call histdel("search", '^'.histget("search", -1).'$') | |
| 5610 < | |
| 5611 To delete the last search pattern and use the last-but-one for | |
| 5612 the "n" command and 'hlsearch': > | |
| 5613 :call histdel("search", -1) | |
| 5614 :let @/ = histget("search", -1) | |
| 5615 | |
| 5616 histget({history} [, {index}]) *histget()* | |
| 5617 The result is a String, the entry with Number {index} from | |
| 5618 {history}. See |hist-names| for the possible values of | |
| 5619 {history}, and |:history-indexing| for {index}. If there is | |
| 5620 no such entry, an empty String is returned. When {index} is | |
| 5621 omitted, the most recent item from the history is used. | |
| 5622 | |
| 5623 Examples: | |
| 5624 Redo the second last search from history. > | |
| 5625 :execute '/' . histget("search", -2) | |
| 5626 | |
| 5627 < Define an Ex command ":H {num}" that supports re-execution of | |
| 5628 the {num}th entry from the output of |:history|. > | |
| 5629 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 5630 < | |
| 5631 histnr({history}) *histnr()* | |
| 5632 The result is the Number of the current entry in {history}. | |
| 5633 See |hist-names| for the possible values of {history}. | |
| 5634 If an error occurred, -1 is returned. | |
| 5635 | |
| 5636 Example: > | |
| 5637 :let inp_index = histnr("expr") | |
| 5638 < | |
| 5639 hlexists({name}) *hlexists()* | |
| 5640 The result is a Number, which is non-zero if a highlight group | |
| 5641 called {name} exists. This is when the group has been | |
| 5642 defined in some way. Not necessarily when highlighting has | |
| 5643 been defined for it, it may also have been used for a syntax | |
| 5644 item. | |
| 5645 *highlight_exists()* | |
| 5646 Obsolete name: highlight_exists(). | |
| 5647 | |
| 5648 *hlID()* | |
| 5649 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 5650 with name {name}. When the highlight group doesn't exist, | |
| 5651 zero is returned. | |
| 5652 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
|
5653 group. For example, to get the background color of the |
| 7 | 5654 "Comment" group: > |
| 5655 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 5656 < *highlightID()* | |
| 5657 Obsolete name: highlightID(). | |
| 5658 | |
| 5659 hostname() *hostname()* | |
| 5660 The result is a String, which is the name of the machine on | |
| 236 | 5661 which Vim is currently running. Machine names greater than |
| 7 | 5662 256 characters long are truncated. |
| 5663 | |
| 5664 iconv({expr}, {from}, {to}) *iconv()* | |
| 5665 The result is a String, which is the text {expr} converted | |
| 5666 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5667 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5668 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5669 are replaced with "?". |
| 7 | 5670 The encoding names are whatever the iconv() library function |
| 5671 can accept, see ":!man 3 iconv". | |
| 5672 Most conversions require Vim to be compiled with the |+iconv| | |
| 5673 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 5674 can be done. | |
| 5675 This can be used to display messages with special characters, | |
| 5676 no matter what 'encoding' is set to. Write the message in | |
| 5677 UTF-8 and use: > | |
| 5678 echo iconv(utf8_str, "utf-8", &enc) | |
| 5679 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 5680 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 5681 cannot use UCS-2 in a string anyway, because of the NUL bytes. | |
| 5682 | |
| 5683 *indent()* | |
| 5684 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 5685 current buffer. The indent is counted in spaces, the value | |
| 5686 of 'tabstop' is relevant. {lnum} is used just like in | |
| 5687 |getline()|. | |
| 5688 When {lnum} is invalid -1 is returned. | |
| 5689 | |
| 79 | 5690 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5691 index({object}, {expr} [, {start} [, {ic}]]) *index()* |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5692 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
|
5693 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
|
5694 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
|
5695 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
|
5696 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
|
5697 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5698 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
|
5699 value is equal to {expr}. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5700 |
| 153 | 5701 If {start} is given then start looking at the item with index |
| 5702 {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
|
5703 When {ic} is given and it is |TRUE|, ignore case. Otherwise |
| 79 | 5704 case must match. |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5705 -1 is returned when {expr} is not found in {object}. |
| 79 | 5706 Example: > |
| 5707 :let idx = index(words, "the") | |
| 87 | 5708 :if index(numbers, 123) >= 0 |
| 79 | 5709 |
| 5710 | |
| 531 | 5711 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 5712 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
|
5713 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5714 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
|
5715 in the prompt to start a new line. |
| 531 | 5716 The highlighting set with |:echohl| is used for the prompt. |
| 5717 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
|
5718 editing commands and mappings. There is a separate history |
| 531 | 5719 for lines typed for input(). |
| 5720 Example: > | |
| 5721 :if input("Coffee or beer? ") == "beer" | |
| 5722 : echo "Cheers!" | |
| 5723 :endif | |
| 5724 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5725 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5726 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
|
5727 Example: > |
| 531 | 5728 :let color = input("Color? ", "white") |
| 5729 | |
| 5730 < The optional {completion} argument specifies the type of | |
| 5731 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
|
5732 not performed. The supported completion types are the same as |
| 531 | 5733 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
|
5734 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 5735 more information. Example: > |
| 5736 let fname = input("File: ", "", "file") | |
| 5737 < | |
| 5738 NOTE: This function must not be used in a startup file, for | |
| 5739 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 5740 Note: When input() is called from within a mapping it will |
| 5741 consume remaining characters from that mapping, because a | |
| 5742 mapping is handled like the characters were typed. | |
| 5743 Use |inputsave()| before input() and |inputrestore()| | |
| 5744 after input() to avoid that. Another solution is to avoid | |
| 5745 that further characters follow in the mapping, e.g., by using | |
| 5746 |:execute| or |:normal|. | |
| 5747 | |
| 531 | 5748 Example with a mapping: > |
| 7 | 5749 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 5750 :function GetFoo() | |
| 5751 : call inputsave() | |
| 5752 : let g:Foo = input("enter search pattern: ") | |
| 5753 : call inputrestore() | |
| 5754 :endfunction | |
| 5755 | |
| 5756 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5757 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5758 are supported, a dialog window pops up to input the text. |
| 7 | 5759 Example: > |
| 3875 | 5760 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 5761 :if n != "" | |
| 5762 : let &sw = n | |
| 5763 :endif | |
| 7 | 5764 < When the dialog is cancelled {cancelreturn} is returned. When |
| 5765 omitted an empty string is returned. | |
| 5766 Hitting <Enter> works like pressing the OK button. Hitting | |
| 5767 <Esc> works like pressing the Cancel button. | |
| 531 | 5768 NOTE: Command-line completion is not supported. |
| 7 | 5769 |
| 519 | 5770 inputlist({textlist}) *inputlist()* |
| 819 | 5771 {textlist} must be a |List| of strings. This |List| is |
| 5772 displayed, one string per line. The user will be prompted to | |
| 5773 enter a number, which is returned. | |
| 519 | 5774 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
|
5775 mouse. For the first string 0 is returned. When clicking |
| 519 | 5776 above the first item a negative number is returned. When |
| 5777 clicking on the prompt one more than the length of {textlist} | |
| 5778 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5779 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
|
5780 it won't work. It's a good idea to put the entry number at |
| 1156 | 5781 the start of the string. And put a prompt in the first item. |
| 5782 Example: > | |
| 519 | 5783 let color = inputlist(['Select color:', '1. red', |
| 5784 \ '2. green', '3. blue']) | |
| 5785 | |
| 7 | 5786 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5787 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 5788 Should be called the same number of times inputsave() is |
| 5789 called. Calling it more often is harmless though. | |
| 5790 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 5791 | |
| 5792 inputsave() *inputsave()* | |
| 5793 Preserve typeahead (also from mappings) and clear it, so that | |
| 5794 a following prompt gets input from the user. Should be | |
| 5795 followed by a matching inputrestore() after the prompt. Can | |
| 5796 be used several times, in which case there must be just as | |
| 5797 many inputrestore() calls. | |
| 5798 Returns 1 when out of memory, 0 otherwise. | |
| 5799 | |
| 5800 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 5801 This function acts much like the |input()| function with but | |
| 5802 two exceptions: | |
| 5803 a) the user's response will be displayed as a sequence of | |
| 5804 asterisks ("*") thereby keeping the entry secret, and | |
| 5805 b) the user's response will not be recorded on the input | |
| 5806 |history| stack. | |
| 5807 The result is a String, which is whatever the user actually | |
| 5808 typed on the command-line in response to the issued prompt. | |
| 531 | 5809 NOTE: Command-line completion is not supported. |
| 7 | 5810 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5811 insert({object}, {item} [, {idx}]) *insert()* |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5812 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
|
5813 of it. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5814 |
| 55 | 5815 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
|
5816 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 5817 like omitting {idx}. A negative {idx} is also possible, see |
| 5818 |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
|
5819 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
5820 Returns the resulting |List| or |Blob|. Examples: > |
| 55 | 5821 :let mylist = insert([2, 3, 5], 1) |
| 5822 :call insert(mylist, 4, -1) | |
| 5823 :call insert(mylist, 6, len(mylist)) | |
| 82 | 5824 < The last example can be done simpler with |add()|. |
| 685 | 5825 Note that when {item} is a |List| it is inserted as a single |
| 692 | 5826 item. Use |extend()| to concatenate |Lists|. |
| 55 | 5827 |
| 3214 | 5828 invert({expr}) *invert()* |
| 5829 Bitwise invert. The argument is converted to a number. A | |
| 5830 List, Dict or Float argument causes an error. Example: > | |
| 5831 :let bits = invert(bits) | |
| 5832 | |
| 7 | 5833 isdirectory({directory}) *isdirectory()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5834 The result is a Number, which is |TRUE| when a directory |
| 7 | 5835 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
|
5836 exist, or isn't a directory, the result is |FALSE|. {directory} |
| 7 | 5837 is any expression, which is used as a String. |
| 5838 | |
|
16213
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
5839 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
|
5840 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
|
5841 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
|
5842 :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
|
5843 < 1 > |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
5844 :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
|
5845 < -1 |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
5846 |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
5847 {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
|
5848 |
| 819 | 5849 islocked({expr}) *islocked()* *E786* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5850 The result is a Number, which is |TRUE| when {expr} is the |
| 148 | 5851 name of a locked variable. |
| 685 | 5852 {expr} must be the name of a variable, |List| item or |
| 5853 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 5854 :let alist = [0, ['a', 'b'], 2, 3] |
| 5855 :lockvar 1 alist | |
| 5856 :echo islocked('alist') " 1 | |
| 5857 :echo islocked('alist[1]') " 0 | |
| 5858 | |
| 5859 < When {expr} is a variable that does not exist you get an error | |
| 843 | 5860 message. Use |exists()| to check for existence. |
| 148 | 5861 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5862 isnan({expr}) *isnan()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5863 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
|
5864 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
|
5865 < 1 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5866 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5867 {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
|
5868 |
| 140 | 5869 items({dict}) *items()* |
| 685 | 5870 Return a |List| with all the key-value pairs of {dict}. Each |
| 5871 |List| item is a list with two items: the key of a {dict} | |
| 5872 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
|
5873 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
|
5874 Example: > |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
5875 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
|
5876 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
|
5877 endfor |
| 140 | 5878 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5879 job_getchannel({job}) *job_getchannel()* |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5880 Get the channel handle that {job} is using. |
|
8497
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5881 To check if the job has no channel: > |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5882 if string(job_getchannel()) == 'channel fail' |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5883 < |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5884 {only available when compiled with the |+job| feature} |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5885 |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
5886 job_info([{job}]) *job_info()* |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5887 Returns a Dictionary with information about {job}: |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5888 "status" what |job_status()| returns |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5889 "channel" what |job_getchannel()| returns |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
5890 "cmd" List of command arguments used to start the job |
|
11933
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
5891 "process" process ID |
|
12389
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
5892 "tty_in" terminal input name, empty when none |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
5893 "tty_out" terminal output name, empty when none |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5894 "exitval" only valid when "status" is "dead" |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5895 "exit_cb" function to be called on exit |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5896 "stoponexit" |job-stoponexit| |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5897 |
|
15711
287104a1d51e
patch 8.1.0863: cannot see what signal caused a job to end
Bram Moolenaar <Bram@vim.org>
parents:
15677
diff
changeset
|
5898 Only in Unix: |
|
287104a1d51e
patch 8.1.0863: cannot see what signal caused a job to end
Bram Moolenaar <Bram@vim.org>
parents:
15677
diff
changeset
|
5899 "termsig" the signal which terminated the process |
|
287104a1d51e
patch 8.1.0863: cannot see what signal caused a job to end
Bram Moolenaar <Bram@vim.org>
parents:
15677
diff
changeset
|
5900 (See |job_stop()| for the values) |
|
287104a1d51e
patch 8.1.0863: cannot see what signal caused a job to end
Bram Moolenaar <Bram@vim.org>
parents:
15677
diff
changeset
|
5901 only valid when "status" is "dead" |
|
287104a1d51e
patch 8.1.0863: cannot see what signal caused a job to end
Bram Moolenaar <Bram@vim.org>
parents:
15677
diff
changeset
|
5902 |
|
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
5903 Only in MS-Windows: |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
5904 "tty_type" Type of virtual console in use. |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
5905 Values are "winpty" or "conpty". |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
5906 See 'termwintype'. |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
5907 |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
5908 Without any arguments, returns a List with all Job objects. |
|
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
5909 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5910 job_setoptions({job}, {options}) *job_setoptions()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5911 Change options for {job}. Supported are: |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5912 "stoponexit" |job-stoponexit| |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5913 "exit_cb" |job-exit_cb| |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5914 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5915 job_start({command} [, {options}]) *job_start()* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5916 Start a job and return a Job object. Unlike |system()| and |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5917 |:!cmd| this does not wait for the job to finish. |
| 12254 | 5918 To start a job in a terminal window see |term_start()|. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5919 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
5920 If the job fails to start then |job_status()| on the returned |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
5921 Job object results in "fail" and none of the callbacks will be |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
5922 invoked. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
5923 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5924 {command} can be a String. This works best on MS-Windows. On |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5925 Unix it is split up in white-separated parts to be passed to |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5926 execvp(). Arguments in double quotes can contain white space. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5927 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5928 {command} can be a List, where the first item is the executable |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5929 and further items are the arguments. All items are converted |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5930 to String. This works best on Unix. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5931 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5932 On MS-Windows, job_start() makes a GUI application hidden. If |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5933 want to show it, Use |:!start| instead. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5934 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5935 The command is executed directly, not through a shell, the |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5936 'shell' option is not used. To use the shell: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5937 let job = job_start(["/bin/sh", "-c", "echo hello"]) |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5938 < Or: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5939 let job = job_start('/bin/sh -c "echo hello"') |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5940 < Note that this will start two processes, the shell and the |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5941 command it executes. If you don't want this use the "exec" |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5942 shell command. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5943 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5944 On Unix $PATH is used to search for the executable only when |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5945 the command does not contain a slash. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5946 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5947 The job will use the same terminal as Vim. If it reads from |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5948 stdin the job and Vim will be fighting over input, that |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5949 doesn't work. Redirect stdin and stdout to avoid problems: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5950 let job = job_start(['sh', '-c', "myserver </dev/null >/dev/null"]) |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5951 < |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5952 The returned Job object can be used to get the status with |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5953 |job_status()| and stop the job with |job_stop()|. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5954 |
| 14123 | 5955 Note that the job object will be deleted if there are no |
| 5956 references to it. This closes the stdin and stderr, which may | |
| 5957 cause the job to fail with an error. To avoid this keep a | |
| 5958 reference to the job. Thus instead of: > | |
| 5959 call job_start('my-command') | |
| 5960 < use: > | |
| 5961 let myjob = job_start('my-command') | |
| 5962 < and unlet "myjob" once the job is not needed or is past the | |
| 5963 point where it would fail (e.g. when it prints a message on | |
| 5964 startup). Keep in mind that variables local to a function | |
| 5965 will cease to exist if the function returns. Use a | |
| 5966 script-local variable if needed: > | |
| 5967 let s:myjob = job_start('my-command') | |
| 5968 < | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5969 {options} must be a Dictionary. It can contain many optional |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5970 items, see |job-options|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5971 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5972 {only available when compiled with the |+job| feature} |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5973 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5974 job_status({job}) *job_status()* *E916* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5975 Returns a String with the status of {job}: |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5976 "run" job is running |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5977 "fail" job failed to start |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5978 "dead" job died or was stopped after running |
| 12785 | 5979 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5980 On Unix a non-existing command results in "dead" instead of |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5981 "fail", because a fork happens before the failure can be |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5982 detected. |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5983 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5984 If an exit callback was set with the "exit_cb" option and the |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5985 job is now detected to be "dead" the callback will be invoked. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5986 |
|
8502
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5987 For more information see |job_info()|. |
|
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5988 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5989 {only available when compiled with the |+job| feature} |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5990 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5991 job_stop({job} [, {how}]) *job_stop()* |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5992 Stop the {job}. This can also be used to signal the job. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5993 |
|
8251
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5994 When {how} is omitted or is "term" the job will be terminated. |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5995 For Unix SIGTERM is sent. On MS-Windows the job will be |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5996 terminated forcedly (there is no "gentle" way). |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5997 This goes to the process group, thus children may also be |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5998 affected. |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5999 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6000 Effect for Unix: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6001 "term" SIGTERM (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6002 "hup" SIGHUP |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6003 "quit" SIGQUIT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6004 "int" SIGINT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6005 "kill" SIGKILL (strongest way to stop) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6006 number signal with that number |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6007 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6008 Effect for MS-Windows: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6009 "term" terminate process forcedly (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6010 "hup" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6011 "quit" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6012 "int" CTRL_C |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6013 "kill" terminate process forcedly |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
6014 Others CTRL_BREAK |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6015 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6016 On Unix the signal is sent to the process group. This means |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6017 that when the job is "sh -c command" it affects both the shell |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6018 and the command. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6019 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
6020 The result is a Number: 1 if the operation could be executed, |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
6021 0 if "how" is not supported on the system. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
6022 Note that even when the operation was executed, whether the |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
6023 job was actually stopped needs to be checked with |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6024 |job_status()|. |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6025 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6026 If the status of the job is "dead", the signal will not be |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6027 sent. This is to avoid to stop the wrong job (esp. on Unix, |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6028 where process numbers are recycled). |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6029 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6030 When using "kill" Vim will assume the job will die and close |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
6031 the channel. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6032 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6033 {only available when compiled with the |+job| feature} |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
6034 |
| 95 | 6035 join({list} [, {sep}]) *join()* |
| 6036 Join the items in {list} together into one String. | |
| 6037 When {sep} is specified it is put in between the items. If | |
| 6038 {sep} is omitted a single space is used. | |
| 6039 Note that {sep} is not added at the end. You might want to | |
| 6040 add it there too: > | |
| 6041 let lines = join(mylist, "\n") . "\n" | |
| 692 | 6042 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 6043 converted into a string like with |string()|. |
| 6044 The opposite function is |split()|. | |
| 6045 | |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6046 js_decode({string}) *js_decode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6047 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
|
6048 - 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
|
6049 - 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
|
6050 - 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
|
6051 result in v:none items. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6052 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6053 js_encode({expr}) *js_encode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6054 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
|
6055 - 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
|
6056 - 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
|
6057 commas. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6058 For example, the Vim object: |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6059 [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
|
6060 Will be encoded as: |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6061 [1,,{one:1},,] ~ |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6062 While json_encode() would produce: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6063 [1,null,{"one":1},null] ~ |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6064 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
|
6065 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
|
6066 |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6067 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6068 json_decode({string}) *json_decode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6069 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
|
6070 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
|
6071 JSON and Vim values. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6072 The decoding is permissive: |
| 11347 | 6073 - A trailing comma in an array and object is ignored, e.g. |
| 6074 "[1, 2, ]" is the same as "[1, 2]". | |
| 15512 | 6075 - 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
|
6076 same as {"1":2}. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6077 - More floating point numbers are recognized, e.g. "1." for |
| 11347 | 6078 "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
|
6079 "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
|
6080 are accepted. |
| 11347 | 6081 - Leading zeroes in integer numbers are ignored, e.g. "012" |
| 6082 for "12" or "-012" for "-12". | |
| 6083 - Capitalization is ignored in literal names null, true or | |
| 6084 false, e.g. "NULL" for "null", "True" for "true". | |
| 6085 - Control characters U+0000 through U+001F which are not | |
| 6086 escaped in strings are accepted, e.g. " " (tab | |
| 6087 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
|
6088 - 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
|
6089 and results in v:none. |
| 11347 | 6090 - Backslash in an invalid 2-character sequence escape is |
| 6091 ignored, e.g. "\a" is decoded as "a". | |
| 6092 - A correct surrogate pair in JSON strings should normally be | |
| 6093 a 12 character sequence such as "\uD834\uDD1E", but | |
| 6094 json_decode() silently accepts truncated surrogate pairs | |
| 6095 such as "\uD834" or "\uD834\u" | |
| 6096 *E938* | |
| 6097 A duplicate key in an object, valid in rfc7159, is not | |
| 6098 accepted by json_decode() as the result must be a valid Vim | |
| 6099 type, e.g. this fails: {"a":"b", "a":"c"} | |
| 6100 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6101 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6102 json_encode({expr}) *json_encode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6103 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
|
6104 The encoding is specified in: |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
6105 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
|
6106 Vim values are converted as follows: |
| 15512 | 6107 |Number| decimal number |
| 6108 |Float| floating point number | |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6109 Float nan "NaN" |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6110 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
|
6111 Float -inf "-Infinity" |
| 15512 | 6112 |String| in double quotes (possibly null) |
| 6113 |Funcref| not possible, error | |
| 6114 |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
|
6115 used recursively: [] |
| 15512 | 6116 |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
|
6117 used recursively: {} |
| 15512 | 6118 |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
|
6119 v:false "false" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6120 v:true "true" |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6121 v:none "null" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6122 v:null "null" |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6123 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
|
6124 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
|
6125 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
|
6126 |
| 99 | 6127 keys({dict}) *keys()* |
| 685 | 6128 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
|
6129 arbitrary order. Also see |items()| and |values()|. |
| 99 | 6130 |
| 85 | 6131 *len()* *E701* |
| 55 | 6132 len({expr}) The result is a Number, which is the length of the argument. |
| 6133 When {expr} is a String or a Number the length in bytes is | |
| 6134 used, as with |strlen()|. | |
| 685 | 6135 When {expr} is a |List| the number of items in the |List| is |
| 55 | 6136 returned. |
| 15512 | 6137 When {expr} is a |Blob| the number of bytes is returned. |
| 685 | 6138 When {expr} is a |Dictionary| the number of entries in the |
| 6139 |Dictionary| is returned. | |
| 55 | 6140 Otherwise an error is given. |
| 6141 | |
| 7 | 6142 *libcall()* *E364* *E368* |
| 6143 libcall({libname}, {funcname}, {argument}) | |
| 6144 Call function {funcname} in the run-time library {libname} | |
| 6145 with single argument {argument}. | |
| 6146 This is useful to call functions in a library that you | |
| 6147 especially made to be used with Vim. Since only one argument | |
| 6148 is possible, calling standard library functions is rather | |
| 6149 limited. | |
| 6150 The result is the String returned by the function. If the | |
| 6151 function returns NULL, this will appear as an empty string "" | |
| 6152 to Vim. | |
| 6153 If the function returns a number, use libcallnr()! | |
| 6154 If {argument} is a number, it is passed to the function as an | |
| 6155 int; if {argument} is a string, it is passed as a | |
| 6156 null-terminated string. | |
| 6157 This function will fail in |restricted-mode|. | |
| 6158 | |
| 6159 libcall() allows you to write your own 'plug-in' extensions to | |
| 6160 Vim without having to recompile the program. It is NOT a | |
| 6161 means to call system functions! If you try to do so Vim will | |
| 6162 very probably crash. | |
| 6163 | |
| 6164 For Win32, the functions you write must be placed in a DLL | |
| 6165 and use the normal C calling convention (NOT Pascal which is | |
| 6166 used in Windows System DLLs). The function must take exactly | |
| 6167 one parameter, either a character pointer or a long integer, | |
| 6168 and must return a character pointer or NULL. The character | |
| 6169 pointer returned must point to memory that will remain valid | |
| 6170 after the function has returned (e.g. in static data in the | |
| 6171 DLL). If it points to allocated memory, that memory will | |
| 6172 leak away. Using a static buffer in the function should work, | |
| 6173 it's then freed when the DLL is unloaded. | |
| 6174 | |
| 6175 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 6176 crash! This also happens if the function returns a number, |
| 7 | 6177 because Vim thinks it's a pointer. |
| 6178 For Win32 systems, {libname} should be the filename of the DLL | |
| 6179 without the ".DLL" suffix. A full path is only required if | |
| 6180 the DLL is not in the usual places. | |
| 6181 For Unix: When compiling your own plugins, remember that the | |
| 6182 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6183 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 6184 feature is present} |
| 6185 Examples: > | |
| 6186 :echo libcall("libc.so", "getenv", "HOME") | |
| 6187 < | |
| 6188 *libcallnr()* | |
| 6189 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6190 Just like |libcall()|, but used for a function that returns an |
| 7 | 6191 int instead of a string. |
| 6192 {only in Win32 on some Unix versions, when the |+libcall| | |
| 6193 feature is present} | |
| 1621 | 6194 Examples: > |
| 6195 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 6196 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 6197 :call libcallnr("libc.so", "sleep", 10) | |
| 6198 < | |
| 6199 *line()* | |
| 6200 line({expr}) The result is a Number, which is the line number of the file | |
| 6201 position given with {expr}. The accepted positions are: | |
| 6202 . the cursor position | |
| 6203 $ the last line in the current buffer | |
| 6204 'x position of mark x (if the mark is not set, 0 is | |
| 6205 returned) | |
|
11313
327a04a762f6
patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents:
11263
diff
changeset
|
6206 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
|
6207 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
|
6208 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
|
6209 less than "w0" if no lines are visible) |
| 1609 | 6210 v In Visual mode: the start of the Visual area (the |
| 6211 cursor is the end). When not in Visual mode | |
| 6212 returns the cursor position. Differs from |'<| in | |
| 6213 that it's updated right away. | |
| 1156 | 6214 Note that a mark in another file can be used. The line number |
| 6215 then applies to another buffer. | |
| 703 | 6216 To get the column number use |col()|. To get both use |
| 6217 |getpos()|. | |
| 7 | 6218 Examples: > |
| 6219 line(".") line number of the cursor | |
| 6220 line("'t") line number of mark t | |
| 6221 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
|
6222 < |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6223 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
|
6224 |last-position-jump|. |
| 9 | 6225 |
| 7 | 6226 line2byte({lnum}) *line2byte()* |
| 6227 Return the byte count from the start of the buffer for line | |
| 6228 {lnum}. This includes the end-of-line character, depending on | |
| 6229 the 'fileformat' option for the current buffer. The first | |
| 3237 | 6230 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 6231 This can also be used to get the byte count for the line just |
| 6232 below the last line: > | |
| 6233 line2byte(line("$") + 1) | |
| 3237 | 6234 < This is the buffer size plus one. If 'fileencoding' is empty |
| 6235 it is the file size plus one. | |
| 7 | 6236 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 6237 disabled at compile time, -1 is returned. | |
| 6238 Also see |byte2line()|, |go| and |:goto|. | |
| 6239 | |
| 6240 lispindent({lnum}) *lispindent()* | |
| 6241 Get the amount of indent for line {lnum} according the lisp | |
| 6242 indenting rules, as with 'lisp'. | |
| 6243 The indent is counted in spaces, the value of 'tabstop' is | |
| 6244 relevant. {lnum} is used just like in |getline()|. | |
| 6245 When {lnum} is invalid or Vim was not compiled the | |
| 6246 |+lispindent| feature, -1 is returned. | |
| 6247 | |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6248 list2str({list} [, {utf8}]) *list2str()* |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6249 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
|
6250 concatenate them all. Examples: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6251 list2str([32]) returns " " |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6252 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
|
6253 < 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
|
6254 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
|
6255 < |str2list()| does the opposite. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6256 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6257 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
|
6258 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
|
6259 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
|
6260 list2str([97, 769]) returns "á" |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
6261 < |
| 7 | 6262 localtime() *localtime()* |
| 6263 Return the current time, measured as seconds since 1st Jan | |
| 6264 1970. See also |strftime()| and |getftime()|. | |
| 6265 | |
| 95 | 6266 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6267 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6268 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
|
6269 {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
|
6270 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6271 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6272 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6273 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6274 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6275 < 5.0 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
6276 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6277 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
6278 |
| 1621 | 6279 log10({expr}) *log10()* |
| 6280 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 6281 {expr} must evaluate to a |Float| or a |Number|. | |
| 6282 Examples: > | |
| 6283 :echo log10(1000) | |
| 6284 < 3.0 > | |
| 6285 :echo log10(0.01) | |
| 6286 < -2.0 | |
| 6287 {only available when compiled with the |+float| feature} | |
| 12785 | 6288 |
| 6289 luaeval({expr} [, {expr}]) *luaeval()* | |
| 6290 Evaluate Lua expression {expr} and return its result converted | |
| 6291 to Vim data structures. Second {expr} may hold additional | |
| 3492 | 6292 argument accessible as _A inside first {expr}. |
| 6293 Strings are returned as they are. | |
| 6294 Boolean objects are converted to numbers. | |
| 12785 | 6295 Numbers are converted to |Float| values if vim was compiled |
| 3492 | 6296 with |+float| and to numbers otherwise. |
| 12785 | 6297 Dictionaries and lists obtained by vim.eval() are returned |
| 3492 | 6298 as-is. |
| 6299 Other objects are returned as zero without any errors. | |
| 6300 See |lua-luaeval| for more details. | |
| 6301 {only available when compiled with the |+lua| feature} | |
| 6302 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6303 map({expr1}, {expr2}) *map()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6304 {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
|
6305 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
|
6306 {expr2}. {expr2} must be a |string| or |Funcref|. |
| 12785 | 6307 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6308 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
|
6309 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
|
6310 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
|
6311 the current item. |
| 102 | 6312 Example: > |
| 6313 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 6314 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 6315 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6316 Note that {expr2} is the result of an expression and is then |
| 102 | 6317 used as an expression again. Often it is good to use a |
| 158 | 6318 |literal-string| to avoid having to double backslashes. You |
| 6319 still have to double ' quotes | |
| 102 | 6320 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6321 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
|
6322 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
|
6323 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
|
6324 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
|
6325 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
|
6326 func KeyValue(key, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6327 return a:key . '-' . a:val |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6328 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6329 call map(myDict, function('KeyValue')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6330 < 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
|
6331 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
|
6332 < 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
|
6333 call map(myDict, {key -> 'item: ' . key}) |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6334 < |
| 685 | 6335 The operation is done in-place. If you want a |List| or |
| 6336 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 6337 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 6338 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
6339 < 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
|
6340 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
|
6341 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
|
6342 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
|
6343 defined with the "abort" flag. |
| 95 | 6344 |
| 6345 | |
| 12785 | 6346 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 2610 | 6347 When {dict} is omitted or zero: Return the rhs of mapping |
| 6348 {name} in mode {mode}. The returned String has special | |
| 6349 characters translated like in the output of the ":map" command | |
| 6350 listing. | |
| 12785 | 6351 |
| 2610 | 6352 When there is no mapping for {name}, an empty String is |
| 14006 | 6353 returned. When the mapping for {name} is empty, then "<Nop>" |
| 6354 is returned. | |
| 2610 | 6355 |
| 6356 The {name} can have special key names, like in the ":map" | |
| 6357 command. | |
| 6358 | |
| 644 | 6359 {mode} can be one of these strings: |
| 7 | 6360 "n" Normal |
| 2610 | 6361 "v" Visual (including Select) |
| 7 | 6362 "o" Operator-pending |
| 6363 "i" Insert | |
| 6364 "c" Cmd-line | |
| 2610 | 6365 "s" Select |
| 6366 "x" Visual | |
| 7 | 6367 "l" langmap |language-mapping| |
| 12499 | 6368 "t" Terminal-Job |
| 7 | 6369 "" Normal, Visual and Operator-pending |
| 644 | 6370 When {mode} is omitted, the modes for "" are used. |
| 2610 | 6371 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6372 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 6373 instead of mappings. |
| 2610 | 6374 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6375 When {dict} is there and it is |TRUE| return a dictionary |
| 2610 | 6376 containing all the information of the mapping with the |
| 6377 following items: | |
| 6378 "lhs" The {lhs} of the mapping. | |
| 6379 "rhs" The {rhs} of the mapping as typed. | |
| 6380 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 6381 "noremap" 1 if the {rhs} of the mapping is not remappable. |
| 2610 | 6382 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 6383 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 6384 "mode" Modes for which the mapping is defined. In | |
| 6385 addition to the modes mentioned above, these | |
| 6386 characters will be used: | |
| 6387 " " Normal, Visual and Operator-pending | |
| 6388 "!" Insert and Commandline mode | |
| 2642 | 6389 (|mapmode-ic|) |
| 2625 | 6390 "sid" The script local ID, used for <sid> mappings |
| 6391 (|<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
|
6392 "lnum" The line number in "sid", zero if unknown. |
| 5555 | 6393 "nowait" Do not wait for other, longer mappings. |
| 6394 (|:map-<nowait>|). | |
| 2610 | 6395 |
| 7 | 6396 The mappings local to the current buffer are checked first, |
| 6397 then the global mappings. | |
| 626 | 6398 This function can be used to map a key even when it's already |
| 6399 mapped, and have it do the original mapping too. Sketch: > | |
| 6400 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 6401 | |
| 7 | 6402 |
| 12785 | 6403 mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 6404 Check if there is a mapping that matches with {name} in mode |
| 6405 {mode}. See |maparg()| for {mode} and special names in | |
| 6406 {name}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6407 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 6408 instead of mappings. |
| 7 | 6409 A match happens with a mapping that starts with {name} and |
| 6410 with a mapping which is equal to the start of {name}. | |
| 6411 | |
| 1621 | 6412 matches mapping "a" "ab" "abc" ~ |
| 7 | 6413 mapcheck("a") yes yes yes |
| 6414 mapcheck("abc") yes yes yes | |
| 6415 mapcheck("ax") yes no no | |
| 6416 mapcheck("b") no no no | |
| 6417 | |
| 6418 The difference with maparg() is that mapcheck() finds a | |
| 6419 mapping that matches with {name}, while maparg() only finds a | |
| 6420 mapping for {name} exactly. | |
| 6421 When there is no mapping that starts with {name}, an empty | |
| 14006 | 6422 String is returned. If there is one, the RHS of that mapping |
| 7 | 6423 is returned. If there are several mappings that start with |
| 14006 | 6424 {name}, the RHS of one of them is returned. This will be |
| 6425 "<Nop>" if the RHS is empty. | |
| 7 | 6426 The mappings local to the current buffer are checked first, |
| 6427 then the global mappings. | |
| 6428 This function can be used to check if a mapping can be added | |
| 6429 without being ambiguous. Example: > | |
| 6430 :if mapcheck("_vv") == "" | |
| 6431 : map _vv :set guifont=7x13<CR> | |
| 6432 :endif | |
| 6433 < This avoids adding the "_vv" mapping when there already is a | |
| 6434 mapping for "_v" or for "_vvv". | |
| 6435 | |
| 12785 | 6436 match({expr}, {pat} [, {start} [, {count}]]) *match()* |
| 685 | 6437 When {expr} is a |List| then this returns the index of the |
| 6438 first item where {pat} matches. Each item is used as a | |
| 692 | 6439 String, |Lists| and |Dictionaries| are used as echoed. |
| 14695 | 6440 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6441 Otherwise, {expr} is used as a String. The result is a |
| 95 | 6442 Number, which gives the index (byte offset) in {expr} where |
| 6443 {pat} matches. | |
| 14695 | 6444 |
| 685 | 6445 A match at the first character or |List| item returns zero. |
| 19 | 6446 If there is no match -1 is returned. |
| 14695 | 6447 |
| 2833 | 6448 For getting submatches see |matchlist()|. |
| 19 | 6449 Example: > |
| 95 | 6450 :echo match("testing", "ing") " results in 4 |
| 714 | 6451 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 6452 < See |string-match| for how {pat} is used. |
| 170 | 6453 *strpbrk()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6454 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 6455 :let sepidx = match(line, '[.,;: \t]') |
| 6456 < *strcasestr()* | |
| 6457 Vim doesn't have a strcasestr() function. But you can add | |
| 6458 "\c" to the pattern to ignore case: > | |
| 6459 :let idx = match(haystack, '\cneedle') | |
| 6460 < | |
| 95 | 6461 If {start} is given, the search starts from byte index |
| 685 | 6462 {start} in a String or item {start} in a |List|. |
| 7 | 6463 The result, however, is still the index counted from the |
| 236 | 6464 first character/item. Example: > |
| 7 | 6465 :echo match("testing", "ing", 2) |
| 6466 < result is again "4". > | |
| 6467 :echo match("testing", "ing", 4) | |
| 6468 < result is again "4". > | |
| 6469 :echo match("testing", "t", 2) | |
| 6470 < result is "3". | |
| 694 | 6471 For a String, if {start} > 0 then it is like the string starts |
| 703 | 6472 {start} bytes later, thus "^" will match at {start}. Except |
| 6473 when {count} is given, then it's like matches before the | |
| 6474 {start} byte are ignored (this is a bit complicated to keep it | |
| 6475 backwards compatible). | |
| 95 | 6476 For a String, if {start} < 0, it will be set to 0. For a list |
| 6477 the index is counted from the end. | |
| 697 | 6478 If {start} is out of range ({start} > strlen({expr}) for a |
| 6479 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 6480 |
| 694 | 6481 When {count} is given use the {count}'th match. When a match |
| 697 | 6482 is found in a String the search for the next one starts one |
| 694 | 6483 character further. Thus this example results in 1: > |
| 6484 echo match("testing", "..", 0, 2) | |
| 6485 < In a |List| the search continues in the next item. | |
| 703 | 6486 Note that when {count} is added the way {start} works changes, |
| 6487 see above. | |
| 694 | 6488 |
| 7 | 6489 See |pattern| for the patterns that are accepted. |
| 6490 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
|
6491 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 6492 done like 'magic' is set and 'cpoptions' is empty. |
| 6493 | |
|
14407
631344964949
patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents:
14347
diff
changeset
|
6494 *matchadd()* *E798* *E799* *E801* *E957* |
| 12785 | 6495 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 6496 Defines a pattern to be highlighted in the current window (a |
| 6497 "match"). It will be highlighted with {group}. Returns an | |
| 6498 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
|
6499 match using |matchdelete()|. The ID is bound to the window. |
| 5466 | 6500 Matching is case sensitive and magic, unless case sensitivity |
| 6501 or magicness are explicitly overridden in {pattern}. The | |
| 6502 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
6503 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
|
6504 concealed. |
| 1326 | 6505 |
| 6506 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
|
6507 match. A match with a high priority will have its |
| 1326 | 6508 highlighting overrule that of a match with a lower priority. |
| 6509 A priority is specified as an integer (negative numbers are no | |
| 6510 exception). If the {priority} argument is not specified, the | |
| 6511 default priority is 10. The priority of 'hlsearch' is zero, | |
| 6512 hence all matches with a priority greater than zero will | |
| 6513 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 6514 mechanism, and regardless of the chosen priority a match will | |
| 6515 always overrule syntax highlighting. | |
| 6516 | |
| 6517 The optional {id} argument allows the request for a specific | |
| 6518 match ID. If a specified ID is already taken, an error | |
| 6519 message will appear and the match will not be added. An ID | |
| 6520 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 6521 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 6522 respectively. If the {id} argument is not specified or -1, |
| 1326 | 6523 |matchadd()| automatically chooses a free ID. |
| 6524 | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
6525 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
|
6526 values. Currently this is used to specify a match specific |
| 6947 | 6527 conceal character that will be shown for |hl-Conceal| |
| 6528 highlighted matches. The dict can have the following members: | |
| 6529 | |
| 6530 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
|
6531 match (only for |hl-Conceal| highlighted |
| 6947 | 6532 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
|
6533 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
|
6534 window with this number or window ID. |
| 6947 | 6535 |
| 1326 | 6536 The number of matches is not limited, as it is the case with |
| 6537 the |:match| commands. | |
| 6538 | |
| 6539 Example: > | |
| 6540 :highlight MyGroup ctermbg=green guibg=green | |
| 6541 :let m = matchadd("MyGroup", "TODO") | |
| 6542 < Deletion of the pattern: > | |
| 6543 :call matchdelete(m) | |
| 6544 | |
| 6545 < 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
|
6546 available from |getmatches()|. All matches can be deleted in |
| 1326 | 6547 one operation by |clearmatches()|. |
| 819 | 6548 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6549 *matchaddpos()* |
| 12785 | 6550 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 6551 Same as |matchadd()|, but requires a list of positions {pos} |
| 6552 instead of a pattern. This command is faster than |matchadd()| | |
| 6553 because it does not require to handle regular expressions and | |
| 6554 sets buffer line boundaries to redraw screen. It is supposed | |
| 6555 to be used when fast match additions and deletions are | |
| 6556 required, for example to highlight matching parentheses. | |
| 6557 | |
| 6558 The list {pos} can contain one of these items: | |
| 6007 | 6559 - A number. This whole line will be highlighted. The first |
| 5979 | 6560 line has number 1. |
| 6561 - A list with one number, e.g., [23]. The whole line with this | |
| 6562 number will be highlighted. | |
| 6563 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 6564 the line number, the second one is the column number (first |
| 6565 column is 1, the value must correspond to the byte index as | |
| 6566 |col()| would return). The character at this position will | |
| 6567 be highlighted. | |
| 5979 | 6568 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 6569 the third number gives the length of the highlight in bytes. |
| 12785 | 6570 |
| 5979 | 6571 The maximum number of positions is 8. |
| 6572 | |
| 6573 Example: > | |
| 6574 :highlight MyGroup ctermbg=green guibg=green | |
| 6575 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 6576 < Deletion of the pattern: > | |
| 6577 :call matchdelete(m) | |
| 6578 | |
| 6579 < Matches added by |matchaddpos()| are returned by | |
| 6580 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
| 6581 value a list like the {pos} item. | |
| 6582 | |
| 819 | 6583 matcharg({nr}) *matcharg()* |
| 856 | 6584 Selects the {nr} match item, as set with a |:match|, |
| 819 | 6585 |:2match| or |:3match| command. |
| 6586 Return a |List| with two elements: | |
| 6587 The name of the highlight group used | |
| 6588 The pattern used. | |
| 6589 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 6590 When there is no match item set returns ['', '']. | |
| 1326 | 6591 This is useful to save and restore a |:match|. |
| 6592 Highlighting matches using the |:match| commands are limited | |
| 6593 to three matches. |matchadd()| does not have this limitation. | |
| 6594 | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
6595 matchdelete({id} [, {win}) *matchdelete()* *E802* *E803* |
| 1326 | 6596 Deletes a match with ID {id} previously defined by |matchadd()| |
| 1621 | 6597 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 6598 otherwise -1. See example for |matchadd()|. All matches can |
| 6599 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
|
6600 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
|
6601 window ID instead of the current window. |
| 819 | 6602 |
| 12785 | 6603 matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6604 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6605 after the match. Example: > |
| 7 | 6606 :echo matchend("testing", "ing") |
| 6607 < results in "7". | |
| 170 | 6608 *strspn()* *strcspn()* |
| 6609 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 6610 do it with matchend(): > | |
| 6611 :let span = matchend(line, '[a-zA-Z]') | |
| 6612 :let span = matchend(line, '[^a-zA-Z]') | |
| 6613 < Except that -1 is returned when there are no matches. | |
| 6614 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6615 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 6616 :echo matchend("testing", "ing", 2) |
| 6617 < results in "7". > | |
| 6618 :echo matchend("testing", "ing", 5) | |
| 6619 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6620 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 6621 |
| 12785 | 6622 matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6623 Same as |match()|, but return a |List|. The first item in the |
| 158 | 6624 list is the matched string, same as what matchstr() would |
| 6625 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 6626 in |:substitute|. When an optional submatch didn't match an |
| 6627 empty string is used. Example: > | |
| 6628 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 6629 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 6630 When there is no match an empty list is returned. |
| 6631 | |
| 12785 | 6632 matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()* |
| 1621 | 6633 Same as |match()|, but return the matched string. Example: > |
| 7 | 6634 :echo matchstr("testing", "ing") |
| 6635 < results in "ing". | |
| 6636 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6637 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 6638 :echo matchstr("testing", "ing", 2) |
| 6639 < results in "ing". > | |
| 6640 :echo matchstr("testing", "ing", 5) | |
| 6641 < result is "". | |
| 685 | 6642 When {expr} is a |List| then the matching item is returned. |
| 95 | 6643 The type isn't changed, it's not necessarily a String. |
| 7 | 6644 |
| 12785 | 6645 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
|
6646 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
|
6647 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
|
6648 :echo matchstrpos("testing", "ing") |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6649 < results in ["ing", 4, 7]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6650 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
|
6651 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
|
6652 :echo matchstrpos("testing", "ing", 2) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6653 < results in ["ing", 4, 7]. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6654 :echo matchstrpos("testing", "ing", 5) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6655 < result is ["", -1, -1]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6656 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
|
6657 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
|
6658 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
|
6659 :echo matchstrpos([1, '__x'], '\a') |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6660 < result is ["x", 1, 2, 3]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6661 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
|
6662 |
| 87 | 6663 *max()* |
| 10734 | 6664 max({expr}) Return the maximum value of all items in {expr}. |
| 6665 {expr} can be a list or a dictionary. For a dictionary, | |
| 6666 it returns the maximum of all values in the dictionary. | |
| 6667 If {expr} is neither a list nor a dictionary, or one of the | |
| 6668 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
|
6669 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 6670 |
| 6671 *min()* | |
| 10734 | 6672 min({expr}) Return the minimum value of all items in {expr}. |
| 6673 {expr} can be a list or a dictionary. For a dictionary, | |
| 6674 it returns the minimum of all values in the dictionary. | |
| 6675 If {expr} is neither a list nor a dictionary, or one of the | |
| 6676 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
|
6677 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 6678 |
| 843 | 6679 *mkdir()* *E739* |
| 168 | 6680 mkdir({name} [, {path} [, {prot}]]) |
| 6681 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
|
6682 |
| 168 | 6683 If {path} is "p" then intermediate directories are created as |
| 6684 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
|
6685 |
| 168 | 6686 If {prot} is given it is used to set the protection bits of |
| 6687 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
|
6688 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 6689 for others. This is only used for the last part of {name}. |
| 6690 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 6691 with 0755. | |
| 6692 Example: > | |
| 6693 :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
|
6694 |
| 1702 | 6695 < 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
|
6696 |
|
13672
4a1efd1a6018
patch 8.0.1708: mkdir with 'p' flag fails on existing directory
Christian Brabandt <cb@256bit.org>
parents:
13626
diff
changeset
|
6697 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
|
6698 flag is passed (since patch 8.0.1708). However, without the |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6699 "p" option the call will fail. |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6700 |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6701 The function result is a Number, which is 1 if the call was |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6702 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
|
6703 failed. |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6704 |
| 168 | 6705 Not available on all systems. To check use: > |
| 6706 :if exists("*mkdir") | |
| 6707 < | |
| 7 | 6708 *mode()* |
| 1621 | 6709 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 6710 If [expr] is supplied and it evaluates to a non-zero Number or |
| 6711 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
|
6712 returned, otherwise only the first letter is returned. |
| 1621 | 6713 |
|
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
|
6714 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
|
6715 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
|
6716 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
|
6717 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
|
6718 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
|
6719 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
|
6720 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
|
6721 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
|
6722 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
|
6723 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
|
6724 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
|
6725 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
|
6726 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
|
6727 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
|
6728 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
|
6729 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
|
6730 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
|
6731 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
|
6732 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
|
6733 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
|
6734 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
|
6735 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
|
6736 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
|
6737 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
|
6738 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
|
6739 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
|
6740 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
|
6741 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
|
6742 ! 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
|
6743 t Terminal-Job mode: keys go to the job |
| 1621 | 6744 This is useful in the 'statusline' option or when used |
| 6745 with |remote_expr()| In most other places it always returns | |
| 6746 "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
|
6747 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
|
6748 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
|
6749 the leading character(s). |
| 1621 | 6750 Also see |visualmode()|. |
| 7 | 6751 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6752 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6753 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 6754 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6755 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6756 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
|
6757 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6758 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
|
6759 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6760 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
|
6761 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6762 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6763 :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
|
6764 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6765 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6766 < |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6767 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6768 |
| 7 | 6769 nextnonblank({lnum}) *nextnonblank()* |
| 6770 Return the line number of the first line at or below {lnum} | |
| 6771 that is not blank. Example: > | |
| 6772 if getline(nextnonblank(1)) =~ "Java" | |
| 6773 < When {lnum} is invalid or there is no non-blank line at or | |
| 6774 below it, zero is returned. | |
| 6775 See also |prevnonblank()|. | |
| 6776 | |
| 12785 | 6777 nr2char({expr} [, {utf8}]) *nr2char()* |
| 7 | 6778 Return a string with a single character, which has the number |
| 6779 value {expr}. Examples: > | |
| 6780 nr2char(64) returns "@" | |
| 6781 nr2char(32) returns " " | |
| 4051 | 6782 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 6783 Example for "utf-8": > | |
| 7 | 6784 nr2char(300) returns I with bow character |
| 4051 | 6785 < With {utf8} set to 1, always return utf-8 characters. |
| 6786 Note that a NUL character in the file is specified with | |
| 7 | 6787 nr2char(10), because NULs are represented with newline |
| 6788 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 6789 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
|
6790 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
|
6791 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
|
6792 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
|
6793 < Result: "ABC" |
| 7 | 6794 |
| 3214 | 6795 or({expr}, {expr}) *or()* |
| 6796 Bitwise OR on the two arguments. The arguments are converted | |
| 6797 to a number. A List, Dict or Float argument causes an error. | |
| 6798 Example: > | |
| 6799 :let bits = or(bits, 0x80) | |
| 6800 | |
| 6801 | |
| 819 | 6802 pathshorten({expr}) *pathshorten()* |
| 6803 Shorten directory names in the path {expr} and return the | |
| 6804 result. The tail, the file name, is kept as-is. The other | |
| 6805 components in the path are reduced to single letters. Leading | |
| 6806 '~' and '.' characters are kept. Example: > | |
| 6807 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 6808 < ~/.v/a/myfile.vim ~ | |
| 6809 It doesn't matter if the path exists or not. | |
| 6810 | |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6811 perleval({expr}) *perleval()* |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6812 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
|
6813 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
|
6814 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
|
6815 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
|
6816 reference to it. |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6817 Example: > |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6818 :echo perleval('[1 .. 4]') |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6819 < [1, 2, 3, 4] |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6820 {only available when compiled with the |+perl| feature} |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6821 |
| 1621 | 6822 pow({x}, {y}) *pow()* |
| 6823 Return the power of {x} to the exponent {y} as a |Float|. | |
| 6824 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 6825 Examples: > | |
| 6826 :echo pow(3, 3) | |
| 6827 < 27.0 > | |
| 6828 :echo pow(2, 16) | |
| 6829 < 65536.0 > | |
| 6830 :echo pow(32, 0.20) | |
| 6831 < 2.0 | |
| 6832 {only available when compiled with the |+float| feature} | |
| 12785 | 6833 |
| 667 | 6834 prevnonblank({lnum}) *prevnonblank()* |
| 6835 Return the line number of the first line at or above {lnum} | |
| 6836 that is not blank. Example: > | |
| 6837 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 6838 < When {lnum} is invalid or there is no non-blank line at or | |
| 6839 above it, zero is returned. | |
| 6840 Also see |nextnonblank()|. | |
| 6841 | |
| 6842 | |
| 449 | 6843 printf({fmt}, {expr1} ...) *printf()* |
| 6844 Return a String with {fmt}, where "%" items are replaced by | |
| 6845 the formatted form of their respective arguments. Example: > | |
| 452 | 6846 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 6847 < May result in: |
| 452 | 6848 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 6849 |
| 6850 Often used items are: | |
| 856 | 6851 %s string |
| 3914 | 6852 %6S string right-aligned in 6 display cells |
| 653 | 6853 %6s string right-aligned in 6 bytes |
| 1621 | 6854 %.9s string truncated to 9 bytes |
| 6855 %c single byte | |
| 6856 %d decimal number | |
| 6857 %5d decimal number padded with spaces to 5 characters | |
| 6858 %x hex number | |
| 6859 %04x hex number padded with zeros to at least 4 characters | |
| 6860 %X hex number using upper case letters | |
| 6861 %o octal number | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6862 %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
|
6863 %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
|
6864 %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
|
6865 %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
|
6866 %E floating point number as 1.23E3, INF, -INF or NAN |
| 1621 | 6867 %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
|
6868 %G floating point number, as %F or %E depending on value |
| 1621 | 6869 %% the % character itself |
| 449 | 6870 |
| 6871 Conversion specifications start with '%' and end with the | |
| 6872 conversion type. All other characters are copied unchanged to | |
| 6873 the result. | |
| 6874 | |
| 6875 The "%" starts a conversion specification. The following | |
| 452 | 6876 arguments appear in sequence: |
| 6877 | |
| 6878 % [flags] [field-width] [.precision] type | |
| 6879 | |
| 856 | 6880 flags |
| 452 | 6881 Zero or more of the following flags: |
| 6882 | |
| 449 | 6883 # The value should be converted to an "alternate |
| 6884 form". For c, d, and s conversions, this option | |
| 6885 has no effect. For o conversions, the precision | |
| 6886 of the number is increased to force the first | |
| 6887 character of the output string to a zero (except | |
| 6888 if a zero value is printed with an explicit | |
| 6889 precision of zero). | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6890 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
|
6891 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
|
6892 prepended to it. |
| 449 | 6893 For x and X conversions, a non-zero result has |
| 6894 the string "0x" (or "0X" for X conversions) | |
| 6895 prepended to it. | |
| 452 | 6896 |
| 449 | 6897 0 (zero) Zero padding. For all conversions the converted |
| 6898 value is padded on the left with zeros rather | |
| 6899 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
|
6900 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
|
6901 flag is ignored. |
| 452 | 6902 |
| 449 | 6903 - A negative field width flag; the converted value |
| 6904 is to be left adjusted on the field boundary. | |
| 6905 The converted value is padded on the right with | |
| 6906 blanks, rather than on the left with blanks or | |
| 6907 zeros. A - overrides a 0 if both are given. | |
| 452 | 6908 |
| 449 | 6909 ' ' (space) A blank should be left before a positive |
| 6910 number produced by a signed conversion (d). | |
| 452 | 6911 |
| 449 | 6912 + 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
|
6913 produced by a signed conversion. A + overrides |
| 449 | 6914 a space if both are used. |
| 452 | 6915 |
| 6916 field-width | |
| 6917 An optional decimal digit string specifying a minimum | |
| 653 | 6918 field width. If the converted value has fewer bytes |
| 6919 than the field width, it will be padded with spaces on | |
| 6920 the left (or right, if the left-adjustment flag has | |
| 6921 been given) to fill out the field width. | |
| 452 | 6922 |
| 6923 .precision | |
| 6924 An optional precision, in the form of a period '.' | |
| 6925 followed by an optional digit string. If the digit | |
| 6926 string is omitted, the precision is taken as zero. | |
| 6927 This gives the minimum number of digits to appear for | |
| 6928 d, o, x, and X conversions, or the maximum number of | |
| 653 | 6929 bytes to be printed from a string for s conversions. |
| 1621 | 6930 For floating point it is the number of digits after |
| 6931 the decimal point. | |
| 452 | 6932 |
| 6933 type | |
| 6934 A character that specifies the type of conversion to | |
| 6935 be applied, see below. | |
| 6936 | |
| 449 | 6937 A field width or precision, or both, may be indicated by an |
| 6938 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
|
6939 Number argument supplies the field width or precision. A |
| 449 | 6940 negative field width is treated as a left adjustment flag |
| 6941 followed by a positive field width; a negative precision is | |
| 6942 treated as though it were missing. Example: > | |
| 452 | 6943 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 6944 < This limits the length of the text used from "line" to |
| 452 | 6945 "width" bytes. |
| 449 | 6946 |
| 856 | 6947 The conversion specifiers and their meanings are: |
| 452 | 6948 |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6949 *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
|
6950 *printf-x* *printf-X* |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6951 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
|
6952 (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
|
6953 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
|
6954 "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
|
6955 "ABCDEF" are used for X conversions. |
| 452 | 6956 The precision, if any, gives the minimum number of |
| 6957 digits that must appear; if the converted value | |
| 6958 requires fewer digits, it is padded on the left with | |
| 6959 zeros. | |
| 6960 In no case does a non-existent or small field width | |
| 6961 cause truncation of a numeric field; if the result of | |
| 6962 a conversion is wider than the field width, the field | |
| 6963 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
|
6964 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
|
6965 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
|
6966 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
|
6967 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
|
6968 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
|
6969 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6970 i alias for d |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6971 D alias for ld |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6972 U alias for lu |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6973 O alias for lo |
| 452 | 6974 |
| 1621 | 6975 *printf-c* |
| 452 | 6976 c The Number argument is converted to a byte, and the |
| 6977 resulting character is written. | |
| 6978 | |
| 1621 | 6979 *printf-s* |
| 452 | 6980 s The text of the String argument is used. If a |
| 6981 precision is specified, no more bytes than the number | |
| 6982 specified are used. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6983 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
|
6984 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
|
6985 as ":echo". |
| 6583 | 6986 *printf-S* |
| 3914 | 6987 S The text of the String argument is used. If a |
| 6988 precision is specified, no more display cells than the | |
| 15878 | 6989 number specified are used. |
| 452 | 6990 |
| 1621 | 6991 *printf-f* *E807* |
| 12785 | 6992 f F The Float argument is converted into a string of the |
| 1621 | 6993 form 123.456. The precision specifies the number of |
| 6994 digits after the decimal point. When the precision is | |
| 6995 zero the decimal point is omitted. When the precision | |
| 6996 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
|
6997 (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
|
6998 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
|
6999 "0.0 / 0.0" results in "nan" with %f (NAN with %F). |
| 1621 | 7000 Example: > |
| 7001 echo printf("%.2f", 12.115) | |
| 7002 < 12.12 | |
| 7003 Note that roundoff depends on the system libraries. | |
| 7004 Use |round()| when in doubt. | |
| 7005 | |
| 7006 *printf-e* *printf-E* | |
| 7007 e E The Float argument is converted into a string of the | |
| 7008 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 7009 precision specifies the number of digits after the | |
| 7010 decimal point, like with 'f'. | |
| 7011 | |
| 7012 *printf-g* *printf-G* | |
| 7013 g G The Float argument is converted like with 'f' if the | |
| 7014 value is between 0.001 (inclusive) and 10000000.0 | |
| 7015 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 7016 for 'G'. When no precision is specified superfluous | |
| 7017 zeroes and '+' signs are removed, except for the zero | |
| 7018 immediately after the decimal point. Thus 10000000.0 | |
| 7019 results in 1.0e7. | |
| 7020 | |
| 7021 *printf-%* | |
| 449 | 7022 % A '%' is written. No argument is converted. The |
| 7023 complete conversion specification is "%%". | |
| 452 | 7024 |
| 1668 | 7025 When a Number argument is expected a String argument is also |
| 7026 accepted and automatically converted. | |
| 7027 When a Float or String argument is expected a Number argument | |
| 7028 is also accepted and automatically converted. | |
| 7029 Any other argument type results in an error message. | |
| 449 | 7030 |
| 459 | 7031 *E766* *E767* |
| 449 | 7032 The number of {exprN} arguments must exactly match the number |
| 7033 of "%" items. If there are not sufficient or too many | |
| 452 | 7034 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 7035 |
| 7036 | |
|
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
|
7037 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
|
7038 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
|
7039 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
|
7040 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
|
7041 |
|
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
|
7042 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
|
7043 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
|
7044 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
|
7045 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
|
7046 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
|
7047 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
|
7048 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
|
7049 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
|
7050 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
|
7051 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
|
7052 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
|
7053 Example: > |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
7054 call prompt_setcallback(bufnr(''), function('s:TextEntered')) |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
7055 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
|
7056 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
|
7057 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
|
7058 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
|
7059 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
|
7060 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
|
7061 " 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
|
7062 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
|
7063 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
|
7064 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
|
7065 |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7066 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
|
7067 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
|
7068 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
|
7069 {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
|
7070 |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7071 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
|
7072 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
|
7073 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
|
7074 |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7075 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
|
7076 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
|
7077 {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
|
7078 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
|
7079 "prompt". Example: > |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7080 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
|
7081 < |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7082 *prop_add()* *E965* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7083 prop_add({lnum}, {col}, {props}) |
|
15335
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7084 Attach a text property at position {lnum}, {col}. {col} is |
|
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7085 counted in bytes, use one for the first column. |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7086 If {lnum} is invalid an error is given. *E966* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7087 If {col} is invalid an error is given. *E964* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7088 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7089 {props} is a dictionary with these fields: |
|
15335
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7090 length length of text in bytes, can only be used |
| 15281 | 7091 for a property that does not continue in |
|
15335
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7092 another line; can be zero |
|
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7093 end_lnum line number for the end of text |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7094 end_col column just after the text; not used when |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7095 "length" is present; when {col} and "end_col" |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7096 are equal, and "end_lnum" is omitted or equal |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7097 to {lnum}, this is a zero-width text property |
| 15281 | 7098 bufnr buffer to add the property to; when omitted |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7099 the current buffer is used |
| 15281 | 7100 id user defined ID for the property; when omitted |
| 7101 zero is used | |
| 7102 type name of the text property type | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7103 All fields except "type" are optional. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7104 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7105 It is an error when both "length" and "end_lnum" or "end_col" |
|
15335
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7106 are given. Either use "length" or "end_col" for a property |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7107 within one line, or use "end_lnum" and "end_col" for a |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7108 property that spans more than one line. |
|
15335
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7109 When neither "length" nor "end_col" are given the property |
|
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7110 will be zero-width. That means it will not be highlighted but |
|
18c20ceee4b5
patch 8.1.0675: text property column in screen columns is not practical
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
7111 will move with the text, as a kind of mark. |
|
15251
17525ca95e1e
patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents:
15219
diff
changeset
|
7112 The property can end exactly at the last character of the |
|
17525ca95e1e
patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents:
15219
diff
changeset
|
7113 text, or just after it. In the last case, if text is appended |
|
17525ca95e1e
patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents:
15219
diff
changeset
|
7114 to the line, the text property size will increase, also when |
|
17525ca95e1e
patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents:
15219
diff
changeset
|
7115 the property type does not have "end_incl" set. |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7116 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7117 "type" will first be looked up in the buffer the property is |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7118 added to. When not found, the global property types are used. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7119 If not found an error is given. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7120 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7121 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7122 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7123 |
| 15194 | 7124 prop_clear({lnum} [, {lnum-end} [, {props}]]) *prop_clear()* |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7125 Remove all text properties from line {lnum}. |
| 15194 | 7126 When {lnum-end} is given, remove all text properties from line |
| 7127 {lnum} to {lnum-end} (inclusive). | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7128 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7129 When {props} contains a "bufnr" item use this buffer, |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7130 otherwise use the current buffer. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7131 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7132 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7133 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7134 *prop_find()* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7135 prop_find({props} [, {direction}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7136 NOT IMPLEMENTED YET |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7137 Search for a text property as specified with {props}: |
| 15281 | 7138 id property with this ID |
| 7139 type property with this type name | |
| 7140 bufnr buffer to search in; when present a | |
| 7141 start position with "lnum" and "col" | |
| 7142 must be given; when omitted the | |
| 7143 current buffer is used | |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7144 lnum start in this line (when omitted start |
| 15281 | 7145 at the cursor) |
| 7146 col start at this column (when omitted | |
| 7147 and "lnum" is given: use column 1, | |
| 7148 otherwise start at the cursor) | |
| 7149 skipstart do not look for a match at the start | |
| 7150 position | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7151 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7152 {direction} can be "f" for forward and "b" for backward. When |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7153 omitted forward search is performed. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7154 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7155 If a match is found then a Dict is returned with the entries |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7156 as with prop_list(), and additionally an "lnum" entry. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7157 If no match is found then an empty Dict is returned. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7158 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7159 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7160 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7161 |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7162 prop_list({lnum} [, {props}]) *prop_list()* |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7163 Return a List with all text properties in line {lnum}. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7164 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7165 When {props} contains a "bufnr" item, use this buffer instead |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7166 of the current buffer. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7167 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7168 The properties are ordered by starting column and priority. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7169 Each property is a Dict with these entries: |
| 15281 | 7170 col starting column |
| 15334 | 7171 length length in bytes, one more if line break is |
| 7172 included | |
| 15281 | 7173 id property ID |
| 7174 type name of the property type, omitted if | |
| 7175 the type was deleted | |
| 7176 start when TRUE property starts in this line | |
| 7177 end when TRUE property ends in this line | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7178 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7179 When "start" is zero the property started in a previous line, |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7180 the current one is a continuation. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7181 When "end" is zero the property continues in the next line. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7182 The line break after this line is included. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7183 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7184 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7185 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7186 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7187 *prop_remove()* *E968* |
| 15281 | 7188 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
|
7189 Remove a matching text property from line {lnum}. When |
| 15281 | 7190 {lnum-end} is given, remove matching text properties from line |
| 7191 {lnum} to {lnum-end} (inclusive). | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7192 When {lnum} is omitted remove matching text properties from |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7193 all lines. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7194 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7195 {props} is a dictionary with these fields: |
| 15281 | 7196 id remove text properties with this ID |
| 7197 type remove text properties with this type name | |
| 7198 bufnr use this buffer instead of the current one | |
| 7199 all when TRUE remove all matching text properties, | |
| 7200 not just the first one | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7201 A property matches when either "id" or "type" matches. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7202 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7203 Returns the number of properties that were removed. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7204 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7205 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7206 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7207 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7208 prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7209 Add a text property type {name}. If a property type with this |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7210 name already exists an error is given. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7211 {props} is a dictionary with these optional fields: |
| 15281 | 7212 bufnr define the property only for this buffer; this |
| 7213 avoids name collisions and automatically | |
| 7214 clears the property types when the buffer is | |
| 7215 deleted. | |
| 7216 highlight name of highlight group to use | |
| 7217 priority when a character has multiple text | |
| 7218 properties the one with the highest priority | |
| 7219 will be used; negative values can be used, the | |
| 7220 default priority is zero | |
| 7221 start_incl when TRUE inserts at the start position will | |
| 7222 be included in the text property | |
| 7223 end_incl when TRUE inserts at the end position will be | |
| 7224 included in the text property | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7225 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7226 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7227 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7228 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7229 prop_type_change({name}, {props}) *prop_type_change()* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7230 Change properties of an existing text property type. If a |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7231 property with this name does not exist an error is given. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7232 The {props} argument is just like |prop_type_add()|. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7233 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7234 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7235 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7236 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7237 prop_type_delete({name} [, {props}]) *prop_type_delete()* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7238 Remove the text property type {name}. When text properties |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7239 using the type {name} are still in place, they will not have |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7240 an effect and can no longer be removed by name. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7241 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7242 {props} can contain a "bufnr" item. When it is given, delete |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7243 a property type from this buffer instead of from the global |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7244 property types. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7245 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7246 When text property type {name} is not found there is no error. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7247 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7248 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7249 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7250 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7251 prop_type_get([{name} [, {props}]) *prop_type_get()* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7252 Returns the properties of property type {name}. This is a |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7253 dictionary with the same fields as was given to |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7254 prop_type_add(). |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7255 When the property type {name} does not exist, an empty |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7256 dictionary is returned. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7257 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7258 {props} can contain a "bufnr" item. When it is given, use |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7259 this buffer instead of the global property types. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7260 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7261 See |text-properties| for information about text properties. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7262 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7263 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7264 prop_type_list([{props}]) *prop_type_list()* |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7265 Returns a list with all property type names. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7266 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7267 {props} can contain a "bufnr" item. When it is given, use |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7268 this buffer instead of the global property types. |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7269 |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
7270 See |text-properties| for information about text properties. |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
7271 |
|
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
|
7272 |
| 667 | 7273 pumvisible() *pumvisible()* |
| 7274 Returns non-zero when the popup menu is visible, zero | |
| 7275 otherwise. See |ins-completion-menu|. | |
| 712 | 7276 This can be used to avoid some things that would remove the |
| 7277 popup menu. | |
| 7 | 7278 |
| 3682 | 7279 py3eval({expr}) *py3eval()* |
| 7280 Evaluate Python expression {expr} and return its result | |
| 7281 converted to Vim data structures. | |
| 12785 | 7282 Numbers and strings are returned as they are (strings are |
| 7283 copied though, Unicode strings are additionally converted to | |
| 3682 | 7284 'encoding'). |
| 7285 Lists are represented as Vim |List| type. | |
| 12785 | 7286 Dictionaries are represented as Vim |Dictionary| type with |
| 3682 | 7287 keys converted to strings. |
| 7288 {only available when compiled with the |+python3| feature} | |
| 7289 | |
| 7290 *E858* *E859* | |
| 7291 pyeval({expr}) *pyeval()* | |
| 7292 Evaluate Python expression {expr} and return its result | |
| 7293 converted to Vim data structures. | |
| 12785 | 7294 Numbers and strings are returned as they are (strings are |
| 3682 | 7295 copied though). |
| 7296 Lists are represented as Vim |List| type. | |
| 12785 | 7297 Dictionaries are represented as Vim |Dictionary| type, |
| 3830 | 7298 non-string keys result in error. |
| 3682 | 7299 {only available when compiled with the |+python| feature} |
| 7300 | |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
7301 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
|
7302 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
|
7303 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
|
7304 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
|
7305 See also: |pyeval()|, |py3eval()| |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
7306 {only available when compiled with the |+python| or the |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
7307 |+python3| feature} |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
7308 |
| 114 | 7309 *E726* *E727* |
| 99 | 7310 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 7311 Returns a |List| with Numbers: |
| 99 | 7312 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 7313 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 7314 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 7315 {max}] (increasing {expr} with {stride} each time, not | |
| 7316 producing a value past {max}). | |
| 336 | 7317 When the maximum is one before the start the result is an |
| 7318 empty list. When the maximum is more than one before the | |
| 7319 start this is an error. | |
| 99 | 7320 Examples: > |
| 856 | 7321 range(4) " [0, 1, 2, 3] |
| 99 | 7322 range(2, 4) " [2, 3, 4] |
| 7323 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 7324 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 7325 range(0) " [] |
| 7326 range(2, 0) " error! | |
| 99 | 7327 < |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7328 *readdir()* |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7329 readdir({directory} [, {expr}]) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7330 Return a list with file and directory names in {directory}. |
| 16267 | 7331 You can also use |glob()| if you don't need to do complicated |
| 7332 things, such as limiting the number of matches. | |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7333 |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7334 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
|
7335 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
|
7336 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
|
7337 be handled. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7338 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
|
7339 added to the list. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7340 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
|
7341 to the list. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7342 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
|
7343 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
|
7344 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
|
7345 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
|
7346 < 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
|
7347 readdir(dirname, {n -> n !~ '^\.\|\~$'}) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7348 |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7349 < 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
|
7350 function! s:tree(dir) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7351 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
|
7352 \ {_, x -> isdirectory(x) ? |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7353 \ {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
|
7354 endfunction |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7355 echo s:tree(".") |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
7356 < |
| 158 | 7357 *readfile()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7358 readfile({fname} [, {type} [, {max}]]) |
| 685 | 7359 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
|
7360 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
|
7361 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
|
7362 (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
|
7363 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
|
7364 When {type} contains "b" binary mode is used: |
| 158 | 7365 - When the last line ends in a NL an extra empty list item is |
| 7366 added. | |
| 7367 - No CR characters are removed. | |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7368 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
|
7369 data of the file unmodified. |
| 158 | 7370 Otherwise: |
| 7371 - CR characters that appear before a NL are removed. | |
| 7372 - 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
|
7373 - 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
|
7374 removed from the text. |
| 168 | 7375 When {max} is given this specifies the maximum number of lines |
| 7376 to be read. Useful if you only want to check the first ten | |
| 7377 lines of a file: > | |
| 7378 :for line in readfile(fname, '', 10) | |
| 7379 : if line =~ 'Date' | echo line | endif | |
| 7380 :endfor | |
| 233 | 7381 < When {max} is negative -{max} lines from the end of the file |
| 7382 are returned, or as many as there are. | |
| 7383 When {max} is zero the result is an empty list. | |
| 168 | 7384 Note that without {max} the whole file is read into memory. |
| 7385 Also note that there is no recognition of encoding. Read a | |
| 7386 file into a buffer if you need to. | |
| 158 | 7387 When the file can't be opened an error message is given and |
| 7388 the result is an empty list. | |
| 7389 Also see |writefile()|. | |
| 7390 | |
|
14004
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
7391 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
|
7392 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
|
7393 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
|
7394 See |@|. |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
7395 |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
7396 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
|
7397 Returns the single letter name of the register being recorded. |
| 16267 | 7398 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
|
7399 |
| 794 | 7400 reltime([{start} [, {end}]]) *reltime()* |
| 7401 Return an item that represents a time value. The format of | |
| 7402 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
|
7403 |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
|
7404 to convert to a Float. |
| 794 | 7405 Without an argument it returns the current time. |
| 7406 With one argument is returns the time passed since the time | |
| 7407 specified in the argument. | |
| 843 | 7408 With two arguments it returns the time passed between {start} |
| 794 | 7409 and {end}. |
| 7410 The {start} and {end} arguments must be values returned by | |
| 7411 reltime(). | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
7412 {only available when compiled with the |+reltime| feature} |
| 794 | 7413 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7414 reltimefloat({time}) *reltimefloat()* |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7415 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
|
7416 Example: > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7417 let start = reltime() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7418 call MyFunction() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7419 let seconds = reltimefloat(reltime(start)) |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7420 < 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
|
7421 Also see |profiling|. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7422 {only available when compiled with the |+reltime| feature} |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
7423 |
| 794 | 7424 reltimestr({time}) *reltimestr()* |
| 7425 Return a String that represents the time value of {time}. | |
| 7426 This is the number of seconds, a dot and the number of | |
| 7427 microseconds. Example: > | |
| 7428 let start = reltime() | |
| 7429 call MyFunction() | |
| 7430 echo reltimestr(reltime(start)) | |
| 7431 < Note that overhead for the commands will be added to the time. | |
| 7432 The accuracy depends on the system. | |
| 1156 | 7433 Leading spaces are used to make the string align nicely. You |
| 7434 can use split() to remove it. > | |
| 7435 echo split(reltimestr(reltime(start)))[0] | |
| 7436 < Also see |profiling|. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
7437 {only available when compiled with the |+reltime| feature} |
| 794 | 7438 |
| 7 | 7439 *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
|
7440 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
|
7441 Send the {string} to {server}. The string is sent as an |
| 7 | 7442 expression and the result is returned after evaluation. |
| 714 | 7443 The result must be a String or a |List|. A |List| is turned |
| 7444 into a String by joining the items with a line break in | |
| 7445 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
|
7446 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
|
7447 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
|
7448 |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
|
7449 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
|
7450 seconds. Otherwise a timeout of 600 seconds is used. |
| 7 | 7451 See also |clientserver| |RemoteReply|. |
| 7452 This function is not available in the |sandbox|. | |
| 7453 {only available when compiled with the |+clientserver| feature} | |
| 7454 Note: Any errors will cause a local error message to be issued | |
| 7455 and the result will be the empty string. | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
7456 |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
7457 Variables will be evaluated in the global namespace, |
| 12785 | 7458 independent of a function currently being active. Except |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
7459 when in debug mode, then local function variables and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
7460 arguments can be evaluated. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
7461 |
| 7 | 7462 Examples: > |
| 7463 :echo remote_expr("gvim", "2+2") | |
| 7464 :echo remote_expr("gvim1", "b:current_syntax") | |
| 7465 < | |
| 7466 | |
| 7467 remote_foreground({server}) *remote_foreground()* | |
| 7468 Move the Vim server with the name {server} to the foreground. | |
| 7469 This works like: > | |
| 7470 remote_expr({server}, "foreground()") | |
| 7471 < Except that on Win32 systems the client does the work, to work | |
| 7472 around the problem that the OS doesn't always allow the server | |
| 7473 to bring itself to the foreground. | |
| 574 | 7474 Note: This does not restore the window if it was minimized, |
| 7475 like foreground() does. | |
| 7 | 7476 This function is not available in the |sandbox|. |
| 7477 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 7478 Win32 console version} | |
| 7479 | |
| 7480 | |
| 7481 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 7482 Returns a positive number if there are available strings | |
| 7483 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
|
7484 {retvar} if specified. {retvar} must be a string with the |
| 7 | 7485 name of a variable. |
| 7486 Returns zero if none are available. | |
| 7487 Returns -1 if something is wrong. | |
| 7488 See also |clientserver|. | |
| 7489 This function is not available in the |sandbox|. | |
| 7490 {only available when compiled with the |+clientserver| feature} | |
| 7491 Examples: > | |
| 7492 :let repl = "" | |
| 7493 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 7494 | |
|
11211
71311d899b42
patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents:
11181
diff
changeset
|
7495 remote_read({serverid}, [{timeout}]) *remote_read()* |
| 7 | 7496 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
|
7497 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
|
7498 reply is available. |
| 7 | 7499 See also |clientserver|. |
| 7500 This function is not available in the |sandbox|. | |
| 7501 {only available when compiled with the |+clientserver| feature} | |
| 7502 Example: > | |
| 7503 :echo remote_read(id) | |
| 7504 < | |
| 7505 *remote_send()* *E241* | |
| 7506 remote_send({server}, {string} [, {idvar}]) | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7507 Send the {string} to {server}. The string is sent as input |
| 22 | 7508 keys and the function returns immediately. At the Vim server |
| 7509 the keys are not mapped |:map|. | |
| 667 | 7510 If {idvar} is present, it is taken as the name of a variable |
| 7511 and a {serverid} for later use with remote_read() is stored | |
| 7512 there. | |
| 7 | 7513 See also |clientserver| |RemoteReply|. |
| 7514 This function is not available in the |sandbox|. | |
| 7515 {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
|
7516 |
| 7 | 7517 Note: Any errors will be reported in the server and may mess |
| 7518 up the display. | |
| 7519 Examples: > | |
| 7520 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 7521 \ remote_read(serverid) | |
| 7522 | |
| 7523 :autocmd NONE RemoteReply * | |
| 7524 \ echo remote_read(expand("<amatch>")) | |
| 7525 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 7526 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 7527 < |
|
11177
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
7528 *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
|
7529 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
|
7530 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
|
7531 server, when |v:servername| is not empty. |
|
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
7532 {only available when compiled with the |+clientserver| feature} |
|
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
7533 |
| 79 | 7534 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 7535 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
|
7536 return the item. |
| 79 | 7537 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7538 return a List with these items. When {idx} points to the same |
| 79 | 7539 item as {end} a list with one item is returned. When {end} |
| 7540 points to an item before {idx} this is an error. | |
| 7541 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 7542 Example: > |
| 7543 :echo "last item: " . remove(mylist, -1) | |
| 79 | 7544 :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
|
7545 < |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7546 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
|
7547 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7548 remove({blob}, {idx} [, {end}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7549 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
|
7550 return the byte. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7551 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
|
7552 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
|
7553 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
|
7554 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
|
7555 Example: > |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7556 :echo "last byte: " . remove(myblob, -1) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7557 :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
|
7558 |
| 99 | 7559 remove({dict}, {key}) |
| 7560 Remove the entry from {dict} with key {key}. Example: > | |
| 7561 :echo "removed " . remove(dict, "one") | |
| 7562 < If there is no {key} in {dict} this is an error. | |
| 7563 | |
| 7 | 7564 rename({from}, {to}) *rename()* |
| 7565 Rename the file by the name {from} to the name {to}. This | |
| 7566 should also work to move files across file systems. The | |
| 7567 result is a Number, which is 0 if the file was renamed | |
| 7568 successfully, and non-zero when the renaming failed. | |
| 1851 | 7569 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 7570 This function is not available in the |sandbox|. |
| 7571 | |
| 18 | 7572 repeat({expr}, {count}) *repeat()* |
| 7573 Repeat {expr} {count} times and return the concatenated | |
| 7574 result. Example: > | |
| 843 | 7575 :let separator = repeat('-', 80) |
| 18 | 7576 < When {count} is zero or negative the result is empty. |
| 685 | 7577 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
|
7578 {count} times. Example: > |
| 79 | 7579 :let longlist = repeat(['a', 'b'], 3) |
| 7580 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 7581 |
| 82 | 7582 |
| 7 | 7583 resolve({filename}) *resolve()* *E655* |
| 7584 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 7585 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
|
7586 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
|
7587 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
|
7588 removed, return {filename}. |
| 7 | 7589 On Unix, repeat resolving symbolic links in all path |
| 7590 components of {filename} and return the simplified result. | |
| 7591 To cope with link cycles, resolving of symbolic links is | |
| 7592 stopped after 100 iterations. | |
| 7593 On other systems, return the simplified {filename}. | |
| 7594 The simplification step is done as by |simplify()|. | |
| 7595 resolve() keeps a leading path component specifying the | |
| 7596 current directory (provided the result is still a relative | |
| 7597 path name) and also keeps a trailing path separator. | |
| 7598 | |
| 82 | 7599 *reverse()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7600 reverse({object}) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7601 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
|
7602 {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
|
7603 Returns {object}. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
7604 If you want an object to remain unmodified make a copy first: > |
| 82 | 7605 :let revlist = reverse(copy(mylist)) |
| 7606 | |
| 1621 | 7607 round({expr}) *round()* |
| 1668 | 7608 Round off {expr} to the nearest integral value and return it |
| 1621 | 7609 as a |Float|. If {expr} lies halfway between two integral |
| 7610 values, then use the larger one (away from zero). | |
| 7611 {expr} must evaluate to a |Float| or a |Number|. | |
| 7612 Examples: > | |
| 7613 echo round(0.456) | |
| 7614 < 0.0 > | |
| 7615 echo round(4.5) | |
| 7616 < 5.0 > | |
| 7617 echo round(-4.5) | |
| 7618 < -5.0 | |
| 7619 {only available when compiled with the |+float| feature} | |
| 3996 | 7620 |
|
16103
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
7621 rubyeval({expr}) *rubyeval()* |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
7622 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
|
7623 converted to Vim data structures. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
7624 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
|
7625 are copied though). |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
7626 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
|
7627 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
|
7628 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
|
7629 "Object#to_s" method. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
7630 {only available when compiled with the |+ruby| feature} |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
7631 |
| 12785 | 7632 screenattr({row}, {col}) *screenattr()* |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
7633 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
|
7634 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
|
7635 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
7636 |
| 12785 | 7637 screenchar({row}, {col}) *screenchar()* |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
7638 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
|
7639 [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
|
7640 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
|
7641 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
|
7642 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
7643 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
7644 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
7645 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
|
7646 |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
7647 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
|
7648 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
|
7649 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
|
7650 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
|
7651 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
|
7652 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
|
7653 |
| 3996 | 7654 screencol() *screencol()* |
| 7655 The result is a Number, which is the current screen column of | |
| 7656 the cursor. The leftmost column has number 1. | |
| 7657 This function is mainly used for testing. | |
| 7658 | |
| 7659 Note: Always returns the current screen column, thus if used | |
| 7660 in a command (e.g. ":echo screencol()") it will return the | |
| 7661 column inside the command line, which is 1 when the command is | |
| 7662 executed. To get the cursor position in the file use one of | |
| 7663 the following mappings: > | |
| 7664 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 7665 nnoremap <silent> GG :echom screencol()<CR> | |
| 7666 < | |
| 7667 screenrow() *screenrow()* | |
| 7668 The result is a Number, which is the current screen row of the | |
| 7669 cursor. The top line has number one. | |
| 7670 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
|
7671 Alternatively you can use |winline()|. |
| 3996 | 7672 |
| 7673 Note: Same restrictions as with |screencol()|. | |
| 7674 | |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
7675 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
|
7676 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
|
7677 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
|
7678 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
|
7679 characters. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
7680 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
|
7681 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
|
7682 |
| 1496 | 7683 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
| 7 | 7684 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 7685 cursor position (you can use |cursor()| to set it). |
| 707 | 7686 |
| 3967 | 7687 When a match has been found its line number is returned. |
| 3312 | 7688 If there is no match a 0 is returned and the cursor doesn't |
| 7689 move. No error message is given. | |
| 7690 | |
| 7 | 7691 {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
|
7692 'b' search Backward instead of forward |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
7693 'c' accept a match at the Cursor position |
| 712 | 7694 'e' move to the End of the match |
| 20 | 7695 '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
|
7696 '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
|
7697 '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
|
7698 '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
|
7699 '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
|
7700 'z' start searching at the cursor column instead of zero |
| 7 | 7701 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
| 7702 | |
| 444 | 7703 If the 's' flag is supplied, the ' mark is set, only if the |
| 7704 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 7705 flag. | |
| 7706 | |
| 1156 | 7707 'ignorecase', 'smartcase' and 'magic' are used. |
| 12785 | 7708 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
7709 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
|
7710 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
|
7711 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
|
7712 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
|
7713 one column further. |
| 1156 | 7714 |
| 692 | 7715 When the {stopline} argument is given then the search stops |
| 7716 after searching this line. This is useful to restrict the | |
| 7717 search to a range of lines. Examples: > | |
| 7718 let match = search('(', 'b', line("w0")) | |
| 7719 let end = search('END', '', line("w$")) | |
| 7720 < When {stopline} is used and it is not zero this also implies | |
| 7721 that the search does not wrap around the end of the file. | |
| 1496 | 7722 A zero value is equal to not giving the argument. |
| 7723 | |
| 7724 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
|
7725 more than this many milliseconds have passed. Thus when |
| 1496 | 7726 {timeout} is 500 the search stops after half a second. |
| 7727 The value must not be negative. A zero value is like not | |
| 7728 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
|
7729 {only available when compiled with the |+reltime| feature} |
| 692 | 7730 |
| 714 | 7731 *search()-sub-match* |
| 7732 With the 'p' flag the returned value is one more than the | |
| 7733 first sub-match in \(\). One if none of them matched but the | |
| 7734 whole pattern did match. | |
| 712 | 7735 To get the column number too use |searchpos()|. |
| 7736 | |
| 20 | 7737 The cursor will be positioned at the match, unless the 'n' |
| 707 | 7738 flag is used. |
| 7 | 7739 |
| 7740 Example (goes over all files in the argument list): > | |
| 7741 :let n = 1 | |
| 7742 :while n <= argc() " loop over all files in arglist | |
| 7743 : exe "argument " . n | |
| 7744 : " start at the last char in the file and wrap for the | |
| 7745 : " first search to find match at start of file | |
| 7746 : normal G$ | |
| 7747 : let flags = "w" | |
| 7748 : while search("foo", flags) > 0 | |
| 1621 | 7749 : s/foo/bar/g |
| 7 | 7750 : let flags = "W" |
| 7751 : endwhile | |
| 7752 : update " write the file if modified | |
| 7753 : let n = n + 1 | |
| 7754 :endwhile | |
| 7755 < | |
| 712 | 7756 Example for using some flags: > |
| 7757 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 7758 < This will search for the keywords "if", "else", and "endif" | |
| 7759 under or after the cursor. Because of the 'p' flag, it | |
| 7760 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 7761 if the search fails. With the cursor on the first word of the | |
| 7762 line: | |
| 7763 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 7764 the function returns 1. Without the 'c' flag, the function | |
| 7765 finds the "endif" and returns 3. The same thing happens | |
| 7766 without the 'e' flag if the cursor is on the "f" of "if". | |
| 7767 The 'n' flag tells the function not to move the cursor. | |
| 7768 | |
| 504 | 7769 |
| 523 | 7770 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 7771 Search for the declaration of {name}. | |
| 856 | 7772 |
| 523 | 7773 With a non-zero {global} argument it works like |gD|, find |
| 7774 first match in the file. Otherwise it works like |gd|, find | |
| 7775 first match in the function. | |
| 7776 | |
| 7777 With a non-zero {thisblock} argument matches in a {} block | |
| 7778 that ends before the cursor position are ignored. Avoids | |
| 7779 finding variable declarations only valid in another scope. | |
| 7780 | |
| 504 | 7781 Moves the cursor to the found match. |
| 7782 Returns zero for success, non-zero for failure. | |
| 7783 Example: > | |
| 7784 if searchdecl('myvar') == 0 | |
| 7785 echo getline('.') | |
| 7786 endif | |
| 7787 < | |
| 7 | 7788 *searchpair()* |
| 1496 | 7789 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 7790 [, {stopline} [, {timeout}]]]]) | |
| 7 | 7791 Search for the match of a nested start-end pair. This can be |
| 7792 used to find the "endif" that matches an "if", while other | |
| 7793 if/endif pairs in between are ignored. | |
| 677 | 7794 The search starts at the cursor. The default is to search |
| 7795 forward, include 'b' in {flags} to search backward. | |
| 7796 If a match is found, the cursor is positioned at it and the | |
| 7797 line number is returned. If no match is found 0 or -1 is | |
| 7798 returned and the cursor doesn't move. No error message is | |
| 7799 given. | |
| 7 | 7800 |
| 7801 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 7802 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 7803 {middle} is not empty, it is found when searching from either | |
| 7804 direction, but only when not in a nested start-end pair. A | |
| 7805 typical use is: > | |
| 7806 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 7807 < By leaving {middle} empty the "else" is skipped. | |
| 7808 | |
| 712 | 7809 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 7810 |search()|. Additionally: | |
| 7 | 7811 'r' Repeat until no more matches found; will find the |
| 1621 | 7812 outer pair. Implies the 'W' flag. |
| 7813 'm' Return number of matches instead of line number with | |
| 712 | 7814 the match; will be > 1 when 'r' is used. |
| 1621 | 7815 Note: it's nearly always a good idea to use the 'W' flag, to |
| 7816 avoid wrapping around the end of the file. | |
| 7 | 7817 |
| 7818 When a match for {start}, {middle} or {end} is found, the | |
| 7819 {skip} expression is evaluated with the cursor positioned on | |
| 7820 the start of the match. It should return non-zero if this | |
| 7821 match is to be skipped. E.g., because it is inside a comment | |
| 7822 or a string. | |
| 7823 When {skip} is omitted or empty, every match is accepted. | |
| 7824 When evaluating {skip} causes an error the search is aborted | |
| 7825 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
|
7826 {skip} can be a string, a lambda, a funcref or a partial. |
| 14193 | 7827 Anything else makes the function fail. |
| 7 | 7828 |
| 1496 | 7829 For {stopline} and {timeout} see |search()|. |
| 692 | 7830 |
| 7 | 7831 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 7832 patterns are used like it's on. | |
| 7833 | |
| 7834 The search starts exactly at the cursor. A match with | |
| 7835 {start}, {middle} or {end} at the next character, in the | |
| 7836 direction of searching, is the first one found. Example: > | |
| 7837 if 1 | |
| 7838 if 2 | |
| 7839 endif 2 | |
| 7840 endif 1 | |
| 7841 < When starting at the "if 2", with the cursor on the "i", and | |
| 7842 searching forwards, the "endif 2" is found. When starting on | |
| 7843 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
|
7844 found. That's because the "if 2" will be found first, and |
| 7 | 7845 then this is considered to be a nested if/endif from "if 2" to |
| 7846 "endif 2". | |
| 7847 When searching backwards and {end} is more than one character, | |
| 7848 it may be useful to put "\zs" at the end of the pattern, so | |
| 7849 that when the cursor is inside a match with the end it finds | |
| 7850 the matching start. | |
| 7851 | |
| 7852 Example, to find the "endif" command in a Vim script: > | |
| 7853 | |
| 7854 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 7855 \ 'getline(".") =~ "^\\s*\""') | |
| 7856 | |
| 7857 < The cursor must be at or after the "if" for which a match is | |
| 7858 to be found. Note that single-quote strings are used to avoid | |
| 7859 having to double the backslashes. The skip expression only | |
| 7860 catches comments at the start of a line, not after a command. | |
| 7861 Also, a word "en" or "if" halfway a line is considered a | |
| 7862 match. | |
| 7863 Another example, to search for the matching "{" of a "}": > | |
| 7864 | |
| 7865 :echo searchpair('{', '', '}', 'bW') | |
| 7866 | |
| 7867 < This works when the cursor is at or before the "}" for which a | |
| 7868 match is to be found. To reject matches that syntax | |
| 7869 highlighting recognized as strings: > | |
| 7870 | |
| 7871 :echo searchpair('{', '', '}', 'bW', | |
| 7872 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 7873 < | |
| 667 | 7874 *searchpairpos()* |
| 1496 | 7875 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 7876 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7877 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 7878 column position of the match. The first element of the |List| |
| 7879 is the line number and the second element is the byte index of | |
| 667 | 7880 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
|
7881 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7882 |
| 667 | 7883 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 7884 < | |
| 7885 See |match-parens| for a bigger and more useful example. | |
| 7886 | |
| 1496 | 7887 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
| 692 | 7888 Same as |search()|, but returns a |List| with the line and |
| 685 | 7889 column position of the match. The first element of the |List| |
| 7890 is the line number and the second element is the byte index of | |
| 7891 the column position of the match. If no match is found, | |
| 7892 returns [0, 0]. | |
| 714 | 7893 Example: > |
| 7894 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 7895 | |
| 7896 < When the 'p' flag is given then there is an extra item with | |
| 7897 the sub-pattern match number |search()-sub-match|. Example: > | |
| 7898 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 7899 < In this example "submatch" is 2 when a lowercase letter is | |
| 7900 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 7901 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7902 server2client({clientid}, {string}) *server2client()* |
| 7 | 7903 Send a reply string to {clientid}. The most recent {clientid} |
| 7904 that sent a string can be retrieved with expand("<client>"). | |
| 7905 {only available when compiled with the |+clientserver| feature} | |
| 7906 Note: | |
| 7907 This id has to be stored before the next command can be | |
| 236 | 7908 received. I.e. before returning from the received command and |
| 7 | 7909 before calling any commands that waits for input. |
| 7910 See also |clientserver|. | |
| 7911 Example: > | |
| 7912 :echo server2client(expand("<client>"), "HELLO") | |
| 7913 < | |
| 7914 serverlist() *serverlist()* | |
| 7915 Return a list of available server names, one per line. | |
| 7916 When there are no servers or the information is not available | |
| 7917 an empty string is returned. See also |clientserver|. | |
| 7918 {only available when compiled with the |+clientserver| feature} | |
| 7919 Example: > | |
| 7920 :echo serverlist() | |
| 7921 < | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7922 setbufline({expr}, {lnum}, {text}) *setbufline()* |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7923 Set line {lnum} to {text} in buffer {expr}. To insert |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
7924 lines use |append()|. Any text properties in {lnum} are |
|
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
7925 cleared. |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7926 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7927 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
|
7928 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7929 {lnum} is used like with |setline()|. |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7930 This works like |setline()| for the specified buffer. |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7931 On success 0 is returned, on failure 1 is returned. |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7932 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7933 If {expr} is not a valid buffer or {lnum} is not valid, an |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7934 error message is given. |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7935 |
| 7 | 7936 setbufvar({expr}, {varname}, {val}) *setbufvar()* |
| 7937 Set option or local variable {varname} in buffer {expr} to | |
| 7938 {val}. | |
| 7939 This also works for a global or local window option, but it | |
| 7940 doesn't work for a global or local window variable. | |
| 7941 For a local window option the global value is unchanged. | |
| 7942 For the use of {expr}, see |bufname()| above. | |
| 7943 Note that the variable name without "b:" must be used. | |
| 7944 Examples: > | |
| 7945 :call setbufvar(1, "&mod", 1) | |
| 7946 :call setbufvar("todo", "myvar", "foobar") | |
| 7947 < This function is not available in the |sandbox|. | |
| 7948 | |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
7949 setcharsearch({dict}) *setcharsearch()* |
| 6991 | 7950 Set the current character search information to {dict}, |
| 7951 which contains one or more of the following entries: | |
| 7952 | |
| 7953 char character which will be used for a subsequent | |
| 7954 |,| or |;| command; an empty string clears the | |
| 7955 character search | |
| 7956 forward direction of character search; 1 for forward, | |
| 7957 0 for backward | |
| 7958 until type of character search; 1 for a |t| or |T| | |
| 7959 character search, 0 for an |f| or |F| | |
| 7960 character search | |
| 7961 | |
| 7962 This can be useful to save/restore a user's character search | |
| 7963 from a script: > | |
| 7964 :let prevsearch = getcharsearch() | |
| 7965 :" Perform a command which clobbers user's search | |
| 7966 :call setcharsearch(prevsearch) | |
| 7967 < Also see |getcharsearch()|. | |
| 7968 | |
| 7 | 7969 setcmdpos({pos}) *setcmdpos()* |
| 7970 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
|
7971 {pos}. The first position is 1. |
| 7 | 7972 Use |getcmdpos()| to obtain the current position. |
| 7973 Only works while editing the command line, thus you must use | |
| 99 | 7974 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 7975 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 7976 set after the command line is set to the expression. For | |
| 7977 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 7978 before inserting the resulting text. | |
| 7 | 7979 When the number is too big the cursor is put at the end of the |
| 7980 line. A number smaller than one has undefined results. | |
| 7981 Returns 0 when successful, 1 when not editing the command | |
| 7982 line. | |
| 7983 | |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7984 setfperm({fname}, {mode}) *setfperm()* *chmod* |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7985 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
|
7986 {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
|
7987 "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
|
7988 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
|
7989 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
|
7990 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
|
7991 characters are not supported. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7992 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7993 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
|
7994 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
|
7995 would do the same thing. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7996 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7997 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
|
7998 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7999 To read permissions see |getfperm()|. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8000 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
8001 |
| 1621 | 8002 setline({lnum}, {text}) *setline()* |
| 3312 | 8003 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
|
8004 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
|
8005 |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
|
8006 |
| 236 | 8007 {lnum} is used like with |getline()|. |
| 1621 | 8008 When {lnum} is just below the last line the {text} will be |
| 282 | 8009 added as a new line. |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8010 |
| 236 | 8011 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
|
8012 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
|
8013 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
8014 Example: > |
| 7 | 8015 :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
|
8016 |
| 1621 | 8017 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 8018 will be set to the items in the list. Example: > |
| 8019 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 8020 < This is equivalent to: > | |
| 3465 | 8021 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 8022 : call setline(n, l) |
| 8023 :endfor | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8024 |
| 7 | 8025 < Note: The '[ and '] marks are not set. |
| 8026 | |
| 12785 | 8027 setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()* |
| 647 | 8028 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
|
8029 {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
|
8030 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
|
8031 |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8032 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
|
8033 modified. For an invalid window number {nr}, -1 is returned. |
| 1326 | 8034 Otherwise, same as |setqflist()|. |
| 8035 Also see |location-list|. | |
| 8036 | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8037 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
|
8038 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
|
8039 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
|
8040 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
8041 setmatches({list} [, {win}]) *setmatches()* |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
8042 Restores a list of matches saved by |getmatches() for the |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
8043 current window|. Returns 0 if successful, otherwise -1. All |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
8044 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
|
8045 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
|
8046 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
|
8047 window ID instead of the current window. |
| 230 | 8048 |
| 707 | 8049 *setpos()* |
| 8050 setpos({expr}, {list}) | |
| 8051 Set the position for {expr}. Possible values: | |
| 8052 . the cursor | |
| 8053 'x mark x | |
| 8054 | |
| 5938 | 8055 {list} must be a |List| with four or five numbers: |
| 707 | 8056 [bufnum, lnum, col, off] |
| 5938 | 8057 [bufnum, lnum, col, off, curswant] |
| 707 | 8058 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8059 "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
|
8060 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
|
8061 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
|
8062 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
|
8063 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
|
8064 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
|
8065 since these are associated with a window, not a buffer. |
| 798 | 8066 Does not change the jumplist. |
| 707 | 8067 |
| 8068 "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
|
8069 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
|
8070 smaller than 1 then 1 is used. |
| 707 | 8071 |
| 8072 The "off" number is only used when 'virtualedit' is set. Then | |
| 8073 it is the offset in screen columns from the start of the | |
| 1266 | 8074 character. E.g., a position within a <Tab> or after the last |
| 707 | 8075 character. |
| 8076 | |
| 5938 | 8077 The "curswant" number is only used when setting the cursor |
| 8078 position. It sets the preferred column for when moving the | |
| 8079 cursor vertically. When the "curswant" number is missing the | |
| 8080 preferred column is not set. When it is present and setting a | |
| 8081 mark position it is not used. | |
| 8082 | |
| 5555 | 8083 Note that for '< and '> changing the line number may result in |
| 8084 the marks to be effectively be swapped, so that '< is always | |
| 8085 before '>. | |
| 8086 | |
| 1533 | 8087 Returns 0 when the position could be set, -1 otherwise. |
| 8088 An error message is given if {expr} is invalid. | |
| 8089 | |
| 5944 | 8090 Also see |getpos()| and |getcurpos()|. |
| 707 | 8091 |
| 1156 | 8092 This does not restore the preferred column for moving |
| 5938 | 8093 vertically; if you set the cursor position with this, |j| and |
| 8094 |k| motions will jump to previous columns! Use |cursor()| to | |
| 8095 also set the preferred column. Also see the "curswant" key in | |
| 8096 |winrestview()|. | |
| 1156 | 8097 |
| 12785 | 8098 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
|
8099 Create or replace or add to the quickfix list. |
| 12785 | 8100 |
|
12048
ebd313aa5a6c
patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents:
12045
diff
changeset
|
8101 When {what} is not present, use the items in {list}. Each |
|
ebd313aa5a6c
patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents:
12045
diff
changeset
|
8102 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
|
8103 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
|
8104 entries: |
| 230 | 8105 |
| 1065 | 8106 bufnr buffer number; must be the number of a valid |
| 1621 | 8107 buffer |
| 1065 | 8108 filename name of a file; only used when "bufnr" is not |
| 1621 | 8109 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
|
8110 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
|
8111 quickfix error window instead of the filename. |
| 230 | 8112 lnum line number in the file |
| 233 | 8113 pattern search pattern used to locate the error |
| 230 | 8114 col column number |
| 233 | 8115 vcol when non-zero: "col" is visual column |
| 856 | 8116 when zero: "col" is byte index |
| 233 | 8117 nr error number |
| 230 | 8118 text description of the error |
| 233 | 8119 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
|
8120 valid recognized error message |
| 233 | 8121 |
| 8122 The "col", "vcol", "nr", "type" and "text" entries are | |
| 8123 optional. Either "lnum" or "pattern" entry can be used to | |
| 8124 locate a matching error line. | |
| 1065 | 8125 If the "filename" and "bufnr" entries are not present or |
| 8126 neither the "lnum" or "pattern" entries are present, then the | |
| 8127 item will not be handled as an error line. | |
| 230 | 8128 If both "pattern" and "lnum" are present then "pattern" will |
| 8129 be used. | |
|
11390
73cfcf11d983
patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents:
11347
diff
changeset
|
8130 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
|
8131 set when "bufnr" is a valid buffer or "filename" exists. |
| 2152 | 8132 If you supply an empty {list}, the quickfix list will be |
| 8133 cleared. | |
| 1065 | 8134 Note that the list is not exactly the same as what |
| 8135 |getqflist()| returns. | |
| 230 | 8136 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8137 {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
|
8138 '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
|
8139 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
|
8140 new list is created. |
| 12785 | 8141 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8142 '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
|
8143 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
|
8144 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
|
8145 :call setqflist([], 'r') |
| 12785 | 8146 < |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8147 '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
|
8148 freed. |
|
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
8149 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
8150 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
|
8151 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
|
8152 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
|
8153 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
|
8154 set "nr" in {what} to "$". |
| 277 | 8155 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8156 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
|
8157 only the items listed in {what} are set. The first {list} |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8158 argument is ignored. The following items can be specified in |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8159 {what}: |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
8160 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
|
8161 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
|
8162 "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
|
8163 '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
|
8164 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
|
8165 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
|
8166 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
|
8167 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
|
8168 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
|
8169 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
|
8170 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
|
8171 argument. |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
8172 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
|
8173 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
|
8174 {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
|
8175 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
|
8176 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
|
8177 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
|
8178 the last quickfix list. |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
8179 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
|
8180 Unsupported keys in {what} are ignored. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8181 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
|
8182 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
|
8183 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
|
8184 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
|
8185 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
|
8186 specify the list. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8187 |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
8188 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
|
8189 :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
|
8190 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'}) |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
8191 :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
|
8192 < |
| 230 | 8193 Returns zero for success, -1 for failure. |
| 8194 | |
| 8195 This function can be used to create a quickfix list | |
| 8196 independent of the 'errorformat' setting. Use a command like | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11390
diff
changeset
|
8197 `:cc 1` to jump to the first position. |
| 230 | 8198 |
| 8199 | |
| 7 | 8200 *setreg()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
8201 setreg({regname}, {value} [, {options}]) |
| 7 | 8202 Set the register {regname} to {value}. |
| 12785 | 8203 {value} may be any value returned by |getreg()|, including |
| 5798 | 8204 a |List|. |
| 7 | 8205 If {options} contains "a" or {regname} is upper case, |
| 8206 then the value is appended. | |
| 2423 | 8207 {options} can also contain a register type specification: |
| 7 | 8208 "c" or "v" |characterwise| mode |
| 8209 "l" or "V" |linewise| mode | |
| 8210 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 8211 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 8212 used as the width of the selection - if it is not specified | |
| 8213 then the width of the block is set to the number of characters | |
| 1266 | 8214 in the longest line (counting a <Tab> as 1 character). |
| 7 | 8215 |
| 8216 If {options} contains no register settings, then the default | |
| 12785 | 8217 is to use character mode unless {value} ends in a <NL> for |
| 8218 string {value} and linewise mode for list {value}. Blockwise | |
| 5798 | 8219 mode is never selected automatically. |
| 8220 Returns zero for success, non-zero for failure. | |
| 8221 | |
| 8222 *E883* | |
| 12785 | 8223 Note: you may not use |List| containing more than one item to |
| 8224 set search and expression registers. Lists containing no | |
| 5798 | 8225 items act like empty strings. |
| 7 | 8226 |
| 8227 Examples: > | |
| 8228 :call setreg(v:register, @*) | |
| 8229 :call setreg('*', @%, 'ac') | |
| 8230 :call setreg('a', "1\n2\n3", 'b5') | |
| 8231 | |
| 8232 < 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
|
8233 register: > |
| 5798 | 8234 :let var_a = getreg('a', 1, 1) |
| 7 | 8235 :let var_amode = getregtype('a') |
| 8236 .... | |
| 8237 :call setreg('a', var_a, var_amode) | |
| 12785 | 8238 < Note: you may not reliably restore register value |
| 8239 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
|
8240 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
|
8241 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
|
8242 |
|
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8243 You can also change the type of a register by appending |
| 7 | 8244 nothing: > |
| 8245 :call setreg('a', '', 'al') | |
| 8246 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
8247 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
8248 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
|
8249 |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
8250 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
|
8251 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
8252 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
8253 |
| 831 | 8254 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 8255 Set option or local variable {varname} in window {winnr} to | |
| 8256 {val}. | |
| 8257 Tabs are numbered starting with one. For the current tabpage | |
| 8258 use |setwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8259 {winnr} can be the window number or the |window-ID|. |
| 831 | 8260 When {winnr} is zero the current window is used. |
| 7 | 8261 This also works for a global or local buffer option, but it |
| 8262 doesn't work for a global or local buffer variable. | |
| 8263 For a local buffer option the global value is unchanged. | |
| 8264 Note that the variable name without "w:" must be used. | |
| 831 | 8265 Examples: > |
| 8266 :call settabwinvar(1, 1, "&list", 0) | |
| 8267 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 8268 < This function is not available in the |sandbox|. | |
| 8269 | |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8270 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
|
8271 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
|
8272 {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
|
8273 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8274 For a list of supported items in {dict}, refer to |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8275 |gettagstack()| |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8276 *E962* |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8277 If {action} is not present or is set to 'r', then the tag |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8278 stack is replaced. If {action} is set to 'a', then new entries |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8279 from {dict} are pushed onto the tag stack. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8280 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8281 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
|
8282 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8283 Examples: |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8284 Set current index of the tag stack to 4: > |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8285 call settagstack(1005, {'curidx' : 4}) |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8286 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8287 < Empty the tag stack of window 3: > |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8288 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
|
8289 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8290 < Push a new item onto the tag stack: > |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8291 let pos = [bufnr('myfile.txt'), 10, 1, 0] |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8292 let newtag = [{'tagname' : 'mytag', 'from' : pos}] |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8293 call settagstack(2, {'items' : newtag}, 'a') |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8294 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8295 < 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
|
8296 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
|
8297 " do something else |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8298 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
|
8299 unlet stack |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
8300 < |
| 831 | 8301 setwinvar({nr}, {varname}, {val}) *setwinvar()* |
| 8302 Like |settabwinvar()| for the current tab page. | |
| 7 | 8303 Examples: > |
| 8304 :call setwinvar(1, "&list", 0) | |
| 8305 :call setwinvar(2, "myvar", "foobar") | |
| 8306 | |
| 4126 | 8307 sha256({string}) *sha256()* |
| 6647 | 8308 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 8309 checksum of {string}. |
| 8310 {only available when compiled with the |+cryptv| feature} | |
| 8311 | |
| 1661 | 8312 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8313 Escape {string} for use as a shell command argument. |
| 985 | 8314 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
| 1661 | 8315 will enclose {string} in double quotes and double all double |
| 985 | 8316 quotes within {string}. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
8317 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
|
8318 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
|
8319 |
| 1661 | 8320 When the {special} argument is present and it's a non-zero |
| 8321 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 8322 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 8323 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 8324 command. |
|
11502
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
8325 |
| 1698 | 8326 The "!" character will be escaped (again with a |non-zero-arg| |
| 8327 {special}) when 'shell' contains "csh" in the tail. That is | |
| 8328 because for csh and tcsh "!" is used for history replacement | |
| 8329 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
|
8330 |
|
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
8331 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
|
8332 escaped. When 'shell' containing "csh" in the tail it's |
| 1698 | 8333 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
|
8334 |
| 1661 | 8335 Example of use with a |:!| command: > |
| 8336 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 8337 < This results in a directory listing for the file under the | |
| 8338 cursor. Example of use with |system()|: > | |
| 8339 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 8340 < See also |::S|. |
| 985 | 8341 |
| 8342 | |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
8343 shiftwidth([{col}]) *shiftwidth()* |
| 3875 | 8344 Returns the effective value of 'shiftwidth'. This is the |
| 8345 '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
|
8346 '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
|
8347 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
|
8348 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
|
8349 |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
8350 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
|
8351 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
|
8352 '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
|
8353 no {col} argument is given, column 1 will be assumed. |
| 15033 | 8354 |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8355 sign_define({name} [, {dict}]) *sign_define()* |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8356 Define a new sign named {name} or modify the attributes of an |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8357 existing sign. This is similar to the |:sign-define| command. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8358 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8359 Prefix {name} with a unique text to avoid name collisions. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8360 There is no {group} like with placing signs. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8361 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8362 The {name} can be a String or a Number. The optional {dict} |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8363 argument specifies the sign attributes. The following values |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8364 are supported: |
| 15281 | 8365 icon full path to the bitmap file for the sign. |
| 8366 linehl highlight group used for the whole line the | |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8367 sign is placed in. |
| 15281 | 8368 text text that is displayed when there is no icon |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8369 or the GUI is not being used. |
| 15281 | 8370 texthl highlight group used for the text item |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
8371 |
|
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
8372 If the sign named {name} already exists, then the attributes |
|
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
8373 of the sign are updated. |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8374 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8375 Returns 0 on success and -1 on failure. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8376 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8377 Examples: > |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8378 call sign_define("mySign", {"text" : "=>", "texthl" : |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8379 \ "Error", "linehl" : "Search"}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8380 < |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8381 sign_getdefined([{name}]) *sign_getdefined()* |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8382 Get a list of defined signs and their attributes. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8383 This is similar to the |:sign-list| command. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8384 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8385 If the {name} is not supplied, then a list of all the defined |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8386 signs is returned. Otherwise the attribute of the specified |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8387 sign is returned. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8388 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8389 Each list item in the returned value is a dictionary with the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8390 following entries: |
| 15281 | 8391 icon full path to the bitmap file of the sign |
| 8392 linehl highlight group used for the whole line the | |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8393 sign is placed in. |
| 15281 | 8394 name name of the sign |
| 8395 text text that is displayed when there is no icon | |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8396 or the GUI is not being used. |
| 15281 | 8397 texthl highlight group used for the text item |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8398 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8399 Returns an empty List if there are no signs and when {name} is |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8400 not found. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8401 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8402 Examples: > |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8403 " Get a list of all the defined signs |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8404 echo sign_getdefined() |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8405 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8406 " Get the attribute of the sign named mySign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8407 echo sign_getdefined("mySign") |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8408 < |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8409 sign_getplaced([{expr} [, {dict}]]) *sign_getplaced()* |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8410 Return a list of signs placed in a buffer or all the buffers. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8411 This is similar to the |:sign-place-list| command. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8412 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8413 If the optional buffer name {expr} is specified, then only the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8414 list of signs placed in that buffer is returned. For the use |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8415 of {expr}, see |bufname()|. The optional {dict} can contain |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8416 the following entries: |
| 15281 | 8417 group select only signs in this group |
| 8418 id select sign with this identifier | |
| 8419 lnum select signs placed in this line. For the use | |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8420 of {lnum}, see |line()|. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8421 If {group} is '*', then signs in all the groups including the |
|
15271
a6319aca721b
patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents:
15251
diff
changeset
|
8422 global group are returned. If {group} is not supplied or is an |
|
a6319aca721b
patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents:
15251
diff
changeset
|
8423 empty string, then only signs in the global group are |
|
a6319aca721b
patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents:
15251
diff
changeset
|
8424 returned. If no arguments are supplied, then signs in the |
|
a6319aca721b
patch 8.1.0644: finding next sign ID is inefficient
Bram Moolenaar <Bram@vim.org>
parents:
15251
diff
changeset
|
8425 global group placed in all the buffers are returned. |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
8426 See |sign-group|. |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8427 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8428 Each list item in the returned value is a dictionary with the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8429 following entries: |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8430 bufnr number of the buffer with the sign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8431 signs list of signs placed in {bufnr}. Each list |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8432 item is a dictionary with the below listed |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8433 entries |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8434 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8435 The dictionary for each sign contains the following entries: |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8436 group sign group. Set to '' for the global group. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8437 id identifier of the sign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8438 lnum line number where the sign is placed |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8439 name name of the defined sign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8440 priority sign priority |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8441 |
|
15388
7444fffa482d
patch 8.1.0702: ":sign place" only uses the current buffer
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
8442 The returned signs in a buffer are ordered by their line |
|
7444fffa482d
patch 8.1.0702: ":sign place" only uses the current buffer
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
8443 number. |
|
7444fffa482d
patch 8.1.0702: ":sign place" only uses the current buffer
Bram Moolenaar <Bram@vim.org>
parents:
15378
diff
changeset
|
8444 |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
8445 Returns an empty list on failure or if there are no placed |
|
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
8446 signs. |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8447 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8448 Examples: > |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8449 " Get a List of signs placed in eval.c in the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8450 " global group |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8451 echo sign_getplaced("eval.c") |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8452 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8453 " Get a List of signs in group 'g1' placed in eval.c |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8454 echo sign_getplaced("eval.c", {'group' : 'g1'}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8455 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8456 " Get a List of signs placed at line 10 in eval.c |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8457 echo sign_getplaced("eval.c", {'lnum' : 10}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8458 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8459 " Get sign with identifier 10 placed in a.py |
| 15281 | 8460 echo sign_getplaced("a.py", {'id' : 10}) |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8461 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8462 " Get sign with id 20 in group 'g1' placed in a.py |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8463 echo sign_getplaced("a.py", {'group' : 'g1', |
| 15281 | 8464 \ 'id' : 20}) |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8465 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8466 " Get a List of all the placed signs |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8467 echo sign_getplaced() |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8468 < |
|
15418
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8469 *sign_jump()* |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8470 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
|
8471 Open the buffer {expr} or jump to the window that contains |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8472 {expr} and position the cursor at sign {id} in group {group}. |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8473 This is similar to the |:sign-jump| command. |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8474 |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8475 For the use of {expr}, see |bufname()|. |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8476 |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8477 Returns the line number of the sign. Returns -1 if the |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8478 arguments are invalid. |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8479 |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8480 Example: > |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8481 " Jump to sign 10 in the current buffer |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8482 call sign_jump(10, '', '') |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
8483 < |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8484 *sign_place()* |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8485 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
|
8486 Place the sign defined as {name} at line {lnum} in file {expr} |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8487 and assign {id} and {group} to sign. This is similar to the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8488 |:sign-place| command. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8489 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8490 If the sign identifier {id} is zero, then a new identifier is |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8491 allocated. Otherwise the specified number is used. {group} is |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8492 the sign group name. To use the global sign group, use an |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8493 empty string. {group} functions as a namespace for {id}, thus |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
8494 two groups can use the same IDs. Refer to |sign-identifier| |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
8495 and |sign-group| for more information. |
| 15281 | 8496 |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8497 {name} refers to a defined sign. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8498 {expr} refers to a buffer name or number. For the accepted |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8499 values, see |bufname()|. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8500 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8501 The optional {dict} argument supports the following entries: |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8502 lnum line number in the buffer {expr} where |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8503 the sign is to be placed. For the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8504 accepted values, see |line()|. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8505 priority priority of the sign. See |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8506 |sign-priority| for more information. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8507 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8508 If the optional {dict} is not specified, then it modifies the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8509 placed sign {id} in group {group} to use the defined sign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8510 {name}. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8511 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8512 Returns the sign identifier on success and -1 on failure. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8513 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8514 Examples: > |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8515 " Place a sign named sign1 with id 5 at line 20 in |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8516 " buffer json.c |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8517 call sign_place(5, '', 'sign1', 'json.c', |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8518 \ {'lnum' : 20}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8519 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8520 " Updates sign 5 in buffer json.c to use sign2 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8521 call sign_place(5, '', 'sign2', 'json.c') |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8522 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8523 " Place a sign named sign3 at line 30 in |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8524 " buffer json.c with a new identifier |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8525 let id = sign_place(0, '', 'sign3', 'json.c', |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8526 \ {'lnum' : 30}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8527 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8528 " Place a sign named sign4 with id 10 in group 'g3' |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8529 " at line 40 in buffer json.c with priority 90 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8530 call sign_place(10, 'g3', 'sign4', 'json.c', |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8531 \ {'lnum' : 40, 'priority' : 90}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8532 < |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8533 sign_undefine([{name}]) *sign_undefine()* |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8534 Deletes a previously defined sign {name}. This is similar to |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8535 the |:sign-undefine| command. If {name} is not supplied, then |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8536 deletes all the defined signs. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8537 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8538 Returns 0 on success and -1 on failure. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8539 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8540 Examples: > |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8541 " Delete a sign named mySign |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8542 call sign_undefine("mySign") |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8543 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8544 " Delete all the signs |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8545 call sign_undefine() |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8546 < |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8547 sign_unplace({group} [, {dict}]) *sign_unplace()* |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8548 Remove a previously placed sign in one or more buffers. This |
| 15281 | 8549 is similar to the |:sign-unplace| command. |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8550 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8551 {group} is the sign group name. To use the global sign group, |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8552 use an empty string. If {group} is set to '*', then all the |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8553 groups including the global group are used. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8554 The signs in {group} are selected based on the entries in |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8555 {dict}. The following optional entries in {dict} are |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8556 supported: |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8557 buffer buffer name or number. See |bufname()|. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8558 id sign identifier |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8559 If {dict} is not supplied, then all the signs in {group} are |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8560 removed. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8561 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8562 Returns 0 on success and -1 on failure. |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8563 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8564 Examples: > |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8565 " Remove sign 10 from buffer a.vim |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8566 call sign_unplace('', {'buffer' : "a.vim", 'id' : 10}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8567 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8568 " Remove sign 20 in group 'g1' from buffer 3 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8569 call sign_unplace('g1', {'buffer' : 3, 'id' : 20}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8570 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8571 " Remove all the signs in group 'g2' from buffer 10 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8572 call sign_unplace('g2', {'buffer' : 10}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8573 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8574 " Remove sign 30 in group 'g3' from all the buffers |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8575 call sign_unplace('g3', {'id' : 30}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8576 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8577 " Remove all the signs placed in buffer 5 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8578 call sign_unplace('*', {'buffer' : 5}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8579 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8580 " Remove the signs in group 'g4' from all the buffers |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8581 call sign_unplace('g4') |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8582 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8583 " Remove sign 40 from all the buffers |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8584 call sign_unplace('*', {'id' : 40}) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8585 |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8586 " Remove all the placed signs from all the buffers |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8587 call sign_unplace('*') |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
8588 < |
| 7 | 8589 simplify({filename}) *simplify()* |
| 8590 Simplify the file name as much as possible without changing | |
| 8591 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 8592 Unix) are not resolved. If the first path component in | |
| 8593 {filename} designates the current directory, this will be | |
| 8594 valid for the result as well. A trailing path separator is | |
| 8595 not removed either. | |
| 8596 Example: > | |
| 8597 simplify("./dir/.././/file/") == "./file/" | |
| 8598 < Note: The combination "dir/.." is only removed if "dir" is | |
| 8599 a searchable directory or does not exist. On Unix, it is also | |
| 8600 removed when "dir" is a symbolic link within the same | |
| 8601 directory. In order to resolve all the involved symbolic | |
| 8602 links before simplifying the path name, use |resolve()|. | |
| 8603 | |
| 82 | 8604 |
| 1621 | 8605 sin({expr}) *sin()* |
| 8606 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 8607 {expr} must evaluate to a |Float| or a |Number|. | |
| 8608 Examples: > | |
| 8609 :echo sin(100) | |
| 8610 < -0.506366 > | |
| 8611 :echo sin(-4.01) | |
| 8612 < 0.763301 | |
| 8613 {only available when compiled with the |+float| feature} | |
| 12785 | 8614 |
| 1621 | 8615 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8616 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8617 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
|
8618 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8619 {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
|
8620 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8621 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8622 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8623 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8624 < -1.026517 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
8625 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8626 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8627 |
| 2902 | 8628 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 8629 Sort the items in {list} in-place. Returns {list}. |
| 12785 | 8630 |
| 5747 | 8631 If you want a list to remain unmodified make a copy first: > |
| 82 | 8632 :let sortedlist = sort(copy(mylist)) |
| 5968 | 8633 |
| 6009 | 8634 < When {func} is omitted, is empty or zero, then sort() uses the |
| 8635 string representation of each item to sort on. Numbers sort | |
| 8636 after Strings, |Lists| after Numbers. For sorting text in the | |
| 8637 current buffer use |:sort|. | |
| 8638 | |
| 6180 | 8639 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 8640 ignored. |
| 12785 | 8641 |
| 6009 | 8642 When {func} is given and it is 'n' then all items will be |
| 8643 sorted numerical (Implementation detail: This uses the | |
| 8644 strtod() function to parse numbers, Strings, Lists, Dicts and | |
| 8645 Funcrefs will be considered as being 0). | |
| 8646 | |
|
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
8647 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
|
8648 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
|
8649 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
|
8650 |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
8651 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
|
8652 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
|
8653 |
| 685 | 8654 When {func} is a |Funcref| or a function name, this function |
| 8655 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
|
8656 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
|
8657 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
|
8658 smaller if the first one sorts before the second one. |
| 5747 | 8659 |
| 8660 {dict} is for functions with the "dict" attribute. It will be | |
| 8661 used to set the local variable "self". |Dictionary-function| | |
| 8662 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
8663 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
|
8664 string) will keep their relative position. E.g., when sorting |
| 6051 | 8665 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
|
8666 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
8667 |
| 5747 | 8668 Also see |uniq()|. |
| 8669 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8670 Example: > |
| 82 | 8671 func MyCompare(i1, i2) |
| 8672 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 8673 endfunc | |
| 8674 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8675 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8676 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8677 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8678 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
8679 endfunc |
| 344 | 8680 < |
| 374 | 8681 *soundfold()* |
| 8682 soundfold({word}) | |
| 8683 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 8684 language in 'spelllang' for the current window that supports |
| 375 | 8685 soundfolding. 'spell' must be set. When no sound folding is |
| 8686 possible the {word} is returned unmodified. | |
| 374 | 8687 This can be used for making spelling suggestions. Note that |
| 8688 the method can be quite slow. | |
| 8689 | |
| 344 | 8690 *spellbadword()* |
| 532 | 8691 spellbadword([{sentence}]) |
| 8692 Without argument: The result is the badly spelled word under | |
| 8693 or after the cursor. The cursor is moved to the start of the | |
| 8694 bad word. When no bad word is found in the cursor line the | |
| 8695 result is an empty string and the cursor doesn't move. | |
| 8696 | |
| 8697 With argument: The result is the first word in {sentence} that | |
| 8698 is badly spelled. If there are no spelling mistakes the | |
| 8699 result is an empty string. | |
| 8700 | |
| 8701 The return value is a list with two items: | |
| 8702 - The badly spelled word or an empty string. | |
| 8703 - The type of the spelling error: | |
| 856 | 8704 "bad" spelling mistake |
| 532 | 8705 "rare" rare word |
| 8706 "local" word only valid in another region | |
| 8707 "caps" word should start with Capital | |
| 8708 Example: > | |
| 8709 echo spellbadword("the quik brown fox") | |
| 8710 < ['quik', 'bad'] ~ | |
| 8711 | |
| 8712 The spelling information for the current window is used. The | |
| 8713 'spell' option must be set and the value of 'spelllang' is | |
| 8714 used. | |
| 344 | 8715 |
| 8716 *spellsuggest()* | |
| 537 | 8717 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 8718 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 8719 When {max} is given up to this number of suggestions are |
| 8720 returned. Otherwise up to 25 suggestions are returned. | |
| 8721 | |
| 537 | 8722 When the {capital} argument is given and it's non-zero only |
| 8723 suggestions with a leading capital will be given. Use this | |
| 8724 after a match with 'spellcapcheck'. | |
| 8725 | |
| 344 | 8726 {word} can be a badly spelled word followed by other text. |
| 8727 This allows for joining two words that were split. The | |
| 359 | 8728 suggestions also include the following text, thus you can |
| 8729 replace a line. | |
| 8730 | |
| 8731 {word} may also be a good word. Similar words will then be | |
| 537 | 8732 returned. {word} itself is not included in the suggestions, |
| 8733 although it may appear capitalized. | |
| 344 | 8734 |
| 8735 The spelling information for the current window is used. The | |
| 375 | 8736 'spell' option must be set and the values of 'spelllang' and |
| 8737 'spellsuggest' are used. | |
| 344 | 8738 |
| 82 | 8739 |
| 282 | 8740 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 8741 Make a |List| out of {expr}. When {pattern} is omitted or |
| 8742 empty each white-separated sequence of characters becomes an | |
| 8743 item. | |
| 82 | 8744 Otherwise the string is split where {pattern} matches, |
| 3920 | 8745 removing the matched characters. 'ignorecase' is not used |
| 8746 here, add \c to ignore case. |/\c| | |
| 282 | 8747 When the first or last item is empty it is omitted, unless the |
| 8748 {keepempty} argument is given and it's non-zero. | |
| 293 | 8749 Other empty items are kept when {pattern} matches at least one |
| 8750 character or when {keepempty} is non-zero. | |
| 82 | 8751 Example: > |
| 95 | 8752 :let words = split(getline('.'), '\W\+') |
| 282 | 8753 < To split a string in individual characters: > |
| 236 | 8754 :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
|
8755 < 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
|
8756 the end of the pattern: > |
| 258 | 8757 :echo split('abc:def:ghi', ':\zs') |
| 8758 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 8759 Splitting a table where the first element can be empty: > |
| 8760 :let items = split(line, ':', 1) | |
| 8761 < The opposite function is |join()|. | |
| 82 | 8762 |
| 8763 | |
| 1621 | 8764 sqrt({expr}) *sqrt()* |
| 8765 Return the non-negative square root of Float {expr} as a | |
| 8766 |Float|. | |
| 8767 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 8768 is negative the result is NaN (Not a Number). | |
| 8769 Examples: > | |
| 8770 :echo sqrt(100) | |
| 8771 < 10.0 > | |
| 8772 :echo sqrt(-4.01) | |
| 8773 < nan | |
| 1668 | 8774 "nan" may be different, it depends on system libraries. |
| 1621 | 8775 {only available when compiled with the |+float| feature} |
| 12785 | 8776 |
| 1621 | 8777 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
8778 str2float({expr}) *str2float()* |
| 1621 | 8779 Convert String {expr} to a Float. This mostly works the same |
| 8780 as when using a floating point number in an expression, see | |
| 8781 |floating-point-format|. But it's a bit more permissive. | |
| 8782 E.g., "1e40" is accepted, while in an expression you need to | |
| 15131 | 8783 write "1.0e40". The hexadecimal form "0x123" is also |
| 8784 accepted, but not others, like binary or octal. | |
| 1621 | 8785 Text after the number is silently ignored. |
| 8786 The decimal point is always '.', no matter what the locale is | |
| 8787 set to. A comma ends the number: "12,345.67" is converted to | |
| 8788 12.0. You can strip out thousands separators with | |
| 8789 |substitute()|: > | |
| 8790 let f = str2float(substitute(text, ',', '', 'g')) | |
| 8791 < {only available when compiled with the |+float| feature} | |
| 8792 | |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
8793 str2list({expr} [, {utf8}]) *str2list()* |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
8794 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
|
8795 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
|
8796 str2list(" ") returns [32] |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
8797 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
|
8798 < |list2str()| does the opposite. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
8799 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
8800 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
|
8801 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
|
8802 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
|
8803 properly: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
8804 str2list("á") returns [97, 769] |
| 1621 | 8805 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
8806 str2nr({expr} [, {base}]) *str2nr()* |
| 782 | 8807 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
|
8808 {base} is the conversion base, it can be 2, 8, 10 or 16. |
| 782 | 8809 When {base} is omitted base 10 is used. This also means that |
| 8810 a leading zero doesn't cause octal conversion to be used, as | |
| 8811 with the default String to Number conversion. | |
| 8812 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
|
8813 different base the result will be zero. Similarly, when |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
8814 {base} is 8 a leading "0" is ignored, and when {base} is 2 a |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
8815 leading "0b" or "0B" is ignored. |
| 782 | 8816 Text after the number is silently ignored. |
| 856 | 8817 |
| 782 | 8818 |
| 6884 | 8819 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
8820 The result is a Number, which is the number of characters |
| 6884 | 8821 in String {expr}. |
| 8822 When {skipcc} is omitted or zero, composing characters are | |
| 8823 counted separately. | |
| 8824 When {skipcc} set to 1, Composing characters are ignored. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
8825 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
| 12785 | 8826 |
| 6918 | 8827 {skipcc} is only available after 7.4.755. For backward |
| 8828 compatibility, you can define a wrapper function: > | |
| 8829 if has("patch-7.4.755") | |
| 8830 function s:strchars(str, skipcc) | |
| 8831 return strchars(a:str, a:skipcc) | |
| 8832 endfunction | |
| 8833 else | |
| 8834 function s:strchars(str, skipcc) | |
| 8835 if a:skipcc | |
| 8836 return strlen(substitute(a:str, ".", "x", "g")) | |
| 8837 else | |
| 8838 return strchars(a:str) | |
| 8839 endif | |
| 8840 endfunction | |
| 8841 endif | |
| 8842 < | |
| 12785 | 8843 strcharpart({src}, {start} [, {len}]) *strcharpart()* |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8844 Like |strpart()| but using character index and length instead |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8845 of byte index and length. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8846 When a character index is used where a character does not |
| 10617 | 8847 exist it is assumed to be one character. For example: > |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8848 strcharpart('abc', -1, 2) |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8849 < results in 'a'. |
| 6918 | 8850 |
| 12785 | 8851 strdisplaywidth({expr} [, {col}]) *strdisplaywidth()* |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
8852 The result is a Number, which is the number of display cells |
| 15878 | 8853 String {expr} occupies on the screen when it starts at {col} |
| 8854 (first column is zero). When {col} is omitted zero is used. | |
| 8855 Otherwise it is the screen column where to start. This | |
| 8856 matters for Tab characters. | |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
8857 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
|
8858 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
|
8859 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
8860 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
8861 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
8862 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
8863 |
| 7 | 8864 strftime({format} [, {time}]) *strftime()* |
| 8865 The result is a String, which is a formatted date and time, as | |
| 8866 specified by the {format} string. The given {time} is used, | |
| 8867 or the current time if no time is given. The accepted | |
| 8868 {format} depends on your system, thus this is not portable! | |
| 8869 See the manual page of the C function strftime() for the | |
| 8870 format. The maximum length of the result is 80 characters. | |
| 8871 See also |localtime()| and |getftime()|. | |
| 8872 The language can be changed with the |:language| command. | |
| 8873 Examples: > | |
| 8874 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 8875 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 8876 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 8877 :echo strftime("%H:%M") 11:55 | |
| 8878 :echo strftime("%c", getftime("file.c")) | |
| 8879 Show mod time of file.c. | |
| 82 | 8880 < Not available on all systems. To check use: > |
| 8881 :if exists("*strftime") | |
| 8882 | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8883 strgetchar({str}, {index}) *strgetchar()* |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8884 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
|
8885 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
|
8886 separate characters here. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8887 Also see |strcharpart()| and |strchars()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8888 |
| 133 | 8889 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 8890 The result is a Number, which gives the byte index in | |
| 8891 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 8892 If {start} is specified, the search starts at index {start}. |
| 8893 This can be used to find a second match: > | |
| 2662 | 8894 :let colon1 = stridx(line, ":") |
| 8895 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 8896 < The search is done case-sensitive. |
| 205 | 8897 For pattern searches use |match()|. |
| 133 | 8898 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 8899 See also |strridx()|. |
| 8900 Examples: > | |
| 7 | 8901 :echo stridx("An Example", "Example") 3 |
| 8902 :echo stridx("Starting point", "Start") 0 | |
| 8903 :echo stridx("Starting point", "start") -1 | |
| 856 | 8904 < *strstr()* *strchr()* |
| 170 | 8905 stridx() works similar to the C function strstr(). When used |
| 8906 with a single character it works similar to strchr(). | |
| 8907 | |
| 55 | 8908 *string()* |
| 95 | 8909 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
|
8910 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
|
8911 can be parsed back with |eval()|. |
| 55 | 8912 {expr} type result ~ |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
8913 String 'string' (single quotes are doubled) |
| 95 | 8914 Number 123 |
| 1621 | 8915 Float 123.123456 or 1.123456e8 |
| 99 | 8916 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
|
8917 Blob 0z00112233.44556677.8899 |
| 95 | 8918 List [item, item] |
| 323 | 8919 Dictionary {key: value, key: value} |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
8920 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
8921 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
|
8922 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
|
8923 will then fail. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
8924 |
| 1156 | 8925 Also see |strtrans()|. |
| 55 | 8926 |
| 7 | 8927 *strlen()* |
| 8928 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 8929 {expr} in bytes. |
| 55 | 8930 If the argument is a Number it is first converted to a String. |
| 8931 For other types an error is given. | |
| 6870 | 8932 If you want to count the number of multi-byte characters use |
| 8933 |strchars()|. | |
| 8934 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 8935 |
| 12785 | 8936 strpart({src}, {start} [, {len}]) *strpart()* |
| 7 | 8937 The result is a String, which is part of {src}, starting from |
| 574 | 8938 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
|
8939 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
|
8940 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8941 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
|
8942 result in an error, the bytes are simply omitted. |
| 7 | 8943 If {len} is missing, the copy continues from {start} till the |
| 8944 end of the {src}. > | |
| 8945 strpart("abcdefg", 3, 2) == "de" | |
| 8946 strpart("abcdefg", -2, 4) == "ab" | |
| 8947 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 8948 strpart("abcdefg", 3) == "defg" |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
8949 |
| 7 | 8950 < Note: To get the first character, {start} must be 0. For |
| 8951 example, to get three bytes under and after the cursor: > | |
| 823 | 8952 strpart(getline("."), col(".") - 1, 3) |
| 7 | 8953 < |
| 140 | 8954 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 8955 The result is a Number, which gives the byte index in | |
| 8956 {haystack} of the last occurrence of the String {needle}. | |
| 8957 When {start} is specified, matches beyond this index are | |
| 8958 ignored. This can be used to find a match before a previous | |
| 8959 match: > | |
| 8960 :let lastcomma = strridx(line, ",") | |
| 8961 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 8962 < The search is done case-sensitive. | |
| 133 | 8963 For pattern searches use |match()|. |
| 8964 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 8965 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 8966 See also |stridx()|. Examples: > |
| 7 | 8967 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 8968 < *strrchr()* |
| 170 | 8969 When used with a single character it works similar to the C |
| 8970 function strrchr(). | |
| 8971 | |
| 7 | 8972 strtrans({expr}) *strtrans()* |
| 8973 The result is a String, which is {expr} with all unprintable | |
| 8974 characters translated into printable characters |'isprint'|. | |
| 8975 Like they are shown in a window. Example: > | |
| 8976 echo strtrans(@a) | |
| 8977 < This displays a newline in register a as "^@" instead of | |
| 8978 starting a new line. | |
| 8979 | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
8980 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
8981 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
|
8982 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
8983 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
8984 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
8985 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
8986 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
8987 |
| 12785 | 8988 submatch({nr} [, {list}]) *submatch()* *E935* |
| 2908 | 8989 Only for an expression in a |:substitute| command or |
| 8990 substitute() function. | |
| 8991 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 8992 is 0 the whole matched text is returned. | |
| 5794 | 8993 Note that a NL in the string can stand for a line break of a |
| 8994 multi-line match or a NUL character in the text. | |
| 2908 | 8995 Also see |sub-replace-expression|. |
| 5794 | 8996 |
| 12785 | 8997 If {list} is present and non-zero then submatch() returns |
| 8998 a list of strings, similar to |getline()| with two arguments. | |
| 5794 | 8999 NL characters in the text represent NUL characters in the |
| 9000 text. | |
| 9001 Only returns more than one item for |:substitute|, inside | |
| 9002 |substitute()| this list will always contain one or zero | |
| 9003 items, since there are no real line breaks. | |
| 9004 | |
|
10245
d76ccdacb41e
commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
9005 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
|
9006 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
|
9007 |
| 12968 | 9008 Examples: > |
| 7 | 9009 :s/\d\+/\=submatch(0) + 1/ |
| 12968 | 9010 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '') |
| 7 | 9011 < This finds the first number in the line and adds one to it. |
| 9012 A line break is included as a newline character. | |
| 9013 | |
| 9014 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
| 9015 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 9016 the first match of {pat} is replaced with {sub}. |
| 9017 When {flags} is "g", all matches of {pat} in {expr} are | |
| 9018 replaced. Otherwise {flags} should be "". | |
| 12785 | 9019 |
| 2908 | 9020 This works like the ":substitute" command (without any flags). |
| 9021 But the matching with {pat} is always done like the 'magic' | |
| 9022 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 9023 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 9024 if you want to ignore or match case and ignore 'ignorecase'. | |
| 9025 'smartcase' is not used. See |string-match| for how {pat} is | |
| 9026 used. | |
| 2908 | 9027 |
| 9028 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 9029 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
|
9030 |sub-replace-special|. For example, to replace something with |
| 7 | 9031 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 9032 |
| 7 | 9033 When {pat} does not match in {expr}, {expr} is returned |
| 9034 unmodified. | |
| 2908 | 9035 |
| 7 | 9036 Example: > |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
9037 :let &path = substitute(&path, ",\\=[^,]*$", "", "") |
| 7 | 9038 < 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
|
9039 :echo substitute("testing", ".*", "\\U\\0", "") |
| 7 | 9040 < results in "TESTING". |
| 2908 | 9041 |
| 9042 When {sub} starts with "\=", the remainder is interpreted as | |
| 9043 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
|
9044 :echo substitute(s, '%\(\x\x\)', |
| 2833 | 9045 \ '\=nr2char("0x" . submatch(1))', 'g') |
| 7 | 9046 |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
9047 < 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
|
9048 optional argument. Example: > |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
9049 :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
|
9050 < 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
|
9051 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
|
9052 |submatch()| returns. Example: > |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9053 :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
|
9054 |
| 14668 | 9055 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
|
9056 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
|
9057 swapfile {fname}. The available fields are: |
| 14864 | 9058 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
|
9059 user user name |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
9060 host host name |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
9061 fname original file name |
| 14864 | 9062 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
|
9063 file |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
9064 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
|
9065 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
|
9066 dirty 1 if file was modified, 0 if not |
| 14637 | 9067 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
|
9068 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
|
9069 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
|
9070 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
|
9071 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
|
9072 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
|
9073 |
|
14778
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
9074 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
|
9075 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
|
9076 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
|
9077 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
|
9078 |: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
|
9079 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
|
9080 |
| 32 | 9081 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 9082 The result is a Number, which is the syntax ID at the position |
| 32 | 9083 {lnum} and {col} in the current window. |
| 7 | 9084 The syntax ID can be used with |synIDattr()| and |
| 9085 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 9086 |
| 32 | 9087 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 9088 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
|
9089 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
|
9090 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
|
9091 zero. |
| 419 | 9092 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
9093 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
|
9094 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
|
9095 the effective color. When {trans} is |FALSE|, the transparent |
| 7 | 9096 item is returned. This is useful when wanting to know which |
| 9097 syntax item is effective (e.g. inside parens). | |
| 9098 Warning: This function can be very slow. Best speed is | |
| 9099 obtained by going through the file in forward direction. | |
| 9100 | |
| 9101 Example (echoes the name of the syntax item under the cursor): > | |
| 9102 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 9103 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
9104 |
| 7 | 9105 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 9106 The result is a String, which is the {what} attribute of | |
| 9107 syntax ID {synID}. This can be used to obtain information | |
| 9108 about a syntax item. | |
| 9109 {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
|
9110 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 9111 used, the attributes for the currently active highlighting are |
| 9112 used (GUI, cterm or term). | |
| 9113 Use synIDtrans() to follow linked highlight groups. | |
| 9114 {what} result | |
| 9115 "name" the name of the syntax item | |
| 9116 "fg" foreground color (GUI: color name used to set | |
| 9117 the color, cterm: color number as a string, | |
| 9118 term: empty string) | |
| 1755 | 9119 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
9120 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
9121 |highlight-font| |
| 1755 | 9122 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 9123 "fg#" like "fg", but for the GUI and the GUI is |
| 9124 running the name in "#RRGGBB" form | |
| 9125 "bg#" like "fg#" for "bg" | |
| 1755 | 9126 "sp#" like "fg#" for "sp" |
| 7 | 9127 "bold" "1" if bold |
| 9128 "italic" "1" if italic | |
| 9129 "reverse" "1" if reverse | |
| 9130 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
9131 "standout" "1" if standout |
| 7 | 9132 "underline" "1" if underlined |
| 205 | 9133 "undercurl" "1" if undercurled |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12311
diff
changeset
|
9134 "strike" "1" if strikethrough |
| 7 | 9135 |
| 9136 Example (echoes the color of the syntax item under the | |
| 9137 cursor): > | |
| 9138 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 9139 < | |
| 9140 synIDtrans({synID}) *synIDtrans()* | |
| 9141 The result is a Number, which is the translated syntax ID of | |
| 9142 {synID}. This is the syntax group ID of what is being used to | |
| 9143 highlight the character. Highlight links given with | |
| 9144 ":highlight link" are followed. | |
| 9145 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
9146 synconcealed({lnum}, {col}) *synconcealed()* |
|
11553
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
9147 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
|
9148 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
|
9149 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
|
9150 region, 1 if it is. |
|
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
9151 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
|
9152 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
|
9153 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
|
9154 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
|
9155 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
|
9156 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
|
9157 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
|
9158 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
|
9159 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
|
9160 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
|
9161 the text is "123456" and both "23" and "45" are concealed |
| 14864 | 9162 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
|
9163 call returns ~ |
| 12254 | 9164 synconcealed(lnum, 1) [0, '', 0] |
| 9165 synconcealed(lnum, 2) [1, 'X', 1] | |
| 9166 synconcealed(lnum, 3) [1, 'X', 1] | |
| 9167 synconcealed(lnum, 4) [1, 'X', 2] | |
| 9168 synconcealed(lnum, 5) [1, 'X', 2] | |
| 9169 synconcealed(lnum, 6) [0, '', 0] | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
9170 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
9171 |
| 1500 | 9172 synstack({lnum}, {col}) *synstack()* |
| 9173 Return a |List|, which is the stack of syntax items at the | |
| 9174 position {lnum} and {col} in the current window. Each item in | |
| 9175 the List is an ID like what |synID()| returns. | |
| 9176 The first item in the List is the outer region, following are | |
| 9177 items contained in that one. The last one is what |synID()| | |
| 9178 returns, unless not the whole item is highlighted or it is a | |
| 9179 transparent item. | |
| 9180 This function is useful for debugging a syntax file. | |
| 9181 Example that shows the syntax stack under the cursor: > | |
| 9182 for id in synstack(line("."), col(".")) | |
| 9183 echo synIDattr(id, "name") | |
| 9184 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
9185 < 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
|
9186 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
9187 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
|
9188 valid positions. |
| 1500 | 9189 |
| 24 | 9190 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 9191 Get the output of the shell command {expr} as a string. See |
| 9192 |systemlist()| to get the output as a List. | |
| 5806 | 9193 |
| 12785 | 9194 When {input} is given and is a string this string is written |
| 9195 to a file and passed as stdin to the command. The string is | |
| 9196 written as-is, you need to take care of using the correct line | |
| 5806 | 9197 separators yourself. |
| 9198 If {input} is given and is a |List| it is written to the file | |
| 9199 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 9200 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
|
9201 list items converted to NULs). |
|
7232cd9f8a7c
commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
9202 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
|
9203 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
|
9204 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
|
9205 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
|
9206 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
9207 Pipes are not used, the 'shelltemp' option is not used. |
| 5806 | 9208 |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
9209 When prepended by |:silent| the terminal will not be set to |
| 6183 | 9210 cooked mode. This is meant to be used for commands that do |
| 9211 not need the user to type. It avoids stray characters showing | |
| 9212 up on the screen which require |CTRL-L| to remove. > | |
| 9213 :silent let f = system('ls *.vim') | |
| 9214 < | |
| 12785 | 9215 Note: Use |shellescape()| or |::S| with |expand()| or |
| 9216 |fnamemodify()| to escape special characters in a command | |
| 9217 argument. Newlines in {expr} may cause the command to fail. | |
| 9218 The characters in 'shellquote' and 'shellxquote' may also | |
| 5690 | 9219 cause trouble. |
| 7 | 9220 This is not to be used for interactive commands. |
| 1661 | 9221 |
| 7 | 9222 The result is a String. Example: > |
| 1661 | 9223 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 9224 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 9225 |
| 9226 < To make the result more system-independent, the shell output | |
| 9227 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 9228 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 9229 To avoid the string being truncated at a NUL, all NUL |
| 9230 characters are replaced with SOH (0x01). | |
| 9231 | |
| 7 | 9232 The command executed is constructed using several options: |
| 9233 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 9234 ({tmp} is an automatically generated file name). | |
| 9235 For Unix and OS/2 braces are put around {expr} to allow for | |
| 9236 concatenated commands. | |
| 9237 | |
| 794 | 9238 The command will be executed in "cooked" mode, so that a |
| 9239 CTRL-C will interrupt the command (on Unix at least). | |
| 9240 | |
| 7 | 9241 The resulting error code can be found in |v:shell_error|. |
| 9242 This function will fail in |restricted-mode|. | |
| 625 | 9243 |
| 9244 Note that any wrong value in the options mentioned above may | |
| 9245 make the function fail. It has also been reported to fail | |
| 9246 when using a security agent application. | |
| 7 | 9247 Unlike ":!cmd" there is no automatic check for changed files. |
| 9248 Use |:checktime| to force a check. | |
| 9249 | |
| 205 | 9250 |
| 5808 | 9251 systemlist({expr} [, {input}]) *systemlist()* |
| 12785 | 9252 Same as |system()|, but returns a |List| with lines (parts of |
| 9253 output separated by NL) with NULs transformed into NLs. Output | |
| 9254 is the same as |readfile()| will output with {binary} argument | |
|
10548
74effdaa369e
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10522
diff
changeset
|
9255 set to "b". Note that on MS-Windows you may get trailing CR |
|
74effdaa369e
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10522
diff
changeset
|
9256 characters. |
| 5808 | 9257 |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9258 Returns an empty string on error. |
| 5808 | 9259 |
| 9260 | |
| 677 | 9261 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 9262 The result is a |List|, where each item is the number of the |
| 677 | 9263 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
|
9264 {arg} specifies the number of the tab page to be used. When |
| 677 | 9265 omitted the current tab page is used. |
| 9266 When {arg} is invalid the number zero is returned. | |
| 9267 To get a list of all buffers in all tabs use this: > | |
| 3445 | 9268 let buflist = [] |
| 677 | 9269 for i in range(tabpagenr('$')) |
| 3445 | 9270 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 9271 endfor |
| 9272 < Note that a buffer may appear in more than one window. | |
| 9273 | |
| 9274 | |
| 9275 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 9276 The result is a Number, which is the number of the current |
| 9277 tab page. The first tab page has number 1. | |
| 9278 When the optional argument is "$", the number of the last tab | |
| 9279 page is returned (the tab page count). | |
| 9280 The number can be used with the |:tab| command. | |
| 9281 | |
| 9282 | |
| 5763 | 9283 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
9284 Like |winnr()| but for tab page {tabarg}. |
| 677 | 9285 {tabarg} specifies the number of tab page to be used. |
| 9286 {arg} is used like with |winnr()|: | |
| 9287 - When omitted the current window number is returned. This is | |
| 9288 the window which will be used when going to this tab page. | |
| 9289 - When "$" the number of windows is returned. | |
| 9290 - When "#" the previous window nr is returned. | |
| 9291 Useful examples: > | |
| 9292 tabpagewinnr(1) " current window of tab page 1 | |
| 9293 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 9294 < When {tabarg} is invalid zero is returned. | |
| 9295 | |
| 805 | 9296 *tagfiles()* |
| 9297 tagfiles() Returns a |List| with the file names used to search for tags | |
| 9298 for the current buffer. This is the 'tags' option expanded. | |
| 9299 | |
| 9300 | |
| 12785 | 9301 taglist({expr} [, {filename}]) *taglist()* |
| 205 | 9302 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
|
9303 |
|
d3415ec1cdaf
patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents:
11211
diff
changeset
|
9304 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
|
9305 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
|
9306 {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
|
9307 |
| 438 | 9308 Each list item is a dictionary with at least the following |
| 9309 entries: | |
| 648 | 9310 name Name of the tag. |
| 9311 filename Name of the file where the tag is | |
| 1156 | 9312 defined. It is either relative to the |
| 9313 current directory or a full path. | |
| 205 | 9314 cmd Ex command used to locate the tag in |
| 9315 the file. | |
| 648 | 9316 kind Type of the tag. The value for this |
| 205 | 9317 entry depends on the language specific |
| 1156 | 9318 kind values. Only available when |
| 9319 using a tags file generated by | |
| 9320 Exuberant ctags or hdrtag. | |
| 648 | 9321 static A file specific tag. Refer to |
| 205 | 9322 |static-tag| for more information. |
| 1156 | 9323 More entries may be present, depending on the content of the |
| 9324 tags file: access, implementation, inherits and signature. | |
| 9325 Refer to the ctags documentation for information about these | |
| 9326 fields. For C code the fields "struct", "class" and "enum" | |
| 9327 may appear, they give the name of the entity the tag is | |
| 9328 contained in. | |
| 452 | 9329 |
| 11062 | 9330 The ex-command "cmd" can be either an ex search pattern, a |
| 216 | 9331 line number or a line number followed by a byte number. |
| 205 | 9332 |
| 9333 If there are no matching tags, then an empty list is returned. | |
| 9334 | |
| 9335 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 9336 used in {expr}. This also make the function work faster. |
| 9337 Refer to |tag-regexp| for more information about the tag | |
| 9338 search regular expression pattern. | |
| 205 | 9339 |
| 9340 Refer to |'tags'| for information about how the tags file is | |
| 9341 located by Vim. Refer to |tags-file-format| for the format of | |
| 9342 the tags file generated by the different ctags tools. | |
| 9343 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9344 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9345 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
|
9346 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9347 {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
|
9348 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9349 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9350 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9351 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9352 < -1.181502 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
9353 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9354 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9355 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9356 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9357 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
|
9358 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9359 {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
|
9360 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9361 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9362 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9363 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9364 < -0.761594 |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
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 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9368 tempname() *tempname()* *temp-file-name* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9369 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
|
9370 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
|
9371 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
|
9372 :let tmpfile = tempname() |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9373 :exe "redir > " . tmpfile |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9374 < 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
|
9375 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
|
9376 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
|
9377 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9378 *term_dumpdiff()* |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9379 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
|
9380 Open a new window displaying the difference between the two |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9381 files. The files must have been created with |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9382 |term_dumpwrite()|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9383 Returns the buffer number or zero when the diff fails. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9384 Also see |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9385 NOTE: this does not work with double-width characters yet. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9386 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9387 The top part of the buffer contains the contents of the first |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9388 file, the bottom part of the buffer contains the contents of |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9389 the second file. The middle part shows the differences. |
| 14864 | 9390 The parts are separated by a line of equals. |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9391 |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9392 If the {options} argument is present, it must be a Dict with |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9393 these possible members: |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9394 "term_name" name to use for the buffer name, instead |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9395 of the first file name. |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9396 "term_rows" vertical size to use for the terminal, |
| 13735 | 9397 instead of using 'termwinsize' |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9398 "term_cols" horizontal size to use for the terminal, |
| 13735 | 9399 instead of using 'termwinsize' |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9400 "vertical" split the window vertically |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9401 "curwin" use the current window, do not split the |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9402 window; fails if the current buffer |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9403 cannot be |abandon|ed |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9404 "norestore" do not add the terminal window to a |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9405 session file |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9406 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9407 Each character in the middle part indicates a difference. If |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9408 there are multiple differences only the first in this list is |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9409 used: |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9410 X different character |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9411 w different width |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9412 f different foreground color |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9413 b different background color |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9414 a different attribute |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9415 + missing position in first file |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9416 - missing position in second file |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9417 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9418 Using the "s" key the top and bottom parts are swapped. This |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9419 makes it easy to spot a difference. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9420 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9421 *term_dumpload()* |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9422 term_dumpload({filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9423 Open a new window displaying the contents of {filename} |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9424 The file must have been created with |term_dumpwrite()|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9425 Returns the buffer number or zero when it fails. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9426 Also see |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9427 |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9428 For {options} see |term_dumpdiff()|. |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9429 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9430 *term_dumpwrite()* |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
9431 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
|
9432 Dump the contents of the terminal screen of {buf} in the file |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9433 {filename}. This uses a format that can be used with |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
9434 |term_dumpload()| and |term_dumpdiff()|. |
| 14695 | 9435 If the job in the terminal already finished an error is given: |
| 9436 *E958* | |
| 9437 If {filename} already exists an error is given: *E953* | |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9438 Also see |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
9439 |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
9440 {options} is a dictionary with these optional entries: |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
9441 "rows" maximum number of rows to dump |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
9442 "columns" maximum number of columns to dump |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
9443 |
|
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
|
9444 term_getaltscreen({buf}) *term_getaltscreen()* |
|
a3ed3d236839
patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12031
diff
changeset
|
9445 Returns 1 if the terminal of {buf} is using the alternate |
|
a3ed3d236839
patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12031
diff
changeset
|
9446 screen. |
|
a3ed3d236839
patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12031
diff
changeset
|
9447 {buf} is used as with |term_getsize()|. |
|
a3ed3d236839
patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12031
diff
changeset
|
9448 {only available when compiled with the |+terminal| feature} |
|
a3ed3d236839
patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12031
diff
changeset
|
9449 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9450 term_getansicolors({buf}) *term_getansicolors()* |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9451 Get the ANSI color palette in use by terminal {buf}. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9452 Returns a List of length 16 where each element is a String |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9453 representing a color in hexadecimal "#rrggbb" format. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9454 Also see |term_setansicolors()| and |g:terminal_ansi_colors|. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9455 If neither was used returns the default colors. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9456 |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9457 {buf} is used as with |term_getsize()|. If the buffer does not |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9458 exist or is not a terminal window, an empty list is returned. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9459 {only available when compiled with the |+terminal| feature and |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9460 with GUI enabled and/or the |+termguicolors| feature} |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9461 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9462 term_getattr({attr}, {what}) *term_getattr()* |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9463 Given {attr}, a value returned by term_scrape() in the "attr" |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9464 item, return whether {what} is on. {what} can be one of: |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9465 bold |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9466 italic |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9467 underline |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9468 strike |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9469 reverse |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9470 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9471 |
|
11876
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
9472 term_getcursor({buf}) *term_getcursor()* |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9473 Get the cursor position of terminal {buf}. Returns a list with |
| 12499 | 9474 two numbers and a dictionary: [row, col, dict]. |
| 9475 | |
| 9476 "row" and "col" are one based, the first screen cell is row | |
|
12076
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9477 1, column 1. This is the cursor position of the terminal |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9478 itself, not of the Vim window. |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9479 |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9480 "dict" can have these members: |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9481 "visible" one when the cursor is visible, zero when it |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9482 is hidden. |
| 14864 | 9483 "blink" one when the cursor is blinking, zero when it |
| 9484 is not blinking. | |
|
12076
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9485 "shape" 1 for a block cursor, 2 for underline and 3 |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9486 for a vertical bar. |
| 16380 | 9487 "color" color of the cursor, e.g. "green" |
|
11876
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
9488 |
|
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
9489 {buf} must be the buffer number of a terminal window. If the |
|
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
9490 buffer does not exist or is not a terminal window, an empty |
|
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
9491 list is returned. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9492 {only available when compiled with the |+terminal| feature} |
|
11876
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
9493 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9494 term_getjob({buf}) *term_getjob()* |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9495 Get the Job associated with terminal window {buf}. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9496 {buf} is used as with |term_getsize()|. |
|
11933
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
9497 Returns |v:null| when there is no job. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9498 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9499 |
|
11904
40322e8f07e7
patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents:
11882
diff
changeset
|
9500 term_getline({buf}, {row}) *term_getline()* |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9501 Get a line of text from the terminal window of {buf}. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9502 {buf} is used as with |term_getsize()|. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9503 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9504 The first line has {row} one. When {row} is "." the cursor |
|
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9505 line is used. When {row} is invalid an empty string is |
|
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9506 returned. |
|
13438
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9507 |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9508 To get attributes of each character use |term_scrape()|. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9509 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9510 |
|
12025
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9511 term_getscrolled({buf}) *term_getscrolled()* |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9512 Return the number of lines that scrolled to above the top of |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9513 terminal {buf}. This is the offset between the row number |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9514 used for |term_getline()| and |getline()|, so that: > |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9515 term_getline(buf, N) |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9516 < is equal to: > |
| 14864 | 9517 getline(N + term_getscrolled(buf)) |
|
12025
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9518 < (if that line exists). |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9519 |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9520 {buf} is used as with |term_getsize()|. |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9521 {only available when compiled with the |+terminal| feature} |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
9522 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9523 term_getsize({buf}) *term_getsize()* |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9524 Get the size of terminal {buf}. Returns a list with two |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9525 numbers: [rows, cols]. This is the size of the terminal, not |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9526 the window containing the terminal. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9527 |
|
11933
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
9528 {buf} must be the buffer number of a terminal window. Use an |
|
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
9529 empty string for the current buffer. If the buffer does not |
|
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
9530 exist or is not a terminal window, an empty list is returned. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9531 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9532 |
|
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
|
9533 term_getstatus({buf}) *term_getstatus()* |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9534 Get the status of terminal {buf}. This returns a comma |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9535 separated list of these items: |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9536 running job is running |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9537 finished job has finished |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9538 normal in Terminal-Normal mode |
|
11882
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9539 One of "running" or "finished" is always present. |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9540 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9541 {buf} must be the buffer number of a terminal window. If the |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9542 buffer does not exist or is not a terminal window, an empty |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9543 string is returned. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9544 {only available when compiled with the |+terminal| feature} |
|
11882
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9545 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9546 term_gettitle({buf}) *term_gettitle()* |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9547 Get the title of terminal {buf}. This is the title that the |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9548 job in the terminal has set. |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9549 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9550 {buf} must be the buffer number of a terminal window. If the |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9551 buffer does not exist or is not a terminal window, an empty |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9552 string is returned. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9553 {only available when compiled with the |+terminal| feature} |
|
11882
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
9554 |
|
12389
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9555 term_gettty({buf} [, {input}]) *term_gettty()* |
|
11933
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
9556 Get the name of the controlling terminal associated with |
|
12389
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9557 terminal window {buf}. {buf} is used as with |term_getsize()|. |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9558 |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9559 When {input} is omitted or 0, return the name for writing |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9560 (stdout). When {input} is 1 return the name for reading |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9561 (stdin). On UNIX, both return same name. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9562 {only available when compiled with the |+terminal| feature} |
|
11933
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
9563 |
|
11874
d444e087b8fd
patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents:
11846
diff
changeset
|
9564 term_list() *term_list()* |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9565 Return a list with the buffer numbers of all buffers for |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9566 terminal windows. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9567 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9568 |
|
11904
40322e8f07e7
patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents:
11882
diff
changeset
|
9569 term_scrape({buf}, {row}) *term_scrape()* |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9570 Get the contents of {row} of terminal screen of {buf}. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9571 For {buf} see |term_getsize()|. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9572 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9573 The first line has {row} one. When {row} is "." the cursor |
|
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9574 line is used. When {row} is invalid an empty string is |
|
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9575 returned. |
|
11874
d444e087b8fd
patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents:
11846
diff
changeset
|
9576 |
| 12785 | 9577 Return a List containing a Dict for each screen cell: |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9578 "chars" character(s) at the cell |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9579 "fg" foreground color as #rrggbb |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9580 "bg" background color as #rrggbb |
|
11933
d033653d3df8
patch 8.0.0846: cannot get the name of the pty of a job
Christian Brabandt <cb@256bit.org>
parents:
11904
diff
changeset
|
9581 "attr" attributes of the cell, use |term_getattr()| |
|
12076
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9582 to get the individual flags |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9583 "width" cell width: 1 or 2 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9584 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9585 |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9586 term_sendkeys({buf}, {keys}) *term_sendkeys()* |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9587 Send keystrokes {keys} to terminal {buf}. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9588 {buf} is used as with |term_getsize()|. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9589 |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9590 {keys} are translated as key sequences. For example, "\<c-x>" |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9591 means the character CTRL-X. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9592 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9593 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9594 term_setansicolors({buf}, {colors}) *term_setansicolors()* |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9595 Set the ANSI color palette used by terminal {buf}. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9596 {colors} must be a List of 16 valid color names or hexadecimal |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9597 color codes, like those accepted by |highlight-guifg|. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9598 Also see |term_getansicolors()| and |g:terminal_ansi_colors|. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9599 |
|
13678
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9600 The colors normally are: |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9601 0 black |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9602 1 dark red |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9603 2 dark green |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9604 3 brown |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9605 4 dark blue |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9606 5 dark magenta |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9607 6 dark cyan |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9608 7 light grey |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9609 8 dark grey |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9610 9 red |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9611 10 green |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9612 11 yellow |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9613 12 blue |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9614 13 magenta |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9615 14 cyan |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9616 15 white |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9617 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9618 These colors are used in the GUI and in the terminal when |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9619 'termguicolors' is set. When not using GUI colors (GUI mode |
| 13735 | 9620 or 'termguicolors'), the terminal window always uses the 16 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9621 ANSI colors of the underlying terminal. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9622 {only available when compiled with the |+terminal| feature and |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9623 with GUI enabled and/or the |+termguicolors| feature} |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9624 |
|
13438
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9625 term_setkill({buf}, {how}) *term_setkill()* |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9626 When exiting Vim or trying to close the terminal window in |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9627 another way, {how} defines whether the job in the terminal can |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9628 be stopped. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9629 When {how} is empty (the default), the job will not be |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9630 stopped, trying to exit will result in |E947|. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9631 Otherwise, {how} specifies what signal to send to the job. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9632 See |job_stop()| for the values. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9633 |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9634 After sending the signal Vim will wait for up to a second to |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9635 check that the job actually stopped. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9636 |
| 13437 | 9637 term_setrestore({buf}, {command}) *term_setrestore()* |
| 9638 Set the command to write in a session file to restore the job | |
| 9639 in this terminal. The line written in the session file is: > | |
| 9640 terminal ++curwin ++cols=%d ++rows=%d {command} | |
| 9641 < Make sure to escape the command properly. | |
| 9642 | |
| 9643 Use an empty {command} to run 'shell'. | |
| 9644 Use "NONE" to not restore this window. | |
| 9645 {only available when compiled with the |+terminal| feature} | |
| 9646 | |
| 13735 | 9647 term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955* |
|
13678
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9648 Set the size of terminal {buf}. The size of the window |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9649 containing the terminal will also be adjusted, if possible. |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9650 If {rows} or {cols} is zero or negative, that dimension is not |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9651 changed. |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9652 |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9653 {buf} must be the buffer number of a terminal window. Use an |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9654 empty string for the current buffer. If the buffer does not |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
9655 exist or is not a terminal window, an error is given. |
| 12499 | 9656 {only available when compiled with the |+terminal| feature} |
| 9657 | |
| 16380 | 9658 term_start({cmd} [, {options}]) *term_start()* |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9659 Open a terminal window and run {cmd} in it. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9660 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9661 {cmd} can be a string or a List, like with |job_start()|. The |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9662 string "NONE" can be used to open a terminal window without |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9663 starting a job, the pty of the terminal can be used by a |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9664 command like gdb. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9665 |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9666 Returns the buffer number of the terminal window. If {cmd} |
|
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9667 cannot be executed the window does open and shows an error |
|
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9668 message. |
|
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9669 If opening the window fails zero is returned. |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9670 |
|
11967
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9671 {options} are similar to what is used for |job_start()|, see |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9672 |job-options|. However, not all options can be used. These |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9673 are supported: |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9674 all timeout options |
| 14519 | 9675 "stoponexit", "cwd", "env" |
| 9676 "callback", "out_cb", "err_cb", "exit_cb", "close_cb" | |
|
11967
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9677 "in_io", "in_top", "in_bot", "in_name", "in_buf" |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9678 "out_io", "out_name", "out_buf", "out_modifiable", "out_msg" |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9679 "err_io", "err_name", "err_buf", "err_modifiable", "err_msg" |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9680 However, at least one of stdin, stdout or stderr must be |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9681 connected to the terminal. When I/O is connected to the |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9682 terminal then the callback function for that part is not used. |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
9683 |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9684 There are extra options: |
|
12031
9897241c08b5
patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents:
12025
diff
changeset
|
9685 "term_name" name to use for the buffer name, instead |
|
9897241c08b5
patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents:
12025
diff
changeset
|
9686 of the command name. |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9687 "term_rows" vertical size to use for the terminal, |
| 13735 | 9688 instead of using 'termwinsize' |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9689 "term_cols" horizontal size to use for the terminal, |
| 13735 | 9690 instead of using 'termwinsize' |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
9691 "vertical" split the window vertically; note that |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
9692 other window position can be defined with |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
9693 command modifiers, such as |:belowright|. |
|
12060
a879814b8a37
patch 8.0.0910: cannot create a terminal in the current window
Christian Brabandt <cb@256bit.org>
parents:
12056
diff
changeset
|
9694 "curwin" use the current window, do not split the |
|
a879814b8a37
patch 8.0.0910: cannot create a terminal in the current window
Christian Brabandt <cb@256bit.org>
parents:
12056
diff
changeset
|
9695 window; fails if the current buffer |
|
a879814b8a37
patch 8.0.0910: cannot create a terminal in the current window
Christian Brabandt <cb@256bit.org>
parents:
12056
diff
changeset
|
9696 cannot be |abandon|ed |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
9697 "hidden" do not open a window |
| 13437 | 9698 "norestore" do not add the terminal window to a |
| 9699 session file | |
|
13438
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9700 "term_kill" what to do when trying to close the |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
9701 terminal window, see |term_setkill()| |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
9702 "term_finish" What to do when the job is finished: |
|
12031
9897241c08b5
patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents:
12025
diff
changeset
|
9703 "close": close any windows |
|
9897241c08b5
patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents:
12025
diff
changeset
|
9704 "open": open window if needed |
|
9897241c08b5
patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents:
12025
diff
changeset
|
9705 Note that "open" can be interruptive. |
|
9897241c08b5
patch 8.0.0896: cannot close a terminal window when the job ends
Christian Brabandt <cb@256bit.org>
parents:
12025
diff
changeset
|
9706 See |term++close| and |term++open|. |
|
12072
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
9707 "term_opencmd" command to use for opening the window when |
|
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
9708 "open" is used for "term_finish"; must |
|
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
9709 have "%d" where the buffer number goes, |
|
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
9710 e.g. "10split|buffer %d"; when not |
|
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
9711 specified "botright sbuf %d" is used |
|
12311
66fa8eabbd6e
patch 8.0.1035: sending buffer lines to terminal doesn't work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12303
diff
changeset
|
9712 "eof_chars" Text to send after all buffer lines were |
|
66fa8eabbd6e
patch 8.0.1035: sending buffer lines to terminal doesn't work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12303
diff
changeset
|
9713 written to the terminal. When not set |
|
12389
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9714 CTRL-D is used on MS-Windows. For Python |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9715 use CTRL-Z or "exit()". For a shell use |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
9716 "exit". A CR is always added. |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9717 "ansi_colors" A list of 16 color names or hex codes |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9718 defining the ANSI palette used in GUI |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
9719 color modes. See |g:terminal_ansi_colors|. |
|
15746
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
9720 "tty_type" (MS-Windows only): Specify which pty to |
|
c017195b121b
patch 8.1.0880: MS-Windows: inconsistent selection of winpty/conpty
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
9721 use. See 'termwintype' for the values. |
|
12072
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
9722 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9723 {only available when compiled with the |+terminal| feature} |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9724 |
|
12007
64b822c4f7ae
patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents:
12003
diff
changeset
|
9725 term_wait({buf} [, {time}]) *term_wait()* |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9726 Wait for pending updates of {buf} to be handled. |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
9727 {buf} is used as with |term_getsize()|. |
|
12007
64b822c4f7ae
patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents:
12003
diff
changeset
|
9728 {time} is how long to wait for updates to arrive in msec. If |
|
64b822c4f7ae
patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents:
12003
diff
changeset
|
9729 not set then 10 msec will be used. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
9730 {only available when compiled with the |+terminal| feature} |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9731 |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
9732 test_alloc_fail({id}, {countdown}, {repeat}) *test_alloc_fail()* |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
9733 This is for testing: If the memory allocation with {id} is |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
9734 called, then decrement {countdown}, and when it reaches zero |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
9735 let memory allocation fail {repeat} times. When {repeat} is |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
9736 smaller than one it fails one time. |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
9737 |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
9738 test_autochdir() *test_autochdir()* |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
9739 Set a flag to enable the effect of 'autochdir' before Vim |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
9740 startup has finished. |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
9741 |
|
12337
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
9742 test_feedinput({string}) *test_feedinput()* |
|
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
9743 Characters in {string} are queued for processing as if they |
|
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
9744 were typed by the user. This uses a low level input buffer. |
|
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
9745 This function works only when with |+unix| or GUI is running. |
|
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
9746 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9747 test_garbagecollect_now() *test_garbagecollect_now()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9748 Like garbagecollect(), but executed right away. This must |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9749 only be called directly to avoid any structure to exist |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9750 internally, and |v:testing| must have been set before calling |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9751 any function. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9752 |
|
11006
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9753 test_ignore_error({expr}) *test_ignore_error()* |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9754 Ignore any error containing {expr}. A normal message is given |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9755 instead. |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9756 This is only meant to be used in tests, where catching the |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9757 error with try/catch cannot be used (because it skips over |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9758 following code). |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9759 {expr} is used literally, not as a pattern. |
|
15219
dada0b389d4f
patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents:
15209
diff
changeset
|
9760 When the {expr} is the string "RESET" then the list of ignored |
|
dada0b389d4f
patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents:
15209
diff
changeset
|
9761 errors is made empty. |
|
11006
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
9762 |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9763 test_null_blob() *test_null_blob()* |
|
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9764 Return a |Blob| that is null. Only useful for testing. |
|
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9765 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9766 test_null_channel() *test_null_channel()* |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9767 Return a |Channel| that is null. Only useful for testing. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9768 {only available when compiled with the +channel feature} |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9769 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9770 test_null_dict() *test_null_dict()* |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9771 Return a |Dict| that is null. Only useful for testing. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9772 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9773 test_null_job() *test_null_job()* |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9774 Return a |Job| that is null. Only useful for testing. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9775 {only available when compiled with the +job feature} |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9776 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9777 test_null_list() *test_null_list()* |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9778 Return a |List| that is null. Only useful for testing. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9779 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9780 test_null_partial() *test_null_partial()* |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9781 Return a |Partial| that is null. Only useful for testing. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9782 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9783 test_null_string() *test_null_string()* |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
9784 Return a |String| that is null. Only useful for testing. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9785 |
|
14748
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9786 test_option_not_set({name}) *test_option_not_set()* |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9787 Reset the flag that indicates option {name} was set. Thus it |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9788 looks like it still has the default value. Use like this: > |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9789 set ambiwidth=double |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9790 call test_option_not_set('ambiwidth') |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9791 < Now the 'ambiwidth' option behaves like it was never changed, |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9792 even though the value is "double". |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9793 Only to be used for testing! |
|
00da090af0ab
patch 8.1.0386: cannot test with non-default option value
Christian Brabandt <cb@256bit.org>
parents:
14700
diff
changeset
|
9794 |
| 11160 | 9795 test_override({name}, {val}) *test_override()* |
| 15194 | 9796 Overrides certain parts of Vim's internal processing to be able |
| 11160 | 9797 to run tests. Only to be used for testing Vim! |
| 9798 The override is enabled when {val} is non-zero and removed | |
| 9799 when {val} is zero. | |
| 12785 | 9800 Current supported values for name are: |
| 11160 | 9801 |
| 9802 name effect when {val} is non-zero ~ | |
| 9803 redraw disable the redrawing() function | |
|
14673
f1b7d308de2f
patch 8.1.0349: crash when wiping buffer in a callback
Christian Brabandt <cb@256bit.org>
parents:
14668
diff
changeset
|
9804 redraw_flag ignore the RedrawingDisabled flag |
| 11160 | 9805 char_avail disable the char_avail() function |
|
11587
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9806 starting reset the "starting" variable, see below |
|
14161
7cac4646c552
patch 8.1.0098: segfault when pattern with z() is very slow
Christian Brabandt <cb@256bit.org>
parents:
14147
diff
changeset
|
9807 nfa_fail makes the NFA regexp engine fail to force a |
|
7cac4646c552
patch 8.1.0098: segfault when pattern with z() is very slow
Christian Brabandt <cb@256bit.org>
parents:
14147
diff
changeset
|
9808 fallback to the old engine |
|
16489
42910f306377
patch 8.1.1248: no test for dec mouse
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
9809 no_query_mouse do not query the mouse position for "dec" |
|
42910f306377
patch 8.1.1248: no test for dec mouse
Bram Moolenaar <Bram@vim.org>
parents:
16427
diff
changeset
|
9810 terminals |
| 11160 | 9811 ALL clear all overrides ({val} is not used) |
| 9812 | |
|
11587
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9813 "starting" is to be used when a test should behave like |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9814 startup was done. Since the tests are run by sourcing a |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9815 script the "starting" variable is non-zero. This is usually a |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9816 good thing (tests run faster), but sometimes changes behavior |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9817 in a way that the test doesn't work properly. |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9818 When using: > |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9819 call test_override('starting', 1) |
|
12076
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
9820 < The value of "starting" is saved. It is restored by: > |
|
11587
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9821 call test_override('starting', 0) |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
9822 |
|
16078
d13aa9c5a1d1
patch 8.1.1044: no way to check the reference count of objects
Bram Moolenaar <Bram@vim.org>
parents:
16019
diff
changeset
|
9823 test_refcount({expr}) *test_refcount()* |
|
d13aa9c5a1d1
patch 8.1.1044: no way to check the reference count of objects
Bram Moolenaar <Bram@vim.org>
parents:
16019
diff
changeset
|
9824 Return the reference count of {expr}. When {expr} is of a |
|
d13aa9c5a1d1
patch 8.1.1044: no way to check the reference count of objects
Bram Moolenaar <Bram@vim.org>
parents:
16019
diff
changeset
|
9825 type that does not have a reference count, returns -1. Only |
|
d13aa9c5a1d1
patch 8.1.1044: no way to check the reference count of objects
Bram Moolenaar <Bram@vim.org>
parents:
16019
diff
changeset
|
9826 to be used for testing. |
|
d13aa9c5a1d1
patch 8.1.1044: no way to check the reference count of objects
Bram Moolenaar <Bram@vim.org>
parents:
16019
diff
changeset
|
9827 |
|
14756
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9828 test_scrollbar({which}, {value}, {dragging}) *test_scrollbar()* |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9829 Pretend using scrollbar {which} to move it to position |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9830 {value}. {which} can be: |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9831 left Left scrollbar of the current window |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9832 right Right scrollbar of the current window |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9833 hor Horizontal scrollbar |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9834 |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9835 For the vertical scrollbars {value} can be 1 to the |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9836 line-count of the buffer. For the horizontal scrollbar the |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9837 {value} can be between 1 and the maximum line length, assuming |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9838 'wrap' is not set. |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9839 |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9840 When {dragging} is non-zero it's like dragging the scrollbar, |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9841 otherwise it's like clicking in the scrollbar. |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9842 Only works when the {which} scrollbar actually exists, |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9843 obviously only when using the GUI. |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
9844 |
|
16517
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
9845 test_setmouse({row}, {col}) *test_setmouse()* |
|
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
9846 Set the mouse position to be used for the next mouse action. |
|
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
9847 {row} and {col} are one based. |
|
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
9848 For example: > |
|
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
9849 call test_setmouse(4, 20) |
|
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
9850 call feedkeys("\<LeftMouse>", "xt") |
|
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
9851 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
9852 test_settime({expr}) *test_settime()* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
9853 Set the time Vim uses internally. Currently only used for |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
9854 timestamps in the history, as they are used in viminfo, and |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
9855 for undo. |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9856 Using a value of 1 makes Vim not sleep after a warning or |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9857 error message. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
9858 {expr} must evaluate to a number. When the value is zero the |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
9859 normal behavior is restored. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
9860 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9861 *timer_info()* |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9862 timer_info([{id}]) |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9863 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
|
9864 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
|
9865 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
|
9866 returned. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9867 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
|
9868 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9869 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
|
9870 these items: |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9871 "id" the timer ID |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9872 "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
|
9873 "remaining" time until the timer fires |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9874 "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
|
9875 -1 means forever |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
9876 "callback" the callback |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9877 "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
|
9878 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9879 {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
|
9880 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9881 timer_pause({timer}, {paused}) *timer_pause()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9882 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
|
9883 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
|
9884 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
|
9885 has passed. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9886 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9887 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
|
9888 for a short time. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9889 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9890 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
|
9891 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
|
9892 See |non-zero-arg|. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9893 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9894 {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
|
9895 |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
9896 *timer_start()* *timer* *timers* |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9897 timer_start({time}, {callback} [, {options}]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9898 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
|
9899 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9900 {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
|
9901 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
|
9902 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
|
9903 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9904 {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
|
9905 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
|
9906 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
|
9907 waiting for input. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9908 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9909 {options} is a dictionary. Supported entries: |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9910 "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
|
9911 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
|
9912 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
|
9913 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
|
9914 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
|
9915 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
|
9916 messages. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9917 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9918 Example: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9919 func MyHandler(timer) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9920 echo 'Handler called' |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9921 endfunc |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9922 let timer = timer_start(500, 'MyHandler', |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9923 \ {'repeat': 3}) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9924 < 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
|
9925 intervals. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9926 |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9927 {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
|
9928 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
9929 timer_stop({timer}) *timer_stop()* |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
9930 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
|
9931 {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
|
9932 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
|
9933 |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9934 {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
|
9935 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9936 timer_stopall() *timer_stopall()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9937 Stop all timers. The timer callbacks will no longer be |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9938 invoked. Useful if some timers is misbehaving. If there are |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9939 no timers there is no error. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9940 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
9941 {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
|
9942 |
| 7 | 9943 tolower({expr}) *tolower()* |
| 9944 The result is a copy of the String given, with all uppercase | |
| 9945 characters turned into lowercase (just like applying |gu| to | |
| 9946 the string). | |
| 9947 | |
| 9948 toupper({expr}) *toupper()* | |
| 9949 The result is a copy of the String given, with all lowercase | |
| 9950 characters turned into uppercase (just like applying |gU| to | |
| 9951 the string). | |
| 9952 | |
| 15 | 9953 tr({src}, {fromstr}, {tostr}) *tr()* |
| 9954 The result is a copy of the {src} string with all characters | |
| 9955 which appear in {fromstr} replaced by the character in that | |
| 9956 position in the {tostr} string. Thus the first character in | |
| 9957 {fromstr} is translated into the first character in {tostr} | |
| 9958 and so on. Exactly like the unix "tr" command. | |
| 9959 This code also deals with multibyte characters properly. | |
| 9960 | |
| 9961 Examples: > | |
| 9962 echo tr("hello there", "ht", "HT") | |
| 9963 < returns "Hello THere" > | |
| 9964 echo tr("<blob>", "<>", "{}") | |
| 9965 < returns "{blob}" | |
| 9966 | |
| 14519 | 9967 trim({text} [, {mask}]) *trim()* |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
9968 Return {text} as a String where any character in {mask} is |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
9969 removed from the beginning and end of {text}. |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
9970 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
|
9971 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
|
9972 space character 0xa0. |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
9973 This code deals with multibyte characters properly. |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
9974 |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
9975 Examples: > |
| 13563 | 9976 echo trim(" some text ") |
| 9977 < returns "some text" > | |
| 9978 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
|
9979 < returns "RESERVE_TAIL" > |
| 13563 | 9980 echo trim("rm<Xrm<>X>rrm", "rm<>") |
| 9981 < returns "Xrm<>X" (characters in the middle are not removed) | |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
9982 |
| 1621 | 9983 trunc({expr}) *trunc()* |
| 1668 | 9984 Return the largest integral value with magnitude less than or |
| 1621 | 9985 equal to {expr} as a |Float| (truncate towards zero). |
| 9986 {expr} must evaluate to a |Float| or a |Number|. | |
| 9987 Examples: > | |
| 9988 echo trunc(1.456) | |
| 9989 < 1.0 > | |
| 9990 echo trunc(-5.456) | |
| 9991 < -5.0 > | |
| 9992 echo trunc(4.0) | |
| 9993 < 4.0 | |
| 9994 {only available when compiled with the |+float| feature} | |
| 12785 | 9995 |
| 87 | 9996 *type()* |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
9997 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
|
9998 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
|
9999 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
|
10000 Number: 0 |v:t_number| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10001 String: 1 |v:t_string| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10002 Funcref: 2 |v:t_func| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10003 List: 3 |v:t_list| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10004 Dictionary: 4 |v:t_dict| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10005 Float: 5 |v:t_float| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10006 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
|
10007 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
|
10008 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
|
10009 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
|
10010 Blob: 10 |v:t_blob| |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10011 For backward compatibility, this method can be used: > |
| 87 | 10012 :if type(myvar) == type(0) |
| 10013 :if type(myvar) == type("") | |
| 10014 :if type(myvar) == type(function("tr")) | |
| 10015 :if type(myvar) == type([]) | |
| 153 | 10016 :if type(myvar) == type({}) |
| 1621 | 10017 :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
|
10018 :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
|
10019 :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
|
10020 < 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
|
10021 :if exists('v:t_number') |
| 7 | 10022 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
10023 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
10024 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
|
10025 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
|
10026 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
|
10027 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
10028 {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
|
10029 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
10030 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
|
10031 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
|
10032 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
|
10033 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
|
10034 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
10035 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10036 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10037 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
|
10038 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10039 "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
|
10040 "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
|
10041 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
|
10042 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
|
10043 "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
|
10044 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
|
10045 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10046 "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
|
10047 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
10048 "save_cur" Number of the current position in the undo |
| 12785 | 10049 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10050 "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
|
10051 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
|
10052 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10053 "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
|
10054 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10055 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10056 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
|
10057 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
|
10058 "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
|
10059 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10060 "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
|
10061 |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
|
10062 "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
|
10063 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
|
10064 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
|
10065 "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
|
10066 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
|
10067 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
|
10068 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
|
10069 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
|
10070 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10071 "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
|
10072 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
|
10073 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
|
10074 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10075 "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
|
10076 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
|
10077 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
10078 |
| 5747 | 10079 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 10080 Remove second and succeeding copies of repeated adjacent | |
| 10081 {list} items in-place. Returns {list}. If you want a list | |
| 10082 to remain unmodified make a copy first: > | |
| 10083 :let newlist = uniq(copy(mylist)) | |
| 10084 < The default compare function uses the string representation of | |
| 10085 each item. For the use of {func} and {dict} see |sort()|. | |
| 10086 | |
| 140 | 10087 values({dict}) *values()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10088 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
|
10089 in arbitrary order. Also see |items()| and |keys()|. |
| 140 | 10090 |
| 10091 | |
| 7 | 10092 virtcol({expr}) *virtcol()* |
| 10093 The result is a Number, which is the screen column of the file | |
| 10094 position given with {expr}. That is, the last screen position | |
| 10095 occupied by the character at that position, when the screen | |
| 10096 would be of unlimited width. When there is a <Tab> at the | |
| 10097 position, the returned Number will be the column at the end of | |
| 10098 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 10099 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 10100 For the byte position use |col()|. |
| 10101 For the use of {expr} see |col()|. | |
| 10102 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 10103 "off" is the offset in screen columns from the start of the |
| 1266 | 10104 character. E.g., a position within a <Tab> or after the last |
| 2965 | 10105 character. When "off" is omitted zero is used. |
| 7 | 10106 When Virtual editing is active in the current mode, a position |
| 10107 beyond the end of the line can be returned. |'virtualedit'| | |
| 10108 The accepted positions are: | |
| 10109 . the cursor position | |
| 10110 $ the end of the cursor line (the result is the | |
| 10111 number of displayed characters in the cursor line | |
| 10112 plus one) | |
| 10113 'x position of mark x (if the mark is not set, 0 is | |
| 10114 returned) | |
| 6447 | 10115 v In Visual mode: the start of the Visual area (the |
| 10116 cursor is the end). When not in Visual mode | |
| 10117 returns the cursor position. Differs from |'<| in | |
| 10118 that it's updated right away. | |
| 7 | 10119 Note that only marks in the current file can be used. |
| 10120 Examples: > | |
| 10121 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 10122 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 10123 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
|
10124 < The first column is 1. 0 is returned for an error. |
| 1156 | 10125 A more advanced example that echoes the maximum length of |
| 10126 all lines: > | |
| 10127 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 10128 | |
| 7 | 10129 |
| 10130 visualmode([expr]) *visualmode()* | |
| 10131 The result is a String, which describes the last Visual mode | |
| 856 | 10132 used in the current buffer. Initially it returns an empty |
| 10133 string, but once Visual mode has been used, it returns "v", | |
| 10134 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 10135 character-wise, line-wise, or block-wise Visual mode | |
| 10136 respectively. | |
| 7 | 10137 Example: > |
| 10138 :exe "normal " . visualmode() | |
| 10139 < This enters the same Visual mode as before. It is also useful | |
| 10140 in scripts if you wish to act differently depending on the | |
| 10141 Visual mode that was used. | |
| 1621 | 10142 If Visual mode is active, use |mode()| to get the Visual mode |
| 10143 (e.g., in a |:vmap|). | |
| 1661 | 10144 If [expr] is supplied and it evaluates to a non-zero Number or |
| 10145 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
|
10146 the old value is returned. See |non-zero-arg|. |
| 7 | 10147 |
| 4151 | 10148 wildmenumode() *wildmenumode()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
10149 Returns |TRUE| when the wildmenu is active and |FALSE| |
| 4151 | 10150 otherwise. See 'wildmenu' and 'wildmode'. |
| 10151 This can be used in mappings to handle the 'wildcharm' option | |
| 10152 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 10153 | |
| 10154 For example to make <c-j> work like <down> in wildmode, use: > | |
| 10155 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 10156 < | |
| 10157 (Note, this needs the 'wildcharm' option set appropriately). | |
| 10158 | |
| 10159 | |
|
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
10160 win_findbuf({bufnr}) *win_findbuf()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
10161 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
|
10162 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
|
10163 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10164 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
|
10165 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
|
10166 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
|
10167 With {win} this is the window number. The top window has |
| 14999 | 10168 number 1. |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10169 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
|
10170 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
|
10171 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
|
10172 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10173 win_gotoid({expr}) *win_gotoid()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10174 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
|
10175 tabpage. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10176 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
|
10177 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
10178 win_id2tabwin({expr}) *win_id2tabwin()* |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10179 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
|
10180 with ID {expr}: [tabnr, winnr]. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10181 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
|
10182 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10183 win_id2win({expr}) *win_id2win()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
10184 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
|
10185 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
|
10186 |
|
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
|
10187 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
|
10188 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
|
10189 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
|
10190 [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
|
10191 {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
|
10192 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
|
10193 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
|
10194 |
| 7 | 10195 *winbufnr()* |
| 10196 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
|
10197 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
|
10198 the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
10199 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
|
10200 window is returned. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
10201 When window {nr} doesn't exist, -1 is returned. |
| 7 | 10202 Example: > |
| 10203 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 10204 < | |
| 10205 *wincol()* | |
| 10206 wincol() The result is a Number, which is the virtual column of the | |
| 10207 cursor in the window. This is counting screen cells from the | |
| 10208 left side of the window. The leftmost column is one. | |
| 10209 | |
| 10210 winheight({nr}) *winheight()* | |
| 10211 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
|
10212 {nr} can be the window number or the |window-ID|. |
| 7 | 10213 When {nr} is zero, the height of the current window is |
| 10214 returned. When window {nr} doesn't exist, -1 is returned. | |
| 10215 An existing window always has a height of zero or more. | |
| 12499 | 10216 This excludes any window toolbar line. |
| 7 | 10217 Examples: > |
| 10218 :echo "The current window has " . winheight(0) . " lines." | |
| 10219 < | |
|
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
|
10220 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
|
10221 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
|
10222 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
|
10223 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10224 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
|
10225 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
|
10226 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
|
10227 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10228 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
|
10229 ['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
|
10230 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
|
10231 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
|
10232 ['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
|
10233 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
|
10234 ['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
|
10235 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10236 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
|
10237 " 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
|
10238 :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
|
10239 ['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
|
10240 " 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
|
10241 :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
|
10242 ['col', [['leaf', 1000], ['leaf', 1001]]] |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10243 " Three horizontally split windows, with two |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10244 " vertically split windows in the middle window |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10245 :echo winlayout(2) |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10246 ['col', [['leaf', 1002], ['row', ['leaf', 1003], |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10247 ['leaf', 1001]]], ['leaf', 1000]] |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
10248 < |
| 7 | 10249 *winline()* |
| 10250 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
|
10251 in the window. This is counting screen lines from the top of |
| 7 | 10252 the window. The first line is one. |
| 531 | 10253 If the cursor was moved the view on the file will be updated |
| 10254 first, this may cause a scroll. | |
| 7 | 10255 |
| 10256 *winnr()* | |
| 20 | 10257 winnr([{arg}]) The result is a Number, which is the number of the current |
| 10258 window. The top window has number 1. | |
|
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
|
10259 |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10260 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
|
10261 $ 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
|
10262 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
|
10263 # 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
|
10264 |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
|
10265 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
|
10266 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
|
10267 {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
|
10268 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
|
10269 {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
|
10270 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
|
10271 {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
|
10272 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
|
10273 {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
|
10274 current window (where |CTRL-W_l| goes to). |
| 20 | 10275 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 10276 |:wincmd|. | |
| 10734 | 10277 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
|
10278 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
|
10279 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
|
10280 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
|
10281 let wnum = winnr('3k') |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
10282 < |
| 7 | 10283 *winrestcmd()* |
| 10284 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 10285 the current window sizes. Only works properly when no windows | |
| 712 | 10286 are opened or closed and the current window and tab page is |
| 10287 unchanged. | |
| 7 | 10288 Example: > |
| 10289 :let cmd = winrestcmd() | |
| 10290 :call MessWithWindowSizes() | |
| 10291 :exe cmd | |
| 712 | 10292 < |
| 10293 *winrestview()* | |
| 10294 winrestview({dict}) | |
| 10295 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 10296 the view of the current window. | |
| 5940 | 10297 Note: The {dict} does not have to contain all values, that are |
| 10298 returned by |winsaveview()|. If values are missing, those | |
| 10299 settings won't be restored. So you can use: > | |
| 10300 :call winrestview({'curswant': 4}) | |
| 10301 < | |
| 10302 This will only set the curswant value (the column the cursor | |
| 10303 wants to move on vertical movements) of the cursor to column 5 | |
| 10304 (yes, that is 5), while all other settings will remain the | |
| 10305 same. This is useful, if you set the cursor position manually. | |
| 10306 | |
| 712 | 10307 If you have changed the values the result is unpredictable. |
| 10308 If the window size changed the result won't be the same. | |
| 10309 | |
| 10310 *winsaveview()* | |
| 10311 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 10312 the view of the current window. Use |winrestview()| to | |
| 10313 restore the view. | |
| 10314 This is useful if you have a mapping that jumps around in the | |
| 10315 buffer and you want to go back to the original view. | |
| 10316 This does not save fold information. Use the 'foldenable' | |
| 798 | 10317 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
|
10318 not opened when moving around. This may have side effects. |
| 712 | 10319 The return value includes: |
| 10320 lnum cursor line number | |
| 5940 | 10321 col cursor column (Note: the first column |
| 10322 zero, as opposed to what getpos() | |
| 10323 returns) | |
| 712 | 10324 coladd cursor column offset for 'virtualedit' |
| 10325 curswant column for vertical movement | |
| 10326 topline first line in the window | |
| 10327 topfill filler lines, only in diff mode | |
| 10328 leftcol first column displayed | |
| 10329 skipcol columns skipped | |
| 10330 Note that no option values are saved. | |
| 10331 | |
| 7 | 10332 |
| 10333 winwidth({nr}) *winwidth()* | |
| 10334 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
|
10335 {nr} can be the window number or the |window-ID|. |
| 7 | 10336 When {nr} is zero, the width of the current window is |
| 10337 returned. When window {nr} doesn't exist, -1 is returned. | |
| 10338 An existing window always has a width of zero or more. | |
| 10339 Examples: > | |
| 10340 :echo "The current window has " . winwidth(0) . " columns." | |
| 10341 :if winwidth(0) <= 50 | |
|
12857
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
10342 : 50 wincmd | |
| 7 | 10343 :endif |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
10344 < 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
|
10345 option. |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
10346 |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
10347 |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10348 wordcount() *wordcount()* |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10349 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
|
10350 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
|
10351 |g_CTRL-G| |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10352 The return value includes: |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10353 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
|
10354 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
|
10355 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
|
10356 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
|
10357 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10358 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
|
10359 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10360 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
|
10361 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10362 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
|
10363 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10364 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
|
10365 (only in Visual mode) |
| 12254 | 10366 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
|
10367 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10368 |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
10369 |
| 158 | 10370 *writefile()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
10371 writefile({object}, {fname} [, {flags}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
10372 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
|
10373 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
|
10374 or Number. |
| 6341 | 10375 When {flags} contains "b" then binary mode is used: There will |
| 158 | 10376 not be a NL after the last list item. An empty item at the |
| 10377 end does cause the last line in the file to end in a NL. | |
| 6341 | 10378 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
10379 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
|
10380 unmodified. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
10381 |
| 6341 | 10382 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
|
10383 appended to the file: > |
| 6341 | 10384 :call writefile(["foo"], "event.log", "a") |
| 10385 :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
|
10386 < |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
10387 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
|
10388 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
|
10389 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
|
10390 crashes. |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
10391 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
|
10392 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
|
10393 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
|
10394 when 'fsync' is set. |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
10395 |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
10396 All NL characters are replaced with a NUL character. |
| 158 | 10397 Inserting CR characters needs to be done before passing {list} |
| 10398 to writefile(). | |
| 10399 An existing file is overwritten, if possible. | |
| 10400 When the write fails -1 is returned, otherwise 0. There is an | |
| 10401 error message if the file can't be created or when writing | |
| 10402 fails. | |
| 10403 Also see |readfile()|. | |
| 10404 To copy a file byte for byte: > | |
| 10405 :let fl = readfile("foo", "b") | |
| 10406 :call writefile(fl, "foocopy", "b") | |
| 3214 | 10407 |
| 10408 | |
| 10409 xor({expr}, {expr}) *xor()* | |
| 10410 Bitwise XOR on the two arguments. The arguments are converted | |
| 10411 to a number. A List, Dict or Float argument causes an error. | |
| 10412 Example: > | |
| 10413 :let bits = xor(bits, 0x80) | |
| 3256 | 10414 < |
| 3214 | 10415 |
| 7 | 10416 |
| 10417 *feature-list* | |
| 6009 | 10418 There are four types of features: |
| 7 | 10419 1. Features that are only supported when they have been enabled when Vim |
| 10420 was compiled |+feature-list|. Example: > | |
| 10421 :if has("cindent") | |
| 10422 2. Features that are only supported when certain conditions have been met. | |
| 10423 Example: > | |
| 10424 :if has("gui_running") | |
| 10425 < *has-patch* | |
|
13967
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
10426 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
|
10427 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
|
10428 later, or it is version 7.4 and patch 248 was included. Example: > |
| 5862 | 10429 :if has("patch-7.4.248") |
|
13967
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
10430 < 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
|
10431 included. Only happens when cherry-picking patches. |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
10432 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
|
10433 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
|
10434 version 6.2.148 or later): > |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
10435 :if v:version > 602 || (v:version == 602 && has("patch148")) |
| 7 | 10436 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
10437 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
|
10438 use: `if exists('+shellslash')` |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
10439 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
10440 |
| 5340 | 10441 acl Compiled with |ACL| support. |
| 7 | 10442 all_builtin_terms Compiled with all builtin terminals enabled. |
| 10443 amiga Amiga version of Vim. | |
| 10444 arabic Compiled with Arabic support |Arabic|. | |
| 10445 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
|
10446 autocmd Compiled with autocommand support. (always true) |
| 14421 | 10447 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
|
10448 autoservername Automatically enable |clientserver| |
| 7 | 10449 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 10450 balloon_multiline GUI supports multiline balloons. |
| 7 | 10451 beos BeOS version of Vim. |
| 10452 browse Compiled with |:browse| support, and browse() will | |
| 10453 work. | |
| 3682 | 10454 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
|
10455 bsd Compiled on an OS in the BSD family (excluding macOS). |
| 7 | 10456 builtin_terms Compiled with some builtin terminals. |
| 10457 byte_offset Compiled with support for 'o' in 'statusline' | |
| 10458 cindent Compiled with 'cindent' support. | |
| 10459 clientserver Compiled with remote invocation support |clientserver|. | |
| 10460 clipboard Compiled with 'clipboard' support. | |
| 10461 cmdline_compl Compiled with |cmdline-completion| support. | |
| 10462 cmdline_hist Compiled with |cmdline-history| support. | |
| 10463 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 10464 comments Compiled with |'comments'| support. | |
| 2681 | 10465 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
|
10466 conpty Platform where |ConPTY| can be used. |
| 7 | 10467 cryptv Compiled with encryption support |encryption|. |
| 10468 cscope Compiled with |cscope| support. | |
| 15729 | 10469 cursorbind Compiled with |'cursorbind'| (always true) |
| 7 | 10470 debug Compiled with "DEBUG" defined. |
| 10471 dialog_con Compiled with console dialog support. | |
| 10472 dialog_gui Compiled with GUI dialog support. | |
| 10473 diff Compiled with |vimdiff| and 'diff' support. | |
| 10474 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
|
10475 directx Compiled with support for DirectX and 'renderoptions'. |
| 7 | 10476 dnd Compiled with support for the "~ register |quote_~|. |
| 10477 ebcdic Compiled on a machine with ebcdic character set. | |
| 10478 emacs_tags Compiled with support for Emacs tags. | |
| 10479 eval Compiled with expression evaluation support. Always | |
| 10480 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
|
10481 ex_extra |+ex_extra| (always true) |
| 7 | 10482 extra_search Compiled with support for |'incsearch'| and |
| 10483 |'hlsearch'| | |
| 10484 farsi Compiled with Farsi support |farsi|. | |
| 10485 file_in_path Compiled with support for |gf| and |<cfile>| | |
| 168 | 10486 filterpipe When 'shelltemp' is off pipes are used for shell |
| 10487 read/write/filter commands | |
| 7 | 10488 find_in_path Compiled with support for include file searches |
| 10489 |+find_in_path|. | |
| 1621 | 10490 float Compiled with support for |Float|. |
| 7 | 10491 fname_case Case in file names matters (for Amiga, MS-DOS, and |
| 10492 Windows this is not present). | |
| 10493 folding Compiled with |folding| support. | |
| 10494 footer Compiled with GUI footer support. |gui-footer| | |
| 10495 fork Compiled to use fork()/exec() instead of system(). | |
| 10496 gettext Compiled with message translation |multi-lang| | |
| 10497 gui Compiled with GUI enabled. | |
| 10498 gui_athena Compiled with Athena GUI. | |
| 2681 | 10499 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 10500 gui_gtk Compiled with GTK+ GUI (any version). |
| 10501 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
|
10502 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
| 7 | 10503 gui_mac Compiled with Macintosh GUI. |
| 10504 gui_motif Compiled with Motif GUI. | |
| 10505 gui_photon Compiled with Photon GUI. | |
| 2681 | 10506 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 10507 gui_win32 Compiled with MS Windows Win32 GUI. |
| 10508 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
| 10509 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
|
10510 hpux HP-UX version of Vim. |
| 7 | 10511 iconv Can use iconv() for conversion. |
| 10512 insert_expand Compiled with support for CTRL-X expansion commands in | |
| 10513 Insert mode. | |
| 10514 jumplist Compiled with |jumplist| support. | |
| 10515 keymap Compiled with 'keymap' support. | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
10516 lambda Compiled with |lambda| support. |
| 7 | 10517 langmap Compiled with 'langmap' support. |
| 10518 libcall Compiled with |libcall()| support. | |
| 5995 | 10519 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 10520 '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
|
10521 linux Linux version of Vim. |
| 7 | 10522 lispindent Compiled with support for lisp indenting. |
| 10523 listcmds Compiled with commands for the buffer list |:files| | |
| 10524 and the argument list |arglist|. | |
| 10525 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
|
10526 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
|
10527 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
|
10528 macunix Synonym for osxdarwin |
| 7 | 10529 menu Compiled with support for |:menu|. |
| 10530 mksession Compiled with support for |:mksession|. | |
| 10531 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
| 10532 mouse Compiled with support mouse. | |
| 10533 mouse_dec Compiled with support for Dec terminal mouse. | |
| 10534 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
| 10535 mouse_netterm Compiled with support for netterm mouse. | |
| 10536 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 10537 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 10538 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 10539 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 10540 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 10541 mouseshape Compiled with support for 'mouseshape'. |
| 15878 | 10542 multi_byte Compiled with support for 'encoding' (always true) |
| 1768 | 10543 multi_byte_encoding 'encoding' is set to a multi-byte encoding. |
| 7 | 10544 multi_byte_ime Compiled with support for IME input method. |
| 10545 multi_lang Compiled with support for multiple languages. | |
| 14 | 10546 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 10547 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 10548 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
|
10549 num64 Compiled with 64-bit |Number| support. |
| 7 | 10550 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
|
10551 osx Compiled for macOS cf. mac |
|
351cf7c67bbe
patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents:
12632
diff
changeset
|
10552 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
|
10553 packages Compiled with |packages| support. |
| 7 | 10554 path_extra Compiled with up/downwards search in 'path' and 'tags' |
| 10555 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
|
10556 persistent_undo Compiled with support for persistent undo history. |
| 7 | 10557 postscript Compiled with PostScript file printing. |
| 10558 printer Compiled with |:hardcopy| support. | |
| 170 | 10559 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
|
10560 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
|
10561 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
|
10562 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
|
10563 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
|
10564 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
|
10565 python3_dynamic Python 3.x interface is dynamically loaded. |has-python| |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
10566 pythonx Compiled with |python_x| interface. |has-pythonx| |
| 7 | 10567 qnx QNX version of Vim. |
| 10568 quickfix Compiled with |quickfix| support. | |
| 857 | 10569 reltime Compiled with |reltime()| support. |
| 7 | 10570 rightleft Compiled with 'rightleft' support. |
| 10571 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
|
10572 scrollbind Compiled with 'scrollbind' support. (always true) |
| 7 | 10573 showcmd Compiled with 'showcmd' support. |
| 10574 signs Compiled with |:sign| support. | |
| 10575 smartindent Compiled with 'smartindent' support. | |
| 2681 | 10576 spell Compiled with spell checking support |spell|. |
| 1989 | 10577 startuptime Compiled with |--startuptime| support. |
| 7 | 10578 statusline Compiled with support for 'statusline', 'rulerformat' |
| 10579 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
|
10580 sun SunOS version of Vim. |
| 15512 | 10581 sun_workshop Support for Sun |workshop| has been removed. |
| 314 | 10582 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 10583 syntax_items There are active syntax highlighting items for the |
| 10584 current buffer. | |
| 10585 system Compiled to use system() instead of fork()/exec(). | |
| 10586 tag_binary Compiled with binary searching in tags files | |
| 10587 |tag-binary-search|. | |
| 16208 | 10588 tag_old_static Support for old static tags was removed, see |
| 7 | 10589 |tag-old-static|. |
| 10590 tcl Compiled with Tcl interface. | |
|
9076
9305a1251e51
commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
10591 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
|
10592 terminal Compiled with |terminal| support. |
| 7 | 10593 terminfo Compiled with terminfo instead of termcap. |
| 10594 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 10595 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
|
10596 textprop Compiled with support for |text-properties|. |
| 7 | 10597 tgetent Compiled with tgetent support, able to use a termcap |
| 10598 or terminfo file. | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10599 timers Compiled with |timer_start()| support. |
| 7 | 10600 title Compiled with window title support |'title'|. |
| 10601 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
|
10602 ttyin input is a terminal (tty) |
|
65e0537a4560
commit https://github.com/vim/vim/commit/2cab0e191055a8145ccd46cd52869fbb9798b971
Christian Brabandt <cb@256bit.org>
parents:
10348
diff
changeset
|
10603 ttyout output is a terminal (tty) |
| 12499 | 10604 unix Unix version of Vim. *+unix* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
10605 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
|
10606 user_commands User-defined commands. (always true) |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
10607 vcon Win32: Virtual console support is working, can use |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
10608 'termguicolors'. Also see |+vtp|. |
| 2681 | 10609 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
|
10610 (always true) |
| 2581 | 10611 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
|
10612 *vim_starting* |
| 2681 | 10613 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
|
10614 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
|
10615 vimscript-2 Compiled Vim script version 2 support |
| 16380 | 10616 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
|
10617 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
|
10618 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
|
10619 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
|
10620 true) |blockwise-operators|. |
| 7 | 10621 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
|
10622 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
|
10623 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
|
10624 out if it works in the current console). |
| 7 | 10625 wildignore Compiled with 'wildignore' option. |
| 10626 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
|
10627 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
|
10628 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
|
10629 64 bits) |
| 2681 | 10630 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 10631 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
|
10632 win95 Win32 version for MS-Windows 95/98/ME (always false) |
| 2681 | 10633 winaltkeys Compiled with 'winaltkeys' option. |
| 10634 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
|
10635 (always true) |
| 7 | 10636 writebackup Compiled with 'writebackup' default on. |
| 10637 xfontset Compiled with X fontset support |xfontset|. | |
| 10638 xim Compiled with X input method support |xim|. | |
| 5340 | 10639 xpm Compiled with pixmap support. |
| 10640 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 10641 backward compatibility. Use "xpm" instead.) | |
| 7 | 10642 xsmp Compiled with X session management support. |
| 10643 xsmp_interact Compiled with interactive X session management support. | |
| 10644 xterm_clipboard Compiled with support for xterm clipboard. | |
| 10645 xterm_save Compiled with support for saving and restoring the | |
| 10646 xterm screen. | |
| 10647 x11 Compiled with X11 support. | |
| 10648 | |
| 10649 *string-match* | |
| 10650 Matching a pattern in a String | |
| 10651 | |
| 10652 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 10653 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 10654 everything works in the same way. The difference is that a String is handled | |
| 10655 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 10656 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 10657 with ".". Example: > | |
| 10658 :let a = "aaaa\nxxxx" | |
| 10659 :echo matchstr(a, "..\n..") | |
| 10660 aa | |
| 10661 xx | |
| 10662 :echo matchstr(a, "a.x") | |
| 10663 a | |
| 10664 x | |
| 10665 | |
| 10666 Don't forget that "^" will only match at the first character of the String and | |
| 10667 "$" at the last character of the string. They don't match after or before a | |
| 10668 "\n". | |
| 10669 | |
| 10670 ============================================================================== | |
| 10671 5. Defining functions *user-functions* | |
| 10672 | |
| 10673 New functions can be defined. These can be called just like builtin | |
| 10674 functions. The function executes a sequence of Ex commands. Normal mode | |
| 10675 commands can be executed with the |:normal| command. | |
| 10676 | |
| 10677 The function name must start with an uppercase letter, to avoid confusion with | |
| 10678 builtin functions. To prevent from using the same name in different scripts | |
| 10679 avoid obvious, short names. A good habit is to start the function name with | |
| 10680 the name of the script, e.g., "HTMLcolor()". | |
| 10681 | |
| 504 | 10682 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 10683 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 10684 |
| 10685 *local-function* | |
| 10686 A function local to a script must start with "s:". A local script function | |
| 10687 can only be called from within the script and from functions, user commands | |
| 10688 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 10689 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 10690 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 10691 There are only script-local functions, no buffer-local or window-local |
| 10692 functions. | |
| 7 | 10693 |
| 10694 *:fu* *:function* *E128* *E129* *E123* | |
| 10695 :fu[nction] List all functions and their arguments. | |
| 10696 | |
| 10697 :fu[nction] {name} List function {name}. | |
| 685 | 10698 {name} can also be a |Dictionary| entry that is a |
| 10699 |Funcref|: > | |
| 114 | 10700 :function dict.init |
| 504 | 10701 |
| 10702 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 10703 Example that lists all functions ending with "File": > | |
| 10704 :function /File$ | |
| 482 | 10705 < |
| 10706 *:function-verbose* | |
| 10707 When 'verbose' is non-zero, listing a function will also display where it was | |
| 10708 last defined. Example: > | |
| 10709 | |
| 10710 :verbose function SetFileTypeSH | |
| 10711 function SetFileTypeSH(name) | |
| 10712 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 10713 < | |
| 484 | 10714 See |:verbose-cmd| for more information. |
| 482 | 10715 |
| 5862 | 10716 *E124* *E125* *E853* *E884* |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10717 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
10718 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
|
10719 the function follows in the next lines, until the |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
10720 matching |:endfunction|. |
| 12785 | 10721 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
10722 The name must be made of alphanumeric characters and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
10723 '_', and must start with a capital or "s:" (see |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
10724 above). Note that using "b:" or "g:" is not allowed. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
10725 (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
|
10726 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
|
10727 Before that patch no error was given). |
| 114 | 10728 |
| 685 | 10729 {name} can also be a |Dictionary| entry that is a |
| 10730 |Funcref|: > | |
| 114 | 10731 :function dict.init(arg) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10732 < "dict" must be an existing dictionary. The entry |
| 114 | 10733 "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
|
10734 is required to overwrite an existing function. The |
| 114 | 10735 result is a |Funcref| to a numbered function. The |
| 10736 function can only be used with a |Funcref| and will be | |
| 10737 deleted if there are no more references to it. | |
| 7 | 10738 *E127* *E122* |
| 10739 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
|
10740 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
|
10741 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
|
10742 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
|
10743 silently replaced. |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
10744 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
|
10745 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
|
10746 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
|
10747 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
|
10748 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
|
10749 which is hard to debug. |
| 133 | 10750 |
| 10751 For the {arguments} see |function-argument|. | |
| 10752 | |
| 5618 | 10753 *:func-range* *a:firstline* *a:lastline* |
| 7 | 10754 When the [range] argument is added, the function is |
| 10755 expected to take care of a range itself. The range is | |
| 10756 passed as "a:firstline" and "a:lastline". If [range] | |
| 10757 is excluded, ":{range}call" will call the function for | |
| 10758 each line in the range, with the cursor on the start | |
| 10759 of each line. See |function-range-example|. | |
| 3967 | 10760 The cursor is still moved to the first line of the |
| 10761 range, as is the case with all Ex commands. | |
| 5618 | 10762 *:func-abort* |
| 7 | 10763 When the [abort] argument is added, the function will |
| 10764 abort as soon as an error is detected. | |
| 5618 | 10765 *:func-dict* |
| 102 | 10766 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
|
10767 be invoked through an entry in a |Dictionary|. The |
| 102 | 10768 local variable "self" will then be set to the |
| 10769 dictionary. See |Dictionary-function|. | |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10770 *:func-closure* *E932* |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10771 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
|
10772 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
|
10773 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
|
10774 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
|
10775 remains referenced even after Foo() returns: > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10776 :function! Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10777 : let x = 0 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10778 : function! Bar() closure |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10779 : let x += 1 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10780 : return x |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10781 : endfunction |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
10782 : return funcref('Bar') |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10783 :endfunction |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10784 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10785 :let F = Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10786 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10787 < 1 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10788 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10789 < 2 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10790 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
10791 < 3 |
| 7 | 10792 |
| 1621 | 10793 *function-search-undo* |
| 653 | 10794 The last used search pattern and the redo command "." |
| 1621 | 10795 will not be changed by the function. This also |
| 10796 implies that the effect of |:nohlsearch| is undone | |
| 10797 when the function returns. | |
| 653 | 10798 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
10799 *: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
|
10800 :endf[unction] [argument] |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
10801 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
|
10802 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
|
10803 |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
10804 [argument] can be: |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
10805 | 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
|
10806 \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
|
10807 " 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
|
10808 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
|
10809 '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
|
10810 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
|
10811 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
|
10812 ignored. |
| 7 | 10813 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
10814 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
|
10815 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
|
10816 :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
|
10817 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
10818 *: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
|
10819 :delf[unction][!] {name} |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
10820 Delete function {name}. |
| 685 | 10821 {name} can also be a |Dictionary| entry that is a |
| 10822 |Funcref|: > | |
| 114 | 10823 :delfunc dict.init |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10824 < This will remove the "init" entry from "dict". The |
| 114 | 10825 function is deleted if there are no more references to |
| 10826 it. | |
|
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
10827 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
|
10828 exist. |
| 7 | 10829 *:retu* *:return* *E133* |
| 10830 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 10831 evaluated and returned as the result of the function. | |
| 10832 If "[expr]" is not given, the number 0 is returned. | |
| 10833 When a function ends without an explicit ":return", | |
| 10834 the number 0 is returned. | |
| 10835 Note that there is no check for unreachable lines, | |
| 10836 thus there is no warning if commands follow ":return". | |
| 10837 | |
| 10838 If the ":return" is used after a |:try| but before the | |
| 10839 matching |:finally| (if present), the commands | |
| 10840 following the ":finally" up to the matching |:endtry| | |
| 10841 are executed first. This process applies to all | |
| 10842 nested ":try"s inside the function. The function | |
| 10843 returns at the outermost ":endtry". | |
| 10844 | |
| 133 | 10845 *function-argument* *a:var* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10846 An argument can be defined by giving its name. In the function this can then |
| 133 | 10847 be used as "a:name" ("a:" for argument). |
| 1156 | 10848 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 10849 Up to 20 arguments can be given, separated by commas. After the named |
| 10850 arguments an argument "..." can be specified, which means that more arguments | |
| 10851 may optionally be following. In the function the extra arguments can be used | |
| 10852 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 10853 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 10854 that "a:1" is the same as "a:000[0]". | |
| 148 | 10855 *E742* |
| 10856 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
|
10857 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
|
10858 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
|
10859 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
|
10860 change a |List| or |Dictionary| use |:lockvar|. |
| 133 | 10861 |
| 10862 When not using "...", the number of arguments in a function call must be equal | |
| 10863 to the number of named arguments. When using "...", the number of arguments | |
| 10864 may be larger. | |
| 10865 | |
| 10866 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
|
10867 still supply the () then. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
10868 |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
10869 It is allowed to define another function inside a function body. |
| 133 | 10870 |
| 10871 *local-variables* | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
10872 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
|
10873 function returns. Global variables need to be accessed with "g:". |
| 7 | 10874 |
| 10875 Example: > | |
| 10876 :function Table(title, ...) | |
| 10877 : echohl Title | |
| 10878 : echo a:title | |
| 10879 : echohl None | |
| 140 | 10880 : echo a:0 . " items:" |
| 10881 : for s in a:000 | |
| 10882 : echon ' ' . s | |
| 10883 : endfor | |
| 7 | 10884 :endfunction |
| 10885 | |
| 10886 This function can then be called with: > | |
| 140 | 10887 call Table("Table", "line1", "line2") |
| 10888 call Table("Empty Table") | |
| 7 | 10889 |
| 1156 | 10890 To return more than one value, return a |List|: > |
| 10891 :function Compute(n1, n2) | |
| 7 | 10892 : if a:n2 == 0 |
| 1156 | 10893 : return ["fail", 0] |
| 7 | 10894 : endif |
| 1156 | 10895 : return ["ok", a:n1 / a:n2] |
| 7 | 10896 :endfunction |
| 10897 | |
| 10898 This function can then be called with: > | |
| 1156 | 10899 :let [success, div] = Compute(102, 6) |
| 7 | 10900 :if success == "ok" |
| 10901 : echo div | |
| 10902 :endif | |
| 1156 | 10903 < |
| 786 | 10904 *:cal* *:call* *E107* *E117* |
| 7 | 10905 :[range]cal[l] {name}([arguments]) |
| 10906 Call a function. The name of the function and its arguments | |
| 10907 are as specified with |:function|. Up to 20 arguments can be | |
| 1156 | 10908 used. The returned value is discarded. |
| 7 | 10909 Without a range and for functions that accept a range, the |
| 10910 function is called once. When a range is given the cursor is | |
| 10911 positioned at the start of the first line before executing the | |
| 10912 function. | |
| 10913 When a range is given and the function doesn't handle it | |
| 10914 itself, the function is executed for each line in the range, | |
| 10915 with the cursor in the first column of that line. The cursor | |
| 10916 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
|
10917 call). The arguments are re-evaluated for each line. Thus |
| 7 | 10918 this works: |
| 10919 *function-range-example* > | |
| 10920 :function Mynumber(arg) | |
| 10921 : echo line(".") . " " . a:arg | |
| 10922 :endfunction | |
| 10923 :1,5call Mynumber(getline(".")) | |
| 10924 < | |
| 10925 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 10926 can be used to do something different at the start or end of | |
| 10927 the range. | |
| 10928 | |
| 10929 Example of a function that handles the range itself: > | |
| 10930 | |
| 10931 :function Cont() range | |
| 10932 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 10933 :endfunction | |
| 10934 :4,8call Cont() | |
| 10935 < | |
| 10936 This function inserts the continuation character "\" in front | |
| 10937 of all the lines in the range, except the first one. | |
| 10938 | |
| 1156 | 10939 When the function returns a composite value it can be further |
| 10940 dereferenced, but the range will not be used then. Example: > | |
| 10941 :4,8call GetDict().method() | |
| 10942 < Here GetDict() gets the range but method() does not. | |
| 10943 | |
| 7 | 10944 *E132* |
| 10945 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 10946 option. | |
| 10947 | |
| 161 | 10948 |
| 10949 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 10950 *autoload-functions* |
| 10951 When using many or large functions, it's possible to automatically define them | |
| 161 | 10952 only when they are used. There are two methods: with an autocommand and with |
| 10953 the "autoload" directory in 'runtimepath'. | |
| 10954 | |
| 10955 | |
| 10956 Using an autocommand ~ | |
| 10957 | |
| 170 | 10958 This is introduced in the user manual, section |41.14|. |
| 10959 | |
| 161 | 10960 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 10961 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
|
10962 That makes Vim startup faster. The autocommand should then load the same file |
| 161 | 10963 again, setting a variable to skip the |:finish| command. |
| 10964 | |
| 10965 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 10966 function(s) to be defined. Example: > | |
| 7 | 10967 |
| 10968 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 10969 | |
| 10970 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 10971 "BufNet". Also see |FuncUndefined|. | |
| 10972 | |
| 161 | 10973 |
| 10974 Using an autoload script ~ | |
| 168 | 10975 *autoload* *E746* |
| 170 | 10976 This is introduced in the user manual, section |41.15|. |
| 10977 | |
| 161 | 10978 Using a script in the "autoload" directory is simpler, but requires using |
| 10979 exactly the right file name. A function that can be autoloaded has a name | |
| 10980 like this: > | |
| 10981 | |
| 270 | 10982 :call filename#funcname() |
| 161 | 10983 |
| 10984 When such a function is called, and it is not defined yet, Vim will search the | |
| 10985 "autoload" directories in 'runtimepath' for a script file called | |
| 10986 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 10987 then define the function like this: > | |
| 10988 | |
| 270 | 10989 function filename#funcname() |
| 161 | 10990 echo "Done!" |
| 10991 endfunction | |
| 10992 | |
| 530 | 10993 The file name and the name used before the # in the function must match |
| 161 | 10994 exactly, and the defined function must have the name exactly as it will be |
| 10995 called. | |
| 10996 | |
| 270 | 10997 It is possible to use subdirectories. Every # in the function name works like |
| 10998 a path separator. Thus when calling a function: > | |
| 10999 | |
| 11000 :call foo#bar#func() | |
| 161 | 11001 |
| 11002 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 11003 | |
| 168 | 11004 This also works when reading a variable that has not been set yet: > |
| 11005 | |
| 270 | 11006 :let l = foo#bar#lvar |
| 168 | 11007 |
| 557 | 11008 However, when the autoload script was already loaded it won't be loaded again |
| 11009 for an unknown variable. | |
| 11010 | |
| 168 | 11011 When assigning a value to such a variable nothing special happens. This can |
| 11012 be used to pass settings to the autoload script before it's loaded: > | |
| 11013 | |
| 270 | 11014 :let foo#bar#toggle = 1 |
| 11015 :call foo#bar#func() | |
| 168 | 11016 |
| 164 | 11017 Note that when you make a mistake and call a function that is supposed to be |
| 11018 defined in an autoload script, but the script doesn't actually define the | |
| 11019 function, the script will be sourced every time you try to call the function. | |
| 168 | 11020 And you will get an error message every time. |
| 11021 | |
| 11022 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 11023 other and vice versa, before the used function is defined, it won't work. |
| 168 | 11024 Avoid using the autoload functionality at the toplevel. |
| 161 | 11025 |
| 794 | 11026 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 11027 |vimball| utility. Also read the user manual |distribute-script|. | |
| 11028 | |
| 7 | 11029 ============================================================================== |
| 11030 6. Curly braces names *curly-braces-names* | |
| 11031 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11032 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
|
11033 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
|
11034 wrapped in braces {} like this: > |
| 7 | 11035 my_{adjective}_variable |
| 11036 | |
| 11037 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 11038 that in place of the expression, and re-interprets the whole as a variable | |
| 11039 name. So in the above example, if the variable "adjective" was set to | |
| 11040 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 11041 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 11042 | |
| 11043 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
|
11044 value. For example, the statement > |
| 7 | 11045 echo my_{&background}_message |
| 11046 | |
| 11047 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 11048 on the current value of 'background'. | |
| 11049 | |
| 11050 You can use multiple brace pairs: > | |
| 11051 echo my_{adverb}_{adjective}_message | |
| 11052 ..or even nest them: > | |
| 11053 echo my_{ad{end_of_word}}_message | |
| 11054 where "end_of_word" is either "verb" or "jective". | |
| 11055 | |
| 11056 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 11057 variable name, e.g. this is invalid: > |
| 7 | 11058 :let foo='a + b' |
| 11059 :echo c{foo}d | |
| 11060 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 11061 | |
| 11062 *curly-braces-function-names* | |
| 11063 You can call and define functions by an evaluated name in a similar way. | |
| 11064 Example: > | |
| 11065 :let func_end='whizz' | |
| 11066 :call my_func_{func_end}(parameter) | |
| 11067 | |
| 11068 This would call the function "my_func_whizz(parameter)". | |
| 11069 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11070 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11071 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11072 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11073 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
11074 |
| 7 | 11075 ============================================================================== |
| 11076 7. Commands *expression-commands* | |
| 11077 | |
| 11078 :let {var-name} = {expr1} *:let* *E18* | |
| 11079 Set internal variable {var-name} to the result of the | |
| 11080 expression {expr1}. The variable will get the type | |
| 11081 from the {expr}. If {var-name} didn't exist yet, it | |
| 11082 is created. | |
| 11083 | |
| 85 | 11084 :let {var-name}[{idx}] = {expr1} *E689* |
| 11085 Set a list item to the result of the expression | |
| 11086 {expr1}. {var-name} must refer to a list and {idx} | |
| 11087 must be a valid index in that list. For nested list | |
| 11088 the index can be repeated. | |
| 1621 | 11089 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
|
11090 This cannot be used to set a byte in a String. You |
| 1621 | 11091 can do that like this: > |
| 11092 :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
|
11093 < 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
|
11094 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
|
11095 appended. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11096 |
| 114 | 11097 *E711* *E719* |
| 11098 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 11099 Set a sequence of items in a |List| to the result of |
| 11100 the expression {expr1}, which must be a list with the | |
| 87 | 11101 correct number of items. |
| 11102 {idx1} can be omitted, zero is used instead. | |
| 11103 {idx2} can be omitted, meaning the end of the list. | |
| 11104 When the selected range of items is partly past the | |
| 11105 end of the list, items will be added. | |
| 11106 | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11107 *:let+=* *:let-=* *:letstar=* |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11108 *:let/=* *:let%=* *:let.=* *:let..=* *E734* *E985* |
| 114 | 11109 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 11110 :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
|
11111 :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
|
11112 :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
|
11113 :let {var} %= {expr1} Like ":let {var} = {var} % {expr1}". |
| 114 | 11114 :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
|
11115 :let {var} ..= {expr1} Like ":let {var} = {var} .. {expr1}". |
| 114 | 11116 These fail if {var} was not set yet and when the type |
| 11117 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
|
11118 `.=` 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
|
11119 later, see |vimscript-version|. |
| 114 | 11120 |
| 11121 | |
| 7 | 11122 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 11123 Set environment variable {env-name} to the result of | |
| 11124 the expression {expr1}. The type is always String. | |
| 114 | 11125 :let ${env-name} .= {expr1} |
| 11126 Append {expr1} to the environment variable {env-name}. | |
| 11127 If the environment variable didn't exist yet this | |
| 11128 works like "=". | |
| 7 | 11129 |
| 11130 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 11131 Write the result of the expression {expr1} in register | |
| 11132 {reg-name}. {reg-name} must be a single letter, and | |
| 11133 must be the name of a writable register (see | |
| 11134 |registers|). "@@" can be used for the unnamed | |
| 11135 register, "@/" for the search pattern. | |
| 11136 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 11137 register will be linewise, otherwise it will be set to | |
| 11138 characterwise. | |
| 11139 This can be used to clear the last search pattern: > | |
| 11140 :let @/ = "" | |
| 11141 < This is different from searching for an empty string, | |
| 11142 that would match everywhere. | |
| 11143 | |
| 114 | 11144 :let @{reg-name} .= {expr1} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
11145 Append {expr1} to register {reg-name}. If the |
| 114 | 11146 register was empty it's like setting it to {expr1}. |
| 11147 | |
| 1156 | 11148 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 11149 Set option {option-name} to the result of the |
| 68 | 11150 expression {expr1}. A String or Number value is |
| 11151 always converted to the type of the option. | |
| 7 | 11152 For an option local to a window or buffer the effect |
| 11153 is just like using the |:set| command: both the local | |
| 555 | 11154 value and the global value are changed. |
| 68 | 11155 Example: > |
| 11156 :let &path = &path . ',/usr/local/include' | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11157 < This also works for terminal codes in the form t_xx. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11158 But only for alphanumerical names. Example: > |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11159 :let &t_k1 = "\<Esc>[234;" |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11160 < 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
|
11161 a terminal key code, there is no error. |
| 7 | 11162 |
| 114 | 11163 :let &{option-name} .= {expr1} |
| 11164 For a string option: Append {expr1} to the value. | |
| 11165 Does not insert a comma like |:set+=|. | |
| 11166 | |
| 11167 :let &{option-name} += {expr1} | |
| 11168 :let &{option-name} -= {expr1} | |
| 11169 For a number or boolean option: Add or subtract | |
| 11170 {expr1}. | |
| 11171 | |
| 7 | 11172 :let &l:{option-name} = {expr1} |
| 114 | 11173 :let &l:{option-name} .= {expr1} |
| 11174 :let &l:{option-name} += {expr1} | |
| 11175 :let &l:{option-name} -= {expr1} | |
| 7 | 11176 Like above, but only set the local value of an option |
| 11177 (if there is one). Works like |:setlocal|. | |
| 11178 | |
| 11179 :let &g:{option-name} = {expr1} | |
| 114 | 11180 :let &g:{option-name} .= {expr1} |
| 11181 :let &g:{option-name} += {expr1} | |
| 11182 :let &g:{option-name} -= {expr1} | |
| 7 | 11183 Like above, but only set the global value of an option |
| 11184 (if there is one). Works like |:setglobal|. | |
| 11185 | |
| 85 | 11186 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 11187 {expr1} must evaluate to a |List|. The first item in |
| 68 | 11188 the list is assigned to {name1}, the second item to |
| 11189 {name2}, etc. | |
| 11190 The number of names must match the number of items in | |
| 685 | 11191 the |List|. |
| 68 | 11192 Each name can be one of the items of the ":let" |
| 11193 command as mentioned above. | |
| 11194 Example: > | |
| 11195 :let [s, item] = GetItem(s) | |
| 114 | 11196 < Detail: {expr1} is evaluated first, then the |
| 11197 assignments are done in sequence. This matters if | |
| 11198 {name2} depends on {name1}. Example: > | |
| 11199 :let x = [0, 1] | |
| 11200 :let i = 0 | |
| 11201 :let [i, x[i]] = [1, 2] | |
| 11202 :echo x | |
| 11203 < The result is [0, 2]. | |
| 11204 | |
| 11205 :let [{name1}, {name2}, ...] .= {expr1} | |
| 11206 :let [{name1}, {name2}, ...] += {expr1} | |
| 11207 :let [{name1}, {name2}, ...] -= {expr1} | |
| 11208 Like above, but append/add/subtract the value for each | |
| 685 | 11209 |List| item. |
| 68 | 11210 |
| 11211 :let [{name}, ..., ; {lastname}] = {expr1} | |
| 685 | 11212 Like |:let-unpack| above, but the |List| may have more |
| 114 | 11213 items than there are names. A list of the remaining |
| 11214 items is assigned to {lastname}. If there are no | |
| 11215 remaining items {lastname} is set to an empty list. | |
| 68 | 11216 Example: > |
| 11217 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 11218 < | |
| 114 | 11219 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 11220 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 11221 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 11222 Like above, but append/add/subtract the value for each | |
| 685 | 11223 |List| item. |
| 2596 | 11224 |
| 11225 *E121* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
11226 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 11227 variable names may be given. Special names recognized |
| 11228 here: *E738* | |
| 777 | 11229 g: global variables |
| 11230 b: local buffer variables | |
| 11231 w: local window variables | |
| 819 | 11232 t: local tab page variables |
| 777 | 11233 s: script-local variables |
| 11234 l: local function variables | |
| 123 | 11235 v: Vim variables. |
| 7 | 11236 |
| 55 | 11237 :let List the values of all variables. The type of the |
| 11238 variable is indicated before the value: | |
| 11239 <nothing> String | |
| 11240 # Number | |
| 856 | 11241 * Funcref |
| 7 | 11242 |
| 148 | 11243 |
| 1156 | 11244 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 11245 Remove the internal variable {name}. Several variable |
| 11246 names can be given, they are all removed. The name | |
| 685 | 11247 may also be a |List| or |Dictionary| item. |
| 7 | 11248 With [!] no error message is given for non-existing |
| 11249 variables. | |
| 685 | 11250 One or more items from a |List| can be removed: > |
| 108 | 11251 :unlet list[3] " remove fourth item |
| 11252 :unlet list[3:] " remove fourth item to last | |
| 685 | 11253 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 11254 :unlet dict['two'] |
| 11255 :unlet dict.two | |
| 1668 | 11256 < This is especially useful to clean up used global |
| 11257 variables and script-local variables (these are not | |
| 11258 deleted when the script ends). Function-local | |
| 11259 variables are automatically deleted when the function | |
| 11260 ends. | |
| 7 | 11261 |
|
13923
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
11262 :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
|
11263 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
|
11264 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
|
11265 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
|
11266 variable, also without !. |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
11267 If the system does not support deleting an environment |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
11268 variable, it is made emtpy. |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
11269 |
| 148 | 11270 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 11271 Lock the internal variable {name}. Locking means that | |
| 11272 it can no longer be changed (until it is unlocked). | |
| 11273 A locked variable can be deleted: > | |
| 11274 :lockvar v | |
| 11275 :let v = 'asdf' " fails! | |
| 11276 :unlet v | |
|
10908
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
11277 < *E741* *E940* |
| 148 | 11278 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
|
11279 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
|
11280 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
|
11281 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
|
11282 variable {name}". |
| 148 | 11283 |
| 685 | 11284 [depth] is relevant when locking a |List| or |
| 11285 |Dictionary|. It specifies how deep the locking goes: | |
| 11286 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 11287 cannot add or remove items, but can |
| 11288 still change their values. | |
| 11289 2 Also lock the values, cannot change | |
| 685 | 11290 the items. If an item is a |List| or |
| 11291 |Dictionary|, cannot add or remove | |
| 148 | 11292 items, but can still change the |
| 11293 values. | |
| 685 | 11294 3 Like 2 but for the |List| / |
| 11295 |Dictionary| in the |List| / | |
| 11296 |Dictionary|, one level deeper. | |
| 11297 The default [depth] is 2, thus when {name} is a |List| | |
| 11298 or |Dictionary| the values cannot be changed. | |
| 148 | 11299 *E743* |
| 11300 For unlimited depth use [!] and omit [depth]. | |
| 11301 However, there is a maximum depth of 100 to catch | |
| 11302 loops. | |
| 11303 | |
| 685 | 11304 Note that when two variables refer to the same |List| |
| 11305 and you lock one of them, the |List| will also be | |
| 819 | 11306 locked when used through the other variable. |
| 11307 Example: > | |
| 148 | 11308 :let l = [0, 1, 2, 3] |
| 11309 :let cl = l | |
| 11310 :lockvar l | |
| 11311 :let cl[1] = 99 " won't work! | |
| 11312 < You may want to make a copy of a list to avoid this. | |
| 11313 See |deepcopy()|. | |
| 11314 | |
| 11315 | |
| 11316 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 11317 Unlock the internal variable {name}. Does the | |
| 11318 opposite of |:lockvar|. | |
| 11319 | |
| 11320 | |
| 7 | 11321 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
| 11322 :en[dif] Execute the commands until the next matching ":else" | |
| 11323 or ":endif" if {expr1} evaluates to non-zero. | |
| 11324 | |
| 11325 From Vim version 4.5 until 5.0, every Ex command in | |
| 11326 between the ":if" and ":endif" is ignored. These two | |
| 11327 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
|
11328 backward compatible way. Nesting was allowed. Note |
| 7 | 11329 that any ":else" or ":elseif" was ignored, the "else" |
| 11330 part was not executed either. | |
| 11331 | |
| 11332 You can use this to remain compatible with older | |
| 11333 versions: > | |
| 11334 :if version >= 500 | |
| 11335 : version-5-specific-commands | |
| 11336 :endif | |
| 11337 < The commands still need to be parsed to find the | |
| 11338 "endif". Sometimes an older Vim has a problem with a | |
| 11339 new command. For example, ":silent" is recognized as | |
| 11340 a ":substitute" command. In that case ":execute" can | |
| 11341 avoid problems: > | |
| 11342 :if version >= 600 | |
| 11343 : execute "silent 1,$delete" | |
| 11344 :endif | |
| 11345 < | |
| 11346 NOTE: The ":append" and ":insert" commands don't work | |
| 11347 properly in between ":if" and ":endif". | |
| 11348 | |
| 11349 *:else* *:el* *E581* *E583* | |
| 11350 :el[se] Execute the commands until the next matching ":else" | |
| 11351 or ":endif" if they previously were not being | |
| 11352 executed. | |
| 11353 | |
| 11354 *:elseif* *:elsei* *E582* *E584* | |
| 11355 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 11356 is no extra ":endif". | |
| 11357 | |
| 11358 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 11359 *E170* *E585* *E588* *E733* |
| 7 | 11360 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 11361 as long as {expr1} evaluates to non-zero. | |
| 11362 When an error is detected from a command inside the | |
| 11363 loop, execution continues after the "endwhile". | |
| 75 | 11364 Example: > |
| 11365 :let lnum = 1 | |
| 11366 :while lnum <= line("$") | |
| 11367 :call FixLine(lnum) | |
| 11368 :let lnum = lnum + 1 | |
| 11369 :endwhile | |
| 11370 < | |
| 7 | 11371 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 11372 properly inside a ":while" and ":for" loop. |
| 75 | 11373 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
11374 :for {var} in {object} *:for* *E690* *E732* |
| 75 | 11375 :endfo[r] *:endfo* *:endfor* |
| 11376 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
|
11377 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
|
11378 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
|
11379 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
|
11380 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
|
11381 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
|
11382 are used. Make a copy if this is unwanted: > |
| 79 | 11383 :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
|
11384 < |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
11385 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
|
11386 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
|
11387 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
|
11388 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
|
11389 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
|
11390 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
|
11391 to make a |List| empty): > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
11392 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
11393 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
11394 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
|
11395 < Note that reordering the |List| (e.g., with sort() or |
| 87 | 11396 reverse()) may have unexpected effects. |
| 75 | 11397 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
11398 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
|
11399 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
|
11400 |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
|
11401 |
| 75 | 11402 :for [{var1}, {var2}, ...] in {listlist} |
| 11403 :endfo[r] | |
| 11404 Like ":for" above, but each item in {listlist} must be | |
| 11405 a list, of which each item is assigned to {var1}, | |
| 11406 {var2}, etc. Example: > | |
| 11407 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 11408 :echo getline(lnum)[col] | |
| 11409 :endfor | |
| 11410 < | |
| 7 | 11411 *:continue* *:con* *E586* |
| 75 | 11412 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 11413 to the start of the loop. | |
| 11414 If it is used after a |:try| inside the loop but | |
| 11415 before the matching |:finally| (if present), the | |
| 11416 commands following the ":finally" up to the matching | |
| 11417 |:endtry| are executed first. This process applies to | |
| 11418 all nested ":try"s inside the loop. The outermost | |
| 11419 ":endtry" then jumps back to the start of the loop. | |
| 7 | 11420 |
| 11421 *:break* *:brea* *E587* | |
| 75 | 11422 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 11423 the command after the matching ":endwhile" or | |
| 11424 ":endfor". | |
| 11425 If it is used after a |:try| inside the loop but | |
| 11426 before the matching |:finally| (if present), the | |
| 11427 commands following the ":finally" up to the matching | |
| 11428 |:endtry| are executed first. This process applies to | |
| 11429 all nested ":try"s inside the loop. The outermost | |
| 11430 ":endtry" then jumps to the command after the loop. | |
| 7 | 11431 |
| 11432 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 11433 :endt[ry] Change the error handling for the commands between | |
| 11434 ":try" and ":endtry" including everything being | |
| 11435 executed across ":source" commands, function calls, | |
| 11436 or autocommand invocations. | |
| 11437 | |
| 11438 When an error or interrupt is detected and there is | |
| 11439 a |:finally| command following, execution continues | |
| 11440 after the ":finally". Otherwise, or when the | |
| 11441 ":endtry" is reached thereafter, the next | |
| 11442 (dynamically) surrounding ":try" is checked for | |
| 11443 a corresponding ":finally" etc. Then the script | |
| 11444 processing is terminated. (Whether a function | |
| 11445 definition has an "abort" argument does not matter.) | |
| 11446 Example: > | |
| 11447 :try | edit too much | finally | echo "cleanup" | endtry | |
| 11448 :echo "impossible" " not reached, script terminated above | |
| 11449 < | |
| 11450 Moreover, an error or interrupt (dynamically) inside | |
| 11451 ":try" and ":endtry" is converted to an exception. It | |
| 11452 can be caught as if it were thrown by a |:throw| | |
| 11453 command (see |:catch|). In this case, the script | |
| 11454 processing is not terminated. | |
| 11455 | |
| 11456 The value "Vim:Interrupt" is used for an interrupt | |
| 11457 exception. An error in a Vim command is converted | |
| 11458 to a value of the form "Vim({command}):{errmsg}", | |
| 11459 other errors are converted to a value of the form | |
| 11460 "Vim:{errmsg}". {command} is the full command name, | |
| 11461 and {errmsg} is the message that is displayed if the | |
| 11462 error exception is not caught, always beginning with | |
| 11463 the error number. | |
| 11464 Examples: > | |
| 11465 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
| 11466 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 11467 < | |
| 11468 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
11469 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 11470 |:finally|, or |:endtry| that belongs to the same |
| 11471 |:try| as the ":catch" are executed when an exception | |
| 11472 matching {pattern} is being thrown and has not yet | |
| 11473 been caught by a previous ":catch". Otherwise, these | |
| 11474 commands are skipped. | |
| 11475 When {pattern} is omitted all errors are caught. | |
| 11476 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
|
11477 :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
|
11478 :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
|
11479 :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
|
11480 :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
|
11481 :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
|
11482 :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
|
11483 :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
|
11484 :catch " same as /.*/ |
| 7 | 11485 < |
| 11486 Another character can be used instead of / around the | |
| 11487 {pattern}, so long as it does not have a special | |
| 11488 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 11489 {pattern}. | |
| 5814 | 11490 Information about the exception is available in |
| 11491 |v:exception|. Also see |throw-variables|. | |
| 7 | 11492 NOTE: It is not reliable to ":catch" the TEXT of |
| 11493 an error message because it may vary in different | |
| 11494 locales. | |
| 11495 | |
| 11496 *:fina* *:finally* *E606* *E607* | |
| 11497 :fina[lly] The following commands until the matching |:endtry| | |
| 11498 are executed whenever the part between the matching | |
| 11499 |:try| and the ":finally" is left: either by falling | |
| 11500 through to the ":finally" or by a |:continue|, | |
| 11501 |:break|, |:finish|, or |:return|, or by an error or | |
| 11502 interrupt or exception (see |:throw|). | |
| 11503 | |
| 11504 *:th* *:throw* *E608* | |
| 11505 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 11506 If the ":throw" is used after a |:try| but before the | |
| 11507 first corresponding |:catch|, commands are skipped | |
| 11508 until the first ":catch" matching {expr1} is reached. | |
| 11509 If there is no such ":catch" or if the ":throw" is | |
| 11510 used after a ":catch" but before the |:finally|, the | |
| 11511 commands following the ":finally" (if present) up to | |
| 11512 the matching |:endtry| are executed. If the ":throw" | |
| 11513 is after the ":finally", commands up to the ":endtry" | |
| 11514 are skipped. At the ":endtry", this process applies | |
| 11515 again for the next dynamically surrounding ":try" | |
| 11516 (which may be found in a calling function or sourcing | |
| 11517 script), until a matching ":catch" has been found. | |
| 11518 If the exception is not caught, the command processing | |
| 11519 is terminated. | |
| 11520 Example: > | |
| 11521 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 11522 < Note that "catch" may need to be on a separate line |
| 11523 for when an error causes the parsing to skip the whole | |
| 11524 line and not see the "|" that separates the commands. | |
| 7 | 11525 |
| 11526 *:ec* *:echo* | |
| 11527 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 11528 first {expr1} starts on a new line. | |
| 11529 Also see |:comment|. | |
| 11530 Use "\n" to start a new line. Use "\r" to move the | |
| 11531 cursor to the first column. | |
| 11532 Uses the highlighting set by the |:echohl| command. | |
| 11533 Cannot be followed by a comment. | |
| 11534 Example: > | |
| 11535 :echo "the value of 'shell' is" &shell | |
| 1156 | 11536 < *:echo-redraw* |
| 11537 A later redraw may make the message disappear again. | |
| 11538 And since Vim mostly postpones redrawing until it's | |
| 11539 finished with a sequence of commands this happens | |
| 11540 quite often. To avoid that a command from before the | |
| 11541 ":echo" causes a redraw afterwards (redraws are often | |
| 11542 postponed until you type something), force a redraw | |
| 11543 with the |:redraw| command. Example: > | |
| 7 | 11544 :new | redraw | echo "there is a new window" |
| 11545 < | |
| 11546 *:echon* | |
| 11547 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 11548 |:comment|. | |
| 11549 Uses the highlighting set by the |:echohl| command. | |
| 11550 Cannot be followed by a comment. | |
| 11551 Example: > | |
| 11552 :echon "the value of 'shell' is " &shell | |
| 11553 < | |
| 11554 Note the difference between using ":echo", which is a | |
| 11555 Vim command, and ":!echo", which is an external shell | |
| 11556 command: > | |
| 11557 :!echo % --> filename | |
| 11558 < The arguments of ":!" are expanded, see |:_%|. > | |
| 11559 :!echo "%" --> filename or "filename" | |
| 11560 < Like the previous example. Whether you see the double | |
| 11561 quotes or not depends on your 'shell'. > | |
| 11562 :echo % --> nothing | |
| 11563 < The '%' is an illegal character in an expression. > | |
| 11564 :echo "%" --> % | |
| 11565 < This just echoes the '%' character. > | |
| 11566 :echo expand("%") --> filename | |
| 11567 < This calls the expand() function to expand the '%'. | |
| 11568 | |
| 11569 *:echoh* *:echohl* | |
| 11570 :echoh[l] {name} Use the highlight group {name} for the following | |
| 11571 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 11572 for the |input()| prompt. Example: > | |
| 11573 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 11574 < Don't forget to set the group back to "None", | |
| 11575 otherwise all following echo's will be highlighted. | |
| 11576 | |
| 11577 *:echom* *:echomsg* | |
| 11578 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 11579 message in the |message-history|. | |
| 11580 Spaces are placed between the arguments as with the | |
| 11581 |:echo| command. But unprintable characters are | |
| 11582 displayed, not interpreted. | |
| 1156 | 11583 The parsing works slightly different from |:echo|, |
| 11584 more like |:execute|. All the expressions are first | |
| 11585 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
|
11586 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
|
11587 String, string() is used to turn it into a string. |
| 7 | 11588 Uses the highlighting set by the |:echohl| command. |
| 11589 Example: > | |
| 11590 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 11591 < See |:echo-redraw| to avoid the message disappearing |
| 11592 when the screen is redrawn. | |
| 7 | 11593 *:echoe* *:echoerr* |
| 11594 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 11595 message in the |message-history|. When used in a | |
| 11596 script or function the line number will be added. | |
| 11597 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
|
11598 |:echomsg| command. When used inside a try conditional, |
| 7 | 11599 the message is raised as an error exception instead |
| 11600 (see |try-echoerr|). | |
| 11601 Example: > | |
| 11602 :echoerr "This script just failed!" | |
| 11603 < If you just want a highlighted message use |:echohl|. | |
| 11604 And to get a beep: > | |
| 11605 :exe "normal \<Esc>" | |
| 11606 < | |
| 11607 *:exe* *:execute* | |
| 11608 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 11609 of {expr1} as an Ex command. |
| 11610 Multiple arguments are concatenated, with a space in | |
| 11611 between. To avoid the extra space use the "." | |
| 11612 operator to concatenate strings into one argument. | |
| 11613 {expr1} is used as the processed command, command line | |
| 11614 editing keys are not recognized. | |
| 7 | 11615 Cannot be followed by a comment. |
| 11616 Examples: > | |
| 2152 | 11617 :execute "buffer" nextbuf |
| 11618 :execute "normal" count . "w" | |
| 7 | 11619 < |
| 11620 ":execute" can be used to append a command to commands | |
| 11621 that don't accept a '|'. Example: > | |
| 11622 :execute '!ls' | echo "theend" | |
| 11623 | |
| 11624 < ":execute" is also a nice way to avoid having to type | |
| 11625 control characters in a Vim script for a ":normal" | |
| 11626 command: > | |
| 11627 :execute "normal ixxx\<Esc>" | |
| 11628 < This has an <Esc> character, see |expr-string|. | |
| 11629 | |
| 1621 | 11630 Be careful to correctly escape special characters in |
| 11631 file names. The |fnameescape()| function can be used | |
| 1661 | 11632 for Vim commands, |shellescape()| for |:!| commands. |
| 11633 Examples: > | |
| 1621 | 11634 :execute "e " . fnameescape(filename) |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
11635 :execute "!ls " . shellescape(filename, 1) |
| 1621 | 11636 < |
| 7 | 11637 Note: The executed string may be any command-line, but |
| 5763 | 11638 starting or ending "if", "while" and "for" does not |
| 11639 always work, because when commands are skipped the | |
| 11640 ":execute" is not evaluated and Vim loses track of | |
| 11641 where blocks start and end. Also "break" and | |
| 11642 "continue" should not be inside ":execute". | |
| 11643 This example does not work, because the ":execute" is | |
| 11644 not evaluated and Vim does not see the "while", and | |
| 11645 gives an error for finding an ":endwhile": > | |
| 11646 :if 0 | |
| 11647 : execute 'while i > 5' | |
| 11648 : echo "test" | |
| 11649 : endwhile | |
| 11650 :endif | |
| 7 | 11651 < |
| 11652 It is allowed to have a "while" or "if" command | |
| 11653 completely in the executed string: > | |
| 11654 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 11655 < | |
| 11656 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
11657 *:exe-comment* |
| 7 | 11658 ":execute", ":echo" and ":echon" cannot be followed by |
| 11659 a comment directly, because they see the '"' as the | |
| 11660 start of a string. But, you can use '|' followed by a | |
| 11661 comment. Example: > | |
| 11662 :echo "foo" | "this is a comment | |
| 11663 | |
| 11664 ============================================================================== | |
| 11665 8. Exception handling *exception-handling* | |
| 11666 | |
| 11667 The Vim script language comprises an exception handling feature. This section | |
| 11668 explains how it can be used in a Vim script. | |
| 11669 | |
| 11670 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 11671 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 11672 exception by using the ":throw" command, see |throw-catch|. | |
| 11673 | |
| 11674 | |
| 11675 TRY CONDITIONALS *try-conditionals* | |
| 11676 | |
| 11677 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 11678 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 11679 a finally clause (to be executed for cleanup). | |
| 11680 A try conditional begins with a |:try| command and ends at the matching | |
| 11681 |:endtry| command. In between, you can use a |:catch| command to start | |
| 11682 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 11683 be none or multiple catch clauses, but there is at most one finally clause, | |
| 11684 which must not be followed by any catch clauses. The lines before the catch | |
| 11685 clauses and the finally clause is called a try block. > | |
| 11686 | |
| 11687 :try | |
| 1621 | 11688 : ... |
| 11689 : ... TRY BLOCK | |
| 11690 : ... | |
| 7 | 11691 :catch /{pattern}/ |
| 1621 | 11692 : ... |
| 11693 : ... CATCH CLAUSE | |
| 11694 : ... | |
| 7 | 11695 :catch /{pattern}/ |
| 1621 | 11696 : ... |
| 11697 : ... CATCH CLAUSE | |
| 11698 : ... | |
| 7 | 11699 :finally |
| 1621 | 11700 : ... |
| 11701 : ... FINALLY CLAUSE | |
| 11702 : ... | |
| 7 | 11703 :endtry |
| 11704 | |
| 11705 The try conditional allows to watch code for exceptions and to take the | |
| 11706 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 11707 from the try block and also the catch clauses may cause cleanup actions. | |
| 11708 When no exception is thrown during execution of the try block, the control | |
| 11709 is transferred to the finally clause, if present. After its execution, the | |
| 11710 script continues with the line following the ":endtry". | |
| 11711 When an exception occurs during execution of the try block, the remaining | |
| 11712 lines in the try block are skipped. The exception is matched against the | |
| 11713 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 11714 after the first matching ":catch" is taken, other catch clauses are not | |
| 11715 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 11716 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 11717 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 11718 continues in the following line as usual. | |
| 11719 When an exception that does not match any of the patterns specified by the | |
| 11720 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 11721 that try conditional and none of the catch clauses is executed. Only the | |
| 11722 finally clause, if present, is taken. The exception pends during execution of | |
| 11723 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 11724 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 11725 see |try-nesting|. | |
| 11726 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
|
11727 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 11728 not matched against the patterns in any of the ":catch" commands of the same |
| 11729 try conditional and none of its catch clauses is taken. If there is, however, | |
| 11730 a finally clause, it is executed, and the exception pends during its | |
| 11731 execution. The commands following the ":endtry" are not executed. The new | |
| 11732 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 11733 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
|
11734 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 11735 clause has been taken because of an exception from the try block or one of the |
| 11736 catch clauses, the original (pending) exception is discarded. The commands | |
| 11737 following the ":endtry" are not executed, and the exception from the finally | |
| 11738 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 11739 | |
| 11740 The finally clause is also executed, when a ":break" or ":continue" for | |
| 11741 a ":while" loop enclosing the complete try conditional is executed from the | |
| 11742 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 11743 from the try block or a catch clause of a try conditional in a function or | |
| 11744 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 11745 ":finish" pends during execution of the finally clause and is resumed when the | |
| 11746 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 11747 from the finally clause. | |
| 11748 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 11749 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 11750 clause, the rest of the finally clause is skipped, and the ":break", | |
| 11751 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 11752 clause has been taken because of an exception or an earlier ":break", | |
| 11753 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 11754 this pending exception or command is discarded. | |
| 11755 | |
| 11756 For examples see |throw-catch| and |try-finally|. | |
| 11757 | |
| 11758 | |
| 11759 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 11760 | |
| 11761 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 11762 conditional can be put into the try block, a catch clause, or the finally | |
| 11763 clause of another try conditional. If the inner try conditional does not | |
| 11764 catch an exception thrown in its try block or throws a new exception from one | |
| 11765 of its catch clauses or its finally clause, the outer try conditional is | |
| 11766 checked according to the rules above. If the inner try conditional is in the | |
| 11767 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
|
11768 otherwise only the finally clause is executed. It does not matter for |
| 7 | 11769 nesting, whether the inner try conditional is directly contained in the outer |
| 11770 one, or whether the outer one sources a script or calls a function containing | |
| 11771 the inner try conditional. | |
| 11772 | |
| 11773 When none of the active try conditionals catches an exception, just their | |
| 11774 finally clauses are executed. Thereafter, the script processing terminates. | |
| 11775 An error message is displayed in case of an uncaught exception explicitly | |
| 11776 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 11777 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 11778 as usual. | |
| 11779 | |
| 11780 For examples see |throw-catch|. | |
| 11781 | |
| 11782 | |
| 11783 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 11784 | |
| 11785 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 11786 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 11787 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 11788 finished. When using a verbosity level of at least 14, things pending in | |
| 11789 a finally clause are also shown. This information is also given in debug mode | |
| 11790 (see |debug-scripts|). | |
| 11791 | |
| 11792 | |
| 11793 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 11794 | |
| 11795 You can throw any number or string as an exception. Use the |:throw| command | |
| 11796 and pass the value to be thrown as argument: > | |
| 11797 :throw 4711 | |
| 11798 :throw "string" | |
| 11799 < *throw-expression* | |
| 11800 You can also specify an expression argument. The expression is then evaluated | |
| 11801 first, and the result is thrown: > | |
| 11802 :throw 4705 + strlen("string") | |
| 11803 :throw strpart("strings", 0, 6) | |
| 11804 | |
| 11805 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 11806 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 11807 The ":throw" command then does not throw a new exception. | |
| 11808 Example: > | |
| 11809 | |
| 11810 :function! Foo(arg) | |
| 11811 : try | |
| 11812 : throw a:arg | |
| 11813 : catch /foo/ | |
| 11814 : endtry | |
| 11815 : return 1 | |
| 11816 :endfunction | |
| 11817 : | |
| 11818 :function! Bar() | |
| 11819 : echo "in Bar" | |
| 11820 : return 4710 | |
| 11821 :endfunction | |
| 11822 : | |
| 11823 :throw Foo("arrgh") + Bar() | |
| 11824 | |
| 11825 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 11826 executed. > | |
| 11827 :throw Foo("foo") + Bar() | |
| 11828 however displays "in Bar" and throws 4711. | |
| 11829 | |
| 11830 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
|
11831 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 11832 exception is then propagated to the caller of the command. |
| 11833 Example: > | |
| 11834 | |
| 11835 :if Foo("arrgh") | |
| 11836 : echo "then" | |
| 11837 :else | |
| 11838 : echo "else" | |
| 11839 :endif | |
| 11840 | |
| 11841 Here neither of "then" or "else" is displayed. | |
| 11842 | |
| 11843 *catch-order* | |
| 11844 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 11845 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 11846 command can be specified as a pattern argument. The subsequent catch clause | |
| 11847 gets executed when a matching exception is caught. | |
| 11848 Example: > | |
| 11849 | |
| 11850 :function! Foo(value) | |
| 11851 : try | |
| 11852 : throw a:value | |
| 11853 : catch /^\d\+$/ | |
| 11854 : echo "Number thrown" | |
| 11855 : catch /.*/ | |
| 11856 : echo "String thrown" | |
| 11857 : endtry | |
| 11858 :endfunction | |
| 11859 : | |
| 11860 :call Foo(0x1267) | |
| 11861 :call Foo('string') | |
| 11862 | |
| 11863 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 11864 An exception is matched against the ":catch" commands in the order they are | |
| 11865 specified. Only the first match counts. So you should place the more | |
| 11866 specific ":catch" first. The following order does not make sense: > | |
| 11867 | |
| 11868 : catch /.*/ | |
| 11869 : echo "String thrown" | |
| 11870 : catch /^\d\+$/ | |
| 11871 : echo "Number thrown" | |
| 11872 | |
| 11873 The first ":catch" here matches always, so that the second catch clause is | |
| 11874 never taken. | |
| 11875 | |
| 11876 *throw-variables* | |
| 11877 If you catch an exception by a general pattern, you may access the exact value | |
| 11878 in the variable |v:exception|: > | |
| 11879 | |
| 11880 : catch /^\d\+$/ | |
| 11881 : echo "Number thrown. Value is" v:exception | |
| 11882 | |
| 11883 You may also be interested where an exception was thrown. This is stored in | |
| 11884 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 11885 exception most recently caught as long it is not finished. | |
| 11886 Example: > | |
| 11887 | |
| 11888 :function! Caught() | |
| 11889 : if v:exception != "" | |
| 11890 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 11891 : else | |
| 11892 : echo 'Nothing caught' | |
| 11893 : endif | |
| 11894 :endfunction | |
| 11895 : | |
| 11896 :function! Foo() | |
| 11897 : try | |
| 11898 : try | |
| 11899 : try | |
| 11900 : throw 4711 | |
| 11901 : finally | |
| 11902 : call Caught() | |
| 11903 : endtry | |
| 11904 : catch /.*/ | |
| 11905 : call Caught() | |
| 11906 : throw "oops" | |
| 11907 : endtry | |
| 11908 : catch /.*/ | |
| 11909 : call Caught() | |
| 11910 : finally | |
| 11911 : call Caught() | |
| 11912 : endtry | |
| 11913 :endfunction | |
| 11914 : | |
| 11915 :call Foo() | |
| 11916 | |
| 11917 This displays > | |
| 11918 | |
| 11919 Nothing caught | |
| 11920 Caught "4711" in function Foo, line 4 | |
| 11921 Caught "oops" in function Foo, line 10 | |
| 11922 Nothing caught | |
| 11923 | |
| 11924 A practical example: The following command ":LineNumber" displays the line | |
| 11925 number in the script or function where it has been used: > | |
| 11926 | |
| 11927 :function! LineNumber() | |
| 11928 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 11929 :endfunction | |
| 11930 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 11931 < | |
| 11932 *try-nested* | |
| 11933 An exception that is not caught by a try conditional can be caught by | |
| 11934 a surrounding try conditional: > | |
| 11935 | |
| 11936 :try | |
| 11937 : try | |
| 11938 : throw "foo" | |
| 11939 : catch /foobar/ | |
| 11940 : echo "foobar" | |
| 11941 : finally | |
| 11942 : echo "inner finally" | |
| 11943 : endtry | |
| 11944 :catch /foo/ | |
| 11945 : echo "foo" | |
| 11946 :endtry | |
| 11947 | |
| 11948 The inner try conditional does not catch the exception, just its finally | |
| 11949 clause is executed. The exception is then caught by the outer try | |
| 11950 conditional. The example displays "inner finally" and then "foo". | |
| 11951 | |
| 11952 *throw-from-catch* | |
| 11953 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 11954 catch clause: > | |
| 11955 | |
| 11956 :function! Foo() | |
| 11957 : throw "foo" | |
| 11958 :endfunction | |
| 11959 : | |
| 11960 :function! Bar() | |
| 11961 : try | |
| 11962 : call Foo() | |
| 11963 : catch /foo/ | |
| 11964 : echo "Caught foo, throw bar" | |
| 11965 : throw "bar" | |
| 11966 : endtry | |
| 11967 :endfunction | |
| 11968 : | |
| 11969 :try | |
| 11970 : call Bar() | |
| 11971 :catch /.*/ | |
| 11972 : echo "Caught" v:exception | |
| 11973 :endtry | |
| 11974 | |
| 11975 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 11976 | |
| 11977 *rethrow* | |
| 11978 There is no real rethrow in the Vim script language, but you may throw | |
| 11979 "v:exception" instead: > | |
| 11980 | |
| 11981 :function! Bar() | |
| 11982 : try | |
| 11983 : call Foo() | |
| 11984 : catch /.*/ | |
| 11985 : echo "Rethrow" v:exception | |
| 11986 : throw v:exception | |
| 11987 : endtry | |
| 11988 :endfunction | |
| 11989 < *try-echoerr* | |
| 11990 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 11991 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 11992 Trying so causes an error exception. You should throw your own exception | |
| 11993 denoting the situation. If you want to cause a Vim error exception containing | |
| 11994 the original error exception value, you can use the |:echoerr| command: > | |
| 11995 | |
| 11996 :try | |
| 11997 : try | |
| 11998 : asdf | |
| 11999 : catch /.*/ | |
| 12000 : echoerr v:exception | |
| 12001 : endtry | |
| 12002 :catch /.*/ | |
| 12003 : echo v:exception | |
| 12004 :endtry | |
| 12005 | |
| 12006 This code displays | |
| 12007 | |
| 1621 | 12008 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 12009 |
| 12010 | |
| 12011 CLEANUP CODE *try-finally* | |
| 12012 | |
| 12013 Scripts often change global settings and restore them at their end. If the | |
| 12014 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
|
12015 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 12016 a script when an error occurs or you explicitly throw an exception without |
| 12017 catching it. You can solve these problems by using a try conditional with | |
| 12018 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 12019 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 12020 (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
|
12021 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 12022 clause has been executed.) |
| 12023 Example: > | |
| 12024 | |
| 12025 :try | |
| 12026 : let s:saved_ts = &ts | |
| 12027 : set ts=17 | |
| 12028 : | |
| 12029 : " Do the hard work here. | |
| 12030 : | |
| 12031 :finally | |
| 12032 : let &ts = s:saved_ts | |
| 12033 : unlet s:saved_ts | |
| 12034 :endtry | |
| 12035 | |
| 12036 This method should be used locally whenever a function or part of a script | |
| 12037 changes global settings which need to be restored on failure or normal exit of | |
| 12038 that function or script part. | |
| 12039 | |
| 12040 *break-finally* | |
| 12041 Cleanup code works also when the try block or a catch clause is left by | |
| 12042 a ":continue", ":break", ":return", or ":finish". | |
| 12043 Example: > | |
| 12044 | |
| 12045 :let first = 1 | |
| 12046 :while 1 | |
| 12047 : try | |
| 12048 : if first | |
| 12049 : echo "first" | |
| 12050 : let first = 0 | |
| 12051 : continue | |
| 12052 : else | |
| 12053 : throw "second" | |
| 12054 : endif | |
| 12055 : catch /.*/ | |
| 12056 : echo v:exception | |
| 12057 : break | |
| 12058 : finally | |
| 12059 : echo "cleanup" | |
| 12060 : endtry | |
| 12061 : echo "still in while" | |
| 12062 :endwhile | |
| 12063 :echo "end" | |
| 12064 | |
| 12065 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 12066 | |
| 12067 :function! Foo() | |
| 12068 : try | |
| 12069 : return 4711 | |
| 12070 : finally | |
| 12071 : echo "cleanup\n" | |
| 12072 : endtry | |
| 12073 : echo "Foo still active" | |
| 12074 :endfunction | |
| 12075 : | |
| 12076 :echo Foo() "returned by Foo" | |
| 12077 | |
| 12078 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
|
12079 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 12080 return value.) |
| 12081 | |
| 12082 *except-from-finally* | |
| 12083 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 12084 a finally clause is possible, but not recommended since it abandons the | |
| 12085 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 12086 exceptions might get raised from a finally clause. | |
| 12087 Example where an error in the finally clause stops an interrupt from | |
| 12088 working correctly: > | |
| 12089 | |
| 12090 :try | |
| 12091 : try | |
| 12092 : echo "Press CTRL-C for interrupt" | |
| 12093 : while 1 | |
| 12094 : endwhile | |
| 12095 : finally | |
| 12096 : unlet novar | |
| 12097 : endtry | |
| 12098 :catch /novar/ | |
| 12099 :endtry | |
| 12100 :echo "Script still running" | |
| 12101 :sleep 1 | |
| 12102 | |
| 12103 If you need to put commands that could fail into a finally clause, you should | |
| 12104 think about catching or ignoring the errors in these commands, see | |
| 12105 |catch-errors| and |ignore-errors|. | |
| 12106 | |
| 12107 | |
| 12108 CATCHING ERRORS *catch-errors* | |
| 12109 | |
| 12110 If you want to catch specific errors, you just have to put the code to be | |
| 12111 watched in a try block and add a catch clause for the error message. The | |
| 12112 presence of the try conditional causes all errors to be converted to an | |
| 12113 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 12114 the right pattern for the ":catch" command, you have to know how the format of | |
| 12115 the error exception is. | |
| 12116 Error exceptions have the following format: > | |
| 12117 | |
| 12118 Vim({cmdname}):{errmsg} | |
| 12119 or > | |
| 12120 Vim:{errmsg} | |
| 12121 | |
| 12122 {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
|
12123 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 12124 when the error occurs outside try conditionals. It always begins with |
| 12125 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 12126 a space. | |
| 12127 | |
| 12128 Examples: | |
| 12129 | |
| 12130 The command > | |
| 12131 :unlet novar | |
| 12132 normally produces the error message > | |
| 12133 E108: No such variable: "novar" | |
| 12134 which is converted inside try conditionals to an exception > | |
| 12135 Vim(unlet):E108: No such variable: "novar" | |
| 12136 | |
| 12137 The command > | |
| 12138 :dwim | |
| 12139 normally produces the error message > | |
| 12140 E492: Not an editor command: dwim | |
| 12141 which is converted inside try conditionals to an exception > | |
| 12142 Vim:E492: Not an editor command: dwim | |
| 12143 | |
| 12144 You can catch all ":unlet" errors by a > | |
| 12145 :catch /^Vim(unlet):/ | |
| 12146 or all errors for misspelled command names by a > | |
| 12147 :catch /^Vim:E492:/ | |
| 12148 | |
| 12149 Some error messages may be produced by different commands: > | |
| 12150 :function nofunc | |
| 12151 and > | |
| 12152 :delfunction nofunc | |
| 12153 both produce the error message > | |
| 12154 E128: Function name must start with a capital: nofunc | |
| 12155 which is converted inside try conditionals to an exception > | |
| 12156 Vim(function):E128: Function name must start with a capital: nofunc | |
| 12157 or > | |
| 12158 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 12159 respectively. You can catch the error by its number independently on the | |
| 12160 command that caused it if you use the following pattern: > | |
| 12161 :catch /^Vim(\a\+):E128:/ | |
| 12162 | |
| 12163 Some commands like > | |
| 12164 :let x = novar | |
| 12165 produce multiple error messages, here: > | |
| 12166 E121: Undefined variable: novar | |
| 12167 E15: Invalid expression: novar | |
| 12168 Only the first is used for the exception value, since it is the most specific | |
| 12169 one (see |except-several-errors|). So you can catch it by > | |
| 12170 :catch /^Vim(\a\+):E121:/ | |
| 12171 | |
| 12172 You can catch all errors related to the name "nofunc" by > | |
| 12173 :catch /\<nofunc\>/ | |
| 12174 | |
| 12175 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 12176 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 12177 | |
| 12178 You can catch all Vim errors by the pattern > | |
| 12179 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 12180 < | |
| 12181 *catch-text* | |
| 12182 NOTE: You should never catch the error message text itself: > | |
| 12183 :catch /No such variable/ | |
| 6647 | 12184 only works in the English locale, but not when the user has selected |
| 7 | 12185 a different language by the |:language| command. It is however helpful to |
| 12186 cite the message text in a comment: > | |
| 12187 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 12188 | |
| 12189 | |
| 12190 IGNORING ERRORS *ignore-errors* | |
| 12191 | |
| 12192 You can ignore errors in a specific Vim command by catching them locally: > | |
| 12193 | |
| 12194 :try | |
| 12195 : write | |
| 12196 :catch | |
| 12197 :endtry | |
| 12198 | |
| 12199 But you are strongly recommended NOT to use this simple form, since it could | |
| 12200 catch more than you want. With the ":write" command, some autocommands could | |
| 12201 be executed and cause errors not related to writing, for instance: > | |
| 12202 | |
| 12203 :au BufWritePre * unlet novar | |
| 12204 | |
| 12205 There could even be such errors you are not responsible for as a script | |
| 12206 writer: a user of your script might have defined such autocommands. You would | |
| 12207 then hide the error from the user. | |
| 12208 It is much better to use > | |
| 12209 | |
| 12210 :try | |
| 12211 : write | |
| 12212 :catch /^Vim(write):/ | |
| 12213 :endtry | |
| 12214 | |
| 12215 which only catches real write errors. So catch only what you'd like to ignore | |
| 12216 intentionally. | |
| 12217 | |
| 12218 For a single command that does not cause execution of autocommands, you could | |
| 12219 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 12220 command: > | |
| 12221 :silent! nunmap k | |
| 12222 This works also when a try conditional is active. | |
| 12223 | |
| 12224 | |
| 12225 CATCHING INTERRUPTS *catch-interrupt* | |
| 12226 | |
| 12227 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
|
12228 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 12229 script is not terminated, then. |
| 12230 Example: > | |
| 12231 | |
| 12232 :function! TASK1() | |
| 12233 : sleep 10 | |
| 12234 :endfunction | |
| 12235 | |
| 12236 :function! TASK2() | |
| 12237 : sleep 20 | |
| 12238 :endfunction | |
| 12239 | |
| 12240 :while 1 | |
| 12241 : let command = input("Type a command: ") | |
| 12242 : try | |
| 12243 : if command == "" | |
| 12244 : continue | |
| 12245 : elseif command == "END" | |
| 12246 : break | |
| 12247 : elseif command == "TASK1" | |
| 12248 : call TASK1() | |
| 12249 : elseif command == "TASK2" | |
| 12250 : call TASK2() | |
| 12251 : else | |
| 12252 : echo "\nIllegal command:" command | |
| 12253 : continue | |
| 12254 : endif | |
| 12255 : catch /^Vim:Interrupt$/ | |
| 12256 : echo "\nCommand interrupted" | |
| 12257 : " Caught the interrupt. Continue with next prompt. | |
| 12258 : endtry | |
| 12259 :endwhile | |
| 12260 | |
| 12261 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
|
12262 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 12263 |
| 12264 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 12265 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 12266 command on that line. See |debug-scripts|. | |
| 12267 | |
| 12268 | |
| 12269 CATCHING ALL *catch-all* | |
| 12270 | |
| 12271 The commands > | |
| 12272 | |
| 12273 :catch /.*/ | |
| 12274 :catch // | |
| 12275 :catch | |
| 12276 | |
| 12277 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 12278 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 12279 a script in order to catch unexpected things. | |
| 12280 Example: > | |
| 12281 | |
| 12282 :try | |
| 12283 : | |
| 12284 : " do the hard work here | |
| 12285 : | |
| 12286 :catch /MyException/ | |
| 12287 : | |
| 12288 : " handle known problem | |
| 12289 : | |
| 12290 :catch /^Vim:Interrupt$/ | |
| 12291 : echo "Script interrupted" | |
| 12292 :catch /.*/ | |
| 12293 : echo "Internal error (" . v:exception . ")" | |
| 12294 : echo " - occurred at " . v:throwpoint | |
| 12295 :endtry | |
| 12296 :" end of script | |
| 12297 | |
| 12298 Note: Catching all might catch more things than you want. Thus, you are | |
| 12299 strongly encouraged to catch only for problems that you can really handle by | |
| 12300 specifying a pattern argument to the ":catch". | |
| 12301 Example: Catching all could make it nearly impossible to interrupt a script | |
| 12302 by pressing CTRL-C: > | |
| 12303 | |
| 12304 :while 1 | |
| 12305 : try | |
| 12306 : sleep 1 | |
| 12307 : catch | |
| 12308 : endtry | |
| 12309 :endwhile | |
| 12310 | |
| 12311 | |
| 12312 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 12313 | |
| 12314 Exceptions may be used during execution of autocommands. Example: > | |
| 12315 | |
| 12316 :autocmd User x try | |
| 12317 :autocmd User x throw "Oops!" | |
| 12318 :autocmd User x catch | |
| 12319 :autocmd User x echo v:exception | |
| 12320 :autocmd User x endtry | |
| 12321 :autocmd User x throw "Arrgh!" | |
| 12322 :autocmd User x echo "Should not be displayed" | |
| 12323 : | |
| 12324 :try | |
| 12325 : doautocmd User x | |
| 12326 :catch | |
| 12327 : echo v:exception | |
| 12328 :endtry | |
| 12329 | |
| 12330 This displays "Oops!" and "Arrgh!". | |
| 12331 | |
| 12332 *except-autocmd-Pre* | |
| 12333 For some commands, autocommands get executed before the main action of the | |
| 12334 command takes place. If an exception is thrown and not caught in the sequence | |
| 12335 of autocommands, the sequence and the command that caused its execution are | |
| 12336 abandoned and the exception is propagated to the caller of the command. | |
| 12337 Example: > | |
| 12338 | |
| 12339 :autocmd BufWritePre * throw "FAIL" | |
| 12340 :autocmd BufWritePre * echo "Should not be displayed" | |
| 12341 : | |
| 12342 :try | |
| 12343 : write | |
| 12344 :catch | |
| 12345 : echo "Caught:" v:exception "from" v:throwpoint | |
| 12346 :endtry | |
| 12347 | |
| 12348 Here, the ":write" command does not write the file currently being edited (as | |
| 12349 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 12350 autocommand abandons the ":write". The exception is then caught and the | |
| 12351 script displays: > | |
| 12352 | |
| 12353 Caught: FAIL from BufWrite Auto commands for "*" | |
| 12354 < | |
| 12355 *except-autocmd-Post* | |
| 12356 For some commands, autocommands get executed after the main action of the | |
| 12357 command has taken place. If this main action fails and the command is inside | |
| 12358 an active try conditional, the autocommands are skipped and an error exception | |
| 12359 is thrown that can be caught by the caller of the command. | |
| 12360 Example: > | |
| 12361 | |
| 12362 :autocmd BufWritePost * echo "File successfully written!" | |
| 12363 : | |
| 12364 :try | |
| 12365 : write /i/m/p/o/s/s/i/b/l/e | |
| 12366 :catch | |
| 12367 : echo v:exception | |
| 12368 :endtry | |
| 12369 | |
| 12370 This just displays: > | |
| 12371 | |
| 12372 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 12373 | |
| 12374 If you really need to execute the autocommands even when the main action | |
| 12375 fails, trigger the event from the catch clause. | |
| 12376 Example: > | |
| 12377 | |
| 12378 :autocmd BufWritePre * set noreadonly | |
| 12379 :autocmd BufWritePost * set readonly | |
| 12380 : | |
| 12381 :try | |
| 12382 : write /i/m/p/o/s/s/i/b/l/e | |
| 12383 :catch | |
| 12384 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 12385 :endtry | |
| 12386 < | |
| 12387 You can also use ":silent!": > | |
| 12388 | |
| 12389 :let x = "ok" | |
| 12390 :let v:errmsg = "" | |
| 12391 :autocmd BufWritePost * if v:errmsg != "" | |
| 12392 :autocmd BufWritePost * let x = "after fail" | |
| 12393 :autocmd BufWritePost * endif | |
| 12394 :try | |
| 12395 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 12396 :catch | |
| 12397 :endtry | |
| 12398 :echo x | |
| 12399 | |
| 12400 This displays "after fail". | |
| 12401 | |
| 12402 If the main action of the command does not fail, exceptions from the | |
| 12403 autocommands will be catchable by the caller of the command: > | |
| 12404 | |
| 12405 :autocmd BufWritePost * throw ":-(" | |
| 12406 :autocmd BufWritePost * echo "Should not be displayed" | |
| 12407 : | |
| 12408 :try | |
| 12409 : write | |
| 12410 :catch | |
| 12411 : echo v:exception | |
| 12412 :endtry | |
| 12413 < | |
| 12414 *except-autocmd-Cmd* | |
| 12415 For some commands, the normal action can be replaced by a sequence of | |
| 12416 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 12417 of the command. | |
| 12418 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
|
12419 had actually been written when the exception occurred. You need to tell it in |
| 7 | 12420 some way. > |
| 12421 | |
| 12422 :if !exists("cnt") | |
| 12423 : let cnt = 0 | |
| 12424 : | |
| 12425 : autocmd BufWriteCmd * if &modified | |
| 12426 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 12427 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 12428 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 12429 : autocmd BufWriteCmd * endif | |
| 12430 : autocmd BufWriteCmd * write | set nomodified | |
| 12431 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 12432 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 12433 : autocmd BufWriteCmd * endif | |
| 12434 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 12435 : autocmd BufWriteCmd * endif | |
| 12436 :endif | |
| 12437 : | |
| 12438 :try | |
| 12439 : write | |
| 12440 :catch /^BufWriteCmdError$/ | |
| 12441 : if &modified | |
| 12442 : echo "Error on writing (file contents not changed)" | |
| 12443 : else | |
| 12444 : echo "Error after writing" | |
| 12445 : endif | |
| 12446 :catch /^Vim(write):/ | |
| 12447 : echo "Error on writing" | |
| 12448 :endtry | |
| 12449 | |
| 12450 When this script is sourced several times after making changes, it displays | |
| 12451 first > | |
| 12452 File successfully written! | |
| 12453 then > | |
| 12454 Error on writing (file contents not changed) | |
| 12455 then > | |
| 12456 Error after writing | |
| 12457 etc. | |
| 12458 | |
| 12459 *except-autocmd-ill* | |
| 12460 You cannot spread a try conditional over autocommands for different events. | |
| 12461 The following code is ill-formed: > | |
| 12462 | |
| 12463 :autocmd BufWritePre * try | |
| 12464 : | |
| 12465 :autocmd BufWritePost * catch | |
| 12466 :autocmd BufWritePost * echo v:exception | |
| 12467 :autocmd BufWritePost * endtry | |
| 12468 : | |
| 12469 :write | |
| 12470 | |
| 12471 | |
| 12472 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 12473 | |
| 12474 Some programming languages allow to use hierarchies of exception classes or to | |
| 12475 pass additional information with the object of an exception class. You can do | |
| 12476 similar things in Vim. | |
| 12477 In order to throw an exception from a hierarchy, just throw the complete | |
| 12478 class name with the components separated by a colon, for instance throw the | |
| 12479 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 12480 When you want to pass additional information with your exception class, add | |
| 12481 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 12482 for an error when writing "myfile". | |
| 12483 With the appropriate patterns in the ":catch" command, you can catch for | |
| 12484 base classes or derived classes of your hierarchy. Additional information in | |
| 12485 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 12486 Example: > | |
| 12487 | |
| 12488 :function! CheckRange(a, func) | |
| 12489 : if a:a < 0 | |
| 12490 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 12491 : endif | |
| 12492 :endfunction | |
| 12493 : | |
| 12494 :function! Add(a, b) | |
| 12495 : call CheckRange(a:a, "Add") | |
| 12496 : call CheckRange(a:b, "Add") | |
| 12497 : let c = a:a + a:b | |
| 12498 : if c < 0 | |
| 12499 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 12500 : endif | |
| 12501 : return c | |
| 12502 :endfunction | |
| 12503 : | |
| 12504 :function! Div(a, b) | |
| 12505 : call CheckRange(a:a, "Div") | |
| 12506 : call CheckRange(a:b, "Div") | |
| 12507 : if (a:b == 0) | |
| 12508 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 12509 : endif | |
| 12510 : return a:a / a:b | |
| 12511 :endfunction | |
| 12512 : | |
| 12513 :function! Write(file) | |
| 12514 : try | |
| 1621 | 12515 : execute "write" fnameescape(a:file) |
| 7 | 12516 : catch /^Vim(write):/ |
| 12517 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 12518 : endtry | |
| 12519 :endfunction | |
| 12520 : | |
| 12521 :try | |
| 12522 : | |
| 12523 : " something with arithmetics and I/O | |
| 12524 : | |
| 12525 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 12526 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 12527 : echo "Range error in" function | |
| 12528 : | |
| 12529 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 12530 : echo "Math error" | |
| 12531 : | |
| 12532 :catch /^EXCEPT:IO/ | |
| 12533 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 12534 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 12535 : if file !~ '^/' | |
| 12536 : let file = dir . "/" . file | |
| 12537 : endif | |
| 12538 : echo 'I/O error for "' . file . '"' | |
| 12539 : | |
| 12540 :catch /^EXCEPT/ | |
| 12541 : echo "Unspecified error" | |
| 12542 : | |
| 12543 :endtry | |
| 12544 | |
| 12545 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 12546 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 12547 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 12548 Vim error exceptions are parameterized with the name of the command that | |
| 12549 failed, if known. See |catch-errors|. | |
| 12550 | |
| 12551 | |
| 12552 PECULIARITIES | |
| 12553 *except-compat* | |
| 12554 The exception handling concept requires that the command sequence causing the | |
| 12555 exception is aborted immediately and control is transferred to finally clauses | |
| 12556 and/or a catch clause. | |
| 12557 | |
| 12558 In the Vim script language there are cases where scripts and functions | |
| 12559 continue after an error: in functions without the "abort" flag or in a command | |
| 12560 after ":silent!", control flow goes to the following line, and outside | |
| 12561 functions, control flow goes to the line following the outermost ":endwhile" | |
| 12562 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 12563 (thus, requiring the immediate abortion). | |
| 12564 | |
| 12565 This problem has been solved by converting errors to exceptions and using | |
| 12566 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
|
12567 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
|
12568 be caught only from an active try conditional. If you want an immediate |
| 7 | 12569 termination without catching the error, just use a try conditional without |
| 12570 catch clause. (You can cause cleanup code being executed before termination | |
| 12571 by specifying a finally clause.) | |
| 12572 | |
| 12573 When no try conditional is active, the usual abortion and continuation | |
| 12574 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 12575 scripts written for Vim 6.1 and earlier. | |
| 12576 | |
| 12577 However, when sourcing an existing script that does not use exception handling | |
| 12578 commands (or when calling one of its functions) from inside an active try | |
| 12579 conditional of a new script, you might change the control flow of the existing | |
| 12580 script on error. You get the immediate abortion on error and can catch the | |
| 12581 error in the new script. If however the sourced script suppresses error | |
| 12582 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
|
12583 |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
|
12584 not converted to an exception. (See |:silent|.) So the only remaining cause |
| 7 | 12585 where this happens is for scripts that don't care about errors and produce |
| 12586 error messages. You probably won't want to use such code from your new | |
| 12587 scripts. | |
| 12588 | |
| 12589 *except-syntax-err* | |
| 12590 Syntax errors in the exception handling commands are never caught by any of | |
| 12591 the ":catch" commands of the try conditional they belong to. Its finally | |
| 12592 clauses, however, is executed. | |
| 12593 Example: > | |
| 12594 | |
| 12595 :try | |
| 12596 : try | |
| 12597 : throw 4711 | |
| 12598 : catch /\(/ | |
| 12599 : echo "in catch with syntax error" | |
| 12600 : catch | |
| 12601 : echo "inner catch-all" | |
| 12602 : finally | |
| 12603 : echo "inner finally" | |
| 12604 : endtry | |
| 12605 :catch | |
| 12606 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 12607 : finally | |
| 12608 : echo "outer finally" | |
| 12609 :endtry | |
| 12610 | |
| 12611 This displays: > | |
| 12612 inner finally | |
| 12613 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 12614 outer finally | |
| 12615 The original exception is discarded and an error exception is raised, instead. | |
| 12616 | |
| 12617 *except-single-line* | |
| 12618 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 12619 a single line, but then syntax errors may make it difficult to recognize the | |
| 12620 "catch" line, thus you better avoid this. | |
| 12621 Example: > | |
| 12622 :try | unlet! foo # | catch | endtry | |
| 12623 raises an error exception for the trailing characters after the ":unlet!" | |
| 12624 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 12625 error exception is discarded and the "E488: Trailing characters" message gets | |
| 12626 displayed. | |
| 12627 | |
| 12628 *except-several-errors* | |
| 12629 When several errors appear in a single command, the first error message is | |
| 12630 usually the most specific one and therefor converted to the error exception. | |
| 12631 Example: > | |
| 12632 echo novar | |
| 12633 causes > | |
| 12634 E121: Undefined variable: novar | |
| 12635 E15: Invalid expression: novar | |
| 12636 The value of the error exception inside try conditionals is: > | |
| 12637 Vim(echo):E121: Undefined variable: novar | |
| 12638 < *except-syntax-error* | |
| 12639 But when a syntax error is detected after a normal error in the same command, | |
| 12640 the syntax error is used for the exception being thrown. | |
| 12641 Example: > | |
| 12642 unlet novar # | |
| 12643 causes > | |
| 12644 E108: No such variable: "novar" | |
| 12645 E488: Trailing characters | |
| 12646 The value of the error exception inside try conditionals is: > | |
| 12647 Vim(unlet):E488: Trailing characters | |
| 12648 This is done because the syntax error might change the execution path in a way | |
| 12649 not intended by the user. Example: > | |
| 12650 try | |
| 12651 try | unlet novar # | catch | echo v:exception | endtry | |
| 12652 catch /.*/ | |
| 12653 echo "outer catch:" v:exception | |
| 12654 endtry | |
| 12655 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 12656 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 12657 | |
| 12658 ============================================================================== | |
| 12659 9. Examples *eval-examples* | |
| 12660 | |
| 1156 | 12661 Printing in Binary ~ |
| 7 | 12662 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12663 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 12664 :func Nr2Bin(nr) |
| 7 | 12665 : let n = a:nr |
| 12666 : let r = "" | |
| 12667 : while n | |
| 1156 | 12668 : let r = '01'[n % 2] . r |
| 12669 : let n = n / 2 | |
| 7 | 12670 : endwhile |
| 12671 : return r | |
| 12672 :endfunc | |
| 12673 | |
| 1156 | 12674 :" The function String2Bin() converts each character in a string to a |
| 12675 :" binary string, separated with dashes. | |
| 12676 :func String2Bin(str) | |
| 7 | 12677 : let out = '' |
| 1156 | 12678 : for ix in range(strlen(a:str)) |
| 12679 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 12680 : endfor | |
| 12681 : return out[1:] | |
| 7 | 12682 :endfunc |
| 12683 | |
| 12684 Example of its use: > | |
| 1156 | 12685 :echo Nr2Bin(32) |
| 12686 result: "100000" > | |
| 12687 :echo String2Bin("32") | |
| 12688 result: "110011-110010" | |
| 12689 | |
| 12690 | |
| 12691 Sorting lines ~ | |
| 12692 | |
| 12693 This example sorts lines with a specific compare function. > | |
| 12694 | |
| 12695 :func SortBuffer() | |
| 12696 : let lines = getline(1, '$') | |
| 12697 : call sort(lines, function("Strcmp")) | |
| 12698 : call setline(1, lines) | |
| 7 | 12699 :endfunction |
| 12700 | |
| 1156 | 12701 As a one-liner: > |
| 12702 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 12703 | |
| 12704 | |
| 12705 scanf() replacement ~ | |
| 7 | 12706 *sscanf* |
| 12707 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 12708 line, you can use matchstr() and substitute() to do it. This example shows | |
| 12709 how to get the file name, line number and column number out of a line like | |
| 12710 "foobar.txt, 123, 45". > | |
| 12711 :" Set up the match bit | |
| 12712 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 12713 :"get the part matching the whole expression | |
| 12714 :let l = matchstr(line, mx) | |
| 12715 :"get each item out of the match | |
| 12716 :let file = substitute(l, mx, '\1', '') | |
| 12717 :let lnum = substitute(l, mx, '\2', '') | |
| 12718 :let col = substitute(l, mx, '\3', '') | |
| 12719 | |
| 12720 The input is in the variable "line", the results in the variables "file", | |
| 12721 "lnum" and "col". (idea from Michael Geddes) | |
| 12722 | |
| 1156 | 12723 |
| 12724 getting the scriptnames in a Dictionary ~ | |
| 12725 *scriptnames-dictionary* | |
| 12726 The |:scriptnames| command can be used to get a list of all script files that | |
| 12727 have been sourced. There is no equivalent function or variable for this | |
| 12728 (because it's rarely needed). In case you need to manipulate the list this | |
| 12729 code can be used: > | |
| 12730 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 12731 let scriptnames_output = '' | |
| 12732 redir => scriptnames_output | |
| 12733 silent scriptnames | |
| 12734 redir END | |
| 12785 | 12735 |
| 1621 | 12736 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 12737 " "scripts" dictionary. |
| 12738 let scripts = {} | |
| 12739 for line in split(scriptnames_output, "\n") | |
| 12740 " Only do non-blank lines. | |
| 12741 if line =~ '\S' | |
| 12742 " Get the first number in the line. | |
| 1621 | 12743 let nr = matchstr(line, '\d\+') |
| 1156 | 12744 " Get the file name, remove the script number " 123: ". |
| 1621 | 12745 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 12746 " Add an item to the Dictionary |
| 1621 | 12747 let scripts[nr] = name |
| 1156 | 12748 endif |
| 12749 endfor | |
| 12750 unlet scriptnames_output | |
| 12751 | |
| 7 | 12752 ============================================================================== |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12753 10. Vim script versions *vimscript-version* *vimscript-versions* |
| 16380 | 12754 *scriptversion* |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12755 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
|
12756 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
|
12757 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
|
12758 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12759 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
|
12760 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
|
12761 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
|
12762 compatible with older versions of Vim this will give an explicit error, |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12763 instead of failing in mysterious ways. > |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12764 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12765 :scriptversion 1 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12766 < 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
|
12767 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
|
12768 Test for support with: > |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12769 has('vimscript-1') |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12770 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12771 :scriptversion 2 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12772 < String concatenation with "." is not supported, use ".." instead. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12773 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
|
12774 floating point numbers. Now ".5" means the number 0.5. |
| 16380 | 12775 > |
| 12776 :scriptversion 3 | |
| 12777 < All |vim-variable|s must be prefixed by "v:". E.g. "version" doesn't | |
| 12778 work as |v:version| anymore, it can be used as a normal variable. | |
| 12779 Same for some obvious names as "count" and others. | |
| 12780 | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12781 Test for support with: > |
| 16380 | 12782 has('vimscript-3') |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12783 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12784 ============================================================================== |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12785 11. No +eval feature *no-eval-feature* |
| 7 | 12786 |
| 12787 When the |+eval| feature was disabled at compile time, none of the expression | |
| 12788 evaluation commands are available. To prevent this from causing Vim scripts | |
| 12789 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 12790 recognized, though the argument of the ":if" and everything between the ":if" | |
| 12791 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 12792 only if the commands are at the start of the line. The ":else" command is not | |
| 12793 recognized. | |
| 12794 | |
| 12795 Example of how to avoid executing commands when the |+eval| feature is | |
| 12796 missing: > | |
| 12797 | |
| 12798 :if 1 | |
| 12799 : echo "Expression evaluation is compiled in" | |
| 12800 :else | |
| 12801 : echo "You will _never_ see this message" | |
| 12802 :endif | |
| 12803 | |
| 11347 | 12804 To execute a command only when the |+eval| feature is disabled requires a trick, |
| 12805 as this example shows: > | |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
12806 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
12807 silent! while 0 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
12808 set history=111 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
12809 silent! endwhile |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
12810 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
12811 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
|
12812 "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
|
12813 silently ignored, and the command is executed. |
| 11347 | 12814 |
| 7 | 12815 ============================================================================== |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12816 12. The sandbox *eval-sandbox* *sandbox* *E48* |
| 7 | 12817 |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
12818 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
|
12819 '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
|
12820 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
|
12821 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
|
12822 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 12823 The sandbox is also used for the |:sandbox| command. |
| 7 | 12824 |
| 12825 These items are not allowed in the sandbox: | |
| 12826 - changing the buffer text | |
| 14347 | 12827 - defining or changing mapping, autocommands, user commands |
| 7 | 12828 - setting certain options (see |option-summary|) |
| 1156 | 12829 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 12830 - executing a shell command |
| 12831 - reading or writing a file | |
| 12832 - jumping to another buffer or editing a file | |
| 625 | 12833 - executing Python, Perl, etc. commands |
| 29 | 12834 This is not guaranteed 100% secure, but it should block most attacks. |
| 12835 | |
| 12836 *:san* *:sandbox* | |
| 401 | 12837 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 12838 option that may have been set from a modeline, e.g. |
| 12839 'foldexpr'. | |
| 12840 | |
| 634 | 12841 *sandbox-option* |
| 12842 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 12843 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 12844 restrictive, thus this only happens when the option was set from an insecure |
| 12845 location. Insecure in this context are: | |
| 843 | 12846 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 12847 - while executing in the sandbox |
| 12848 - value coming from a modeline | |
| 14347 | 12849 - executing a function that was defined in the sandbox |
| 634 | 12850 |
| 12851 Note that when in the sandbox and saving an option value and restoring it, the | |
| 12852 option will still be marked as it was set in the sandbox. | |
| 12853 | |
| 12854 ============================================================================== | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12855 13. Textlock *textlock* |
| 634 | 12856 |
| 12857 In a few situations it is not allowed to change the text in the buffer, jump | |
| 12858 to another window and some other things that might confuse or break what Vim | |
| 12859 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
|
12860 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 12861 happen any moment the mouse cursor is resting at some position. |
| 12862 | |
| 12863 This is not allowed when the textlock is active: | |
| 12864 - changing the buffer text | |
| 12865 - jumping to another buffer or window | |
| 12866 - editing another file | |
| 12867 - closing a window or quitting Vim | |
| 12868 - etc. | |
| 12869 | |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12870 ============================================================================== |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12871 14. Testing *testing* |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12872 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12873 Vim can be tested after building it, usually with "make test". |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12874 The tests are located in the directory "src/testdir". |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12875 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12876 There are several types of tests added over time: |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12877 test33.in oldest, don't add any more |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12878 test_something.in old style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12879 test_something.vim new style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12880 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12881 *new-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12882 New tests should be added as new style tests. These use functions such as |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12883 |assert_equal()| to keep the test commands and the expected result in one |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12884 place. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12885 *old-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12886 In some cases an old style test needs to be used. E.g. when testing Vim |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12887 without the |+eval| feature. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12888 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12889 Find more information in the file src/testdir/README.txt. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
12890 |
| 7 | 12891 |
| 14421 | 12892 vim:tw=78:ts=8:noet:ft=help:norl: |