Mercurial > vim
annotate runtime/doc/eval.txt @ 13016:e47e70300f30 v8.0.1384
patch 8.0.1384: not enough quickfix help; confusing winid
commit https://github.com/vim/vim/commit/74240d3febd1e3bc7cf086c647c9348b20716c33
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Dec 10 15:26:15 2017 +0100
patch 8.0.1384: not enough quickfix help; confusing winid
Problem: Not enough quickfix help; confusing winid.
Solution: Add more examples in the help. When the quickfix window is not
present, return zero for getqflist() with 'winid'. Add more tests
for jumping to quickfix list entries. (Yegappan Lakshmanan, closes
#2427)
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Sun, 10 Dec 2017 15:30:06 +0100 |
| parents | 2d817fd289ba |
| children | 58cce40c965b |
| rev | line source |
|---|---|
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
1 *eval.txt* For Vim version 8.0. Last change: 2017 Dec 09 |
| 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| |
| 20 1.5 More about variables |more-variables| | |
| 85 | 21 2. Expression syntax |expression-syntax| |
| 22 3. Internal variable |internal-variables| | |
| 23 4. Builtin Functions |functions| | |
| 24 5. Defining functions |user-functions| | |
| 25 6. Curly braces names |curly-braces-names| | |
| 26 7. Commands |expression-commands| | |
| 27 8. Exception handling |exception-handling| | |
| 28 9. Examples |eval-examples| | |
| 29 10. No +eval feature |no-eval-feature| | |
| 30 11. The sandbox |eval-sandbox| | |
| 634 | 31 12. Textlock |textlock| |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
32 13. Testing |testing| |
| 7 | 33 |
| 34 {Vi does not have any of these commands} | |
| 35 | |
| 36 ============================================================================== | |
| 37 1. Variables *variables* | |
| 38 | |
| 85 | 39 1.1 Variable types ~ |
| 114 | 40 *E712* |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
41 There are nine types of variables: |
| 1621 | 42 |
| 3082 | 43 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
|
44 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
|
45 |+num64| feature. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
46 Examples: -123 0x10 0177 0b1011 |
| 99 | 47 |
| 1621 | 48 Float A floating point number. |floating-point-format| *Float* |
| 49 {only when compiled with the |+float| feature} | |
| 50 Examples: 123.456 1.15e-6 -1.1e3 | |
| 51 | |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
52 *E928* |
| 99 | 53 String A NUL terminated string of 8-bit unsigned characters (bytes). |
| 1621 | 54 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
| 99 | 55 |
| 56 List An ordered sequence of items |List|. | |
| 57 Example: [1, 2, ['a', 'b']] | |
| 55 | 58 |
| 370 | 59 Dictionary An associative, unordered array: Each entry has a key and a |
| 60 value. |Dictionary| | |
| 61 Example: {'blue': "#0000ff", 'red': "#ff0000"} | |
| 62 | |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
63 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
|
64 Example: function("strlen") |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
65 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
|
66 like a Partial. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
67 Example: function("Callback", [arg], myDict) |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
68 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
69 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
|
70 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
71 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
|
72 |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
73 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
|
74 |
| 55 | 75 The Number and String types are converted automatically, depending on how they |
| 76 are used. | |
| 7 | 77 |
| 78 Conversion from a Number to a String is by making the ASCII representation of | |
| 2581 | 79 the Number. Examples: |
| 80 Number 123 --> String "123" ~ | |
| 81 Number 0 --> String "0" ~ | |
| 82 Number -1 --> String "-1" ~ | |
| 2152 | 83 *octal* |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
84 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
|
85 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
|
86 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
|
87 Examples: |
| 2581 | 88 String "456" --> Number 456 ~ |
| 89 String "6bar" --> Number 6 ~ | |
| 90 String "foo" --> Number 0 ~ | |
| 91 String "0xf1" --> Number 241 ~ | |
| 92 String "0100" --> Number 64 ~ | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
93 String "0b101" --> Number 5 ~ |
| 2581 | 94 String "-8" --> Number -8 ~ |
| 95 String "+8" --> Number 0 ~ | |
| 7 | 96 |
| 97 To force conversion from String to Number, add zero to it: > | |
| 98 :echo "0100" + 0 | |
| 782 | 99 < 64 ~ |
| 100 | |
| 101 To avoid a leading zero to cause octal conversion, or for using a different | |
| 102 base, use |str2nr()|. | |
| 7 | 103 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
104 *TRUE* *FALSE* |
| 7 | 105 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
|
106 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
|
107 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
|
108 |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
109 Note that in the command: > |
| 7 | 110 :if "foo" |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
111 :" NOT executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
112 "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
|
113 non-zero number it means TRUE: > |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
114 :if "8foo" |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
115 :" executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
116 To test for a non-empty string, use empty(): > |
| 3893 | 117 :if !empty("foo") |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
118 < |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
119 *non-zero-arg* |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
120 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
|
121 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
|
122 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
|
123 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
|
124 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
|
125 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
126 *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913* |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
127 List, Dictionary, Funcref, Job and Channel types are not automatically |
|
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
128 converted. |
| 85 | 129 |
| 1621 | 130 *E805* *E806* *E808* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
131 When mixing Number and Float the Number is converted to Float. Otherwise |
| 1621 | 132 there is no automatic conversion of Float. You can use str2float() for String |
| 133 to Float, printf() for Float to String and float2nr() for Float to Number. | |
| 134 | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
135 *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
|
136 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
|
137 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
138 *no-type-checking* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
139 You will not get an error if you try to change the type of a variable. |
| 85 | 140 |
| 141 | |
| 87 | 142 1.2 Function references ~ |
| 153 | 143 *Funcref* *E695* *E718* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
144 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
|
145 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
|
146 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
|
147 around the arguments, to invoke the function it refers to. Example: > |
| 55 | 148 |
| 149 :let Fn = function("MyFunc") | |
| 150 :echo Fn() | |
| 114 | 151 < *E704* *E705* *E707* |
| 819 | 152 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
| 5340 | 153 can use "g:" but the following name must still start with a capital. You |
| 819 | 154 cannot have both a Funcref variable and a function with the same name. |
| 85 | 155 |
| 114 | 156 A special case is defining a function and directly assigning its Funcref to a |
| 157 Dictionary entry. Example: > | |
| 158 :function dict.init() dict | |
| 159 : let self.val = 0 | |
| 160 :endfunction | |
| 161 | |
| 162 The key of the Dictionary can start with a lower case letter. The actual | |
| 163 function name is not used here. Also see |numbered-function|. | |
| 164 | |
| 165 A Funcref can also be used with the |:call| command: > | |
| 166 :call Fn() | |
| 167 :call dict.init() | |
| 85 | 168 |
| 169 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 170 :let func = string(Fn) |
| 85 | 171 |
| 172 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 173 arguments: > | |
| 119 | 174 :let r = call(Fn, mylist) |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
175 < |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
176 *Partial* |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
177 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
|
178 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
|
179 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
|
180 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
|
181 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
182 let Cb = function('Callback', ['foo'], myDict) |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
183 call Cb() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
184 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
185 This will invoke the function as if using: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
186 call myDict.Callback('foo') |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
187 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
188 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
|
189 |ch_open()|. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
190 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
191 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
|
192 a member of the Dictionary: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
193 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
194 let myDict.myFunction = MyFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
195 call myDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
196 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
197 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
|
198 "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
|
199 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
|
200 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
201 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
202 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
203 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
204 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
|
205 this won't happen: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
206 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
207 let myDict.myFunction = function(MyFunction, myDict) |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
208 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
209 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
210 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
211 Here "self" will be "myDict", because it was bound explicitly. |
| 85 | 212 |
| 213 | |
| 87 | 214 1.3 Lists ~ |
| 5814 | 215 *list* *List* *Lists* *E686* |
| 55 | 216 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
|
217 can be accessed by their index number. Items can be added and removed at any |
| 55 | 218 position in the sequence. |
| 219 | |
| 85 | 220 |
| 221 List creation ~ | |
| 222 *E696* *E697* | |
| 55 | 223 A List is created with a comma separated list of items in square brackets. |
| 85 | 224 Examples: > |
| 225 :let mylist = [1, two, 3, "four"] | |
| 226 :let emptylist = [] | |
| 55 | 227 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
228 An item can be any expression. Using a List for an item creates a |
| 842 | 229 List of Lists: > |
| 85 | 230 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 231 |
| 232 An extra comma after the last item is ignored. | |
| 233 | |
| 85 | 234 |
| 235 List index ~ | |
| 236 *list-index* *E684* | |
| 55 | 237 An item in the List can be accessed by putting the index in square brackets |
| 85 | 238 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 239 :let item = mylist[0] " get the first item: 1 | |
| 55 | 240 :let item = mylist[2] " get the third item: 3 |
| 85 | 241 |
| 87 | 242 When the resulting item is a list this can be repeated: > |
| 85 | 243 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 244 < |
| 85 | 245 A negative index is counted from the end. Index -1 refers to the last item in |
| 246 the List, -2 to the last but one item, etc. > | |
| 55 | 247 :let last = mylist[-1] " get the last item: "four" |
| 248 | |
| 85 | 249 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 250 is not available it returns zero or the default value you specify: > |
| 85 | 251 :echo get(mylist, idx) |
| 252 :echo get(mylist, idx, "NONE") | |
| 253 | |
| 254 | |
| 255 List concatenation ~ | |
| 256 | |
| 257 Two lists can be concatenated with the "+" operator: > | |
| 258 :let longlist = mylist + [5, 6] | |
| 119 | 259 :let mylist += [7, 8] |
| 85 | 260 |
| 261 To prepend or append an item turn the item into a list by putting [] around | |
| 262 it. To change a list in-place see |list-modification| below. | |
| 263 | |
| 264 | |
| 265 Sublist ~ | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
266 *sublist* |
| 55 | 267 A part of the List can be obtained by specifying the first and last index, |
| 268 separated by a colon in square brackets: > | |
| 85 | 269 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 270 |
| 271 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 272 similar to -1. > |
| 90 | 273 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 274 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 275 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 276 |
| 842 | 277 If the first index is beyond the last item of the List or the second item is |
| 278 before the first item, the result is an empty list. There is no error | |
| 279 message. | |
| 280 | |
| 281 If the second index is equal to or greater than the length of the list the | |
| 282 length minus one is used: > | |
| 829 | 283 :let mylist = [0, 1, 2, 3] |
| 284 :echo mylist[2:8] " result: [2, 3] | |
| 285 | |
| 270 | 286 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
|
287 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 288 mylist[s : e]. |
| 289 | |
| 85 | 290 |
| 291 List identity ~ | |
| 99 | 292 *list-identity* |
| 85 | 293 When variable "aa" is a list and you assign it to another variable "bb", both |
| 294 variables refer to the same list. Thus changing the list "aa" will also | |
| 295 change "bb": > | |
| 296 :let aa = [1, 2, 3] | |
| 297 :let bb = aa | |
| 298 :call add(aa, 4) | |
| 299 :echo bb | |
| 114 | 300 < [1, 2, 3, 4] |
| 85 | 301 |
| 302 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 303 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 304 a list item in the list will also change the item in the copied list: > |
| 85 | 305 :let aa = [[1, 'a'], 2, 3] |
| 306 :let bb = copy(aa) | |
| 114 | 307 :call add(aa, 4) |
| 85 | 308 :let aa[0][1] = 'aaa' |
| 309 :echo aa | |
| 114 | 310 < [[1, aaa], 2, 3, 4] > |
| 85 | 311 :echo bb |
| 114 | 312 < [[1, aaa], 2, 3] |
| 85 | 313 |
| 87 | 314 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 315 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 316 |
| 317 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 318 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 319 the same value. > |
| 320 :let alist = [1, 2, 3] | |
| 321 :let blist = [1, 2, 3] | |
| 322 :echo alist is blist | |
| 114 | 323 < 0 > |
| 87 | 324 :echo alist == blist |
| 114 | 325 < 1 |
| 85 | 326 |
| 323 | 327 Note about comparing lists: Two lists are considered equal if they have the |
| 328 same length and all items compare equal, as with using "==". There is one | |
| 388 | 329 exception: When comparing a number with a string they are considered |
| 330 different. There is no automatic type conversion, as with using "==" on | |
| 331 variables. Example: > | |
| 332 echo 4 == "4" | |
| 323 | 333 < 1 > |
| 388 | 334 echo [4] == ["4"] |
| 323 | 335 < 0 |
| 336 | |
| 388 | 337 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 338 can compare simple values this way too by putting them in a list: > |
| 388 | 339 |
| 340 :let a = 5 | |
| 341 :let b = "5" | |
| 1621 | 342 :echo a == b |
| 388 | 343 < 1 > |
| 1621 | 344 :echo [a] == [b] |
| 388 | 345 < 0 |
| 323 | 346 |
| 85 | 347 |
| 348 List unpack ~ | |
| 349 | |
| 350 To unpack the items in a list to individual variables, put the variables in | |
| 351 square brackets, like list items: > | |
| 352 :let [var1, var2] = mylist | |
| 353 | |
| 354 When the number of variables does not match the number of items in the list | |
| 355 this produces an error. To handle any extra items from the list append ";" | |
| 356 and a variable name: > | |
| 357 :let [var1, var2; rest] = mylist | |
| 358 | |
| 359 This works like: > | |
| 360 :let var1 = mylist[0] | |
| 361 :let var2 = mylist[1] | |
| 95 | 362 :let rest = mylist[2:] |
| 85 | 363 |
| 364 Except that there is no error if there are only two items. "rest" will be an | |
| 365 empty list then. | |
| 366 | |
| 367 | |
| 368 List modification ~ | |
| 369 *list-modification* | |
| 87 | 370 To change a specific item of a list use |:let| this way: > |
| 85 | 371 :let list[4] = "four" |
| 372 :let listlist[0][3] = item | |
| 373 | |
| 87 | 374 To change part of a list you can specify the first and last item to be |
| 114 | 375 modified. The value must at least have the number of items in the range: > |
| 87 | 376 :let list[3:5] = [3, 4, 5] |
| 377 | |
| 85 | 378 Adding and removing items from a list is done with functions. Here are a few |
| 379 examples: > | |
| 380 :call insert(list, 'a') " prepend item 'a' | |
| 381 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 382 :call add(list, "new") " append String item | |
| 114 | 383 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 384 :call extend(list, [1, 2]) " extend the list with two more items |
| 385 :let i = remove(list, 3) " remove item 3 | |
| 108 | 386 :unlet list[3] " idem |
| 85 | 387 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 388 :unlet list[3 : ] " idem |
| 114 | 389 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 390 | |
| 391 Changing the order of items in a list: > | |
| 87 | 392 :call sort(list) " sort a list alphabetically |
| 393 :call reverse(list) " reverse the order of items | |
| 5747 | 394 :call uniq(sort(list)) " sort and remove duplicates |
| 87 | 395 |
| 85 | 396 |
| 397 For loop ~ | |
| 398 | |
| 87 | 399 The |:for| loop executes commands for each item in a list. A variable is set |
| 400 to each item in the list in sequence. Example: > | |
| 114 | 401 :for item in mylist |
| 402 : call Doit(item) | |
| 85 | 403 :endfor |
| 404 | |
| 405 This works like: > | |
| 406 :let index = 0 | |
| 407 :while index < len(mylist) | |
| 114 | 408 : let item = mylist[index] |
| 409 : :call Doit(item) | |
| 85 | 410 : let index = index + 1 |
| 411 :endwhile | |
| 412 | |
| 95 | 413 If all you want to do is modify each item in the list then the |map()| |
| 114 | 414 function will be a simpler method than a for loop. |
| 95 | 415 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
416 Just like the |:let| command, |:for| also accepts a list of variables. This |
| 85 | 417 requires the argument to be a list of lists. > |
| 418 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] | |
| 419 : call Doit(lnum, col) | |
| 420 :endfor | |
| 421 | |
| 422 This works like a |:let| command is done for each list item. Again, the types | |
| 423 must remain the same to avoid an error. | |
| 424 | |
| 114 | 425 It is also possible to put remaining items in a List variable: > |
| 85 | 426 :for [i, j; rest] in listlist |
| 427 : call Doit(i, j) | |
| 428 : if !empty(rest) | |
| 429 : echo "remainder: " . string(rest) | |
| 430 : endif | |
| 431 :endfor | |
| 432 | |
| 433 | |
| 434 List functions ~ | |
| 114 | 435 *E714* |
| 85 | 436 Functions that are useful with a List: > |
| 87 | 437 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 438 :if empty(list) " check if list is empty |
| 102 | 439 :let l = len(list) " number of items in list |
| 440 :let big = max(list) " maximum value in list | |
| 441 :let small = min(list) " minimum value in list | |
| 87 | 442 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 443 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 444 :let lines = getline(1, 10) " get ten text lines from buffer |
| 445 :call append('$', lines) " append text lines in buffer | |
| 95 | 446 :let list = split("a b c") " create list from items in a string |
| 447 :let string = join(list, ', ') " create string from list items | |
| 102 | 448 :let s = string(list) " String representation of list |
| 449 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 450 |
| 258 | 451 Don't forget that a combination of features can make things simple. For |
| 452 example, to add up all the numbers in a list: > | |
| 453 :exe 'let sum = ' . join(nrlist, '+') | |
| 454 | |
| 99 | 455 |
| 456 1.4 Dictionaries ~ | |
| 5814 | 457 *dict* *Dictionaries* *Dictionary* |
| 99 | 458 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 459 entry can be located with the key. The entries are stored without a specific |
| 460 ordering. | |
| 99 | 461 |
| 462 | |
| 463 Dictionary creation ~ | |
| 114 | 464 *E720* *E721* *E722* *E723* |
| 99 | 465 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 466 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 467 only appear once. Examples: > | |
| 99 | 468 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 469 :let emptydict = {} | |
| 114 | 470 < *E713* *E716* *E717* |
| 99 | 471 A key is always a String. You can use a Number, it will be converted to a |
| 472 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
|
473 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
|
474 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
|
475 key. |
| 114 | 476 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
477 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 478 nested Dictionary: > |
| 479 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 480 | |
| 481 An extra comma after the last entry is ignored. | |
| 482 | |
| 483 | |
| 484 Accessing entries ~ | |
| 485 | |
| 486 The normal way to access an entry is by putting the key in square brackets: > | |
| 487 :let val = mydict["one"] | |
| 488 :let mydict["four"] = 4 | |
| 489 | |
| 114 | 490 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 491 |
| 492 For keys that consist entirely of letters, digits and underscore the following | |
| 493 form can be used |expr-entry|: > | |
| 494 :let val = mydict.one | |
| 495 :let mydict.four = 4 | |
| 496 | |
| 497 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 498 key lookup can be repeated: > | |
| 114 | 499 :echo dict.key[idx].key |
| 99 | 500 |
| 501 | |
| 502 Dictionary to List conversion ~ | |
| 503 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
504 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 505 turn the Dictionary into a List and pass it to |:for|. |
| 506 | |
| 507 Most often you want to loop over the keys, using the |keys()| function: > | |
| 508 :for key in keys(mydict) | |
| 509 : echo key . ': ' . mydict[key] | |
| 510 :endfor | |
| 511 | |
| 512 The List of keys is unsorted. You may want to sort them first: > | |
| 513 :for key in sort(keys(mydict)) | |
| 514 | |
| 515 To loop over the values use the |values()| function: > | |
| 516 :for v in values(mydict) | |
| 517 : echo "value: " . v | |
| 518 :endfor | |
| 519 | |
| 520 If you want both the key and the value use the |items()| function. It returns | |
| 1621 | 521 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 522 :for [key, value] in items(mydict) |
| 523 : echo key . ': ' . value | |
| 99 | 524 :endfor |
| 525 | |
| 526 | |
| 527 Dictionary identity ~ | |
| 161 | 528 *dict-identity* |
| 99 | 529 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 530 Dictionary. Otherwise, assignment results in referring to the same | |
| 531 Dictionary: > | |
| 532 :let onedict = {'a': 1, 'b': 2} | |
| 533 :let adict = onedict | |
| 534 :let adict['a'] = 11 | |
| 535 :echo onedict['a'] | |
| 536 11 | |
| 537 | |
| 327 | 538 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 539 more info see |list-identity|. | |
| 99 | 540 |
| 541 | |
| 542 Dictionary modification ~ | |
| 543 *dict-modification* | |
| 544 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 545 use |:let| this way: > | |
| 546 :let dict[4] = "four" | |
| 547 :let dict['one'] = item | |
| 548 | |
| 108 | 549 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 550 Three ways to remove the entry with key "aaa" from dict: > | |
| 551 :let i = remove(dict, 'aaa') | |
| 552 :unlet dict.aaa | |
| 553 :unlet dict['aaa'] | |
| 99 | 554 |
| 555 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 556 :call extend(adict, bdict) |
| 557 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 558 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 559 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 560 expect ":echo adict" to show the items from bdict after the older entries in | |
| 561 adict. | |
| 99 | 562 |
| 563 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 564 :call filter(dict, 'v:val =~ "x"') |
| 114 | 565 This removes all entries from "dict" with a value not matching 'x'. |
| 102 | 566 |
| 567 | |
| 568 Dictionary function ~ | |
| 4159 | 569 *Dictionary-function* *self* *E725* *E862* |
| 102 | 570 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
|
571 special way with a dictionary. Example: > |
| 102 | 572 :function Mylen() dict |
| 114 | 573 : return len(self.data) |
| 102 | 574 :endfunction |
| 114 | 575 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 576 :echo mydict.len() | |
| 102 | 577 |
| 578 This is like a method in object oriented programming. The entry in the | |
| 579 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 580 the function was invoked from. | |
| 581 | |
| 114 | 582 It is also possible to add a function without the "dict" attribute as a |
| 583 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 584 | |
| 819 | 585 *numbered-function* *anonymous-function* |
| 102 | 586 To avoid the extra name for the function it can be defined and directly |
| 587 assigned to a Dictionary in this way: > | |
| 114 | 588 :let mydict = {'data': [0, 1, 2, 3]} |
| 6741 | 589 :function mydict.len() |
| 114 | 590 : return len(self.data) |
| 102 | 591 :endfunction |
| 114 | 592 :echo mydict.len() |
| 593 | |
| 594 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
|
595 that references this function. The function can only be used through a |
| 114 | 596 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 597 remaining that refers to it. | |
| 598 | |
| 599 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 600 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
601 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
|
602 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
|
603 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
604 |
| 102 | 605 |
| 606 Functions for Dictionaries ~ | |
| 114 | 607 *E715* |
| 608 Functions that can be used with a Dictionary: > | |
| 102 | 609 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 610 :if empty(dict) " TRUE if dict is empty | |
| 611 :let l = len(dict) " number of items in dict | |
| 612 :let big = max(dict) " maximum value in dict | |
| 613 :let small = min(dict) " minimum value in dict | |
| 614 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 615 :let s = string(dict) " String representation of dict | |
| 616 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 617 |
| 618 | |
| 619 1.5 More about variables ~ | |
| 85 | 620 *more-variables* |
| 7 | 621 If you need to know the type of a variable or expression, use the |type()| |
| 622 function. | |
| 623 | |
| 624 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 625 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 626 stored in the viminfo file |viminfo-file|. | |
| 627 | |
| 628 When the 'sessionoptions' option contains "global", global variables that | |
| 629 start with an uppercase letter and contain at least one lowercase letter are | |
| 630 stored in the session file |session-file|. | |
| 631 | |
| 632 variable name can be stored where ~ | |
| 633 my_var_6 not | |
| 634 My_Var_6 session file | |
| 635 MY_VAR_6 viminfo file | |
| 636 | |
| 637 | |
| 638 It's possible to form a variable name with curly braces, see | |
| 639 |curly-braces-names|. | |
| 640 | |
| 641 ============================================================================== | |
| 642 2. Expression syntax *expression-syntax* | |
| 643 | |
| 644 Expression syntax summary, from least to most significant: | |
| 645 | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
646 |expr1| expr2 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
647 expr2 ? expr1 : expr1 if-then-else |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
648 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
649 |expr2| expr3 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
650 expr3 || expr3 .. logical OR |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
651 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
652 |expr3| expr4 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
653 expr4 && expr4 .. logical AND |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
654 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
655 |expr4| expr5 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
656 expr5 == expr5 equal |
| 7 | 657 expr5 != expr5 not equal |
| 658 expr5 > expr5 greater than | |
| 659 expr5 >= expr5 greater than or equal | |
| 660 expr5 < expr5 smaller than | |
| 661 expr5 <= expr5 smaller than or equal | |
| 662 expr5 =~ expr5 regexp matches | |
| 663 expr5 !~ expr5 regexp doesn't match | |
| 664 | |
| 665 expr5 ==? expr5 equal, ignoring case | |
| 666 expr5 ==# expr5 equal, match case | |
| 667 etc. As above, append ? for ignoring case, # for | |
| 668 matching case | |
| 669 | |
| 685 | 670 expr5 is expr5 same |List| instance |
| 671 expr5 isnot expr5 different |List| instance | |
| 79 | 672 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
673 |expr5| expr6 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
674 expr6 + expr6 .. number addition or list concatenation |
| 7 | 675 expr6 - expr6 .. number subtraction |
| 676 expr6 . expr6 .. string concatenation | |
| 677 | |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
678 |expr6| expr7 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
679 expr7 * expr7 .. number multiplication |
| 7 | 680 expr7 / expr7 .. number division |
| 681 expr7 % expr7 .. number modulo | |
| 682 | |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
683 |expr7| expr8 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
684 ! expr7 logical NOT |
| 7 | 685 - expr7 unary minus |
| 686 + expr7 unary plus | |
| 102 | 687 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
688 |expr8| expr9 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
689 expr8[expr1] byte of a String or item of a |List| |
| 685 | 690 expr8[expr1 : expr1] substring of a String or sublist of a |List| |
| 691 expr8.name entry in a |Dictionary| | |
| 692 expr8(expr1, ...) function call with |Funcref| variable | |
| 102 | 693 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
694 |expr9| number number constant |
| 26 | 695 "string" string constant, backslash is special |
| 99 | 696 'string' string constant, ' is doubled |
| 685 | 697 [expr1, ...] |List| |
| 698 {expr1: expr1, ...} |Dictionary| | |
| 7 | 699 &option option value |
| 700 (expr1) nested expression | |
| 701 variable internal variable | |
| 702 va{ria}ble internal variable with curly braces | |
| 703 $VAR environment variable | |
| 704 @r contents of register 'r' | |
| 705 function(expr1, ...) function call | |
| 706 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
|
707 {args -> expr1} lambda expression |
| 7 | 708 |
| 709 | |
| 710 ".." indicates that the operations in this level can be concatenated. | |
| 711 Example: > | |
| 712 &nu || &list && &shell == "csh" | |
| 713 | |
| 714 All expressions within one level are parsed from left to right. | |
| 715 | |
| 716 | |
| 717 expr1 *expr1* *E109* | |
| 718 ----- | |
| 719 | |
| 720 expr2 ? expr1 : expr1 | |
| 721 | |
| 722 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
|
723 |TRUE|, the result is the value of the expression between the '?' and ':', |
| 7 | 724 otherwise the result is the value of the expression after the ':'. |
| 725 Example: > | |
| 726 :echo lnum == 1 ? "top" : lnum | |
| 727 | |
| 728 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 729 other two expressions can, thus allow for recursive use of ?:. | |
| 730 Example: > | |
| 731 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 732 | |
| 733 To keep this readable, using |line-continuation| is suggested: > | |
| 734 :echo lnum == 1 | |
| 735 :\ ? "top" | |
| 736 :\ : lnum == 1000 | |
| 737 :\ ? "last" | |
| 738 :\ : lnum | |
| 739 | |
| 1156 | 740 You should always put a space before the ':', otherwise it can be mistaken for |
| 741 use in a variable such as "a:1". | |
| 742 | |
| 7 | 743 |
| 744 expr2 and expr3 *expr2* *expr3* | |
| 745 --------------- | |
| 746 | |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
747 expr3 || expr3 .. logical OR *expr-barbar* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
748 expr4 && expr4 .. logical AND *expr-&&* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
749 |
| 7 | 750 The "||" and "&&" operators take one argument on each side. The arguments |
| 751 are (converted to) Numbers. The result is: | |
| 752 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
753 input output ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
754 n1 n2 n1 || n2 n1 && n2 ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
755 |FALSE| |FALSE| |FALSE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
756 |FALSE| |TRUE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
757 |TRUE| |FALSE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
758 |TRUE| |TRUE| |TRUE| |TRUE| |
| 7 | 759 |
| 760 The operators can be concatenated, for example: > | |
| 761 | |
| 762 &nu || &list && &shell == "csh" | |
| 763 | |
| 764 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 765 | |
| 766 &nu || (&list && &shell == "csh") | |
| 767 | |
| 768 Once the result is known, the expression "short-circuits", that is, further | |
| 769 arguments are not evaluated. This is like what happens in C. For example: > | |
| 770 | |
| 771 let a = 1 | |
| 772 echo a || b | |
| 773 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
774 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
|
775 so the result must be |TRUE|. Similarly below: > |
| 7 | 776 |
| 777 echo exists("b") && b == "yes" | |
| 778 | |
| 779 This is valid whether "b" has been defined or not. The second clause will | |
| 780 only be evaluated if "b" has been defined. | |
| 781 | |
| 782 | |
| 783 expr4 *expr4* | |
| 784 ----- | |
| 785 | |
| 786 expr5 {cmp} expr5 | |
| 787 | |
| 788 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 789 if it evaluates to true. | |
| 790 | |
| 1621 | 791 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 792 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 793 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 794 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 795 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 796 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 2908 | 797 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
| 798 *expr-is?* *expr-isnot?* | |
| 7 | 799 use 'ignorecase' match case ignore case ~ |
| 800 equal == ==# ==? | |
| 801 not equal != !=# !=? | |
| 802 greater than > ># >? | |
| 803 greater than or equal >= >=# >=? | |
| 804 smaller than < <# <? | |
| 805 smaller than or equal <= <=# <=? | |
| 806 regexp matches =~ =~# =~? | |
| 807 regexp doesn't match !~ !~# !~? | |
| 2908 | 808 same instance is is# is? |
| 809 different instance isnot isnot# isnot? | |
| 7 | 810 |
| 811 Examples: | |
| 812 "abc" ==# "Abc" evaluates to 0 | |
| 813 "abc" ==? "Abc" evaluates to 1 | |
| 814 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 815 | |
| 85 | 816 *E691* *E692* |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
817 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
|
818 "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
|
819 recursively. Ignoring case means case is ignored when comparing item values. |
| 79 | 820 |
| 114 | 821 *E735* *E736* |
| 685 | 822 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
|
823 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
|
824 |Dictionary| recursively. Ignoring case means case is ignored when comparing |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
825 item values. |
| 114 | 826 |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
827 *E694* |
|
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
828 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
|
829 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
|
830 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
|
831 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
|
832 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
|
833 |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
834 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
|
835 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
|
836 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
|
837 " Part1 and Part2 refer to the same function |
| 685 | 838 |
| 2908 | 839 When using "is" or "isnot" with a |List| or a |Dictionary| this checks if the |
| 840 expressions are referring to the same |List| or |Dictionary| instance. A copy | |
| 841 of a |List| is different from the original |List|. When using "is" without | |
| 842 a |List| or a |Dictionary| it is equivalent to using "equal", using "isnot" | |
| 843 equivalent to using "not equal". Except that a different type means the | |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
844 values are different: > |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
845 echo 4 == '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
846 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
847 echo 4 is '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
848 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
849 echo 0 is [] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
850 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
851 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
| 79 | 852 |
| 7 | 853 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
|
854 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
|
855 echo 0 == 'x' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
856 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
857 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
|
858 echo [0] == ['x'] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
859 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
860 Inside a List or Dictionary this conversion is not used. |
| 7 | 861 |
| 862 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 863 results in the mathematical difference (comparing byte values), not | |
| 864 necessarily the alphabetical difference in the local language. | |
| 865 | |
| 1621 | 866 When using the operators with a trailing '#', or the short version and |
| 1156 | 867 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 868 |
| 869 When using the operators with a trailing '?', or the short version and | |
| 1156 | 870 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 871 | |
| 872 'smartcase' is not used. | |
| 7 | 873 |
| 874 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 875 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 876 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 877 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 878 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 879 single-quote string, see |literal-string|. | |
| 880 Since a string is considered to be a single line, a multi-line pattern | |
| 881 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 882 can be matched like an ordinary character. Examples: | |
| 883 "foo\nbar" =~ "\n" evaluates to 1 | |
| 884 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 885 | |
| 886 | |
| 887 expr5 and expr6 *expr5* *expr6* | |
| 888 --------------- | |
| 685 | 889 expr6 + expr6 .. Number addition or |List| concatenation *expr-+* |
| 79 | 890 expr6 - expr6 .. Number subtraction *expr--* |
| 891 expr6 . expr6 .. String concatenation *expr-.* | |
| 892 | |
| 692 | 893 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 894 result is a new list with the two lists Concatenated. |
| 79 | 895 |
| 3214 | 896 expr7 * expr7 .. Number multiplication *expr-star* |
| 897 expr7 / expr7 .. Number division *expr-/* | |
| 898 expr7 % expr7 .. Number modulo *expr-%* | |
| 7 | 899 |
| 900 For all, except ".", Strings are converted to Numbers. | |
| 3214 | 901 For bitwise operators see |and()|, |or()| and |xor()|. |
| 7 | 902 |
| 903 Note the difference between "+" and ".": | |
| 904 "123" + "456" = 579 | |
| 905 "123" . "456" = "123456" | |
| 906 | |
| 1621 | 907 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 908 1 . 90 + 90.0 | |
| 909 As: > | |
| 910 (1 . 90) + 90.0 | |
| 911 That works, since the String "190" is automatically converted to the Number | |
| 912 190, which can be added to the Float 90.0. However: > | |
| 913 1 . 90 * 90.0 | |
| 914 Should be read as: > | |
| 915 1 . (90 * 90.0) | |
| 916 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 917 attempts to concatenate a Float and a String. | |
| 918 | |
| 919 When dividing a Number by zero the result depends on the value: | |
| 920 0 / 0 = -0x80000000 (like NaN for Float) | |
| 921 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 922 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 923 (before Vim 7.2 it was always 0x7fffffff) | |
| 924 | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
925 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
|
926 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
|
927 >0 / 0 = 0x7fffffffffffffff (like positive infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
928 <0 / 0 = -0x7fffffffffffffff (like negative infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
929 |
| 7 | 930 When the righthand side of '%' is zero, the result is 0. |
| 931 | |
| 685 | 932 None of these work for |Funcref|s. |
| 79 | 933 |
| 1621 | 934 . and % do not work for Float. *E804* |
| 935 | |
| 7 | 936 |
| 937 expr7 *expr7* | |
| 938 ----- | |
| 939 ! expr7 logical NOT *expr-!* | |
| 940 - expr7 unary minus *expr-unary--* | |
| 941 + expr7 unary plus *expr-unary-+* | |
| 942 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
943 For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one). |
| 7 | 944 For '-' the sign of the number is changed. |
| 945 For '+' the number is unchanged. | |
| 946 | |
| 947 A String will be converted to a Number first. | |
| 948 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
949 These three can be repeated and mixed. Examples: |
| 7 | 950 !-1 == 0 |
| 951 !!8 == 1 | |
| 952 --9 == 9 | |
| 953 | |
| 954 | |
| 955 expr8 *expr8* | |
| 956 ----- | |
| 685 | 957 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
|
958 *E909* *subscript* |
| 102 | 959 If expr8 is a Number or String this results in a String that contains the |
| 960 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
|
961 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
|
962 an alternative, or use `split()` to turn the string into a list of characters. |
| 55 | 963 |
|
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7358
diff
changeset
|
964 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
|
965 text column numbers start with one! Example, to get the byte under the |
| 55 | 966 cursor: > |
| 823 | 967 :let c = getline(".")[col(".") - 1] |
| 7 | 968 |
| 969 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
|
970 String. A negative index always results in an empty string (reason: backward |
| 55 | 971 compatibility). Use [-1:] to get the last byte. |
| 972 | |
| 685 | 973 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 974 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
|
975 error. Example: > |
| 55 | 976 :let item = mylist[-1] " get last item |
| 977 | |
| 685 | 978 Generally, if a |List| index is equal to or higher than the length of the |
| 979 |List|, or more negative than the length of the |List|, this results in an | |
| 980 error. | |
| 55 | 981 |
| 99 | 982 |
| 102 | 983 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 984 | |
| 985 If expr8 is a Number or String this results in the substring with the bytes | |
| 986 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
|
987 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
|
988 |byteidx()| for computing the indexes. |
| 55 | 989 |
| 990 If expr1a is omitted zero is used. If expr1b is omitted the length of the | |
| 991 string minus one is used. | |
| 992 | |
| 993 A negative number can be used to measure from the end of the string. -1 is | |
| 994 the last character, -2 the last but one, etc. | |
| 995 | |
| 996 If an index goes out of range for the string characters are omitted. If | |
| 997 expr1b is smaller than expr1a the result is an empty string. | |
| 998 | |
| 999 Examples: > | |
| 1000 :let c = name[-1:] " last byte of a string | |
| 1001 :let c = name[-2:-2] " last but one byte of a string | |
| 1002 :let s = line(".")[4:] " from the fifth byte to the end | |
| 1003 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1004 < |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
1005 *slice* |
| 685 | 1006 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
|
1007 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
|
1008 just above. Also see |sublist| below. Examples: > |
| 55 | 1009 :let l = mylist[:3] " first four items |
| 1010 :let l = mylist[4:4] " List with one item | |
| 1011 :let l = mylist[:] " shallow copy of a List | |
| 1012 | |
| 685 | 1013 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 1014 error. | |
| 1015 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1016 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
|
1017 for a sublist: > |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1018 mylist[n:] " uses variable n |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1019 mylist[s:] " uses namespace s:, error! |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1020 |
| 685 | 1021 |
| 1022 expr8.name entry in a |Dictionary| *expr-entry* | |
| 1023 | |
| 1024 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 1025 name will be used as a key in the |Dictionary|. This is just like: | |
| 1026 expr8[name]. | |
| 99 | 1027 |
| 1028 The name must consist of alphanumeric characters, just like a variable name, | |
| 1029 but it may start with a number. Curly braces cannot be used. | |
| 1030 | |
| 1031 There must not be white space before or after the dot. | |
| 1032 | |
| 1033 Examples: > | |
| 1034 :let dict = {"one": 1, 2: "two"} | |
| 1035 :echo dict.one | |
| 1036 :echo dict .2 | |
| 1037 | |
| 1038 Note that the dot is also used for String concatenation. To avoid confusion | |
| 1039 always put spaces around the dot for String concatenation. | |
| 1040 | |
| 1041 | |
| 685 | 1042 expr8(expr1, ...) |Funcref| function call |
| 102 | 1043 |
| 1044 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 1045 | |
| 1046 | |
| 1047 | |
| 1048 *expr9* | |
| 7 | 1049 number |
| 1050 ------ | |
| 12785 | 1051 number number constant *expr-number* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1052 *hex-number* *octal-number* *binary-number* |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1053 |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1054 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
|
1055 and Octal (starting with 0). |
| 7 | 1056 |
| 1621 | 1057 *floating-point-format* |
| 1058 Floating point numbers can be written in two forms: | |
| 1059 | |
| 1060 [-+]{N}.{M} | |
| 6530 | 1061 [-+]{N}.{M}[eE][-+]{exp} |
| 1621 | 1062 |
| 1063 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 1064 contain digits. | |
| 1065 [-+] means there is an optional plus or minus sign. | |
| 1066 {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
|
1067 Only a decimal point is accepted, not a comma. No matter what the current |
| 1621 | 1068 locale is. |
| 1069 {only when compiled with the |+float| feature} | |
| 1070 | |
| 1071 Examples: | |
| 1072 123.456 | |
| 1073 +0.0001 | |
| 1074 55.0 | |
| 1075 -0.123 | |
| 1076 1.234e03 | |
| 1077 1.0E-6 | |
| 1078 -3.1416e+88 | |
| 1079 | |
| 1080 These are INVALID: | |
| 1081 3. empty {M} | |
| 1082 1e40 missing .{M} | |
| 1083 | |
| 1698 | 1084 *float-pi* *float-e* |
| 1085 A few useful values to copy&paste: > | |
| 1086 :let pi = 3.14159265359 | |
| 1087 :let e = 2.71828182846 | |
| 1088 | |
| 1621 | 1089 Rationale: |
| 1090 Before floating point was introduced, the text "123.456" was interpreted as | |
| 1091 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 1092 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 1093 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 1094 incompatibility was accepted in favor of being able to use the normal notation |
| 1095 for floating point numbers. | |
| 1096 | |
| 1097 *floating-point-precision* | |
| 1098 The precision and range of floating points numbers depends on what "double" | |
| 1099 means in the library Vim was compiled with. There is no way to change this at | |
| 1100 runtime. | |
| 1101 | |
| 1102 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 1103 printf("%g", f). You can select something else when using the |printf()| | |
| 1104 function. Example: > | |
| 1105 :echo printf('%.15e', atan(1)) | |
| 1106 < 7.853981633974483e-01 | |
| 1107 | |
| 1108 | |
| 7 | 1109 |
| 6884 | 1110 string *string* *String* *expr-string* *E114* |
| 7 | 1111 ------ |
| 1112 "string" string constant *expr-quote* | |
| 1113 | |
| 1114 Note that double quotes are used. | |
| 1115 | |
| 1116 A string constant accepts these special characters: | |
| 1117 \... three-digit octal number (e.g., "\316") | |
| 1118 \.. two-digit octal number (must be followed by non-digit) | |
| 1119 \. one-digit octal number (must be followed by non-digit) | |
| 1120 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1121 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1122 \X.. same as \x.. | |
| 1123 \X. same as \x. | |
| 1621 | 1124 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1125 current value of 'encoding' (e.g., "\u02a4") |
| 6840 | 1126 \U.... same as \u but allows up to 8 hex numbers. |
| 7 | 1127 \b backspace <BS> |
| 1128 \e escape <Esc> | |
| 1129 \f formfeed <FF> | |
| 1130 \n newline <NL> | |
| 1131 \r return <CR> | |
| 1132 \t tab <Tab> | |
| 1133 \\ backslash | |
| 1134 \" double quote | |
| 2152 | 1135 \<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
|
1136 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
|
1137 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
|
1138 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
|
1139 mentioned above. |
| 7 | 1140 |
| 1156 | 1141 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1142 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1143 of 'encoding'. | |
| 1144 | |
| 7 | 1145 Note that "\000" and "\x00" force the end of the string. |
| 1146 | |
| 1147 | |
| 1148 literal-string *literal-string* *E115* | |
| 1149 --------------- | |
| 26 | 1150 'string' string constant *expr-'* |
| 7 | 1151 |
| 1152 Note that single quotes are used. | |
| 1153 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1154 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1155 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1156 |
| 1157 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
|
1158 to be doubled. These two commands are equivalent: > |
| 26 | 1159 if a =~ "\\s*" |
| 1160 if a =~ '\s*' | |
| 7 | 1161 |
| 1162 | |
| 1163 option *expr-option* *E112* *E113* | |
| 1164 ------ | |
| 1165 &option option value, local value if possible | |
| 1166 &g:option global option value | |
| 1167 &l:option local option value | |
| 1168 | |
| 1169 Examples: > | |
| 1170 echo "tabstop is " . &tabstop | |
| 1171 if &insertmode | |
| 1172 | |
| 1173 Any option name can be used here. See |options|. When using the local value | |
| 1174 and there is no buffer-local or window-local value, the global value is used | |
| 1175 anyway. | |
| 1176 | |
| 1177 | |
| 1156 | 1178 register *expr-register* *@r* |
| 7 | 1179 -------- |
| 1180 @r contents of register 'r' | |
| 1181 | |
| 1182 The result is the contents of the named register, as a single string. | |
| 1183 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
|
1184 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1185 registers. |
| 1186 | |
| 1187 When using the '=' register you get the expression itself, not what it | |
| 1188 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1189 |
| 1190 | |
| 1191 nesting *expr-nesting* *E110* | |
| 1192 ------- | |
| 1193 (expr1) nested expression | |
| 1194 | |
| 1195 | |
| 1196 environment variable *expr-env* | |
| 1197 -------------------- | |
| 1198 $VAR environment variable | |
| 1199 | |
| 1200 The String value of any environment variable. When it is not defined, the | |
| 1201 result is an empty string. | |
| 1202 *expr-env-expand* | |
| 1203 Note that there is a difference between using $VAR directly and using | |
| 1204 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1205 are known inside the current Vim session. Using expand() will first try using | |
| 1206 the environment variables known inside the current Vim session. If that | |
| 1207 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1208 does expand all variables that the shell knows about. Example: > | |
| 6180 | 1209 :echo $shell |
| 1210 :echo expand("$shell") | |
| 1211 The first one probably doesn't echo anything, the second echoes the $shell | |
| 7 | 1212 variable (if your shell supports it). |
| 1213 | |
| 1214 | |
| 1215 internal variable *expr-variable* | |
| 1216 ----------------- | |
| 1217 variable internal variable | |
| 1218 See below |internal-variables|. | |
| 1219 | |
| 1220 | |
| 170 | 1221 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1222 ------------- |
| 1223 function(expr1, ...) function call | |
| 1224 See below |functions|. | |
| 1225 | |
| 1226 | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1227 lambda expression *expr-lambda* *lambda* |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1228 ----------------- |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1229 {args -> expr1} lambda expression |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1230 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1231 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
|
1232 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
|
1233 the following ways: |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1234 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1235 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
|
1236 commands. |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1237 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
|
1238 :let F = {arg1, arg2 -> arg1 - arg2} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1239 :echo F(5, 2) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1240 < 3 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1241 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1242 The arguments are optional. Example: > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1243 :let F = {-> 'error function'} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1244 :echo F() |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1245 < error function |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1246 *closure* |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1247 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
|
1248 often called a closure. Example where "i" and "a:arg" are used in a lambda |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
1249 while they exist in the function scope. They remain valid even after the |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1250 function returns: > |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1251 :function Foo(arg) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1252 : let i = 3 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1253 : return {x -> x + i - a:arg} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1254 :endfunction |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1255 :let Bar = Foo(4) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1256 :echo Bar(6) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1257 < 5 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1258 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1259 See also |:func-closure|. Lambda and closure support can be checked with: > |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1260 if has('lambda') |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1261 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1262 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
|
1263 :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
|
1264 < [2, 3, 4] > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1265 :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
|
1266 < [1, 2, 3, 4, 7] |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1267 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1268 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
|
1269 :let timer = timer_start(500, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1270 \ {-> execute("echo 'Handler called'", "")}, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1271 \ {'repeat': 3}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1272 < Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1273 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1274 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1275 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1276 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
|
1277 |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1278 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1279 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
|
1280 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
|
1281 :function {'<lambda>42'} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1282 See also: |numbered-function| |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1283 |
| 7 | 1284 ============================================================================== |
| 2596 | 1285 3. Internal variable *internal-variables* *E461* |
| 1286 | |
| 7 | 1287 An internal variable name can be made up of letters, digits and '_'. But it |
| 1288 cannot start with a digit. It's also possible to use curly braces, see | |
| 1289 |curly-braces-names|. | |
| 1290 | |
| 1291 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1292 An internal variable is explicitly destroyed with the ":unlet" command |
| 1293 |:unlet|. | |
| 1294 Using a name that is not an internal variable or refers to a variable that has | |
| 1295 been destroyed results in an error. | |
| 7 | 1296 |
| 1297 There are several name spaces for variables. Which one is to be used is | |
| 1298 specified by what is prepended: | |
| 1299 | |
| 1300 (nothing) In a function: local to a function; otherwise: global | |
| 1301 |buffer-variable| b: Local to the current buffer. | |
| 1302 |window-variable| w: Local to the current window. | |
| 819 | 1303 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1304 |global-variable| g: Global. |
| 1305 |local-variable| l: Local to a function. | |
| 1306 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1307 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1308 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1309 |
| 685 | 1310 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1311 delete all script-local variables: > | |
| 133 | 1312 :for k in keys(s:) |
| 1313 : unlet s:[k] | |
| 1314 :endfor | |
| 1315 < | |
| 4358 | 1316 *buffer-variable* *b:var* *b:* |
| 7 | 1317 A variable name that is preceded with "b:" is local to the current buffer. |
| 1318 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1319 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1320 |:bdelete|. | |
| 1321 | |
| 1322 One local buffer variable is predefined: | |
| 4264 | 1323 *b:changedtick* *changetick* |
| 7 | 1324 b:changedtick The total number of changes to the current buffer. It is |
| 1325 incremented for each change. An undo command is also a change | |
| 1326 in this case. This can be used to perform an action only when | |
| 1327 the buffer has changed. Example: > | |
| 1328 :if my_changedtick != b:changedtick | |
| 1621 | 1329 : let my_changedtick = b:changedtick |
| 1330 : call My_Update() | |
| 7 | 1331 :endif |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1332 < You cannot change or delete the b:changedtick variable. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1333 |
| 4358 | 1334 *window-variable* *w:var* *w:* |
| 7 | 1335 A variable name that is preceded with "w:" is local to the current window. It |
| 1336 is deleted when the window is closed. | |
| 1337 | |
| 4437 | 1338 *tabpage-variable* *t:var* *t:* |
| 819 | 1339 A variable name that is preceded with "t:" is local to the current tab page, |
| 1340 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
|
1341 without the |+windows| feature} |
| 819 | 1342 |
| 4358 | 1343 *global-variable* *g:var* *g:* |
| 7 | 1344 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
|
1345 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1346 place if you like. |
| 1347 | |
| 4358 | 1348 *local-variable* *l:var* *l:* |
| 7 | 1349 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1350 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1351 you may run into reserved variable names. For example "count". By itself it | |
| 1352 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1353 same name. | |
| 7 | 1354 |
| 1355 *script-variable* *s:var* | |
| 1356 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1357 accessed from outside of the scripts, thus are local to the script. | |
| 1358 | |
| 1359 They can be used in: | |
| 1360 - commands executed while the script is sourced | |
| 1361 - functions defined in the script | |
| 1362 - autocommands defined in the script | |
| 1363 - functions and autocommands defined in functions and autocommands which were | |
| 1364 defined in the script (recursively) | |
| 1365 - user defined commands defined in the script | |
| 1366 Thus not in: | |
| 1367 - other scripts sourced from this one | |
| 1368 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1369 - menus |
| 7 | 1370 - etc. |
| 1371 | |
| 1156 | 1372 Script variables can be used to avoid conflicts with global variable names. |
| 1373 Take this example: > | |
| 7 | 1374 |
| 1375 let s:counter = 0 | |
| 1376 function MyCounter() | |
| 1377 let s:counter = s:counter + 1 | |
| 1378 echo s:counter | |
| 1379 endfunction | |
| 1380 command Tick call MyCounter() | |
| 1381 | |
| 1382 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1383 that script will not be changed, only the "s:counter" in the script where | |
| 1384 "Tick" was defined is used. | |
| 1385 | |
| 1386 Another example that does the same: > | |
| 1387 | |
| 1388 let s:counter = 0 | |
| 1389 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1390 | |
| 1391 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1392 script variables is set to the script where the function or command was |
| 7 | 1393 defined. |
| 1394 | |
| 1395 The script variables are also available when a function is defined inside a | |
| 1396 function that is defined in a script. Example: > | |
| 1397 | |
| 1398 let s:counter = 0 | |
| 1399 function StartCounting(incr) | |
| 1400 if a:incr | |
| 1401 function MyCounter() | |
| 1402 let s:counter = s:counter + 1 | |
| 1403 endfunction | |
| 1404 else | |
| 1405 function MyCounter() | |
| 1406 let s:counter = s:counter - 1 | |
| 1407 endfunction | |
| 1408 endif | |
| 1409 endfunction | |
| 1410 | |
| 1411 This defines the MyCounter() function either for counting up or counting down | |
| 1412 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1413 called, the s:counter variable will be accessible in MyCounter(). | |
| 1414 | |
| 1415 When the same script is sourced again it will use the same script variables. | |
| 1416 They will remain valid as long as Vim is running. This can be used to | |
| 1417 maintain a counter: > | |
| 1418 | |
| 1419 if !exists("s:counter") | |
| 1420 let s:counter = 1 | |
| 1421 echo "script executed for the first time" | |
| 1422 else | |
| 1423 let s:counter = s:counter + 1 | |
| 1424 echo "script executed " . s:counter . " times now" | |
| 1425 endif | |
| 1426 | |
| 1427 Note that this means that filetype plugins don't get a different set of script | |
| 1428 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1429 | |
| 1430 | |
| 4358 | 1431 Predefined Vim variables: *vim-variable* *v:var* *v:* |
| 7 | 1432 |
| 189 | 1433 *v:beval_col* *beval_col-variable* |
| 1434 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1435 This is the byte index in the |v:beval_lnum| line. | |
| 1436 Only valid while evaluating the 'balloonexpr' option. | |
| 1437 | |
| 1438 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1439 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1440 valid while evaluating the 'balloonexpr' option. | |
| 1441 | |
| 1442 *v:beval_lnum* *beval_lnum-variable* | |
| 1443 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1444 valid while evaluating the 'balloonexpr' option. | |
| 1445 | |
| 1446 *v:beval_text* *beval_text-variable* | |
| 374 | 1447 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1448 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1449 but a dot and "->" before the position is included. When on a | |
| 1450 ']' the text before it is used, including the matching '[' and | |
| 189 | 1451 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
|
1452 highlighted text is used. Also see |<cexpr>|. |
| 189 | 1453 Only valid while evaluating the 'balloonexpr' option. |
| 1454 | |
| 1455 *v:beval_winnr* *beval_winnr-variable* | |
| 1456 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1457 valid while evaluating the 'balloonexpr' option. The first |
| 1458 window has number zero (unlike most other places where a | |
| 1459 window gets a number). | |
| 189 | 1460 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1461 *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
|
1462 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
|
1463 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
|
1464 |
| 844 | 1465 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1466 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
|
1467 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
|
1468 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1469 |
| 7 | 1470 *v:charconvert_from* *charconvert_from-variable* |
| 1471 v:charconvert_from | |
| 1472 The name of the character encoding of a file to be converted. | |
| 1473 Only valid while evaluating the 'charconvert' option. | |
| 1474 | |
| 1475 *v:charconvert_to* *charconvert_to-variable* | |
| 1476 v:charconvert_to | |
| 1477 The name of the character encoding of a file after conversion. | |
| 1478 Only valid while evaluating the 'charconvert' option. | |
| 1479 | |
| 1480 *v:cmdarg* *cmdarg-variable* | |
| 1481 v:cmdarg This variable is used for two purposes: | |
| 1482 1. The extra arguments given to a file read/write command. | |
| 1483 Currently these are "++enc=" and "++ff=". This variable is | |
| 1484 set before an autocommand event for a file read/write | |
| 1485 command is triggered. There is a leading space to make it | |
| 1486 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
|
1487 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1488 included here, because it will be executed anyway. |
| 1489 2. When printing a PostScript file with ":hardcopy" this is | |
| 1490 the argument for the ":hardcopy" command. This can be used | |
| 1491 in 'printexpr'. | |
| 1492 | |
| 1493 *v:cmdbang* *cmdbang-variable* | |
| 1494 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1495 was used the value is 1, otherwise it is 0. Note that this | |
| 1496 can only be used in autocommands. For user commands |<bang>| | |
| 1497 can be used. | |
| 1498 | |
| 6909 | 1499 *v:completed_item* *completed_item-variable* |
| 1500 v:completed_item | |
| 1501 |Dictionary| containing the |complete-items| for the most | |
| 1502 recently completed word after |CompleteDone|. The | |
| 1503 |Dictionary| is empty if the completion failed. | |
| 1504 | |
| 7 | 1505 *v:count* *count-variable* |
| 1506 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
|
1507 to get the count before a mapping. Read-only. Example: > |
| 7 | 1508 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1509 < Note: The <C-U> is required to remove the line range that you | |
| 1510 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1511 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1512 just like what happens in the command, "d6w" for the example. |
| 667 | 1513 Also used for evaluating the 'formatexpr' option. |
| 7 | 1514 "count" also works, for backwards compatibility. |
| 1515 | |
| 1516 *v:count1* *count1-variable* | |
| 1517 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1518 used. | |
| 1519 | |
| 1520 *v:ctype* *ctype-variable* | |
| 1521 v:ctype The current locale setting for characters of the runtime | |
| 1522 environment. This allows Vim scripts to be aware of the | |
| 1523 current locale encoding. Technical: it's the value of | |
| 1524 LC_CTYPE. When not using a locale the value is "C". | |
| 1525 This variable can not be set directly, use the |:language| | |
| 1526 command. | |
| 1527 See |multi-lang|. | |
| 1528 | |
| 1529 *v:dying* *dying-variable* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1530 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1531 one. When multiple signals are caught the number increases. |
| 1532 Can be used in an autocommand to check if Vim didn't | |
| 1533 terminate normally. {only works on Unix} | |
| 1534 Example: > | |
| 1535 :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
|
1536 < 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
|
1537 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
|
1538 |
| 7 | 1539 *v:errmsg* *errmsg-variable* |
| 1540 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1541 Example: > | |
| 1542 :let v:errmsg = "" | |
| 1543 :silent! next | |
| 1544 :if v:errmsg != "" | |
| 1545 : ... handle error | |
| 1546 < "errmsg" also works, for backwards compatibility. | |
| 1547 | |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1548 *v:errors* *errors-variable* |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1549 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
|
1550 This is a list of strings. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1551 The assert functions append an item when an assert fails. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1552 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
|
1553 :let v:errors = [] |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1554 < 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
|
1555 list by the assert function. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1556 |
| 7 | 1557 *v:exception* *exception-variable* |
| 1558 v:exception The value of the exception most recently caught and not | |
| 1559 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1560 Example: > | |
| 1561 :try | |
| 1562 : throw "oops" | |
| 1563 :catch /.*/ | |
| 1564 : echo "caught" v:exception | |
| 1565 :endtry | |
| 1566 < Output: "caught oops". | |
| 1567 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1568 *v:false* *false-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1569 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
|
1570 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1571 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
|
1572 echo v:false |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1573 < v:false ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1574 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
|
1575 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1576 |
| 179 | 1577 *v:fcs_reason* *fcs_reason-variable* |
| 1578 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1579 Can be used in an autocommand to decide what to do and/or what | |
| 1580 to set v:fcs_choice to. Possible values: | |
| 1581 deleted file no longer exists | |
| 1582 conflict file contents, mode or timestamp was | |
| 1583 changed and buffer is modified | |
| 1584 changed file contents has changed | |
| 1585 mode mode of file changed | |
| 1586 time only file timestamp changed | |
| 1587 | |
| 1588 *v:fcs_choice* *fcs_choice-variable* | |
| 1589 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1590 triggered. Can be used in an autocommand to tell Vim what to | |
| 1591 do with the affected buffer: | |
| 1592 reload Reload the buffer (does not work if | |
| 1593 the file was deleted). | |
| 1594 ask Ask the user what to do, as if there | |
| 1595 was no autocommand. Except that when | |
| 1596 only the timestamp changed nothing | |
| 1597 will happen. | |
| 1598 <empty> Nothing, the autocommand should do | |
| 1599 everything that needs to be done. | |
| 1600 The default is empty. If another (invalid) value is used then | |
| 1601 Vim behaves like it is empty, there is no warning message. | |
| 1602 | |
| 7 | 1603 *v:fname_in* *fname_in-variable* |
| 579 | 1604 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1605 option used for ~ |
| 1606 'charconvert' file to be converted | |
| 1607 'diffexpr' original file | |
| 1608 'patchexpr' original file | |
| 1609 'printexpr' file to be printed | |
| 593 | 1610 And set to the swap file name for |SwapExists|. |
| 7 | 1611 |
| 1612 *v:fname_out* *fname_out-variable* | |
| 1613 v:fname_out The name of the output file. Only valid while | |
| 1614 evaluating: | |
| 1615 option used for ~ | |
| 1616 'charconvert' resulting converted file (*) | |
| 1617 'diffexpr' output of diff | |
| 1618 'patchexpr' resulting patched file | |
| 1619 (*) 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
|
1620 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1621 for a read command (e.g., ":e file") it will be a temporary |
| 1622 file and different from v:fname_in. | |
| 1623 | |
| 1624 *v:fname_new* *fname_new-variable* | |
| 1625 v:fname_new The name of the new version of the file. Only valid while | |
| 1626 evaluating 'diffexpr'. | |
| 1627 | |
| 1628 *v:fname_diff* *fname_diff-variable* | |
| 1629 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1630 evaluating 'patchexpr'. | |
| 1631 | |
| 1632 *v:folddashes* *folddashes-variable* | |
| 1633 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1634 fold. | |
| 29 | 1635 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1636 |
| 1637 *v:foldlevel* *foldlevel-variable* | |
| 1638 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1639 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1640 |
| 1641 *v:foldend* *foldend-variable* | |
| 1642 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1643 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1644 |
| 1645 *v:foldstart* *foldstart-variable* | |
| 1646 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1647 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1648 |
| 5460 | 1649 *v:hlsearch* *hlsearch-variable* |
| 12785 | 1650 v:hlsearch Variable that indicates whether search highlighting is on. |
| 6413 | 1651 Setting it makes sense only if 'hlsearch' is enabled which |
| 1652 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
|
1653 like the |:nohlsearch| command, setting it to one acts like > |
| 5460 | 1654 let &hlsearch = &hlsearch |
| 6918 | 1655 < Note that the value is restored when returning from a |
| 1656 function. |function-search-undo|. | |
| 1657 | |
| 11 | 1658 *v:insertmode* *insertmode-variable* |
| 1659 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1660 events. Values: | |
| 1661 i Insert mode | |
| 1662 r Replace mode | |
| 1663 v Virtual Replace mode | |
| 1664 | |
| 102 | 1665 *v:key* *key-variable* |
| 685 | 1666 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1667 evaluating the expression used with |map()| and |filter()|. |
| 1668 Read-only. | |
| 1669 | |
| 7 | 1670 *v:lang* *lang-variable* |
| 1671 v:lang The current locale setting for messages of the runtime | |
| 1672 environment. This allows Vim scripts to be aware of the | |
| 1673 current language. Technical: it's the value of LC_MESSAGES. | |
| 1674 The value is system dependent. | |
| 1675 This variable can not be set directly, use the |:language| | |
| 1676 command. | |
| 1677 It can be different from |v:ctype| when messages are desired | |
| 1678 in a different language than what is used for character | |
| 1679 encoding. See |multi-lang|. | |
| 1680 | |
| 1681 *v:lc_time* *lc_time-variable* | |
| 1682 v:lc_time The current locale setting for time messages of the runtime | |
| 1683 environment. This allows Vim scripts to be aware of the | |
| 1684 current language. Technical: it's the value of LC_TIME. | |
| 1685 This variable can not be set directly, use the |:language| | |
| 1686 command. See |multi-lang|. | |
| 1687 | |
| 1688 *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
|
1689 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
|
1690 '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
|
1691 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
|
1692 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
|
1693 |sandbox|. |
| 7 | 1694 |
| 1029 | 1695 *v:mouse_win* *mouse_win-variable* |
| 1696 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1697 First window has number 1, like with |winnr()|. The value is | |
| 1698 zero when there was no mouse button click. | |
| 1699 | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1700 *v:mouse_winid* *mouse_winid-variable* |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1701 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
|
1702 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
|
1703 |
| 1029 | 1704 *v:mouse_lnum* *mouse_lnum-variable* |
| 1705 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1706 This is the text line number, not the screen line number. The | |
| 1707 value is zero when there was no mouse button click. | |
| 1708 | |
| 1709 *v:mouse_col* *mouse_col-variable* | |
| 1710 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1711 This is the screen column number, like with |virtcol()|. The | |
| 1712 value is zero when there was no mouse button click. | |
| 1713 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1714 *v:none* *none-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1715 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
|
1716 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1717 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
|
1718 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
|
1719 echo v:none |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1720 < v:none ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1721 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
|
1722 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1723 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1724 *v:null* *null-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1725 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
|
1726 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1727 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
|
1728 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
|
1729 echo v:null |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1730 < v:null ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1731 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
|
1732 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1733 |
| 1733 | 1734 *v:oldfiles* *oldfiles-variable* |
| 1735 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 1736 startup. These are the files that Vim remembers marks for. | |
| 1737 The length of the List is limited by the ' argument of the | |
| 1738 'viminfo' option (default is 100). | |
| 5618 | 1739 When the |viminfo| file is not used the List is empty. |
| 1733 | 1740 Also see |:oldfiles| and |c_#<|. |
| 1741 The List can be modified, but this has no effect on what is | |
| 1742 stored in the |viminfo| file later. If you use values other | |
| 1743 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
|
1744 {only when compiled with the |+viminfo| feature} |
| 1733 | 1745 |
| 6935 | 1746 *v:option_new* |
| 1747 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 1748 autocommand. | |
| 1749 *v:option_old* | |
| 1750 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
| 1751 autocommand. | |
| 1752 *v:option_type* | |
| 1753 v:option_type Scope of the set command. Valid while executing an | |
| 1754 |OptionSet| autocommand. Can be either "global" or "local" | |
| 1490 | 1755 *v:operator* *operator-variable* |
| 1756 v:operator The last operator given in Normal mode. This is a single | |
| 1757 character except for commands starting with <g> or <z>, | |
| 1758 in which case it is two characters. Best used alongside | |
| 1759 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 1760 Operator-pending mode and then use the operator, e.g.: > | |
| 1761 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 1762 < The value remains set until another operator is entered, thus | |
| 1763 don't expect it to be empty. | |
| 1764 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 1765 commands. | |
| 1766 Read-only. | |
| 1767 | |
| 7 | 1768 *v:prevcount* *prevcount-variable* |
| 1769 v:prevcount The count given for the last but one Normal mode command. | |
| 1770 This is the v:count value of the previous command. Useful if | |
| 1490 | 1771 you want to cancel Visual or Operator-pending mode and then |
| 1772 use the count, e.g.: > | |
| 7 | 1773 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 1774 < Read-only. | |
| 1775 | |
| 170 | 1776 *v:profiling* *profiling-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1777 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 1778 See |profiling|. |
| 1779 | |
| 7 | 1780 *v:progname* *progname-variable* |
| 1781 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 1782 invoked. Allows you to do special initialisations for |view|, |
| 1783 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 1784 Read-only. |
| 1785 | |
| 5780 | 1786 *v:progpath* *progpath-variable* |
| 1787 v:progpath Contains the command with which Vim was invoked, including the | |
| 1788 path. Useful if you want to message a Vim server using a | |
| 1789 |--remote-expr|. | |
| 5782 | 1790 To get the full path use: > |
| 1791 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
|
1792 < 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
|
1793 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
|
1794 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
|
1795 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
|
1796 ".exe" is not added to v:progpath. |
| 5780 | 1797 Read-only. |
| 1798 | |
| 7 | 1799 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1800 v:register The name of the register in effect for the current normal mode |
| 3492 | 1801 command (regardless of whether that command actually used a |
| 1802 register). Or for the currently executing normal mode mapping | |
| 1803 (use this in custom commands that take a register). | |
| 1804 If none is supplied it is the default register '"', unless | |
| 1805 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 1806 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1807 Also see |getreg()| and |setreg()| |
| 7 | 1808 |
| 540 | 1809 *v:scrollstart* *scrollstart-variable* |
| 1810 v:scrollstart String describing the script or function that caused the | |
| 1811 screen to scroll up. It's only set when it is empty, thus the | |
| 1812 first reason is remembered. It is set to "Unknown" for a | |
| 1813 typed command. | |
| 1814 This can be used to find out why your script causes the | |
| 1815 hit-enter prompt. | |
| 1816 | |
| 7 | 1817 *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
|
1818 v:servername The resulting registered |client-server-name| if any. |
| 7 | 1819 Read-only. |
| 1820 | |
| 12785 | 1821 |
| 1621 | 1822 v:searchforward *v:searchforward* *searchforward-variable* |
| 1823 Search direction: 1 after a forward search, 0 after a | |
| 1824 backward search. It is reset to forward when directly setting | |
| 1825 the last search pattern, see |quote/|. | |
| 1826 Note that the value is restored when returning from a | |
| 1827 function. |function-search-undo|. | |
| 1828 Read-write. | |
| 1829 | |
| 7 | 1830 *v:shell_error* *shell_error-variable* |
| 1831 v:shell_error Result of the last shell command. When non-zero, the last | |
| 1832 shell command had an error. When zero, there was no problem. | |
| 1833 This only works when the shell returns the error code to Vim. | |
| 1834 The value -1 is often used when the command could not be | |
| 1835 executed. Read-only. | |
| 1836 Example: > | |
| 1837 :!mv foo bar | |
| 1838 :if v:shell_error | |
| 1839 : echo 'could not rename "foo" to "bar"!' | |
| 1840 :endif | |
| 1841 < "shell_error" also works, for backwards compatibility. | |
| 1842 | |
| 1843 *v:statusmsg* *statusmsg-variable* | |
| 1844 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 1845 | |
| 579 | 1846 *v:swapname* *swapname-variable* |
| 1847 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 1848 the swap file found. Read-only. | |
| 1849 | |
| 1850 *v:swapchoice* *swapchoice-variable* | |
| 1851 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 1852 for handling an existing swap file: | |
| 1853 'o' Open read-only | |
| 1854 'e' Edit anyway | |
| 1855 'r' Recover | |
| 1856 'd' Delete swapfile | |
| 1857 'q' Quit | |
| 1858 'a' Abort | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1859 The value should be a single-character string. An empty value |
| 579 | 1860 results in the user being asked, as would happen when there is |
| 1861 no SwapExists autocommand. The default is empty. | |
| 1862 | |
| 590 | 1863 *v:swapcommand* *swapcommand-variable* |
| 625 | 1864 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 1865 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
|
1866 another Vim open the file and jump to the right place. For |
| 590 | 1867 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 1868 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 1869 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1870 *v:t_TYPE* *v:t_bool* *t_bool-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1871 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
|
1872 *v:t_channel* *t_channel-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1873 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
|
1874 *v:t_dict* *t_dict-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1875 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
|
1876 *v:t_float* *t_float-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1877 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
|
1878 *v:t_func* *t_func-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1879 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
|
1880 *v:t_job* *t_job-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1881 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
|
1882 *v:t_list* *t_list-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1883 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
|
1884 *v:t_none* *t_none-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1885 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
|
1886 *v:t_number* *t_number-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1887 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
|
1888 *v:t_string* *t_string-variable* |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1889 v:t_string Value of String type. Read-only. See: |type()| |
|
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
1890 |
| 7 | 1891 *v:termresponse* *termresponse-variable* |
| 1892 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
|
1893 termcap entry. It is set when Vim receives an escape sequence |
| 7 | 1894 that starts with ESC [ or CSI and ends in a 'c', with only |
| 1895 digits, ';' and '.' in between. | |
| 1896 When this option is set, the TermResponse autocommand event is | |
| 1897 fired, so that you can react to the response from the | |
| 1898 terminal. | |
| 1899 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
| 1900 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
| 1901 patch level (since this was introduced in patch 95, it's | |
| 1902 always 95 or bigger). Pc is always zero. | |
| 1903 {only when compiled with |+termresponse| feature} | |
| 1904 | |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1905 *v:termblinkresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1906 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
|
1907 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
|
1908 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
|
1909 |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1910 *v:termstyleresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1911 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
|
1912 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
|
1913 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
|
1914 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
1915 *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
|
1916 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
|
1917 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
|
1918 background color is, see 'background'. |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1919 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
1920 *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
|
1921 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
|
1922 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
|
1923 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
|
1924 |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1925 *v:termu7resp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1926 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
|
1927 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
|
1928 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
|
1929 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1930 *v:testing* *testing-variable* |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
1931 v:testing Must be set before using `test_garbagecollect_now()`. |
| 11160 | 1932 Also, when set certain error messages won't be shown for 2 |
| 12785 | 1933 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
|
1934 |
| 7 | 1935 *v:this_session* *this_session-variable* |
| 1936 v:this_session Full filename of the last loaded or saved session file. See | |
| 1937 |:mksession|. It is allowed to set this variable. When no | |
| 1938 session file has been saved, this variable is empty. | |
| 1939 "this_session" also works, for backwards compatibility. | |
| 1940 | |
| 1941 *v:throwpoint* *throwpoint-variable* | |
| 1942 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
|
1943 finished was thrown. Not set when commands are typed. See |
| 7 | 1944 also |v:exception| and |throw-variables|. |
| 1945 Example: > | |
| 1946 :try | |
| 1947 : throw "oops" | |
| 1948 :catch /.*/ | |
| 1949 : echo "Exception from" v:throwpoint | |
| 1950 :endtry | |
| 1951 < Output: "Exception from test.vim, line 2" | |
| 1952 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1953 *v:true* *true-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1954 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
|
1955 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1956 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
|
1957 echo v:true |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1958 < v:true ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1959 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
|
1960 value. Read-only. |
| 102 | 1961 *v:val* *val-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1962 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 1963 valid while evaluating the expression used with |map()| and |
| 102 | 1964 |filter()|. Read-only. |
| 1965 | |
| 7 | 1966 *v:version* *version-variable* |
| 1967 v:version Version number of Vim: Major version number times 100 plus | |
| 1968 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
| 1969 is 501. Read-only. "version" also works, for backwards | |
| 1970 compatibility. | |
| 1971 Use |has()| to check if a certain patch was included, e.g.: > | |
| 5786 | 1972 if has("patch-7.4.123") |
| 7 | 1973 < Note that patch numbers are specific to the version, thus both |
| 1974 version 5.0 and 5.1 may have a patch 123, but these are | |
| 1975 completely different. | |
| 1976 | |
|
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1977 *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
|
1978 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
|
1979 before |VimEnter| autocommands are triggered. |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1980 |
| 7 | 1981 *v:warningmsg* *warningmsg-variable* |
| 1982 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 1983 | |
| 2609 | 1984 *v:windowid* *windowid-variable* |
| 1985 v:windowid When any X11 based GUI is running or when running in a | |
| 1986 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 1987 set to the window ID. |
| 1988 When an MS-Windows GUI is running this will be set to the | |
| 1989 window handle. | |
| 1990 Otherwise the value is zero. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1991 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
|
1992 see |window-ID|. |
| 2609 | 1993 |
| 7 | 1994 ============================================================================== |
| 1995 4. Builtin Functions *functions* | |
| 1996 | |
| 1997 See |function-list| for a list grouped by what the function is used for. | |
| 1998 | |
| 236 | 1999 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 2000 |
| 2001 USAGE RESULT DESCRIPTION ~ | |
| 2002 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2003 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
|
2004 acos({expr}) Float arc cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2005 add({list}, {item}) List append {item} to |List| {list} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2006 and({expr}, {expr}) Number bitwise AND |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2007 append({lnum}, {string}) Number append {string} below line {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2008 append({lnum}, {list}) Number append lines {list} below line {lnum} |
| 7 | 2009 argc() Number number of files in the argument list |
| 55 | 2010 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
|
2011 arglistid([{winnr} [, {tabnr}]]) Number argument list id |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2012 argv({nr}) String {nr} entry of the argument list |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2013 argv() List the argument list |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2014 assert_equal({exp}, {act} [, {msg}]) |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2015 none assert {exp} is equal to {act} |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2016 assert_exception({error} [, {msg}]) |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2017 none assert {error} is in v:exception |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2018 assert_fails({cmd} [, {error}]) none assert {cmd} fails |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2019 assert_false({actual} [, {msg}]) |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2020 none assert {actual} is false |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2021 assert_inrange({lower}, {upper}, {actual} [, {msg}]) |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
2022 none 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
|
2023 assert_match({pat}, {text} [, {msg}]) |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2024 none assert {pat} matches {text} |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2025 assert_notequal({exp}, {act} [, {msg}]) |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2026 none assert {exp} is not equal {act} |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2027 assert_notmatch({pat}, {text} [, {msg}]) |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2028 none assert {pat} not matches {text} |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2029 assert_report({msg}) none report a test failure |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2030 assert_true({actual} [, {msg}]) none assert {actual} is true |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2031 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
|
2032 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
|
2033 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
|
2034 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
|
2035 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
|
2036 browse({save}, {title}, {initdir}, {default}) |
| 7 | 2037 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
|
2038 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
|
2039 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
|
2040 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
|
2041 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
|
2042 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
|
2043 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
|
2044 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
|
2045 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
|
2046 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
|
2047 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
|
2048 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
|
2049 call({func}, {arglist} [, {dict}]) |
| 102 | 2050 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
|
2051 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
|
2052 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
|
2053 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
|
2054 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
|
2055 ch_evalexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2056 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
|
2057 ch_evalraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2058 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
|
2059 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
|
2060 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
|
2061 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
|
2062 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
|
2063 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
|
2064 ch_open({address} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2065 Channel open a channel to {address} |
|
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2066 ch_read({handle} [, {options}]) String read from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2067 ch_readraw({handle} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2068 String read raw from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2069 ch_sendexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2070 any send {expr} over JSON {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2071 ch_sendraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2072 any send {string} over raw {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2073 ch_setoptions({handle}, {options}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2074 none set options for {handle} |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2075 ch_status({handle} [, {options}]) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2076 String status of channel {handle} |
| 1621 | 2077 changenr() Number current change number |
| 12785 | 2078 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
|
2079 cindent({lnum}) Number C indent for line {lnum} |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2080 clearmatches() none clear all matches |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2081 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
|
2082 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
|
2083 complete_add({expr}) Number add completion match |
| 1621 | 2084 complete_check() Number check for key typed during completion |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2085 confirm({msg} [, {choices} [, {default} [, {type}]]]) |
| 7 | 2086 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
|
2087 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
|
2088 cos({expr}) Float cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2089 cosh({expr}) Float hyperbolic cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2090 count({list}, {expr} [, {ic} [, {start}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2091 Number count how many {expr} are in {list} |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
2092 cscope_connection([{num}, {dbpath} [, {prepend}]]) |
| 7 | 2093 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
|
2094 cursor({lnum}, {col} [, {off}]) |
| 6385 | 2095 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
|
2096 cursor({list}) Number move cursor to position in {list} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2097 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
|
2098 delete({fname} [, {flags}]) Number delete the file or directory {fname} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2099 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
|
2100 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
|
2101 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
|
2102 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
|
2103 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
|
2104 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
|
2105 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
|
2106 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
|
2107 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
|
2108 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
|
2109 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
|
2110 extend({expr1}, {expr2} [, {expr3}]) |
| 824 | 2111 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
|
2112 exp({expr}) Float exponential of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2113 expand({expr} [, {nosuf} [, {list}]]) |
| 3398 | 2114 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
|
2115 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
|
2116 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
|
2117 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
|
2118 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
|
2119 {expr2} is 0 |
| 12785 | 2120 finddir({name} [, {path} [, {count}]]) |
| 824 | 2121 String find directory {name} in {path} |
| 12785 | 2122 findfile({name} [, {path} [, {count}]]) |
| 824 | 2123 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
|
2124 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
|
2125 floor({expr}) Float round {expr} down |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2126 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
|
2127 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
|
2128 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
|
2129 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
|
2130 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
|
2131 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
|
2132 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
|
2133 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
|
2134 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
|
2135 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2136 Funcref reference to function {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2137 function({name} [, {arglist}] [, {dict}]) |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2138 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
|
2139 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
|
2140 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
|
2141 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
|
2142 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
|
2143 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
|
2144 getbufline({expr}, {lnum} [, {end}]) |
| 435 | 2145 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
|
2146 getbufvar({expr}, {varname} [, {def}]) |
| 4157 | 2147 any variable {varname} in buffer {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2148 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
|
2149 getcharmod() Number modifiers for the last typed character |
| 7013 | 2150 getcharsearch() Dict last character search |
| 7 | 2151 getcmdline() String return the current command-line |
| 2152 getcmdpos() Number return cursor position in command-line | |
| 6153 | 2153 getcmdtype() String return current command-line type |
| 2154 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
|
2155 getcompletion({pat}, {type} [, {filtered}]) |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
2156 List list of cmdline completion matches |
| 5944 | 2157 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
|
2158 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
|
2159 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
|
2160 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
|
2161 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
|
2162 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
|
2163 getftype({fname}) String description of type of file {fname} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2164 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
|
2165 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer |
| 12785 | 2166 getloclist({nr} [, {what}]) List list of location list items |
| 1326 | 2167 getmatches() List list of current matches |
| 1548 | 2168 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
|
2169 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
|
2170 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
|
2171 getreg([{regname} [, 1 [, {list}]]]) |
| 5796 | 2172 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
|
2173 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
|
2174 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
|
2175 gettabvar({nr}, {varname} [, {def}]) |
| 4157 | 2176 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
|
2177 gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) |
| 831 | 2178 any {name} in {winnr} in tab page {tabnr} |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2179 getwininfo([{winid}]) List list of windows |
| 7 | 2180 getwinposx() Number X coord in pixels of GUI Vim window |
| 2181 getwinposy() Number Y coord in pixels of GUI Vim window | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2182 getwinvar({nr}, {varname} [, {def}]) |
| 4157 | 2183 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
|
2184 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 2185 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
|
2186 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
|
2187 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 2188 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
|
2189 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
|
2190 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
|
2191 haslocaldir([{winnr} [, {tabnr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2192 Number |TRUE| if the window executed |:lcd| |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2193 hasmapto({what} [, {mode} [, {abbr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2194 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
|
2195 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
|
2196 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
|
2197 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
|
2198 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
|
2199 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
|
2200 hlID({name}) Number syntax ID of highlight group {name} |
| 7 | 2201 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
|
2202 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
|
2203 indent({lnum}) Number indent of line {lnum} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2204 index({list}, {expr} [, {start} [, {ic}]]) |
| 95 | 2205 Number index in {list} where {expr} appears |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2206 input({prompt} [, {text} [, {completion}]]) |
| 531 | 2207 String get input from the user |
|
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
2208 inputdialog({prompt} [, {text} [, {completion}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2209 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
|
2210 inputlist({textlist}) Number let the user pick from a choice list |
| 55 | 2211 inputrestore() Number restore typeahead |
| 2212 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
|
2213 inputsecret({prompt} [, {text}]) String like input() but hiding the text |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2214 insert({list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2215 invert({expr}) Number bitwise invert |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2216 isdirectory({directory}) Number |TRUE| if {directory} is a directory |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2217 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
|
2218 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
|
2219 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
|
2220 job_getchannel({job}) Channel get the channel handle for {job} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2221 job_info({job}) Dict get information about {job} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2222 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
|
2223 job_start({command} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2224 Job start a job |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2225 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
|
2226 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
|
2227 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
|
2228 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
|
2229 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
|
2230 json_decode({string}) any decode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2231 json_encode({expr}) String encode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2232 keys({dict}) List keys in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2233 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
|
2234 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
|
2235 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
|
2236 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
|
2237 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
|
2238 lispindent({lnum}) Number Lisp indent for line {lnum} |
| 7 | 2239 localtime() Number current time |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2240 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
|
2241 log10({expr}) Float logarithm of Float {expr} to base 10 |
| 12785 | 2242 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
|
2243 map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr} |
| 12785 | 2244 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 2245 String or Dict |
| 2246 rhs of mapping {name} in mode {mode} | |
| 12785 | 2247 mapcheck({name} [, {mode} [, {abbr}]]) |
| 782 | 2248 String check for mappings matching {name} |
| 12785 | 2249 match({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2250 Number position where {pat} matches in {expr} |
| 12785 | 2251 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 2252 Number highlight {pattern} with {group} |
| 12785 | 2253 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 2254 Number highlight positions with {group} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2255 matcharg({nr}) List arguments of |:match| |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2256 matchdelete({id}) Number delete match identified by {id} |
| 12785 | 2257 matchend({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2258 Number position where {pat} ends in {expr} |
| 12785 | 2259 matchlist({expr}, {pat} [, {start} [, {count}]]) |
| 158 | 2260 List match and submatches of {pat} in {expr} |
| 12785 | 2261 matchstr({expr}, {pat} [, {start} [, {count}]]) |
| 19 | 2262 String {count}'th match of {pat} in {expr} |
| 12785 | 2263 matchstrpos({expr}, {pat} [, {start} [, {count}]]) |
|
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
2264 List {count}'th match of {pat} in {expr} |
| 10734 | 2265 max({expr}) Number maximum value of items in {expr} |
| 2266 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
|
2267 mkdir({name} [, {path} [, {prot}]]) |
| 168 | 2268 Number create directory {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2269 mode([expr]) String current editing mode |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2270 mzeval({expr}) any evaluate |MzScheme| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2271 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} |
| 12785 | 2272 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
|
2273 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
|
2274 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
|
2275 perleval({expr}) any evaluate |Perl| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2276 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
|
2277 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
|
2278 printf({fmt}, {expr1}...) String format text |
| 1621 | 2279 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
|
2280 pyeval({expr}) any evaluate |Python| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2281 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
|
2282 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
|
2283 range({expr} [, {max} [, {stride}]]) |
| 99 | 2284 List items from {expr} to {max} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2285 readfile({fname} [, {binary} [, {max}]]) |
| 168 | 2286 List get list of lines from file {fname} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2287 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
|
2288 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
|
2289 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
|
2290 remote_expr({server}, {string} [, {idvar} [, {timeout}]]) |
| 7 | 2291 String send expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2292 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
|
2293 remote_peek({serverid} [, {retvar}]) |
| 7 | 2294 Number check for reply string |
|
11229
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2295 remote_read({serverid} [, {timeout}]) |
|
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2296 String read reply string |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2297 remote_send({server}, {string} [, {idvar}]) |
| 7 | 2298 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
|
2299 remote_startserver({name}) none become server {name} |
|
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
2300 String send key sequence |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
2301 remove({list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2302 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
|
2303 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
|
2304 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
|
2305 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
|
2306 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
|
2307 round({expr}) Float round off {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2308 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
|
2309 screenchar({row}, {col}) Number character at screen position |
| 3986 | 2310 screencol() Number current cursor column |
| 2311 screenrow() Number current cursor row | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2312 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 1496 | 2313 Number search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2314 searchdecl({name} [, {global} [, {thisblock}]]) |
| 1621 | 2315 Number search for variable declaration |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2316 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 2317 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
|
2318 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 2319 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
|
2320 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 667 | 2321 List search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2322 server2client({clientid}, {string}) |
| 7 | 2323 Number send reply string |
| 2324 serverlist() String get a list of available servers | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2325 setbufline({expr}, {lnum}, {line}) |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
2326 Number set line {lnum} to {line} in buffer |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
2327 {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2328 setbufvar({expr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2329 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
|
2330 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
|
2331 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
|
2332 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
|
2333 setline({lnum}, {line}) Number set line {lnum} to {line} |
| 12785 | 2334 setloclist({nr}, {list} [, {action} [, {what}]]) |
| 647 | 2335 Number modify location list using {list} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2336 setmatches({list}) Number restore a list of matches |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2337 setpos({expr}, {list}) Number set the {expr} position to {list} |
| 12785 | 2338 setqflist({list} [, {action} [, {what}]]) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2339 Number modify quickfix list using {list} |
| 12785 | 2340 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
|
2341 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
|
2342 settabwinvar({tabnr}, {winnr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2343 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
|
2344 page {tabnr} to {val} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2345 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
|
2346 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
|
2347 shellescape({string} [, {special}]) |
| 1661 | 2348 String escape {string} for use as shell |
| 985 | 2349 command argument |
| 3875 | 2350 shiftwidth() Number effective value of 'shiftwidth' |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2351 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
|
2352 sin({expr}) Float sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2353 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
|
2354 sort({list} [, {func} [, {dict}]]) |
| 2902 | 2355 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
|
2356 soundfold({word}) String sound-fold {word} |
| 344 | 2357 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
|
2358 spellsuggest({word} [, {max} [, {capital}]]) |
| 537 | 2359 List spelling suggestions |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2360 split({expr} [, {pat} [, {keepempty}]]) |
| 685 | 2361 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
|
2362 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
|
2363 str2float({expr}) Float convert String to Float |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2364 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
|
2365 strchars({expr} [, {skipcc}]) Number character length of the String {expr} |
| 12785 | 2366 strcharpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2367 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
|
2368 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} |
| 12785 | 2369 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
|
2370 strgetchar({str}, {index}) Number get char {index} from {str} |
| 12785 | 2371 stridx({haystack}, {needle} [, {start}]) |
| 133 | 2372 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
|
2373 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
|
2374 strlen({expr}) Number length of the String {expr} |
| 12785 | 2375 strpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2376 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
|
2377 strridx({haystack}, {needle} [, {start}]) |
| 140 | 2378 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
|
2379 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
|
2380 strwidth({expr}) Number display cell length of the String {expr} |
| 12785 | 2381 submatch({nr} [, {list}]) String or List |
| 5794 | 2382 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
|
2383 substitute({expr}, {pat}, {sub}, {flags}) |
| 7 | 2384 String all {pat} in {expr} replaced with {sub} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2385 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
|
2386 synIDattr({synID}, {what} [, {mode}]) |
| 7 | 2387 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
|
2388 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
|
2389 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
|
2390 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
|
2391 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
|
2392 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
|
2393 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
|
2394 tabpagenr([{arg}]) Number number of current or last tab page |
| 12785 | 2395 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page |
| 2396 taglist({expr} [, {filename}]) List list of tags matching {expr} | |
| 1621 | 2397 tagfiles() List tags files used |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2398 tan({expr}) Float tangent of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2399 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
|
2400 tempname() String name for a temporary file |
|
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
|
2401 term_getaltscreen({buf}) Number get the alternate screen flag |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
2402 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
|
2403 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
|
2404 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
|
2405 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
|
2406 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
|
2407 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
|
2408 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
|
2409 term_gettitle({buf}) String get the title of a terminal |
| 12785 | 2410 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
|
2411 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
|
2412 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
|
2413 term_sendkeys({buf}, {keys}) none send keystrokes to a terminal |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
2414 term_start({cmd}, {options}) Job 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
|
2415 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
|
2416 test_alloc_fail({id}, {countdown}, {repeat}) |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2417 none make memory allocation fail |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
2418 test_autochdir() none enable 'autochdir' during startup |
|
12337
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
2419 test_feedinput() 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
|
2420 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
|
2421 test_ignore_error({expr}) none ignore a specific error |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
2422 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
|
2423 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
|
2424 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
|
2425 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
|
2426 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
|
2427 test_null_string() String null value for testing |
|
11105
7c7e496e625d
patch 8.0.0440: not enough test coverage in Insert mode
Christian Brabandt <cb@256bit.org>
parents:
11062
diff
changeset
|
2428 test_override({expr}, {val}) none test with Vim internal overrides |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2429 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
|
2430 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
|
2431 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
|
2432 timer_start({time}, {callback} [, {options}]) |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2433 Number create a timer |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2434 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
|
2435 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
|
2436 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
|
2437 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
|
2438 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 15 | 2439 to chars in {tostr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2440 trunc({expr}) Float truncate Float {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2441 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
|
2442 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
|
2443 undotree() List undo file tree |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2444 uniq({list} [, {func} [, {dict}]]) |
| 5747 | 2445 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
|
2446 values({dict}) List values in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2447 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
|
2448 visualmode([expr]) String last visual mode used |
| 4151 | 2449 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
|
2450 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
|
2451 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
|
2452 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
|
2453 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
|
2454 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
|
2455 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
|
2456 winbufnr({nr}) Number buffer number of window {nr} |
| 7 | 2457 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
|
2458 winheight({nr}) Number height of window {nr} |
| 7 | 2459 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
|
2460 winnr([{expr}]) Number number of current window |
| 55 | 2461 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
|
2462 winrestview({dict}) none restore view of current window |
| 712 | 2463 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
|
2464 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
|
2465 wordcount() Dict get byte/char/word statistics |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2466 writefile({list}, {fname} [, {flags}]) |
| 158 | 2467 Number write list of lines to file {fname} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2468 xor({expr}, {expr}) Number bitwise XOR |
| 7 | 2469 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
2470 |
| 1621 | 2471 abs({expr}) *abs()* |
| 2472 Return the absolute value of {expr}. When {expr} evaluates to | |
| 2473 a |Float| abs() returns a |Float|. When {expr} can be | |
| 2474 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 2475 abs() gives an error message and returns -1. | |
| 2476 Examples: > | |
| 2477 echo abs(1.456) | |
| 2478 < 1.456 > | |
| 2479 echo abs(-5.456) | |
| 2480 < 5.456 > | |
| 2481 echo abs(-4) | |
| 2482 < 4 | |
| 2483 {only available when compiled with the |+float| feature} | |
| 2484 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2485 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2486 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2487 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
|
2488 |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
|
2489 {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
|
2490 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2491 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2492 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2493 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2494 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2495 < 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
|
2496 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2497 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2498 |
| 82 | 2499 add({list}, {expr}) *add()* |
| 685 | 2500 Append the item {expr} to |List| {list}. Returns the |
| 2501 resulting |List|. Examples: > | |
| 82 | 2502 :let alist = add([1, 2, 3], item) |
| 2503 :call add(mylist, "woodstock") | |
| 685 | 2504 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2505 item. Use |extend()| to concatenate |Lists|. |
| 85 | 2506 Use |insert()| to add an item at another position. |
| 55 | 2507 |
| 82 | 2508 |
| 3214 | 2509 and({expr}, {expr}) *and()* |
| 2510 Bitwise AND on the two arguments. The arguments are converted | |
| 2511 to a number. A List, Dict or Float argument causes an error. | |
| 2512 Example: > | |
| 2513 :let flag = and(bits, 0x80) | |
| 2514 | |
| 2515 | |
| 82 | 2516 append({lnum}, {expr}) *append()* |
| 685 | 2517 When {expr} is a |List|: Append each item of the |List| as a |
| 2518 text line below line {lnum} in the current buffer. | |
| 153 | 2519 Otherwise append {expr} as one text line below line {lnum} in |
| 2520 the current buffer. | |
| 2521 {lnum} can be zero to insert a line before the first one. | |
| 82 | 2522 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
|
2523 0 for success. Example: > |
| 55 | 2524 :let failed = append(line('$'), "# THE END") |
| 82 | 2525 :let failed = append(0, ["Chapter 1", "the beginning"]) |
| 55 | 2526 < |
| 7 | 2527 *argc()* |
| 2528 argc() The result is the number of files in the argument list of the | |
| 2529 current window. See |arglist|. | |
| 2530 | |
| 2531 *argidx()* | |
| 2532 argidx() The result is the current index in the argument list. 0 is | |
| 2533 the first file. argc() - 1 is the last one. See |arglist|. | |
| 2534 | |
| 5942 | 2535 *arglistid()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2536 arglistid([{winnr} [, {tabnr}]]) |
| 5942 | 2537 Return the argument list ID. This is a number which |
| 2538 identifies the argument list being used. Zero is used for the | |
| 6153 | 2539 global argument list. See |arglist|. |
| 2540 Return -1 if the arguments are invalid. | |
| 5942 | 2541 |
| 2542 Without arguments use the current window. | |
| 2543 With {winnr} only use this window in the current tab page. | |
| 2544 With {winnr} and {tabnr} use the window in the specified tab | |
| 2545 page. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2546 {winnr} can be the window number or the |window-ID|. |
| 5942 | 2547 |
| 7 | 2548 *argv()* |
| 818 | 2549 argv([{nr}]) The result is the {nr}th file in the argument list of the |
| 7 | 2550 current window. See |arglist|. "argv(0)" is the first one. |
| 2551 Example: > | |
| 2552 :let i = 0 | |
| 2553 :while i < argc() | |
| 1621 | 2554 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 2555 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 2556 : let i = i + 1 | |
| 2557 :endwhile | |
| 818 | 2558 < Without the {nr} argument a |List| with the whole |arglist| is |
| 2559 returned. | |
| 2560 | |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2561 *assert_equal()* |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2562 assert_equal({expected}, {actual} [, {msg}]) |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2563 When {expected} and {actual} are not equal an error message is |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2564 added to |v:errors|. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2565 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
|
2566 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
|
2567 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
|
2568 always matters. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2569 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
|
2570 {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
|
2571 Example: > |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2572 assert_equal('foo', 'bar') |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2573 < 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
|
2574 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
|
2575 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2576 assert_exception({error} [, {msg}]) *assert_exception()* |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2577 When v:exception does not contain the string {error} an error |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2578 message is added to |v:errors|. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2579 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
|
2580 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
|
2581 with translations: > |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2582 try |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2583 commandthatfails |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2584 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
|
2585 catch |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2586 call assert_exception('E492:') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2587 endtry |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2588 |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2589 assert_fails({cmd} [, {error}]) *assert_fails()* |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2590 Run {cmd} and add an error message to |v:errors| if it does |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2591 NOT produce an error. |
|
10348
c78513465e6e
commit https://github.com/vim/vim/commit/25de4c232d580583feadae11ab34e3cc6333c350
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
2592 When {error} is given it must match in |v:errmsg|. |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2593 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2594 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
|
2595 When {actual} is not false 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
|
2596 |v:errors|, like with |assert_equal()|. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
2597 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
|
2598 number the assert fails. |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2599 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
|
2600 "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
|
2601 |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2602 assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()* |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2603 This asserts number values. When {actual} is lower than |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2604 {lower} or higher than {upper} an error message is added to |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2605 |v:errors|. |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2606 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
|
2607 "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
|
2608 produced. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2609 |
|
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2610 *assert_match()* |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2611 assert_match({pattern}, {actual} [, {msg}]) |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2612 When {pattern} does not match {actual} an error message is |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2613 added to |v:errors|. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2614 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2615 {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
|
2616 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
|
2617 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
|
2618 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2619 {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
|
2620 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
|
2621 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
|
2622 |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2623 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
|
2624 "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
|
2625 Example: > |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2626 assert_match('^f.*o$', 'foobar') |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2627 < 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
|
2628 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
|
2629 |
|
8831
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2630 *assert_notequal()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2631 assert_notequal({expected}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2632 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
|
2633 |v:errors| when {expected} and {actual} are equal. |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2634 |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2635 *assert_notmatch()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2636 assert_notmatch({pattern}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2637 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
|
2638 |v:errors| when {pattern} matches {actual}. |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2639 |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2640 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
|
2641 Report a test failure directly, using {msg}. |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2642 |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2643 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
|
2644 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
|
2645 |v:errors|, like with |assert_equal()|. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2646 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
|
2647 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
|
2648 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
|
2649 got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2650 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2651 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2652 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
|
2653 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
|
2654 {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
|
2655 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2656 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2657 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2658 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2659 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2660 < -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
|
2661 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2662 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2663 |
| 1621 | 2664 atan({expr}) *atan()* |
| 2665 Return the principal value of the arc tangent of {expr}, in | |
| 2666 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 2667 {expr} must evaluate to a |Float| or a |Number|. | |
| 2668 Examples: > | |
| 2669 :echo atan(100) | |
| 2670 < 1.560797 > | |
| 2671 :echo atan(-4.01) | |
| 2672 < -1.326405 | |
| 2673 {only available when compiled with the |+float| feature} | |
| 2674 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2675 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2676 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2677 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
|
2678 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
|
2679 {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
|
2680 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2681 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2682 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2683 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2684 < 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
|
2685 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2686 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2687 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
|
2688 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
|
2689 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
|
2690 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
|
2691 split with |balloon_split()|. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2692 |
| 11062 | 2693 Example: > |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2694 func GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2695 " initiate getting the content |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2696 return '' |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2697 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2698 set balloonexpr=GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2699 |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2700 func BalloonCallback(result) |
| 11062 | 2701 call balloon_show(a:result) |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2702 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2703 < |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2704 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
|
2705 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
|
2706 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
|
2707 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
|
2708 empty string or a placeholder. |
| 11062 | 2709 |
| 2710 When showing a balloon is not possible nothing happens, no | |
| 2711 error message. | |
|
12885
10cb5c3df3f5
patch 8.0.1319: can't build GUI on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12883
diff
changeset
|
2712 {only available when compiled with the +balloon_eval or |
|
10cb5c3df3f5
patch 8.0.1319: can't build GUI on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12883
diff
changeset
|
2713 +balloon_eval_term feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2714 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2715 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
|
2716 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
|
2717 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
|
2718 show debugger output. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2719 Returns a |List| with the split lines. |
|
12885
10cb5c3df3f5
patch 8.0.1319: can't build GUI on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12883
diff
changeset
|
2720 {only available when compiled with the +balloon_eval_term |
|
10cb5c3df3f5
patch 8.0.1319: can't build GUI on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12883
diff
changeset
|
2721 feature} |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2722 |
| 7 | 2723 *browse()* |
| 2724 browse({save}, {title}, {initdir}, {default}) | |
| 2725 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
|
2726 returns |TRUE| (only in some GUI versions). |
| 7 | 2727 The input fields are: |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2728 {save} when |TRUE|, select file to write |
| 7 | 2729 {title} title for the requester |
| 2730 {initdir} directory to start browsing in | |
| 2731 {default} default file name | |
| 2732 When the "Cancel" button is hit, something went wrong, or | |
| 2733 browsing is not possible, an empty string is returned. | |
| 2734 | |
| 29 | 2735 *browsedir()* |
| 2736 browsedir({title}, {initdir}) | |
| 2737 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
|
2738 "has("browse")" returns |TRUE| (only in some GUI versions). |
| 29 | 2739 On systems where a directory browser is not supported a file |
| 2740 browser is used. In that case: select a file in the directory | |
| 2741 to be used. | |
| 2742 The input fields are: | |
| 2743 {title} title for the requester | |
| 2744 {initdir} directory to start browsing in | |
| 2745 When the "Cancel" button is hit, something went wrong, or | |
| 2746 browsing is not possible, an empty string is returned. | |
| 2747 | |
| 7 | 2748 bufexists({expr}) *bufexists()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2749 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2750 {expr} exists. |
| 9 | 2751 If the {expr} argument is a number, buffer numbers are used. |
| 12909 | 2752 Number zero is the alternate buffer for the current window. |
| 2753 | |
| 7 | 2754 If the {expr} argument is a string it must match a buffer name |
| 9 | 2755 exactly. The name can be: |
| 2756 - Relative to the current directory. | |
| 2757 - A full path. | |
| 1621 | 2758 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 2759 - A URL name. |
| 7 | 2760 Unlisted buffers will be found. |
| 2761 Note that help files are listed by their short name in the | |
| 2762 output of |:buffers|, but bufexists() requires using their | |
| 2763 long name to be able to find them. | |
| 1621 | 2764 bufexists() may report a buffer exists, but to use the name |
| 2765 with a |:buffer| command you may need to use |expand()|. Esp | |
| 2766 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 2767 Use "bufexists(0)" to test for the existence of an alternate |
| 2768 file name. | |
| 2769 *buffer_exists()* | |
| 2770 Obsolete name: buffer_exists(). | |
| 2771 | |
| 2772 buflisted({expr}) *buflisted()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2773 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2774 {expr} exists and is listed (has the 'buflisted' option set). |
| 9 | 2775 The {expr} argument is used like with |bufexists()|. |
| 7 | 2776 |
| 2777 bufloaded({expr}) *bufloaded()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2778 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2779 {expr} exists and is loaded (shown in a window or hidden). |
| 9 | 2780 The {expr} argument is used like with |bufexists()|. |
| 7 | 2781 |
| 2782 bufname({expr}) *bufname()* | |
| 2783 The result is the name of a buffer, as it is displayed by the | |
| 2784 ":ls" command. | |
| 2785 If {expr} is a Number, that buffer number's name is given. | |
| 2786 Number zero is the alternate buffer for the current window. | |
| 2787 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
|
2788 with the buffer names. This is always done like 'magic' is |
| 7 | 2789 set and 'cpoptions' is empty. When there is more than one |
| 2790 match an empty string is returned. | |
| 2791 "" or "%" can be used for the current buffer, "#" for the | |
| 2792 alternate buffer. | |
| 2793 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 2794 or middle of the buffer name is accepted. If you only want a |
| 2795 full match then put "^" at the start and "$" at the end of the | |
| 2796 pattern. | |
| 7 | 2797 Listed buffers are found first. If there is a single match |
| 2798 with a listed buffer, that one is returned. Next unlisted | |
| 2799 buffers are searched for. | |
| 2800 If the {expr} is a String, but you want to use it as a buffer | |
| 2801 number, force it to be a Number by adding zero to it: > | |
| 2802 :echo bufname("3" + 0) | |
| 2803 < If the buffer doesn't exist, or doesn't have a name, an empty | |
| 2804 string is returned. > | |
| 2805 bufname("#") alternate buffer name | |
| 2806 bufname(3) name of buffer 3 | |
| 2807 bufname("%") name of current buffer | |
| 2808 bufname("file2") name of buffer where "file2" matches. | |
| 2809 < *buffer_name()* | |
| 2810 Obsolete name: buffer_name(). | |
| 2811 | |
| 2812 *bufnr()* | |
| 707 | 2813 bufnr({expr} [, {create}]) |
| 2814 The result is the number of a buffer, as it is displayed by | |
| 7 | 2815 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 2816 above. |
| 2817 If the buffer doesn't exist, -1 is returned. Or, if the | |
| 2818 {create} argument is present and not zero, a new, unlisted, | |
| 2819 buffer is created and its number is returned. | |
| 7 | 2820 bufnr("$") is the last buffer: > |
| 2821 :let last_buffer = bufnr("$") | |
| 2822 < The result is a Number, which is the highest buffer number | |
| 2823 of existing buffers. Note that not all buffers with a smaller | |
| 2824 number necessarily exist, because ":bwipeout" may have removed | |
| 2825 them. Use bufexists() to test for the existence of a buffer. | |
| 2826 *buffer_number()* | |
| 2827 Obsolete name: buffer_number(). | |
| 2828 *last_buffer_nr()* | |
| 2829 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 2830 | |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2831 bufwinid({expr}) *bufwinid()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2832 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
|
2833 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
|
2834 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
|
2835 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
|
2836 |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2837 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
|
2838 < |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2839 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
|
2840 |
| 7 | 2841 bufwinnr({expr}) *bufwinnr()* |
| 2842 The result is a Number, which is the number of the first | |
| 2843 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
|
2844 see |bufname()| above. If buffer {expr} doesn't exist or |
| 7 | 2845 there is no such window, -1 is returned. Example: > |
| 2846 | |
| 2847 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 2848 | |
| 2849 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 2850 |:wincmd|. | |
| 1156 | 2851 Only deals with the current tab page. |
| 7 | 2852 |
| 2853 byte2line({byte}) *byte2line()* | |
| 2854 Return the line number that contains the character at byte | |
| 2855 count {byte} in the current buffer. This includes the | |
| 2856 end-of-line character, depending on the 'fileformat' option | |
| 2857 for the current buffer. The first character has byte count | |
| 2858 one. | |
| 2859 Also see |line2byte()|, |go| and |:goto|. | |
| 2860 {not available when compiled without the |+byte_offset| | |
| 2861 feature} | |
| 2862 | |
| 18 | 2863 byteidx({expr}, {nr}) *byteidx()* |
| 2864 Return byte index of the {nr}'th character in the string | |
| 2865 {expr}. Use zero for the first character, it returns zero. | |
| 2866 This function is only useful when there are multibyte | |
| 2867 characters, otherwise the returned value is equal to {nr}. | |
| 5413 | 2868 Composing characters are not counted separately, their byte |
| 2869 length is added to the preceding base character. See | |
| 2870 |byteidxcomp()| below for counting composing characters | |
| 2871 separately. | |
| 18 | 2872 Example : > |
| 2873 echo matchstr(str, ".", byteidx(str, 3)) | |
| 2874 < will display the fourth character. Another way to do the | |
| 2875 same: > | |
| 2876 let s = strpart(str, byteidx(str, 3)) | |
| 2877 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
|
2878 < Also see |strgetchar()| and |strcharpart()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2879 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2880 If there are less than {nr} characters -1 is returned. |
| 18 | 2881 If there are exactly {nr} characters the length of the string |
| 5413 | 2882 in bytes is returned. |
| 2883 | |
| 2884 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
| 2885 Like byteidx(), except that a composing character is counted | |
| 2886 as a separate character. Example: > | |
| 2887 let s = 'e' . nr2char(0x301) | |
| 2888 echo byteidx(s, 1) | |
| 2889 echo byteidxcomp(s, 1) | |
| 2890 echo byteidxcomp(s, 2) | |
| 2891 < The first and third echo result in 3 ('e' plus composing | |
| 2892 character is 3 bytes), the second echo results in 1 ('e' is | |
| 2893 one byte). | |
| 2894 Only works different from byteidx() when 'encoding' is set to | |
| 2895 a Unicode encoding. | |
| 18 | 2896 |
| 102 | 2897 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 2898 Call function {func} with the items in |List| {arglist} as |
| 79 | 2899 arguments. |
| 685 | 2900 {func} can either be a |Funcref| or the name of a function. |
| 79 | 2901 a:firstline and a:lastline are set to the cursor line. |
| 2902 Returns the return value of the called function. | |
| 102 | 2903 {dict} is for functions with the "dict" attribute. It will be |
| 2904 used to set the local variable "self". |Dictionary-function| | |
| 79 | 2905 |
| 1621 | 2906 ceil({expr}) *ceil()* |
| 2907 Return the smallest integral value greater than or equal to | |
| 2908 {expr} as a |Float| (round up). | |
| 2909 {expr} must evaluate to a |Float| or a |Number|. | |
| 2910 Examples: > | |
| 2911 echo ceil(1.456) | |
| 2912 < 2.0 > | |
| 2913 echo ceil(-5.456) | |
| 2914 < -5.0 > | |
| 2915 echo ceil(4.0) | |
| 2916 < 4.0 | |
| 2917 {only available when compiled with the |+float| feature} | |
| 2918 | |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2919 ch_canread({handle}) *ch_canread()* |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2920 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
|
2921 {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
|
2922 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2923 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
|
2924 e.g. from a timer. |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2925 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2926 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
|
2927 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
|
2928 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2929 {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
|
2930 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2931 ch_close({handle}) *ch_close()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2932 Close {handle}. See |channel-close|. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2933 {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
|
2934 A close callback is not invoked. |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
2935 |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
2936 {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
|
2937 |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
2938 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
|
2939 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
|
2940 {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
|
2941 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
|
2942 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2943 {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
|
2944 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2945 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
|
2946 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
|
2947 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
|
2948 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
|
2949 {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
|
2950 *E917* |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2951 {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
|
2952 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
|
2953 for this specific request. |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2954 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2955 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
|
2956 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
|
2957 empty string. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2958 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2959 {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
|
2960 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2961 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
|
2962 Send {string} over {handle}. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2963 {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
|
2964 |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2965 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
|
2966 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
|
2967 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
|
2968 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
|
2969 is removed. |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2970 Note that Vim does not know when the text received on a raw |
| 12785 | 2971 channel is complete, it may only return the first part and you |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2972 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
|
2973 See |channel-use|. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2974 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2975 {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
|
2976 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2977 ch_getbufnr({handle}, {what}) *ch_getbufnr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2978 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
|
2979 {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
|
2980 {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
|
2981 socket output. |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
2982 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
|
2983 {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
|
2984 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2985 ch_getjob({channel}) *ch_getjob()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2986 Get the Job associated with {channel}. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2987 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
|
2988 will result in "fail". |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2989 |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2990 {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
|
2991 |+job| features} |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
2992 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2993 ch_info({handle}) *ch_info()* |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2994 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
|
2995 items are: |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2996 "id" number of the channel |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2997 "status" "open", "buffered" or "closed", like |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2998 ch_status() |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
2999 When opened with ch_open(): |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3000 "hostname" the hostname of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3001 "port" the port of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3002 "sock_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3003 "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
|
3004 "sock_io" "socket" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3005 "sock_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3006 When opened with job_start(): |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3007 "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
|
3008 "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
|
3009 "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
|
3010 "out_timeout" timeout in msec |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3011 "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
|
3012 "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
|
3013 "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
|
3014 "err_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3015 "in_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3016 "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
|
3017 "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
|
3018 "in_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3019 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3020 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
|
3021 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
|
3022 |ch_logfile()|. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3023 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
|
3024 message. |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10422
diff
changeset
|
3025 {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
|
3026 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
|
3027 |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3028 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
|
3029 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
|
3030 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
|
3031 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3032 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
|
3033 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
|
3034 |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3035 The file is flushed after every message, on Unix you can use |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3036 "tail -f" to see what 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
|
3037 |
|
12025
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
3038 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
|
3039 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
|
3040 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
|
3041 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
|
3042 |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
3043 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3044 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
|
3045 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
|
3046 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
|
3047 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3048 {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
|
3049 "localhost:8765". |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3050 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3051 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
|
3052 See |channel-open-options|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3053 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3054 {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
|
3055 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3056 ch_read({handle} [, {options}]) *ch_read()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3057 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
|
3058 {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
|
3059 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
|
3060 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
|
3061 See |channel-more|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3062 {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
|
3063 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3064 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
|
3065 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
|
3066 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
|
3067 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
|
3068 See |channel-more|. |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3069 {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
|
3070 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3071 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
|
3072 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
|
3073 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
|
3074 with a raw channel. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3075 See |channel-use|. *E912* |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3076 {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
|
3077 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3078 {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
|
3079 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3080 ch_sendraw({handle}, {string} [, {options}]) *ch_sendraw()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3081 Send {string} over {handle}. |
|
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3082 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
|
3083 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
|
3084 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
|
3085 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
|
3086 is removed. |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3087 See |channel-use|. |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3088 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3089 {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
|
3090 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3091 ch_setoptions({handle}, {options}) *ch_setoptions()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3092 Set options on {handle}: |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3093 "callback" the channel callback |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3094 "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
|
3095 "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
|
3096 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
|
3097 {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
|
3098 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3099 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
|
3100 lost. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3101 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3102 These options cannot be changed: |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3103 "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
|
3104 |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3105 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
|
3106 Return the status of {handle}: |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3107 "fail" failed to open the channel |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3108 "open" channel can be used |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3109 "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
|
3110 "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
|
3111 {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
|
3112 "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
|
3113 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
|
3114 |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3115 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
|
3116 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
|
3117 "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
|
3118 ch_status(job, {"part": "err"}) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3119 < |
| 11062 | 3120 changenr() *changenr()* |
| 3121 Return the number of the most recent change. This is the same | |
| 3122 number as what is displayed with |:undolist| and can be used | |
| 3123 with the |:undo| command. | |
| 3124 When a change was made it is the number of that change. After | |
| 3125 redo it is the number of the redone change. After undo it is | |
| 3126 one less than the number of the undone change. | |
| 3127 | |
| 12785 | 3128 char2nr({expr} [, {utf8}]) *char2nr()* |
| 11062 | 3129 Return number value of the first char in {expr}. Examples: > |
| 3130 char2nr(" ") returns 32 | |
| 3131 char2nr("ABC") returns 65 | |
| 3132 < When {utf8} is omitted or zero, the current 'encoding' is used. | |
| 3133 Example for "utf-8": > | |
| 3134 char2nr("á") returns 225 | |
| 3135 char2nr("á"[0]) returns 195 | |
| 3136 < With {utf8} set to 1, always treat as utf-8 characters. | |
| 3137 A combining character is a separate character. | |
| 3138 |nr2char()| does the opposite. | |
| 3139 | |
| 3140 cindent({lnum}) *cindent()* | |
| 3141 Get the amount of indent for line {lnum} according the C | |
| 3142 indenting rules, as with 'cindent'. | |
| 3143 The indent is counted in spaces, the value of 'tabstop' is | |
| 3144 relevant. {lnum} is used just like in |getline()|. | |
| 3145 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 3146 feature, -1 is returned. | |
| 3147 See |C-indenting|. | |
| 3148 | |
| 3149 clearmatches() *clearmatches()* | |
| 3150 Clears all matches previously defined by |matchadd()| and the | |
| 3151 |:match| commands. | |
| 3152 | |
| 3153 *col()* | |
| 3154 col({expr}) The result is a Number, which is the byte index of the column | |
| 3155 position given with {expr}. The accepted positions are: | |
| 3156 . the cursor position | |
| 3157 $ the end of the cursor line (the result is the | |
| 3158 number of bytes in the cursor line plus one) | |
| 3159 'x position of mark x (if the mark is not set, 0 is | |
| 3160 returned) | |
| 3161 v In Visual mode: the start of the Visual area (the | |
| 3162 cursor is the end). When not in Visual mode | |
| 3163 returns the cursor position. Differs from |'<| in | |
| 3164 that it's updated right away. | |
| 3165 Additionally {expr} can be [lnum, col]: a |List| with the line | |
| 3166 and column number. Most useful when the column is "$", to get | |
| 3167 the last column of a specific line. When "lnum" or "col" is | |
| 3168 out of range then col() returns zero. | |
| 3169 To get the line number use |line()|. To get both use | |
| 3170 |getpos()|. | |
| 3171 For the screen column position use |virtcol()|. | |
| 3172 Note that only marks in the current file can be used. | |
| 3173 Examples: > | |
| 3174 col(".") column of cursor | |
| 3175 col("$") length of cursor line plus one | |
| 3176 col("'t") column of mark t | |
| 3177 col("'" . markname) column of mark markname | |
| 3178 < The first column is 1. 0 is returned for an error. | |
| 3179 For an uppercase mark the column may actually be in another | |
| 3180 buffer. | |
| 3181 For the cursor position, when 'virtualedit' is active, the | |
| 3182 column is one higher if the cursor is after the end of the | |
| 3183 line. This can be used to obtain the column in Insert mode: > | |
| 3184 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 3185 \<C-O>:set ve=all<CR> | |
| 3186 \<C-O>:echo col(".") . "\n" <Bar> | |
| 3187 \let &ve = save_ve<CR> | |
| 3188 < | |
| 3189 | |
| 3190 complete({startcol}, {matches}) *complete()* *E785* | |
| 3191 Set the matches for Insert mode completion. | |
| 3192 Can only be used in Insert mode. You need to use a mapping | |
| 3193 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O | |
| 3194 or with an expression mapping. | |
| 3195 {startcol} is the byte offset in the line where the completed | |
| 3196 text start. The text up to the cursor is the original text | |
| 3197 that will be replaced by the matches. Use col('.') for an | |
| 3198 empty string. "col('.') - 1" will replace one character by a | |
| 3199 match. | |
| 3200 {matches} must be a |List|. Each |List| item is one match. | |
| 3201 See |complete-items| for the kind of items that are possible. | |
| 3202 Note that the after calling this function you need to avoid | |
| 3203 inserting anything that would cause completion to stop. | |
| 3204 The match can be selected with CTRL-N and CTRL-P as usual with | |
| 3205 Insert mode completion. The popup menu will appear if | |
| 3206 specified, see |ins-completion-menu|. | |
| 3207 Example: > | |
| 3208 inoremap <F5> <C-R>=ListMonths()<CR> | |
| 3209 | |
| 3210 func! ListMonths() | |
| 3211 call complete(col('.'), ['January', 'February', 'March', | |
| 3212 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 3213 \ 'October', 'November', 'December']) | |
| 3214 return '' | |
| 3215 endfunc | |
| 3216 < This isn't very useful, but it shows how it works. Note that | |
| 3217 an empty string is returned to avoid a zero being inserted. | |
| 3218 | |
| 3219 complete_add({expr}) *complete_add()* | |
| 3220 Add {expr} to the list of matches. Only to be used by the | |
| 3221 function specified with the 'completefunc' option. | |
| 3222 Returns 0 for failure (empty string or out of memory), | |
| 3223 1 when the match was added, 2 when the match was already in | |
| 3224 the list. | |
| 3225 See |complete-functions| for an explanation of {expr}. It is | |
| 3226 the same as one item in the list that 'omnifunc' would return. | |
| 3227 | |
| 3228 complete_check() *complete_check()* | |
| 3229 Check for a key typed while looking for completion matches. | |
| 3230 This is to be used when looking for matches takes some time. | |
| 3231 Returns |TRUE| when searching for matches is to be aborted, | |
| 3232 zero otherwise. | |
| 3233 Only to be used by the function specified with the | |
| 3234 'completefunc' option. | |
| 3235 | |
| 3236 *confirm()* | |
| 3237 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
| 3238 Confirm() offers the user a dialog, from which a choice can be | |
| 3239 made. It returns the number of the choice. For the first | |
| 3240 choice this is 1. | |
| 3241 Note: confirm() is only supported when compiled with dialog | |
| 3242 support, see |+dialog_con| and |+dialog_gui|. | |
| 3243 | |
| 3244 {msg} is displayed in a |dialog| with {choices} as the | |
| 3245 alternatives. When {choices} is missing or empty, "&OK" is | |
| 3246 used (and translated). | |
| 3247 {msg} is a String, use '\n' to include a newline. Only on | |
| 3248 some systems the string is wrapped when it doesn't fit. | |
| 3249 | |
| 3250 {choices} is a String, with the individual choices separated | |
| 3251 by '\n', e.g. > | |
| 3252 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 3253 < The letter after the '&' is the shortcut key for that choice. | |
| 3254 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 3255 not need to be the first letter: > | |
| 3256 confirm("file has been modified", "&Save\nSave &All") | |
| 3257 < For the console, the first letter of each choice is used as | |
| 3258 the default shortcut key. | |
| 3259 | |
| 3260 The optional {default} argument is the number of the choice | |
| 3261 that is made if the user hits <CR>. Use 1 to make the first | |
| 3262 choice the default one. Use 0 to not set a default. If | |
| 3263 {default} is omitted, 1 is used. | |
| 3264 | |
| 3265 The optional {type} argument gives the type of dialog. This | |
| 3266 is only used for the icon of the GTK, Mac, Motif and Win32 | |
| 3267 GUI. It can be one of these values: "Error", "Question", | |
| 3268 "Info", "Warning" or "Generic". Only the first character is | |
| 3269 relevant. When {type} is omitted, "Generic" is used. | |
| 3270 | |
| 3271 If the user aborts the dialog by pressing <Esc>, CTRL-C, | |
| 3272 or another valid interrupt key, confirm() returns 0. | |
| 3273 | |
| 3274 An example: > | |
| 3275 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 3276 :if choice == 0 | |
| 3277 : echo "make up your mind!" | |
| 3278 :elseif choice == 3 | |
| 3279 : echo "tasteful" | |
| 3280 :else | |
| 3281 : echo "I prefer bananas myself." | |
| 3282 :endif | |
| 3283 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 3284 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 3285 the buttons are always put vertically. Otherwise, confirm() | |
| 3286 tries to put the buttons in one horizontal line. If they | |
| 3287 don't fit, a vertical layout is used anyway. For some systems | |
| 3288 the horizontal layout is always used. | |
| 3289 | |
| 55 | 3290 *copy()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3291 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3292 different from using {expr} directly. |
| 685 | 3293 When {expr} is a |List| a shallow copy is created. This means |
| 3294 that the original |List| can be changed without changing the | |
| 1621 | 3295 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
|
3296 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
|
3297 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
|
3298 Also see |deepcopy()|. |
| 55 | 3299 |
| 1621 | 3300 cos({expr}) *cos()* |
| 3301 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 3302 {expr} must evaluate to a |Float| or a |Number|. | |
| 3303 Examples: > | |
| 3304 :echo cos(100) | |
| 3305 < 0.862319 > | |
| 3306 :echo cos(-4.01) | |
| 3307 < -0.646043 | |
| 3308 {only available when compiled with the |+float| feature} | |
| 3309 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3310 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3311 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3312 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
|
3313 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3314 {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
|
3315 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3316 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3317 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3318 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3319 < -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
|
3320 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3321 |
| 12785 | 3322 |
| 102 | 3323 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 3324 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
|
3325 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
|
3326 |
| 102 | 3327 If {start} is given then start with the item with this index. |
| 685 | 3328 {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
|
3329 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3330 When {ic} is given and it's |TRUE| then case is ignored. |
| 79 | 3331 |
|
11828
5a07a3ff56c1
patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents:
11763
diff
changeset
|
3332 When {comp} is a string then the number of not overlapping |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
3333 occurrences of {expr} is returned. |
|
11828
5a07a3ff56c1
patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents:
11763
diff
changeset
|
3334 |
| 79 | 3335 |
| 7 | 3336 *cscope_connection()* |
| 3337 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 3338 Checks for the existence of a |cscope| connection. If no | |
| 3339 parameters are specified, then the function returns: | |
| 3340 0, if cscope was not available (not compiled in), or | |
| 3341 if there are no cscope connections; | |
| 3342 1, if there is at least one cscope connection. | |
| 3343 | |
| 3344 If parameters are specified, then the value of {num} | |
| 3345 determines how existence of a cscope connection is checked: | |
| 3346 | |
| 3347 {num} Description of existence check | |
| 3348 ----- ------------------------------ | |
| 3349 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 3350 1 Ignore {prepend}, and use partial string matches for | |
| 3351 {dbpath}. | |
| 3352 2 Ignore {prepend}, and use exact string matches for | |
| 3353 {dbpath}. | |
| 3354 3 Use {prepend}, use partial string matches for both | |
| 3355 {dbpath} and {prepend}. | |
| 3356 4 Use {prepend}, use exact string matches for both | |
| 3357 {dbpath} and {prepend}. | |
| 3358 | |
| 3359 Note: All string comparisons are case sensitive! | |
| 3360 | |
| 3361 Examples. Suppose we had the following (from ":cs show"): > | |
| 3362 | |
| 3363 # pid database name prepend path | |
| 3364 0 27664 cscope.out /usr/local | |
| 3365 < | |
| 3366 Invocation Return Val ~ | |
| 3367 ---------- ---------- > | |
| 3368 cscope_connection() 1 | |
| 3369 cscope_connection(1, "out") 1 | |
| 3370 cscope_connection(2, "out") 0 | |
| 3371 cscope_connection(3, "out") 0 | |
| 3372 cscope_connection(3, "out", "local") 1 | |
| 3373 cscope_connection(4, "out") 0 | |
| 3374 cscope_connection(4, "out", "local") 0 | |
| 3375 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 3376 < | |
| 703 | 3377 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 3378 cursor({list}) | |
| 1156 | 3379 Positions the cursor at the column (byte count) {col} in the |
| 3380 line {lnum}. The first column is one. | |
| 5938 | 3381 |
| 703 | 3382 When there is one argument {list} this is used as a |List| |
| 5938 | 3383 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
|
3384 [{lnum}, {col}] |
| 5938 | 3385 [{lnum}, {col}, {off}] |
| 3386 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 3387 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 3388 but without the first item. |
| 5938 | 3389 |
| 7 | 3390 Does not change the jumplist. |
| 3391 If {lnum} is greater than the number of lines in the buffer, | |
| 3392 the cursor will be positioned at the last line in the buffer. | |
| 3393 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 3394 If {col} is greater than the number of bytes in the line, |
| 7 | 3395 the cursor will be positioned at the last character in the |
| 3396 line. | |
| 3397 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 3398 If {curswant} is given it is used to set the preferred column |
| 6180 | 3399 for vertical movement. Otherwise {col} is used. |
| 6385 | 3400 |
| 703 | 3401 When 'virtualedit' is used {off} specifies the offset in |
| 3402 screen columns from the start of the character. E.g., a | |
| 1266 | 3403 position within a <Tab> or after the last character. |
| 1851 | 3404 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 3405 |
| 55 | 3406 |
| 12785 | 3407 deepcopy({expr} [, {noref}]) *deepcopy()* *E698* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3408 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3409 different from using {expr} directly. |
| 685 | 3410 When {expr} is a |List| a full copy is created. This means |
| 3411 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
|
3412 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
|
3413 |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
|
3414 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
|
3415 the original |List|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3416 A |Dictionary| is copied in a similar way as a |List|. |
| 685 | 3417 When {noref} is omitted or zero a contained |List| or |
| 3418 |Dictionary| is only copied once. All references point to | |
| 3419 this single copy. With {noref} set to 1 every occurrence of a | |
| 3420 |List| or |Dictionary| results in a new copy. This also means | |
| 3421 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 3422 *E724* |
| 3423 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 3424 that refers back to a higher level making a deep copy with |
| 3425 {noref} set to 1 will fail. | |
| 55 | 3426 Also see |copy()|. |
| 3427 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3428 delete({fname} [, {flags}]) *delete()* |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3429 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
|
3430 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
|
3431 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3432 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
|
3433 {fname}. This fails when directory {fname} is not empty. |
| 12785 | 3434 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3435 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
|
3436 {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
|
3437 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
|
3438 that is being used. |
|
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
10000
diff
changeset
|
3439 |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3440 A symbolic link itself is deleted, not what it points to. |
| 12785 | 3441 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3442 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
|
3443 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
|
3444 |
| 685 | 3445 Use |remove()| to delete an item from a |List|. |
| 4229 | 3446 To delete a line from the buffer use |:delete|. Use |:exe| |
| 3447 when the line number is in a variable. | |
| 7 | 3448 |
| 3449 *did_filetype()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3450 did_filetype() Returns |TRUE| when autocommands are being executed and the |
| 7 | 3451 FileType event has been triggered at least once. Can be used |
| 3452 to avoid triggering the FileType event again in the scripts | |
| 3453 that detect the file type. |FileType| | |
| 11473 | 3454 Returns |FALSE| when `:setf FALLBACK` was used. |
| 7 | 3455 When editing another file, the counter is reset, thus this |
| 3456 really checks if the FileType event has been triggered for the | |
| 3457 current buffer. This allows an autocommand that starts | |
| 3458 editing another buffer to set 'filetype' and load a syntax | |
| 3459 file. | |
| 3460 | |
| 32 | 3461 diff_filler({lnum}) *diff_filler()* |
| 3462 Returns the number of filler lines above line {lnum}. | |
| 3463 These are the lines that were inserted at this point in | |
| 3464 another diff'ed window. These filler lines are shown in the | |
| 3465 display but don't exist in the buffer. | |
| 3466 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3467 line, "'m" mark m, etc. | |
| 3468 Returns 0 if the current window is not in diff mode. | |
| 3469 | |
| 3470 diff_hlID({lnum}, {col}) *diff_hlID()* | |
| 3471 Returns the highlight ID for diff mode at line {lnum} column | |
| 3472 {col} (byte index). When the current line does not have a | |
| 3473 diff change zero is returned. | |
| 3474 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3475 line, "'m" mark m, etc. | |
| 3476 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 3477 line. | |
| 3478 The highlight ID can be used with |synIDattr()| to obtain | |
| 3479 syntax information about the highlighting. | |
| 3480 | |
| 85 | 3481 empty({expr}) *empty()* |
| 3482 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
|
3483 - 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
|
3484 items. |
| 12785 | 3485 - A String 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
|
3486 - A Number and Float is empty when its value is zero. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3487 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3488 - A Job is empty when it failed to start. |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3489 - A Channel is empty when it is closed. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3490 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3491 For a long |List| this is much faster than comparing the |
| 685 | 3492 length with zero. |
| 85 | 3493 |
| 7 | 3494 escape({string}, {chars}) *escape()* |
| 3495 Escape the characters in {chars} that occur in {string} with a | |
| 3496 backslash. Example: > | |
| 3497 :echo escape('c:\program files\vim', ' \') | |
| 3498 < results in: > | |
| 3499 c:\\program\ files\\vim | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
3500 < Also see |shellescape()| and |fnameescape()|. |
| 1621 | 3501 |
| 3502 *eval()* | |
| 95 | 3503 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 3504 turn the result of |string()| back into the original value. | |
| 1621 | 3505 This works for Numbers, Floats, Strings and composites of |
| 3506 them. Also works for |Funcref|s that refer to existing | |
| 3507 functions. | |
| 95 | 3508 |
| 7 | 3509 eventhandler() *eventhandler()* |
| 3510 Returns 1 when inside an event handler. That is that Vim got | |
| 3511 interrupted while waiting for the user to type a character, | |
| 3512 e.g., when dropping a file on Vim. This means interactive | |
| 3513 commands cannot be used. Otherwise zero is returned. | |
| 3514 | |
| 3515 executable({expr}) *executable()* | |
| 3516 This function checks if an executable with the name {expr} | |
| 3517 exists. {expr} must be the name of the program without any | |
| 10 | 3518 arguments. |
| 3519 executable() uses the value of $PATH and/or the normal | |
| 3520 searchpath for programs. *PATHEXT* | |
| 3521 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
| 3522 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
|
3523 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
|
3524 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is |
| 10 | 3525 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
|
3526 the name without an extension. When 'shell' looks like a |
| 10 | 3527 Unix shell, then the name is also tried without adding an |
| 3528 extension. | |
| 3529 On MS-DOS and MS-Windows it only checks if the file exists and | |
| 3530 is not a directory, not if it's really executable. | |
| 819 | 3531 On MS-Windows an executable in the same directory as Vim is |
| 3532 always found. Since this directory is added to $PATH it | |
| 3533 should also work to execute it |win32-PATH|. | |
| 7 | 3534 The result is a Number: |
| 3535 1 exists | |
| 3536 0 does not exist | |
| 3537 -1 not implemented on this system | |
| 3538 | |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3539 execute({command} [, {silent}]) *execute()* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3540 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
|
3541 string. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3542 {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
|
3543 lines are executed one by one. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3544 This is equivalent to: > |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3545 redir => var |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3546 {command} |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3547 redir END |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3548 < |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3549 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
|
3550 "" no `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3551 "silent" `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3552 "silent!" `:silent!` used |
| 11062 | 3553 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
|
3554 `: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
|
3555 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
|
3556 *E930* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3557 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
|
3558 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3559 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
|
3560 split(execute('args'), "\n") |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3561 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3562 < 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
|
3563 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
|
3564 |
| 5782 | 3565 exepath({expr}) *exepath()* |
| 3566 If {expr} is an executable and is either an absolute path, a | |
| 3567 relative path or found in $PATH, return the full path. | |
| 3568 Note that the current directory is used when {expr} starts | |
| 3569 with "./", which may be a problem for Vim: > | |
| 3570 echo exepath(v:progpath) | |
| 5814 | 3571 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 3572 an empty string is returned. |
| 3573 | |
| 7 | 3574 *exists()* |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3575 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
|
3576 zero otherwise. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3577 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3578 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
|
3579 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
|
3580 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3581 The {expr} argument is a string, which contains one of these: |
| 7 | 3582 &option-name Vim option (only checks if it exists, |
| 3583 not if it really works) | |
| 3584 +option-name Vim option that works. | |
| 3585 $ENVNAME environment variable (could also be | |
| 3586 done by comparing with an empty | |
| 3587 string) | |
| 3588 *funcname built-in function (see |functions|) | |
| 3589 or user defined function (see | |
| 5862 | 3590 |user-functions|). Also works for a |
| 3591 variable that is a Funcref. | |
| 7 | 3592 varname internal variable (see |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3593 |internal-variables|). Also works |
| 685 | 3594 for |curly-braces-names|, |Dictionary| |
| 3595 entries, |List| items, etc. Beware | |
| 1668 | 3596 that evaluating an index may cause an |
| 3597 error message for an invalid | |
| 3598 expression. E.g.: > | |
| 3599 :let l = [1, 2, 3] | |
| 3600 :echo exists("l[5]") | |
| 3601 < 0 > | |
| 3602 :echo exists("l[xx]") | |
| 3603 < E121: Undefined variable: xx | |
| 3604 0 | |
| 7 | 3605 :cmdname Ex command: built-in command, user |
| 3606 command or command modifier |:command|. | |
| 3607 Returns: | |
| 3608 1 for match with start of a command | |
| 3609 2 full match with a command | |
| 3610 3 matches several user commands | |
| 3611 To check for a supported command | |
| 3612 always check the return value to be 2. | |
| 864 | 3613 :2match The |:2match| command. |
| 3614 :3match The |:3match| command. | |
| 7 | 3615 #event autocommand defined for this event |
| 3616 #event#pattern autocommand defined for this event and | |
| 3617 pattern (the pattern is taken | |
| 3618 literally and compared to the | |
| 3619 autocommand patterns character by | |
| 3620 character) | |
| 613 | 3621 #group autocommand group exists |
| 3622 #group#event autocommand defined for this group and | |
| 3623 event. | |
| 3624 #group#event#pattern | |
| 856 | 3625 autocommand defined for this group, |
| 613 | 3626 event and pattern. |
| 615 | 3627 ##event autocommand for this event is |
| 3628 supported. | |
| 7 | 3629 |
| 3630 Examples: > | |
| 3631 exists("&shortname") | |
| 3632 exists("$HOSTNAME") | |
| 3633 exists("*strftime") | |
| 3634 exists("*s:MyFunc") | |
| 3635 exists("bufcount") | |
| 3636 exists(":Make") | |
| 613 | 3637 exists("#CursorHold") |
| 7 | 3638 exists("#BufReadPre#*.gz") |
| 613 | 3639 exists("#filetypeindent") |
| 3640 exists("#filetypeindent#FileType") | |
| 3641 exists("#filetypeindent#FileType#*") | |
| 615 | 3642 exists("##ColorScheme") |
| 7 | 3643 < There must be no space between the symbol (&/$/*/#) and the |
| 3644 name. | |
| 867 | 3645 There must be no extra characters after the name, although in |
| 3646 a few cases this is ignored. That may become more strict in | |
| 3647 the future, thus don't count on it! | |
| 3648 Working example: > | |
| 3649 exists(":make") | |
| 3650 < NOT working example: > | |
| 3651 exists(":make install") | |
| 859 | 3652 |
| 3653 < Note that the argument must be a string, not the name of the | |
| 3654 variable itself. For example: > | |
| 7 | 3655 exists(bufcount) |
| 3656 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 3657 but gets the value of "bufcount", and checks if that exists. |
| 7 | 3658 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3659 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3660 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
|
3661 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3662 {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
|
3663 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3664 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3665 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3666 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3667 < 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
|
3668 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3669 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3670 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3671 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 3672 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
|
3673 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3674 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3675 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
|
3676 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
|
3677 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
|
3678 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
|
3679 file name contains a space] |
| 7 | 3680 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3681 If the expansion fails, the result is an empty string. A name |
| 4869 | 3682 for a non-existing file is not included, unless {expr} does |
| 3683 not start with '%', '#' or '<', see below. | |
| 7 | 3684 |
| 3685 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 3686 like for the |cmdline-special| variables with their associated | |
| 3687 modifiers. Here is a short overview: | |
| 3688 | |
| 3689 % current file name | |
| 3690 # alternate file name | |
| 3691 #n alternate file name n | |
| 3692 <cfile> file name under the cursor | |
| 3693 <afile> autocmd file name | |
| 3694 <abuf> autocmd buffer number (as a String!) | |
| 3695 <amatch> autocmd matched name | |
| 5734 | 3696 <sfile> sourced script file or function name |
| 2662 | 3697 <slnum> sourced script file line number |
| 7 | 3698 <cword> word under the cursor |
| 3699 <cWORD> WORD under the cursor | |
| 3700 <client> the {clientid} of the last received | |
| 3701 message |server2client()| | |
| 3702 Modifiers: | |
| 3703 :p expand to full path | |
| 3704 :h head (last path component removed) | |
| 3705 :t tail (last path component only) | |
| 3706 :r root (one extension removed) | |
| 3707 :e extension only | |
| 3708 | |
| 3709 Example: > | |
| 3710 :let &tags = expand("%:p:h") . "/tags" | |
| 3711 < Note that when expanding a string that starts with '%', '#' or | |
| 3712 '<', any following text is ignored. This does NOT work: > | |
| 3713 :let doesntwork = expand("%:h.bak") | |
| 3714 < Use this: > | |
| 3715 :let doeswork = expand("%:h") . ".bak" | |
| 3716 < Also note that expanding "<cfile>" and others only returns the | |
| 3717 referenced file name without further expansion. If "<cfile>" | |
| 3718 is "~/.cshrc", you need to do another expand() to have the | |
| 3719 "~/" expanded into the path of the home directory: > | |
| 3720 :echo expand(expand("<cfile>")) | |
| 3721 < | |
| 3722 There cannot be white space between the variables and the | |
| 3723 following modifier. The |fnamemodify()| function can be used | |
| 3724 to modify normal file names. | |
| 3725 | |
| 3726 When using '%' or '#', and the current or alternate file name | |
| 3727 is not defined, an empty string is used. Using "%:p" in a | |
| 3728 buffer with no name, results in the current directory, with a | |
| 3729 '/' added. | |
| 3730 | |
| 3731 When {expr} does not start with '%', '#' or '<', it is | |
| 3732 expanded like a file name is expanded on the command line. | |
| 3733 '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
|
3734 {nosuf} argument is given and it is |TRUE|. |
| 3398 | 3735 Names for non-existing files are included. The "**" item can |
| 3736 be used to search in a directory tree. For example, to find | |
| 3737 all "README" files in the current directory and below: > | |
| 444 | 3738 :echo expand("**/README") |
| 3739 < | |
| 7 | 3740 Expand() can also be used to expand variables and environment |
| 3741 variables that are only known in a shell. But this can be | |
| 6180 | 3742 slow, because a shell may be used to do the expansion. See |
| 3743 |expr-env-expand|. | |
| 7 | 3744 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
|
3745 names. When an environment variable cannot be expanded, it is |
| 7 | 3746 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 3747 "$FOOBAR". | |
| 3748 | |
| 3749 See |glob()| for finding existing files. See |system()| for | |
| 3750 getting the raw output of an external command. | |
| 3751 | |
| 102 | 3752 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 3753 {expr1} and {expr2} must be both |Lists| or both |
| 3754 |Dictionaries|. | |
| 3755 | |
| 3756 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 3757 If {expr3} is given insert the items of {expr2} before item |
| 3758 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 3759 first item. When {expr3} is equal to len({expr1}) then | |
| 3760 {expr2} is appended. | |
| 79 | 3761 Examples: > |
| 3762 :echo sort(extend(mylist, [7, 5])) | |
| 3763 :call extend(mylist, [2, 3], 1) | |
| 1699 | 3764 < When {expr1} is the same List as {expr2} then the number of |
| 3765 items copied is equal to the original length of the List. | |
| 3766 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 3767 (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
|
3768 Use |add()| to concatenate one item to a list. To concatenate |
| 82 | 3769 two lists into a new list use the + operator: > |
| 79 | 3770 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 3771 < |
| 692 | 3772 If they are |Dictionaries|: |
| 102 | 3773 Add all entries from {expr2} to {expr1}. |
| 3774 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 3775 used to decide what to do: | |
| 3776 {expr3} = "keep": keep the value of {expr1} | |
| 3777 {expr3} = "force": use the value of {expr2} | |
| 856 | 3778 {expr3} = "error": give an error message *E737* |
| 102 | 3779 When {expr3} is omitted then "force" is assumed. |
| 3780 | |
| 3781 {expr1} is changed when {expr2} is not empty. If necessary | |
| 3782 make a copy of {expr1} first. | |
| 3783 {expr2} remains unchanged. | |
| 6823 | 3784 When {expr1} is locked and {expr2} is not empty the operation |
| 3785 fails. | |
| 102 | 3786 Returns {expr1}. |
| 3787 | |
| 79 | 3788 |
| 842 | 3789 feedkeys({string} [, {mode}]) *feedkeys()* |
| 3790 Characters in {string} are queued for processing as if they | |
| 6549 | 3791 come from a mapping or were typed by the user. |
| 3792 By default the string is added to the end of the typeahead | |
| 3793 buffer, thus if a mapping is still being executed the | |
| 3794 characters come after them. Use the 'i' flag to insert before | |
| 3795 other characters, they will be executed next, before any | |
| 3796 characters from a mapping. | |
| 842 | 3797 The function does not wait for processing of keys contained in |
| 3798 {string}. | |
| 3799 To include special keys into {string}, use double-quotes | |
| 3800 and "\..." notation |expr-quote|. For example, | |
| 1215 | 3801 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 3802 feedkeys('\<CR>') pushes 5 characters. |
| 3803 If {mode} is absent, keys are remapped. | |
| 3804 {mode} is a String, which can contain these character flags: | |
| 843 | 3805 'm' Remap keys. This is default. |
| 3806 'n' Do not remap keys. | |
| 3807 't' Handle keys as if typed; otherwise they are handled as | |
| 3808 if coming from a mapping. This matters for undo, | |
| 3809 opening folds, etc. | |
| 6549 | 3810 '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
|
3811 '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
|
3812 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
|
3813 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
|
3814 (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
|
3815 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
|
3816 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
|
3817 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
|
3818 script continues. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3819 '!' 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
|
3820 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
|
3821 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
|
3822 |
| 842 | 3823 Return value is always 0. |
| 3824 | |
| 7 | 3825 filereadable({file}) *filereadable()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3826 The result is a Number, which is |TRUE| when a file with the |
| 7 | 3827 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
|
3828 or is a directory, the result is |FALSE|. {file} is any |
| 7 | 3829 expression, which is used as a String. |
| 1156 | 3830 If you don't care about the file being readable you can use |
| 3831 |glob()|. | |
| 7 | 3832 *file_readable()* |
| 3833 Obsolete name: file_readable(). | |
| 3834 | |
| 95 | 3835 |
| 1156 | 3836 filewritable({file}) *filewritable()* |
| 3837 The result is a Number, which is 1 when a file with the | |
| 3838 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 3839 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 3840 directory, and we can write to it, the result is 2. |
| 3841 | |
| 3842 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3843 filter({expr1}, {expr2}) *filter()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3844 {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
|
3845 For each item in {expr1} evaluate {expr2} and when the result |
| 685 | 3846 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
|
3847 {expr2} must be a |string| or |Funcref|. |
| 12785 | 3848 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
3849 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
|
3850 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
|
3851 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
|
3852 the current item. |
| 102 | 3853 Examples: > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3854 call filter(mylist, 'v:val !~ "OLD"') |
| 102 | 3855 < 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
|
3856 call filter(mydict, 'v:key >= 8') |
| 102 | 3857 < 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
|
3858 call filter(var, 0) |
| 685 | 3859 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 3860 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3861 Note that {expr2} is the result of expression and is then |
| 102 | 3862 used as an expression again. Often it is good to use a |
| 3863 |literal-string| to avoid having to double backslashes. | |
| 3864 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3865 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
|
3866 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
|
3867 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
|
3868 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
|
3869 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
|
3870 func Odd(idx, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3871 return a:idx % 2 == 1 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3872 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3873 call filter(mylist, function('Odd')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
3874 < 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
|
3875 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
|
3876 < 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
|
3877 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
|
3878 < |
| 685 | 3879 The operation is done in-place. If you want a |List| or |
| 3880 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 3881 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 3882 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3883 < 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
|
3884 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
|
3885 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
|
3886 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
|
3887 defined with the "abort" flag. |
| 95 | 3888 |
| 3889 | |
| 12785 | 3890 finddir({name} [, {path} [, {count}]]) *finddir()* |
| 1095 | 3891 Find directory {name} in {path}. Supports both downwards and |
| 3892 upwards recursive directory searches. See |file-searching| | |
| 3893 for the syntax of {path}. | |
| 3894 Returns the path of the first found match. When the found | |
| 3895 directory is below the current directory a relative path is | |
| 3896 returned. Otherwise a full path is returned. | |
| 19 | 3897 If {path} is omitted or empty then 'path' is used. |
| 3898 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 3899 {name} in {path} instead of the first one. |
| 809 | 3900 When {count} is negative return all the matches in a |List|. |
| 19 | 3901 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
|
3902 {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
|
3903 feature} |
| 794 | 3904 |
| 12785 | 3905 findfile({name} [, {path} [, {count}]]) *findfile()* |
| 794 | 3906 Just like |finddir()|, but find a file instead of a directory. |
| 3907 Uses 'suffixesadd'. | |
| 19 | 3908 Example: > |
| 3909 :echo findfile("tags.vim", ".;") | |
| 1156 | 3910 < Searches from the directory of the current file upwards until |
| 3911 it finds the file "tags.vim". | |
| 7 | 3912 |
| 1621 | 3913 float2nr({expr}) *float2nr()* |
| 3914 Convert {expr} to a Number by omitting the part after the | |
| 3915 decimal point. | |
| 3916 {expr} must evaluate to a |Float| or a Number. | |
| 3917 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
|
3918 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
|
3919 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
|
3920 -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
|
3921 64-bit Number support is enabled, -0x8000000000000000). |
| 1621 | 3922 Examples: > |
| 3923 echo float2nr(3.95) | |
| 3924 < 3 > | |
| 3925 echo float2nr(-23.45) | |
| 3926 < -23 > | |
| 3927 echo float2nr(1.0e100) | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3928 < 2147483647 (or 9223372036854775807) > |
| 1621 | 3929 echo float2nr(-1.0e150) |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3930 < -2147483647 (or -9223372036854775807) > |
| 1621 | 3931 echo float2nr(1.0e-100) |
| 3932 < 0 | |
| 3933 {only available when compiled with the |+float| feature} | |
| 3934 | |
| 3935 | |
| 3936 floor({expr}) *floor()* | |
| 3937 Return the largest integral value less than or equal to | |
| 3938 {expr} as a |Float| (round down). | |
| 3939 {expr} must evaluate to a |Float| or a |Number|. | |
| 3940 Examples: > | |
| 3941 echo floor(1.856) | |
| 3942 < 1.0 > | |
| 3943 echo floor(-5.456) | |
| 3944 < -6.0 > | |
| 3945 echo floor(4.0) | |
| 3946 < 4.0 | |
| 3947 {only available when compiled with the |+float| feature} | |
| 12785 | 3948 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3949 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3950 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3951 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3952 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3953 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
|
3954 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
|
3955 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
|
3956 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
|
3957 {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
|
3958 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3959 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3960 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3961 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3962 < -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
|
3963 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3964 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3965 |
| 1586 | 3966 fnameescape({string}) *fnameescape()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3967 Escape {string} for use as file name command argument. All |
| 1586 | 3968 characters that have a special meaning, such as '%' and '|' |
| 3969 are escaped with a backslash. | |
| 1621 | 3970 For most systems the characters escaped are |
| 3971 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 3972 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 3973 A leading '+' and '>' is also escaped (special after |:edit| |
| 3974 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 3975 Example: > |
| 1700 | 3976 :let fname = '+some str%nge|name' |
| 1586 | 3977 :exe "edit " . fnameescape(fname) |
| 3978 < results in executing: > | |
| 1700 | 3979 edit \+some\ str\%nge\|name |
| 1586 | 3980 |
| 7 | 3981 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 3982 Modify file name {fname} according to {mods}. {mods} is a | |
| 3983 string of characters like it is used for file names on the | |
| 3984 command line. See |filename-modifiers|. | |
| 3985 Example: > | |
| 3986 :echo fnamemodify("main.c", ":p:h") | |
| 3987 < results in: > | |
| 3988 /home/mool/vim/vim/src | |
| 1621 | 3989 < Note: Environment variables don't work in {fname}, use |
| 7 | 3990 |expand()| first then. |
| 3991 | |
| 3992 foldclosed({lnum}) *foldclosed()* | |
| 3993 The result is a Number. If the line {lnum} is in a closed | |
| 3994 fold, the result is the number of the first line in that fold. | |
| 3995 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 3996 | |
| 3997 foldclosedend({lnum}) *foldclosedend()* | |
| 3998 The result is a Number. If the line {lnum} is in a closed | |
| 3999 fold, the result is the number of the last line in that fold. | |
| 4000 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4001 | |
| 4002 foldlevel({lnum}) *foldlevel()* | |
| 4003 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
|
4004 in the current buffer. For nested folds the deepest level is |
| 7 | 4005 returned. If there is no fold at line {lnum}, zero is |
| 4006 returned. It doesn't matter if the folds are open or closed. | |
| 4007 When used while updating folds (from 'foldexpr') -1 is | |
| 4008 returned for lines where folds are still to be updated and the | |
| 4009 foldlevel is unknown. As a special case the level of the | |
| 4010 previous line is usually available. | |
| 4011 | |
| 4012 *foldtext()* | |
| 4013 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 4014 the default function used for the 'foldtext' option and should | |
| 4015 only be called from evaluating 'foldtext'. It uses the | |
| 4016 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 4017 The returned string looks like this: > | |
| 4018 +-- 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
|
4019 < 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
|
4020 "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
|
4021 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
|
4022 "//" 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
|
4023 '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
|
4024 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
|
4025 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
|
4026 setting. |
| 7 | 4027 {not available when compiled without the |+folding| feature} |
| 4028 | |
| 29 | 4029 foldtextresult({lnum}) *foldtextresult()* |
| 4030 Returns the text that is displayed for the closed fold at line | |
| 4031 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 4032 When there is no closed fold at {lnum} an empty string is | |
| 4033 returned. | |
| 4034 {lnum} is used like with |getline()|. Thus "." is the current | |
| 4035 line, "'m" mark m, etc. | |
| 4036 Useful when exporting folded text, e.g., to HTML. | |
| 4037 {not available when compiled without the |+folding| feature} | |
| 4038 | |
| 7 | 4039 *foreground()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4040 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 4041 a client to a Vim server. |remote_send()| |
| 4042 On Win32 systems this might not work, the OS does not always | |
| 4043 allow a window to bring itself to the foreground. Use | |
| 4044 |remote_foreground()| instead. | |
| 4045 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 4046 Win32 console version} | |
| 4047 | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4048 *funcref()* |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4049 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4050 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
|
4051 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
|
4052 function {name} is redefined later. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4053 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4054 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
|
4055 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
|
4056 function. |
| 82 | 4057 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4058 *function()* *E700* *E922* *E923* |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4059 function({name} [, {arglist}] [, {dict}]) |
| 685 | 4060 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
|
4061 {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
|
4062 internal function. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4063 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4064 {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
|
4065 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
|
4066 argument is not allowed. E.g.: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4067 let FuncWithArg = function(dict.Func, [arg]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4068 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
|
4069 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4070 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
|
4071 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
|
4072 same function. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4073 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4074 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
|
4075 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
|
4076 the Funcref and will be used when the Funcref is called. |
| 12785 | 4077 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4078 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
|
4079 arguments. Example: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4080 func Callback(arg1, arg2, name) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4081 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4082 let Func = function('Callback', ['one', 'two']) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4083 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4084 call Func('name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4085 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4086 call Callback('one', 'two', 'name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4087 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4088 < 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
|
4089 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
|
4090 arguments. Example: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4091 func Callback(arg1, arg2, name) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4092 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4093 let Func = function('Callback', ['one']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4094 let Func2 = function(Func, ['two']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4095 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4096 call Func2('name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4097 < Invokes the function as with: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4098 call Callback('one', 'two', 'name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4099 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4100 < 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
|
4101 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
|
4102 function Callback() dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4103 echo "called for " . self.name |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4104 endfunction |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4105 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4106 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4107 let Func = function('Callback', context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4108 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4109 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
|
4110 < 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
|
4111 arguments, these two are equivalent: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4112 let Func = function('Callback', context) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4113 let Func = context.Callback |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4114 |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4115 < 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
|
4116 function Callback(arg1, count) dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4117 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4118 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4119 let Func = function('Callback', ['one'], context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4120 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4121 call Func(500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4122 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4123 call context.Callback('one', 500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4124 |
| 82 | 4125 |
| 3224 | 4126 garbagecollect([{atexit}]) *garbagecollect()* |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4127 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
|
4128 that have circular references. |
| 12785 | 4129 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4130 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
|
4131 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
|
4132 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
|
4133 circular references are always freed when they become unused. |
| 685 | 4134 This is useful if you have deleted a very big |List| and/or |
| 4135 |Dictionary| with circular references in a script that runs | |
| 4136 for a long time. | |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4137 |
| 3224 | 4138 When the optional {atexit} argument is one, garbage |
| 1405 | 4139 collection will also be done when exiting Vim, if it wasn't |
| 4140 done before. This is useful when checking for memory leaks. | |
| 370 | 4141 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
4142 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
|
4143 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
|
4144 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
|
4145 |test_garbagecollect_now()|. |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4146 |
| 140 | 4147 get({list}, {idx} [, {default}]) *get()* |
| 685 | 4148 Get item {idx} from |List| {list}. When this item is not |
| 82 | 4149 available return {default}. Return zero when {default} is |
| 4150 omitted. | |
| 102 | 4151 get({dict}, {key} [, {default}]) |
| 685 | 4152 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 4153 item is not available return {default}. Return zero when |
| 4154 {default} is omitted. | |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4155 get({func}, {what}) |
|
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4156 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
|
4157 {what} are: |
| 11062 | 4158 "name" The function name |
| 4159 "func" The function | |
| 4160 "dict" The dictionary | |
| 4161 "args" The list with arguments | |
| 102 | 4162 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4163 *getbufinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4164 getbufinfo([{expr}]) |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4165 getbufinfo([{dict}]) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4166 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
|
4167 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4168 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
|
4169 returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4170 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4171 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
|
4172 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
|
4173 be specified in {dict}: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4174 buflisted include only listed buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4175 bufloaded include only loaded buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4176 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4177 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
|
4178 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
|
4179 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
|
4180 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
|
4181 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4182 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
|
4183 entries: |
|
9904
24900147aa44
commit https://github.com/vim/vim/commit/339288377072f66ec88e21903e75a82d23ffbf4f
Christian Brabandt <cb@256bit.org>
parents:
9894
diff
changeset
|
4184 bufnr buffer number. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4185 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
|
4186 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
|
4187 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
|
4188 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
|
4189 lnum current line number in buffer. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4190 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
|
4191 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
|
4192 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
|
4193 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
|
4194 the following fields: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4195 id sign identifier |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4196 lnum line number |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4197 name sign name |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4198 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
|
4199 buffer-local variables. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4200 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
|
4201 buffer |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4202 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4203 Examples: > |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4204 for buf in getbufinfo() |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4205 echo buf.name |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4206 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4207 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
|
4208 if buf.changed |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4209 .... |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4210 endif |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4211 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4212 < |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4213 To get buffer-local options use: > |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4214 getbufvar({bufnr}, '&') |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4215 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4216 < |
| 435 | 4217 *getbufline()* |
| 4218 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 4219 Return a |List| with the lines starting from {lnum} to {end} |
| 4220 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 4221 |List| with only the line {lnum} is returned. | |
| 435 | 4222 |
| 4223 For the use of {expr}, see |bufname()| above. | |
| 4224 | |
| 448 | 4225 For {lnum} and {end} "$" can be used for the last line of the |
| 4226 buffer. Otherwise a number must be used. | |
| 435 | 4227 |
| 4228 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 4229 lines in the buffer, an empty |List| is returned. |
| 435 | 4230 |
| 4231 When {end} is greater than the number of lines in the buffer, | |
| 4232 it is treated as {end} is set to the number of lines in the | |
| 685 | 4233 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 4234 returned. |
| 4235 | |
| 448 | 4236 This function works only for loaded buffers. For unloaded and |
| 685 | 4237 non-existing buffers, an empty |List| is returned. |
| 435 | 4238 |
| 4239 Example: > | |
| 4240 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 4241 |
| 4157 | 4242 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 4243 The result is the value of option or local buffer variable |
| 4244 {varname} in buffer {expr}. Note that the name without "b:" | |
| 4245 must be used. | |
| 1668 | 4246 When {varname} is empty returns a dictionary with all the |
| 4247 buffer-local variables. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4248 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
|
4249 the buffer-local options. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4250 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
|
4251 a buffer-local option. |
| 216 | 4252 This also works for a global or buffer-local option, but it |
| 4253 doesn't work for a global variable, window-local variable or | |
| 4254 window-local option. | |
| 82 | 4255 For the use of {expr}, see |bufname()| above. |
| 4157 | 4256 When the buffer or variable doesn't exist {def} or an empty |
| 4257 string is returned, there is no error message. | |
| 82 | 4258 Examples: > |
| 4259 :let bufmodified = getbufvar(1, "&mod") | |
| 4260 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
| 4261 < | |
| 7 | 4262 getchar([expr]) *getchar()* |
| 867 | 4263 Get a single character from the user or input stream. |
| 7 | 4264 If [expr] is omitted, wait until a character is available. |
| 4265 If [expr] is 0, only get a character when one is available. | |
| 867 | 4266 Return zero otherwise. |
| 7 | 4267 If [expr] is 1, only check if a character is available, it is |
| 867 | 4268 not consumed. Return zero if no character available. |
| 4269 | |
| 5555 | 4270 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
|
4271 special key is returned. If it is a single character, the |
| 867 | 4272 result is a number. Use nr2char() to convert it to a String. |
| 4273 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
|
4274 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
|
4275 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
|
4276 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
|
4277 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
|
4278 that is not included in the character. |
| 867 | 4279 |
| 5968 | 4280 When [expr] is 0 and Esc is typed, there will be a short delay |
| 4281 while Vim waits to see if this is the start of an escape | |
| 4282 sequence. | |
| 4283 | |
| 5555 | 4284 When [expr] is 1 only the first byte is returned. For a |
| 872 | 4285 one-byte character it is the character itself as a number. |
| 4286 Use nr2char() to convert it to a String. | |
| 867 | 4287 |
| 3224 | 4288 Use getcharmod() to obtain any additional modifiers. |
| 4289 | |
| 1029 | 4290 When the user clicks a mouse button, the mouse event will be |
| 4291 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
|
4292 |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
|
4293 example positions the mouse as it would normally happen: > |
| 1029 | 4294 let c = getchar() |
| 1621 | 4295 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 4296 exe v:mouse_win . "wincmd w" |
| 4297 exe v:mouse_lnum | |
| 4298 exe "normal " . v:mouse_col . "|" | |
| 4299 endif | |
| 4300 < | |
| 10734 | 4301 When using bracketed paste only the first character is |
| 4302 returned, the rest of the pasted text is dropped. | |
| 4303 |xterm-bracketed-paste|. | |
| 4304 | |
| 7 | 4305 There is no prompt, you will somehow have to make clear to the |
| 4306 user that a character has to be typed. | |
| 4307 There is no mapping for the character. | |
| 4308 Key codes are replaced, thus when the user presses the <Del> | |
| 4309 key you get the code for the <Del> key, not the raw character | |
| 4310 sequence. Examples: > | |
| 4311 getchar() == "\<Del>" | |
| 4312 getchar() == "\<S-Left>" | |
| 4313 < This example redefines "f" to ignore case: > | |
| 4314 :nmap f :call FindChar()<CR> | |
| 4315 :function FindChar() | |
| 4316 : let c = nr2char(getchar()) | |
| 4317 : while col('.') < col('$') - 1 | |
| 4318 : normal l | |
| 4319 : if getline('.')[col('.') - 1] ==? c | |
| 4320 : break | |
| 4321 : endif | |
| 4322 : endwhile | |
| 4323 :endfunction | |
| 6421 | 4324 < |
| 6647 | 4325 You may also receive synthetic characters, such as |
| 6421 | 4326 |<CursorHold>|. Often you will want to ignore this and get |
| 4327 another character: > | |
| 4328 :function GetKey() | |
| 4329 : let c = getchar() | |
| 4330 : while c == "\<CursorHold>" | |
| 4331 : let c = getchar() | |
| 4332 : endwhile | |
| 4333 : return c | |
| 4334 :endfunction | |
| 7 | 4335 |
| 4336 getcharmod() *getcharmod()* | |
| 4337 The result is a Number which is the state of the modifiers for | |
| 4338 the last obtained character with getchar() or in another way. | |
| 4339 These values are added together: | |
| 4340 2 shift | |
| 4341 4 control | |
| 4342 8 alt (meta) | |
| 3224 | 4343 16 meta (when it's different from ALT) |
| 4344 32 mouse double click | |
| 4345 64 mouse triple click | |
| 4346 96 mouse quadruple click (== 32 + 64) | |
| 4347 128 command (Macintosh only) | |
| 7 | 4348 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
|
4349 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4350 without a modifier. |
| 7 | 4351 |
| 6991 | 4352 getcharsearch() *getcharsearch()* |
| 4353 Return the current character search information as a {dict} | |
| 4354 with the following entries: | |
| 4355 | |
| 4356 char character previously used for a character | |
| 4357 search (|t|, |f|, |T|, or |F|); empty string | |
| 4358 if no character search has been performed | |
| 4359 forward direction of character search; 1 for forward, | |
| 4360 0 for backward | |
| 4361 until type of character search; 1 for a |t| or |T| | |
| 4362 character search, 0 for an |f| or |F| | |
| 4363 character search | |
| 4364 | |
| 4365 This can be useful to always have |;| and |,| search | |
| 4366 forward/backward regardless of the direction of the previous | |
| 4367 character search: > | |
| 4368 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 4369 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 4370 < Also see |setcharsearch()|. | |
| 4371 | |
| 7 | 4372 getcmdline() *getcmdline()* |
| 4373 Return the current command-line. Only works when the command | |
| 4374 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 4375 |c_CTRL-R_=|. | |
| 4376 Example: > | |
| 4377 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 4378 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 7 | 4379 |
| 95 | 4380 getcmdpos() *getcmdpos()* |
| 7 | 4381 Return the position of the cursor in the command line as a |
| 4382 byte count. The first column is 1. | |
| 4383 Only works when editing the command line, thus requires use of | |
| 3456 | 4384 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4385 Returns 0 otherwise. | |
| 531 | 4386 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 4387 | |
| 4388 getcmdtype() *getcmdtype()* | |
| 4389 Return the current command-line type. Possible return values | |
| 4390 are: | |
| 532 | 4391 : normal Ex command |
| 4392 > debug mode command |debug-mode| | |
| 4393 / forward search command | |
| 4394 ? backward search command | |
| 4395 @ |input()| command | |
| 4396 - |:insert| or |:append| command | |
| 6213 | 4397 = |i_CTRL-R_=| |
| 531 | 4398 Only works when editing the command line, thus requires use of |
| 3456 | 4399 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4400 Returns an empty string otherwise. | |
| 531 | 4401 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 4402 |
| 6153 | 4403 getcmdwintype() *getcmdwintype()* |
| 4404 Return the current |command-line-window| type. Possible return | |
| 4405 values are the same as |getcmdtype()|. Returns an empty string | |
| 4406 when not in the command-line window. | |
| 4407 | |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4408 getcompletion({pat}, {type} [, {filtered}]) *getcompletion()* |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4409 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
|
4410 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
|
4411 supported: |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4412 |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4413 augroup autocmd groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4414 buffer buffer names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4415 behave :behave suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4416 color color schemes |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4417 command Ex command (and arguments) |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4418 compiler compilers |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4419 cscope |:cscope| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4420 dir directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4421 environment environment variable names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4422 event autocommand events |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4423 expression Vim expression |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4424 file file and directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4425 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
|
4426 filetype filetype names |'filetype'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4427 function function name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4428 help help subjects |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4429 highlight highlight groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4430 history :history suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4431 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
|
4432 mapclear buffer argument |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4433 mapping mapping name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4434 menu menus |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
4435 messages |:messages| suboptions |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4436 option options |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
4437 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
|
4438 shellcmd Shell command |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4439 sign |:sign| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4440 syntax syntax file names |'syntax'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4441 syntime |:syntime| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4442 tag tags |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4443 tag_listfiles tags, file names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4444 user user names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4445 var user variables |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4446 |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4447 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
|
4448 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
|
4449 |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
|
4450 |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4451 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
|
4452 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
|
4453 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
|
4454 |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4455 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
|
4456 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
|
4457 |
| 5944 | 4458 *getcurpos()* |
| 4459 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
| 4460 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
|
4461 [bufnum, lnum, col, off, curswant] ~ |
| 5944 | 4462 The "curswant" number is the preferred column when moving the |
| 11347 | 4463 cursor vertically. Also see |getpos()|. |
| 4464 | |
| 5944 | 4465 This can be used to save and restore the cursor position: > |
| 4466 let save_cursor = getcurpos() | |
| 4467 MoveTheCursorAround | |
| 4468 call setpos('.', save_cursor) | |
| 11347 | 4469 < Note that this only works within the window. See |
| 4470 |winrestview()| for restoring more state. | |
| 7 | 4471 *getcwd()* |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4472 getcwd([{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4473 The result is a String, which is the name of the current |
| 7 | 4474 working directory. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4475 Without arguments, for the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4476 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4477 With {winnr} return the local current directory of this window |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4478 in the current tab page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4479 With {winnr} and {tabnr} return the local current directory of |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4480 the window in the specified tab page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4481 {winnr} can be the window number or the |window-ID|. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4482 Return an empty string if the arguments are invalid. |
| 7 | 4483 |
| 4484 getfsize({fname}) *getfsize()* | |
| 4485 The result is a Number, which is the size in bytes of the | |
| 4486 given file {fname}. | |
| 4487 If {fname} is a directory, 0 is returned. | |
| 4488 If the file {fname} can't be found, -1 is returned. | |
| 1293 | 4489 If the size of {fname} is too big to fit in a Number then -2 |
| 4490 is returned. | |
| 7 | 4491 |
| 37 | 4492 getfontname([{name}]) *getfontname()* |
| 4493 Without an argument returns the name of the normal font being | |
| 4494 used. Like what is used for the Normal highlight group | |
| 4495 |hl-Normal|. | |
| 4496 With an argument a check is done whether {name} is a valid | |
| 4497 font name. If not then an empty string is returned. | |
| 4498 Otherwise the actual font name is returned, or {name} if the | |
| 4499 GUI does not support obtaining the real name. | |
| 824 | 4500 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 4501 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 4502 function just after the GUI has started. | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
4503 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
|
4504 a valid name does not work. |
| 37 | 4505 |
| 20 | 4506 getfperm({fname}) *getfperm()* |
| 4507 The result is a String, which is the read, write, and execute | |
| 4508 permissions of the given file {fname}. | |
| 4509 If {fname} does not exist or its directory cannot be read, an | |
| 4510 empty string is returned. | |
| 4511 The result is of the form "rwxrwxrwx", where each group of | |
| 4512 "rwx" flags represent, in turn, the permissions of the owner | |
| 4513 of the file, the group the file belongs to, and other users. | |
| 4514 If a user does not have a given permission the flag for this | |
| 3750 | 4515 is replaced with the string "-". Examples: > |
| 20 | 4516 :echo getfperm("/etc/passwd") |
| 3750 | 4517 :echo getfperm(expand("~/.vimrc")) |
| 20 | 4518 < This will hopefully (from a security point of view) display |
| 4519 the string "rw-r--r--" or even "rw-------". | |
| 205 | 4520 |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10237
diff
changeset
|
4521 For setting permissions use |setfperm()|. |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
4522 |
| 7 | 4523 getftime({fname}) *getftime()* |
| 4524 The result is a Number, which is the last modification time of | |
| 4525 the given file {fname}. The value is measured as seconds | |
| 4526 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 4527 |localtime()| and |strftime()|. | |
| 4528 If the file {fname} can't be found -1 is returned. | |
| 4529 | |
| 20 | 4530 getftype({fname}) *getftype()* |
| 4531 The result is a String, which is a description of the kind of | |
| 4532 file of the given file {fname}. | |
| 4533 If {fname} does not exist an empty string is returned. | |
| 4534 Here is a table over different kinds of files and their | |
| 4535 results: | |
| 4536 Normal file "file" | |
| 4537 Directory "dir" | |
| 4538 Symbolic link "link" | |
| 4539 Block device "bdev" | |
| 4540 Character device "cdev" | |
| 4541 Socket "socket" | |
| 4542 FIFO "fifo" | |
| 4543 All other "other" | |
| 4544 Example: > | |
| 4545 getftype("/home") | |
| 4546 < Note that a type such as "link" will only be returned on | |
| 4547 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
|
4548 "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
|
4549 directory returns "dir" instead of "link". |
| 20 | 4550 |
| 7 | 4551 *getline()* |
| 82 | 4552 getline({lnum} [, {end}]) |
| 4553 Without {end} the result is a String, which is line {lnum} | |
| 4554 from the current buffer. Example: > | |
| 7 | 4555 getline(1) |
| 4556 < When {lnum} is a String that doesn't start with a | |
| 4557 digit, line() is called to translate the String into a Number. | |
| 4558 To get the line under the cursor: > | |
| 4559 getline(".") | |
| 4560 < When {lnum} is smaller than 1 or bigger than the number of | |
| 4561 lines in the buffer, an empty string is returned. | |
| 4562 | |
| 685 | 4563 When {end} is given the result is a |List| where each item is |
| 4564 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 4565 including line {end}. |
| 4566 {end} is used in the same way as {lnum}. | |
| 4567 Non-existing lines are silently omitted. | |
| 685 | 4568 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 4569 Example: > |
| 4570 :let start = line('.') | |
| 4571 :let end = search("^$") - 1 | |
| 4572 :let lines = getline(start, end) | |
| 4573 | |
| 1156 | 4574 < To get lines from another buffer see |getbufline()| |
| 4575 | |
| 12785 | 4576 getloclist({nr} [, {what}]) *getloclist()* |
| 647 | 4577 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
|
4578 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
|
4579 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
|
4580 |
| 647 | 4581 For a location list window, the displayed location list is |
| 648 | 4582 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
|
4583 returned. Otherwise, same as |getqflist()|. |
| 82 | 4584 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4585 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
|
4586 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
|
4587 |getqflist()| for the supported items in {what}. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4588 |
| 1326 | 4589 getmatches() *getmatches()* |
| 4590 Returns a |List| with all matches previously defined by | |
| 4591 |matchadd()| and the |:match| commands. |getmatches()| is | |
| 4592 useful in combination with |setmatches()|, as |setmatches()| | |
| 4593 can restore a list of matches saved by |getmatches()|. | |
| 4594 Example: > | |
| 4595 :echo getmatches() | |
| 4596 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 4597 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 4598 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 4599 :let m = getmatches() | |
| 4600 :call clearmatches() | |
| 4601 :echo getmatches() | |
| 4602 < [] > | |
| 4603 :call setmatches(m) | |
| 4604 :echo getmatches() | |
| 4605 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 4606 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 4607 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 4608 :unlet m | |
| 4609 < | |
| 5968 | 4610 *getpid()* |
| 4611 getpid() Return a Number which is the process ID of the Vim process. | |
| 4612 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
|
4613 exits. On MS-DOS it's always zero. |
| 5968 | 4614 |
| 4615 *getpos()* | |
| 4616 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 4617 see |line()|. For getting the cursor position see | |
| 4618 |getcurpos()|. | |
| 4619 The result is a |List| with four numbers: | |
| 4620 [bufnum, lnum, col, off] | |
| 4621 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 4622 is the buffer number of the mark. | |
| 4623 "lnum" and "col" are the position in the buffer. The first | |
| 4624 column is 1. | |
| 4625 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 4626 it is the offset in screen columns from the start of the | |
| 4627 character. E.g., a position within a <Tab> or after the last | |
| 4628 character. | |
| 4629 Note that for '< and '> Visual mode matters: when it is "V" | |
| 4630 (visual line mode) the column of '< is zero and the column of | |
| 4631 '> is a large number. | |
| 4632 This can be used to save and restore the position of a mark: > | |
| 4633 let save_a_mark = getpos("'a") | |
| 4634 ... | |
| 6421 | 4635 call setpos("'a", save_a_mark) |
| 5968 | 4636 < Also see |getcurpos()| and |setpos()|. |
| 4637 | |
| 1326 | 4638 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4639 getqflist([{what}]) *getqflist()* |
| 230 | 4640 Returns a list with all the current quickfix errors. Each |
| 4641 list item is a dictionary with these entries: | |
| 4642 bufnr number of buffer that has the file name, use | |
| 4643 bufname() to get the name | |
| 4644 lnum line number in the buffer (first line is 1) | |
| 4645 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
|
4646 vcol |TRUE|: "col" is visual column |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4647 |FALSE|: "col" is byte index |
| 230 | 4648 nr error number |
| 1065 | 4649 pattern search pattern used to locate the error |
| 230 | 4650 text description of the error |
| 4651 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
|
4652 valid |TRUE|: recognized error message |
| 230 | 4653 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4654 When there is no error list or it's empty, an empty list is |
| 1065 | 4655 returned. Quickfix list entries with non-existing buffer |
| 4656 number are returned with "bufnr" set to zero. | |
| 515 | 4657 |
| 230 | 4658 Useful application: Find pattern matches in multiple files and |
| 4659 do something with them: > | |
| 4660 :vimgrep /theword/jg *.c | |
| 4661 :for d in getqflist() | |
| 4662 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 4663 :endfor | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4664 < |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4665 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
|
4666 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
|
4667 following string items are supported in {what}: |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
4668 context get the context stored with |setqflist()| |
|
12321
2779d593a706
patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents:
12319
diff
changeset
|
4669 efm errorformat to use when parsing "lines". If |
| 12968 | 4670 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
|
4671 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
|
4672 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
|
4673 |quickfix-ID|; zero means the id for the |
| 12968 | 4674 current list or the list specified by "nr" |
|
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
|
4675 idx index of the current entry in the list |
|
11549
f5add45f9848
patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents:
11543
diff
changeset
|
4676 items quickfix list entries |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
4677 lines use 'errorformat' to extract items from a list |
|
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
4678 of lines and return the resulting entries. |
|
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
4679 Only a |List| type is accepted. The current |
|
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
4680 quickfix list is not modified. |
|
10237
197795e3530d
commit https://github.com/vim/vim/commit/890680ca6364386fabb271c85e0755bcaa6a33c1
Christian Brabandt <cb@256bit.org>
parents:
10233
diff
changeset
|
4681 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
|
4682 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
|
4683 the last quickfix list |
|
12465
805f7fd40e0d
patch 8.0.1112: can't get size or current index from quickfix list
Christian Brabandt <cb@256bit.org>
parents:
12427
diff
changeset
|
4684 size number of entries in the quickfix list |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4685 title get the list title |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
4686 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
|
4687 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
|
4688 Non-string items in {what} are ignored. To get the value of a |
|
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
4689 particular item, set it to one. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4690 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
|
4691 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
|
4692 specified by "id" is used. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
4693 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
|
4694 "$" 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
|
4695 contains the quickfix stack size. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
4696 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
|
4697 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
|
4698 "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
|
4699 In case of error processing {what}, an empty dictionary is |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4700 returned. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4701 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4702 The returned dictionary contains the following entries: |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
4703 context context information stored with |setqflist()| |
|
12287
20641a7e1fc9
patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents:
12273
diff
changeset
|
4704 id quickfix list ID |quickfix-ID| |
|
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
|
4705 idx index of the current entry in the list |
|
11549
f5add45f9848
patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents:
11543
diff
changeset
|
4706 items quickfix list entries |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4707 nr quickfix list number |
|
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
|
4708 size number of entries in the quickfix list |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4709 title quickfix list title text |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
4710 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
|
4711 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4712 Examples: > |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4713 :echo getqflist({'all': 1}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4714 :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
|
4715 :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
|
4716 < |
| 230 | 4717 |
| 5796 | 4718 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 4719 The result is a String, which is the contents of register |
| 236 | 4720 {regname}. Example: > |
| 7 | 4721 :let cliptext = getreg('*') |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
4722 < 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
|
4723 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4724 getreg('=') returns the last evaluated value of the expression |
| 236 | 4725 register. (For use in maps.) |
| 282 | 4726 getreg('=', 1) returns the expression itself, so that it can |
| 4727 be restored with |setreg()|. For other registers the extra | |
| 4728 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
|
4729 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4730 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
|
4731 to |List|. Each list item is one text line. Use it if you care |
| 5796 | 4732 about zero bytes possibly present inside register: without |
| 4733 third argument both NLs and zero bytes are represented as NLs | |
| 4734 (see |NL-used-for-Nul|). | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4735 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
|
4736 |
| 7 | 4737 If {regname} is not specified, |v:register| is used. |
| 4738 | |
| 82 | 4739 |
| 7 | 4740 getregtype([{regname}]) *getregtype()* |
| 4741 The result is a String, which is type of register {regname}. | |
| 4742 The value will be one of: | |
| 4743 "v" for |characterwise| text | |
| 4744 "V" for |linewise| text | |
| 4745 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 4746 "" for an empty or unknown register |
| 7 | 4747 <CTRL-V> is one character with value 0x16. |
| 4748 If {regname} is not specified, |v:register| is used. | |
| 4749 | |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4750 gettabinfo([{arg}]) *gettabinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4751 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
|
4752 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
|
4753 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
|
4754 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
|
4755 empty List is returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4756 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4757 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
|
4758 tabnr tab page number. |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4759 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
|
4760 tabpage-local variables |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4761 windows List of |window-ID|s in the tag page. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4762 |
| 4157 | 4763 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4764 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
|
4765 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4766 Tabs are numbered starting with one. |
| 6197 | 4767 When {varname} is empty a dictionary with all tab-local |
| 4768 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4769 Note that the name without "t:" must be used. |
| 4157 | 4770 When the tab or variable doesn't exist {def} or an empty |
| 4771 string is returned, there is no error message. | |
| 4772 | |
| 4773 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
| 1156 | 4774 Get the value of window-local variable {varname} in window |
| 4775 {winnr} in tab page {tabnr}. | |
| 4157 | 4776 When {varname} is empty a dictionary with all window-local |
| 4777 variables is returned. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4778 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
|
4779 window-local options in a Dictionary. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4780 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
|
4781 window-local option. |
| 4157 | 4782 Note that {varname} must be the name without "w:". |
| 831 | 4783 Tabs are numbered starting with one. For the current tabpage |
| 4784 use |getwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4785 {winnr} can be the window number or the |window-ID|. |
| 831 | 4786 When {winnr} is zero the current window is used. |
| 4787 This also works for a global option, buffer-local option and | |
| 4788 window-local option, but it doesn't work for a global variable | |
| 4789 or buffer-local variable. | |
| 4157 | 4790 When the tab, window or variable doesn't exist {def} or an |
| 4791 empty string is returned, there is no error message. | |
| 831 | 4792 Examples: > |
| 4793 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 4794 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 4795 < |
| 7 | 4796 *getwinposx()* |
| 4797 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 11347 | 4798 the left hand side of the GUI Vim window. Also works for an |
| 4799 xterm. | |
| 4800 The result will be -1 if the information is not available. | |
| 4801 The value can be used with `:winpos`. | |
| 7 | 4802 |
| 4803 *getwinposy()* | |
| 4804 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
| 11347 | 4805 the top of the GUI Vim window. Also works for an xterm. |
| 4806 The result will be -1 if the information is not available. | |
| 4807 The value can be used with `:winpos`. | |
| 7 | 4808 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4809 getwininfo([{winid}]) *getwininfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4810 Returns information about windows as a List with Dictionaries. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4811 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4812 If {winid} is given Information about the window with that ID |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4813 is returned. If the window does not exist the result is an |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4814 empty list. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4815 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4816 Without {winid} information about all the windows in all the |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4817 tab pages is returned. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4818 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4819 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
|
4820 bufnr number of buffer in the window |
| 12499 | 4821 height window height (excluding winbar) |
| 4822 winbar 1 if the window has a toolbar, 0 | |
| 4823 otherwise | |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4824 loclist 1 if showing a location list |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
4825 {only with the +quickfix feature} |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4826 quickfix 1 if quickfix or location list window |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
4827 {only with the +quickfix feature} |
|
12102
560a2b6789c3
patch 8.0.0931: getwininfo() does not indicate a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12084
diff
changeset
|
4828 terminal 1 if a terminal window |
|
560a2b6789c3
patch 8.0.0931: getwininfo() does not indicate a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12084
diff
changeset
|
4829 {only with the +terminal feature} |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4830 tabnr tab page number |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4831 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
|
4832 window-local variables |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4833 width window width |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4834 winid |window-ID| |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4835 winnr window number |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4836 |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4837 To obtain all window-local variables use: > |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4838 gettabwinvar({tabnr}, {winnr}, '&') |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4839 |
| 4157 | 4840 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 4841 Like |gettabwinvar()| for the current tabpage. |
| 7 | 4842 Examples: > |
| 4843 :let list_is_on = getwinvar(2, '&list') | |
| 4844 :echo "myvar = " . getwinvar(1, 'myvar') | |
| 4845 < | |
| 6663 | 4846 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 4847 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 4848 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4849 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4850 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 4851 the 'suffixes' and 'wildignore' options apply: Names matching |
| 4852 one of the patterns in 'wildignore' will be skipped and | |
| 4853 'suffixes' affect the ordering of matches. | |
| 2662 | 4854 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4855 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4856 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
|
4857 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
|
4858 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4859 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
|
4860 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4861 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4862 If the expansion fails, the result is an empty String or List. |
| 6663 | 4863 |
| 3445 | 4864 A name for a non-existing file is not included. A symbolic |
| 4865 link is only included if it points to an existing file. | |
| 6663 | 4866 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
|
4867 |TRUE| then all symbolic links are included. |
| 7 | 4868 |
| 4869 For most systems backticks can be used to get files names from | |
| 4870 any external command. Example: > | |
| 4871 :let tagfiles = glob("`find . -name tags -print`") | |
| 4872 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 4873 < 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
|
4874 item per line. Spaces inside an item are allowed. |
| 7 | 4875 |
| 4876 See |expand()| for expanding special Vim variables. See | |
| 4877 |system()| for getting the raw output of an external command. | |
| 4878 | |
| 6697 | 4879 glob2regpat({expr}) *glob2regpat()* |
| 4880 Convert a file pattern, as used by glob(), into a search | |
| 4881 pattern. The result can be used to match with a string that | |
| 4882 is a file name. E.g. > | |
| 4883 if filename =~ glob2regpat('Make*.mak') | |
| 4884 < This is equivalent to: > | |
| 4885 if filename =~ '^Make.*\.mak$' | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
4886 < 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
|
4887 empty string. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4888 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
|
4889 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
|
4890 |
| 6663 | 4891 *globpath()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4892 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 7 | 4893 Perform glob() on all directories in {path} and concatenate |
| 4894 the results. Example: > | |
| 4895 :echo globpath(&rtp, "syntax/c.vim") | |
| 5873 | 4896 < |
| 4897 {path} is a comma-separated list of directory names. Each | |
| 7 | 4898 directory name is prepended to {expr} and expanded like with |
| 1754 | 4899 |glob()|. A path separator is inserted when needed. |
| 7 | 4900 To add a comma inside a directory name escape it with a |
| 4901 backslash. Note that on MS-Windows a directory may have a | |
| 4902 trailing backslash, remove it if you put a comma after it. | |
| 4903 If the expansion fails for one of the directories, there is no | |
| 4904 error message. | |
| 5873 | 4905 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4906 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 4907 the 'suffixes' and 'wildignore' options apply: Names matching |
| 4908 one of the patterns in 'wildignore' will be skipped and | |
| 4909 'suffixes' affect the ordering of matches. | |
| 7 | 4910 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4911 When {list} is present and it is |TRUE| the result is a List |
| 5873 | 4912 with all matching files. The advantage of using a List is, you |
| 4913 also get filenames containing newlines correctly. Otherwise | |
| 4914 the result is a String and when there are several matches, | |
| 4915 they are separated by <NL> characters. Example: > | |
| 4916 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 4917 < | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4918 {alllinks} is used as with |glob()|. |
| 6663 | 4919 |
| 444 | 4920 The "**" item can be used to search in a directory tree. |
| 4921 For example, to find all "README.txt" files in the directories | |
| 4922 in 'runtimepath' and below: > | |
| 4923 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 4924 < Upwards search and limiting the depth of "**" is not |
| 4925 supported, thus using 'path' will not always work properly. | |
| 4926 | |
| 7 | 4927 *has()* |
| 4928 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
| 4929 supported, zero otherwise. The {feature} argument is a | |
| 4930 string. See |feature-list| below. | |
| 4931 Also see |exists()|. | |
| 4932 | |
| 102 | 4933 |
| 4934 has_key({dict}, {key}) *has_key()* | |
| 685 | 4935 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 4936 an entry with key {key}. Zero otherwise. | |
| 102 | 4937 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4938 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4939 The result is a Number, which is 1 when the window has set a |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4940 local path via |:lcd|, and 0 otherwise. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4941 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4942 Without arguments use the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4943 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
|
4944 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
|
4945 page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4946 {winnr} can be the window number or the |window-ID|. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4947 Return 0 if the arguments are invalid. |
| 102 | 4948 |
| 782 | 4949 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 4950 The result is a Number, which is 1 if there is a mapping that |
| 4951 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 4952 and this mapping exists in one of the modes indicated by | |
| 4953 {mode}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4954 When {abbr} is there and it is |TRUE| use abbreviations |
| 786 | 4955 instead of mappings. Don't forget to specify Insert and/or |
| 4956 Command-line mode. | |
| 7 | 4957 Both the global mappings and the mappings local to the current |
| 4958 buffer are checked for a match. | |
| 4959 If no matching mapping is found 0 is returned. | |
| 4960 The following characters are recognized in {mode}: | |
| 4961 n Normal mode | |
| 4962 v Visual mode | |
| 4963 o Operator-pending mode | |
| 4964 i Insert mode | |
| 4965 l Language-Argument ("r", "f", "t", etc.) | |
| 4966 c Command-line mode | |
| 4967 When {mode} is omitted, "nvo" is used. | |
| 4968 | |
| 4969 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
|
4970 to a function in a Vim script. Example: > |
| 7 | 4971 :if !hasmapto('\ABCdoit') |
| 4972 : map <Leader>d \ABCdoit | |
| 4973 :endif | |
| 4974 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 4975 already a mapping to "\ABCdoit". | |
| 4976 | |
| 4977 histadd({history}, {item}) *histadd()* | |
| 4978 Add the String {item} to the history {history} which can be | |
| 4979 one of: *hist-names* | |
| 4980 "cmd" or ":" command line history | |
| 4981 "search" or "/" search pattern history | |
| 1621 | 4982 "expr" or "=" typed expression history |
| 7 | 4983 "input" or "@" input line history |
| 3682 | 4984 "debug" or ">" debug command history |
|
10228
8a1481e59d64
commit https://github.com/vim/vim/commit/3e496b0ea31996b665824f45664dee1fdd73c4d0
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
4985 empty the current or last used history |
| 3682 | 4986 The {history} string does not need to be the whole name, one |
| 4987 character is sufficient. | |
| 7 | 4988 If {item} does already exist in the history, it will be |
| 4989 shifted to become the newest entry. | |
| 4990 The result is a Number: 1 if the operation was successful, | |
| 4991 otherwise 0 is returned. | |
| 4992 | |
| 4993 Example: > | |
| 4994 :call histadd("input", strftime("%Y %b %d")) | |
| 4995 :let date=input("Enter date: ") | |
| 4996 < This function is not available in the |sandbox|. | |
| 4997 | |
| 4998 histdel({history} [, {item}]) *histdel()* | |
| 236 | 4999 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 5000 for the possible values of {history}. |
| 5001 | |
| 1668 | 5002 If the parameter {item} evaluates to a String, it is used as a |
| 5003 regular expression. All entries matching that expression will | |
| 5004 be removed from the history (if there are any). | |
| 7 | 5005 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 5006 If {item} evaluates to a Number, it will be interpreted as |
| 5007 an index, see |:history-indexing|. The respective entry will | |
| 5008 be removed if it exists. | |
| 7 | 5009 |
| 5010 The result is a Number: 1 for a successful operation, | |
| 5011 otherwise 0 is returned. | |
| 5012 | |
| 5013 Examples: | |
| 5014 Clear expression register history: > | |
| 5015 :call histdel("expr") | |
| 5016 < | |
| 5017 Remove all entries starting with "*" from the search history: > | |
| 5018 :call histdel("/", '^\*') | |
| 5019 < | |
| 5020 The following three are equivalent: > | |
| 5021 :call histdel("search", histnr("search")) | |
| 5022 :call histdel("search", -1) | |
| 5023 :call histdel("search", '^'.histget("search", -1).'$') | |
| 5024 < | |
| 5025 To delete the last search pattern and use the last-but-one for | |
| 5026 the "n" command and 'hlsearch': > | |
| 5027 :call histdel("search", -1) | |
| 5028 :let @/ = histget("search", -1) | |
| 5029 | |
| 5030 histget({history} [, {index}]) *histget()* | |
| 5031 The result is a String, the entry with Number {index} from | |
| 5032 {history}. See |hist-names| for the possible values of | |
| 5033 {history}, and |:history-indexing| for {index}. If there is | |
| 5034 no such entry, an empty String is returned. When {index} is | |
| 5035 omitted, the most recent item from the history is used. | |
| 5036 | |
| 5037 Examples: | |
| 5038 Redo the second last search from history. > | |
| 5039 :execute '/' . histget("search", -2) | |
| 5040 | |
| 5041 < Define an Ex command ":H {num}" that supports re-execution of | |
| 5042 the {num}th entry from the output of |:history|. > | |
| 5043 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 5044 < | |
| 5045 histnr({history}) *histnr()* | |
| 5046 The result is the Number of the current entry in {history}. | |
| 5047 See |hist-names| for the possible values of {history}. | |
| 5048 If an error occurred, -1 is returned. | |
| 5049 | |
| 5050 Example: > | |
| 5051 :let inp_index = histnr("expr") | |
| 5052 < | |
| 5053 hlexists({name}) *hlexists()* | |
| 5054 The result is a Number, which is non-zero if a highlight group | |
| 5055 called {name} exists. This is when the group has been | |
| 5056 defined in some way. Not necessarily when highlighting has | |
| 5057 been defined for it, it may also have been used for a syntax | |
| 5058 item. | |
| 5059 *highlight_exists()* | |
| 5060 Obsolete name: highlight_exists(). | |
| 5061 | |
| 5062 *hlID()* | |
| 5063 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 5064 with name {name}. When the highlight group doesn't exist, | |
| 5065 zero is returned. | |
| 5066 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
|
5067 group. For example, to get the background color of the |
| 7 | 5068 "Comment" group: > |
| 5069 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 5070 < *highlightID()* | |
| 5071 Obsolete name: highlightID(). | |
| 5072 | |
| 5073 hostname() *hostname()* | |
| 5074 The result is a String, which is the name of the machine on | |
| 236 | 5075 which Vim is currently running. Machine names greater than |
| 7 | 5076 256 characters long are truncated. |
| 5077 | |
| 5078 iconv({expr}, {from}, {to}) *iconv()* | |
| 5079 The result is a String, which is the text {expr} converted | |
| 5080 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5081 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5082 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5083 are replaced with "?". |
| 7 | 5084 The encoding names are whatever the iconv() library function |
| 5085 can accept, see ":!man 3 iconv". | |
| 5086 Most conversions require Vim to be compiled with the |+iconv| | |
| 5087 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 5088 can be done. | |
| 5089 This can be used to display messages with special characters, | |
| 5090 no matter what 'encoding' is set to. Write the message in | |
| 5091 UTF-8 and use: > | |
| 5092 echo iconv(utf8_str, "utf-8", &enc) | |
| 5093 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 5094 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 5095 cannot use UCS-2 in a string anyway, because of the NUL bytes. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
5096 {only available when compiled with the |+multi_byte| feature} |
| 7 | 5097 |
| 5098 *indent()* | |
| 5099 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 5100 current buffer. The indent is counted in spaces, the value | |
| 5101 of 'tabstop' is relevant. {lnum} is used just like in | |
| 5102 |getline()|. | |
| 5103 When {lnum} is invalid -1 is returned. | |
| 5104 | |
| 79 | 5105 |
| 95 | 5106 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
| 685 | 5107 Return the lowest index in |List| {list} where the item has a |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5108 value equal to {expr}. There is no automatic conversion, so |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5109 the String "4" is different from the Number 4. And the number |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5110 4 is different from the Float 4.0. The value of 'ignorecase' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5111 is not used here, case always matters. |
| 153 | 5112 If {start} is given then start looking at the item with index |
| 5113 {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
|
5114 When {ic} is given and it is |TRUE|, ignore case. Otherwise |
| 79 | 5115 case must match. |
| 5116 -1 is returned when {expr} is not found in {list}. | |
| 5117 Example: > | |
| 5118 :let idx = index(words, "the") | |
| 87 | 5119 :if index(numbers, 123) >= 0 |
| 79 | 5120 |
| 5121 | |
| 531 | 5122 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 5123 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
|
5124 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5125 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
|
5126 in the prompt to start a new line. |
| 531 | 5127 The highlighting set with |:echohl| is used for the prompt. |
| 5128 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
|
5129 editing commands and mappings. There is a separate history |
| 531 | 5130 for lines typed for input(). |
| 5131 Example: > | |
| 5132 :if input("Coffee or beer? ") == "beer" | |
| 5133 : echo "Cheers!" | |
| 5134 :endif | |
| 5135 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5136 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5137 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
|
5138 Example: > |
| 531 | 5139 :let color = input("Color? ", "white") |
| 5140 | |
| 5141 < The optional {completion} argument specifies the type of | |
| 5142 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
|
5143 not performed. The supported completion types are the same as |
| 531 | 5144 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
|
5145 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 5146 more information. Example: > |
| 5147 let fname = input("File: ", "", "file") | |
| 5148 < | |
| 5149 NOTE: This function must not be used in a startup file, for | |
| 5150 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 5151 Note: When input() is called from within a mapping it will |
| 5152 consume remaining characters from that mapping, because a | |
| 5153 mapping is handled like the characters were typed. | |
| 5154 Use |inputsave()| before input() and |inputrestore()| | |
| 5155 after input() to avoid that. Another solution is to avoid | |
| 5156 that further characters follow in the mapping, e.g., by using | |
| 5157 |:execute| or |:normal|. | |
| 5158 | |
| 531 | 5159 Example with a mapping: > |
| 7 | 5160 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 5161 :function GetFoo() | |
| 5162 : call inputsave() | |
| 5163 : let g:Foo = input("enter search pattern: ") | |
| 5164 : call inputrestore() | |
| 5165 :endfunction | |
| 5166 | |
| 5167 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5168 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5169 are supported, a dialog window pops up to input the text. |
| 7 | 5170 Example: > |
| 3875 | 5171 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 5172 :if n != "" | |
| 5173 : let &sw = n | |
| 5174 :endif | |
| 7 | 5175 < When the dialog is cancelled {cancelreturn} is returned. When |
| 5176 omitted an empty string is returned. | |
| 5177 Hitting <Enter> works like pressing the OK button. Hitting | |
| 5178 <Esc> works like pressing the Cancel button. | |
| 531 | 5179 NOTE: Command-line completion is not supported. |
| 7 | 5180 |
| 519 | 5181 inputlist({textlist}) *inputlist()* |
| 819 | 5182 {textlist} must be a |List| of strings. This |List| is |
| 5183 displayed, one string per line. The user will be prompted to | |
| 5184 enter a number, which is returned. | |
| 519 | 5185 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
|
5186 mouse. For the first string 0 is returned. When clicking |
| 519 | 5187 above the first item a negative number is returned. When |
| 5188 clicking on the prompt one more than the length of {textlist} | |
| 5189 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5190 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
|
5191 it won't work. It's a good idea to put the entry number at |
| 1156 | 5192 the start of the string. And put a prompt in the first item. |
| 5193 Example: > | |
| 519 | 5194 let color = inputlist(['Select color:', '1. red', |
| 5195 \ '2. green', '3. blue']) | |
| 5196 | |
| 7 | 5197 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5198 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 5199 Should be called the same number of times inputsave() is |
| 5200 called. Calling it more often is harmless though. | |
| 5201 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 5202 | |
| 5203 inputsave() *inputsave()* | |
| 5204 Preserve typeahead (also from mappings) and clear it, so that | |
| 5205 a following prompt gets input from the user. Should be | |
| 5206 followed by a matching inputrestore() after the prompt. Can | |
| 5207 be used several times, in which case there must be just as | |
| 5208 many inputrestore() calls. | |
| 5209 Returns 1 when out of memory, 0 otherwise. | |
| 5210 | |
| 5211 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 5212 This function acts much like the |input()| function with but | |
| 5213 two exceptions: | |
| 5214 a) the user's response will be displayed as a sequence of | |
| 5215 asterisks ("*") thereby keeping the entry secret, and | |
| 5216 b) the user's response will not be recorded on the input | |
| 5217 |history| stack. | |
| 5218 The result is a String, which is whatever the user actually | |
| 5219 typed on the command-line in response to the issued prompt. | |
| 531 | 5220 NOTE: Command-line completion is not supported. |
| 7 | 5221 |
| 55 | 5222 insert({list}, {item} [, {idx}]) *insert()* |
| 685 | 5223 Insert {item} at the start of |List| {list}. |
| 55 | 5224 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
|
5225 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 5226 like omitting {idx}. A negative {idx} is also possible, see |
| 5227 |list-index|. -1 inserts just before the last item. | |
| 685 | 5228 Returns the resulting |List|. Examples: > |
| 55 | 5229 :let mylist = insert([2, 3, 5], 1) |
| 5230 :call insert(mylist, 4, -1) | |
| 5231 :call insert(mylist, 6, len(mylist)) | |
| 82 | 5232 < The last example can be done simpler with |add()|. |
| 685 | 5233 Note that when {item} is a |List| it is inserted as a single |
| 692 | 5234 item. Use |extend()| to concatenate |Lists|. |
| 55 | 5235 |
| 3214 | 5236 invert({expr}) *invert()* |
| 5237 Bitwise invert. The argument is converted to a number. A | |
| 5238 List, Dict or Float argument causes an error. Example: > | |
| 5239 :let bits = invert(bits) | |
| 5240 | |
| 7 | 5241 isdirectory({directory}) *isdirectory()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5242 The result is a Number, which is |TRUE| when a directory |
| 7 | 5243 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
|
5244 exist, or isn't a directory, the result is |FALSE|. {directory} |
| 7 | 5245 is any expression, which is used as a String. |
| 5246 | |
| 819 | 5247 islocked({expr}) *islocked()* *E786* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5248 The result is a Number, which is |TRUE| when {expr} is the |
| 148 | 5249 name of a locked variable. |
| 685 | 5250 {expr} must be the name of a variable, |List| item or |
| 5251 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 5252 :let alist = [0, ['a', 'b'], 2, 3] |
| 5253 :lockvar 1 alist | |
| 5254 :echo islocked('alist') " 1 | |
| 5255 :echo islocked('alist[1]') " 0 | |
| 5256 | |
| 5257 < When {expr} is a variable that does not exist you get an error | |
| 843 | 5258 message. Use |exists()| to check for existence. |
| 148 | 5259 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5260 isnan({expr}) *isnan()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5261 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
|
5262 echo isnan(0.0 / 0.0) |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5263 < 1 ~ |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5264 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5265 {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
|
5266 |
| 140 | 5267 items({dict}) *items()* |
| 685 | 5268 Return a |List| with all the key-value pairs of {dict}. Each |
| 5269 |List| item is a list with two items: the key of a {dict} | |
| 5270 entry and the value of this entry. The |List| is in arbitrary | |
| 5271 order. | |
| 140 | 5272 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5273 job_getchannel({job}) *job_getchannel()* |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5274 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
|
5275 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
|
5276 if string(job_getchannel()) == 'channel fail' |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5277 < |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5278 {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
|
5279 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5280 job_info({job}) *job_info()* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5281 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
|
5282 "status" what |job_status()| returns |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5283 "channel" what |job_getchannel()| returns |
|
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
|
5284 "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
|
5285 "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
|
5286 "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
|
5287 "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
|
5288 "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
|
5289 "stoponexit" |job-stoponexit| |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5290 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5291 job_setoptions({job}, {options}) *job_setoptions()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5292 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
|
5293 "stoponexit" |job-stoponexit| |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5294 "exit_cb" |job-exit_cb| |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5295 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5296 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
|
5297 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
|
5298 |:!cmd| this does not wait for the job to finish. |
| 12254 | 5299 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
|
5300 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5301 {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
|
5302 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
|
5303 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
|
5304 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5305 {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
|
5306 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
|
5307 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
|
5308 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5309 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
|
5310 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
|
5311 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5312 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
|
5313 '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
|
5314 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
|
5315 < Or: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5316 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
|
5317 < 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
|
5318 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
|
5319 shell command. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5320 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5321 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
|
5322 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
|
5323 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5324 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
|
5325 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
|
5326 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
|
5327 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
|
5328 < |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5329 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
|
5330 |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
|
5331 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5332 {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
|
5333 items, see |job-options|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5334 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5335 {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
|
5336 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5337 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
|
5338 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
|
5339 "run" job is running |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5340 "fail" job failed to start |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5341 "dead" job died or was stopped after running |
| 12785 | 5342 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5343 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
|
5344 "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
|
5345 detected. |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5346 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5347 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
|
5348 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
|
5349 |
|
8502
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5350 For more information see |job_info()|. |
|
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5351 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5352 {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
|
5353 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5354 job_stop({job} [, {how}]) *job_stop()* |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5355 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
|
5356 |
|
8251
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5357 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
|
5358 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
|
5359 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
|
5360 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
|
5361 affected. |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5362 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5363 Effect for Unix: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5364 "term" SIGTERM (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5365 "hup" SIGHUP |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5366 "quit" SIGQUIT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5367 "int" SIGINT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5368 "kill" SIGKILL (strongest way to stop) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5369 number signal with that number |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5370 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5371 Effect for MS-Windows: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5372 "term" terminate process forcedly (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5373 "hup" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5374 "quit" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5375 "int" CTRL_C |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5376 "kill" terminate process forcedly |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5377 Others CTRL_BREAK |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5378 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5379 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
|
5380 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
|
5381 and the command. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5382 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5383 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
|
5384 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
|
5385 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
|
5386 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
|
5387 |job_status()|. |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5388 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5389 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
|
5390 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
|
5391 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
|
5392 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5393 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
|
5394 the channel. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5395 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5396 {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
|
5397 |
| 95 | 5398 join({list} [, {sep}]) *join()* |
| 5399 Join the items in {list} together into one String. | |
| 5400 When {sep} is specified it is put in between the items. If | |
| 5401 {sep} is omitted a single space is used. | |
| 5402 Note that {sep} is not added at the end. You might want to | |
| 5403 add it there too: > | |
| 5404 let lines = join(mylist, "\n") . "\n" | |
| 692 | 5405 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 5406 converted into a string like with |string()|. |
| 5407 The opposite function is |split()|. | |
| 5408 | |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5409 js_decode({string}) *js_decode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5410 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
|
5411 - 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
|
5412 - 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
|
5413 - 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
|
5414 result in v:none items. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5415 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5416 js_encode({expr}) *js_encode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5417 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
|
5418 - 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
|
5419 - 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
|
5420 commas. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5421 For example, the Vim object: |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5422 [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
|
5423 Will be encoded as: |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5424 [1,,{one:1},,] ~ |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5425 While json_encode() would produce: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5426 [1,null,{"one":1},null] ~ |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5427 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
|
5428 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
|
5429 |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5430 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5431 json_decode({string}) *json_decode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5432 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
|
5433 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
|
5434 JSON and Vim values. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5435 The decoding is permissive: |
| 11347 | 5436 - A trailing comma in an array and object is ignored, e.g. |
| 5437 "[1, 2, ]" is the same as "[1, 2]". | |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5438 - More floating point numbers are recognized, e.g. "1." for |
| 11347 | 5439 "1.0", or "001.2" for "1.2". Special floating point values |
| 5440 "Infinity" and "NaN" (capitalization ignored) are accepted. | |
| 5441 - Leading zeroes in integer numbers are ignored, e.g. "012" | |
| 5442 for "12" or "-012" for "-12". | |
| 5443 - Capitalization is ignored in literal names null, true or | |
| 5444 false, e.g. "NULL" for "null", "True" for "true". | |
| 5445 - Control characters U+0000 through U+001F which are not | |
| 5446 escaped in strings are accepted, e.g. " " (tab | |
| 5447 character in string) for "\t". | |
| 5448 - Backslash in an invalid 2-character sequence escape is | |
| 5449 ignored, e.g. "\a" is decoded as "a". | |
| 5450 - A correct surrogate pair in JSON strings should normally be | |
| 5451 a 12 character sequence such as "\uD834\uDD1E", but | |
| 5452 json_decode() silently accepts truncated surrogate pairs | |
| 5453 such as "\uD834" or "\uD834\u" | |
| 5454 *E938* | |
| 5455 A duplicate key in an object, valid in rfc7159, is not | |
| 5456 accepted by json_decode() as the result must be a valid Vim | |
| 5457 type, e.g. this fails: {"a":"b", "a":"c"} | |
| 5458 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5459 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5460 json_encode({expr}) *json_encode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5461 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
|
5462 The encoding is specified in: |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5463 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
|
5464 Vim values are converted as follows: |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5465 Number decimal number |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5466 Float floating point number |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5467 Float nan "NaN" |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5468 Float inf "Infinity" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5469 String in double quotes (possibly null) |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5470 Funcref not possible, error |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5471 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
|
5472 used recursively: [] |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5473 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
|
5474 used recursively: {} |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5475 v:false "false" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5476 v:true "true" |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5477 v:none "null" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5478 v:null "null" |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5479 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
|
5480 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
|
5481 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
|
5482 |
| 99 | 5483 keys({dict}) *keys()* |
| 685 | 5484 Return a |List| with all the keys of {dict}. The |List| is in |
| 99 | 5485 arbitrary order. |
| 5486 | |
| 85 | 5487 *len()* *E701* |
| 55 | 5488 len({expr}) The result is a Number, which is the length of the argument. |
| 5489 When {expr} is a String or a Number the length in bytes is | |
| 5490 used, as with |strlen()|. | |
| 685 | 5491 When {expr} is a |List| the number of items in the |List| is |
| 55 | 5492 returned. |
| 685 | 5493 When {expr} is a |Dictionary| the number of entries in the |
| 5494 |Dictionary| is returned. | |
| 55 | 5495 Otherwise an error is given. |
| 5496 | |
| 7 | 5497 *libcall()* *E364* *E368* |
| 5498 libcall({libname}, {funcname}, {argument}) | |
| 5499 Call function {funcname} in the run-time library {libname} | |
| 5500 with single argument {argument}. | |
| 5501 This is useful to call functions in a library that you | |
| 5502 especially made to be used with Vim. Since only one argument | |
| 5503 is possible, calling standard library functions is rather | |
| 5504 limited. | |
| 5505 The result is the String returned by the function. If the | |
| 5506 function returns NULL, this will appear as an empty string "" | |
| 5507 to Vim. | |
| 5508 If the function returns a number, use libcallnr()! | |
| 5509 If {argument} is a number, it is passed to the function as an | |
| 5510 int; if {argument} is a string, it is passed as a | |
| 5511 null-terminated string. | |
| 5512 This function will fail in |restricted-mode|. | |
| 5513 | |
| 5514 libcall() allows you to write your own 'plug-in' extensions to | |
| 5515 Vim without having to recompile the program. It is NOT a | |
| 5516 means to call system functions! If you try to do so Vim will | |
| 5517 very probably crash. | |
| 5518 | |
| 5519 For Win32, the functions you write must be placed in a DLL | |
| 5520 and use the normal C calling convention (NOT Pascal which is | |
| 5521 used in Windows System DLLs). The function must take exactly | |
| 5522 one parameter, either a character pointer or a long integer, | |
| 5523 and must return a character pointer or NULL. The character | |
| 5524 pointer returned must point to memory that will remain valid | |
| 5525 after the function has returned (e.g. in static data in the | |
| 5526 DLL). If it points to allocated memory, that memory will | |
| 5527 leak away. Using a static buffer in the function should work, | |
| 5528 it's then freed when the DLL is unloaded. | |
| 5529 | |
| 5530 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 5531 crash! This also happens if the function returns a number, |
| 7 | 5532 because Vim thinks it's a pointer. |
| 5533 For Win32 systems, {libname} should be the filename of the DLL | |
| 5534 without the ".DLL" suffix. A full path is only required if | |
| 5535 the DLL is not in the usual places. | |
| 5536 For Unix: When compiling your own plugins, remember that the | |
| 5537 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5538 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 5539 feature is present} |
| 5540 Examples: > | |
| 5541 :echo libcall("libc.so", "getenv", "HOME") | |
| 5542 < | |
| 5543 *libcallnr()* | |
| 5544 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5545 Just like |libcall()|, but used for a function that returns an |
| 7 | 5546 int instead of a string. |
| 5547 {only in Win32 on some Unix versions, when the |+libcall| | |
| 5548 feature is present} | |
| 1621 | 5549 Examples: > |
| 5550 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 5551 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 5552 :call libcallnr("libc.so", "sleep", 10) | |
| 5553 < | |
| 5554 *line()* | |
| 5555 line({expr}) The result is a Number, which is the line number of the file | |
| 5556 position given with {expr}. The accepted positions are: | |
| 5557 . the cursor position | |
| 5558 $ the last line in the current buffer | |
| 5559 'x position of mark x (if the mark is not set, 0 is | |
| 5560 returned) | |
|
11313
327a04a762f6
patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents:
11263
diff
changeset
|
5561 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
|
5562 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
|
5563 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
|
5564 less than "w0" if no lines are visible) |
| 1609 | 5565 v In Visual mode: the start of the Visual area (the |
| 5566 cursor is the end). When not in Visual mode | |
| 5567 returns the cursor position. Differs from |'<| in | |
| 5568 that it's updated right away. | |
| 1156 | 5569 Note that a mark in another file can be used. The line number |
| 5570 then applies to another buffer. | |
| 703 | 5571 To get the column number use |col()|. To get both use |
| 5572 |getpos()|. | |
| 7 | 5573 Examples: > |
| 5574 line(".") line number of the cursor | |
| 5575 line("'t") line number of mark t | |
| 5576 line("'" . marker) line number of mark marker | |
| 5577 < *last-position-jump* | |
| 5578 This autocommand jumps to the last known position in a file | |
| 5579 just after opening it, if the '" mark is set: > | |
| 11518 | 5580 :au BufReadPost * |
| 12785 | 5581 \ if line("'\"") > 1 && line("'\"") <= line("$") && &ft !~# 'commit' |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
5582 \ | exe "normal! g`\"" |
|
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
5583 \ | endif |
| 9 | 5584 |
| 7 | 5585 line2byte({lnum}) *line2byte()* |
| 5586 Return the byte count from the start of the buffer for line | |
| 5587 {lnum}. This includes the end-of-line character, depending on | |
| 5588 the 'fileformat' option for the current buffer. The first | |
| 3237 | 5589 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 5590 This can also be used to get the byte count for the line just |
| 5591 below the last line: > | |
| 5592 line2byte(line("$") + 1) | |
| 3237 | 5593 < This is the buffer size plus one. If 'fileencoding' is empty |
| 5594 it is the file size plus one. | |
| 7 | 5595 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 5596 disabled at compile time, -1 is returned. | |
| 5597 Also see |byte2line()|, |go| and |:goto|. | |
| 5598 | |
| 5599 lispindent({lnum}) *lispindent()* | |
| 5600 Get the amount of indent for line {lnum} according the lisp | |
| 5601 indenting rules, as with 'lisp'. | |
| 5602 The indent is counted in spaces, the value of 'tabstop' is | |
| 5603 relevant. {lnum} is used just like in |getline()|. | |
| 5604 When {lnum} is invalid or Vim was not compiled the | |
| 5605 |+lispindent| feature, -1 is returned. | |
| 5606 | |
| 5607 localtime() *localtime()* | |
| 5608 Return the current time, measured as seconds since 1st Jan | |
| 5609 1970. See also |strftime()| and |getftime()|. | |
| 5610 | |
| 95 | 5611 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5612 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5613 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
|
5614 {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
|
5615 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5616 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5617 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5618 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5619 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5620 < 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
|
5621 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5622 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5623 |
| 1621 | 5624 log10({expr}) *log10()* |
| 5625 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 5626 {expr} must evaluate to a |Float| or a |Number|. | |
| 5627 Examples: > | |
| 5628 :echo log10(1000) | |
| 5629 < 3.0 > | |
| 5630 :echo log10(0.01) | |
| 5631 < -2.0 | |
| 5632 {only available when compiled with the |+float| feature} | |
| 12785 | 5633 |
| 5634 luaeval({expr} [, {expr}]) *luaeval()* | |
| 5635 Evaluate Lua expression {expr} and return its result converted | |
| 5636 to Vim data structures. Second {expr} may hold additional | |
| 3492 | 5637 argument accessible as _A inside first {expr}. |
| 5638 Strings are returned as they are. | |
| 5639 Boolean objects are converted to numbers. | |
| 12785 | 5640 Numbers are converted to |Float| values if vim was compiled |
| 3492 | 5641 with |+float| and to numbers otherwise. |
| 12785 | 5642 Dictionaries and lists obtained by vim.eval() are returned |
| 3492 | 5643 as-is. |
| 5644 Other objects are returned as zero without any errors. | |
| 5645 See |lua-luaeval| for more details. | |
| 5646 {only available when compiled with the |+lua| feature} | |
| 5647 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5648 map({expr1}, {expr2}) *map()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5649 {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
|
5650 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
|
5651 {expr2}. {expr2} must be a |string| or |Funcref|. |
| 12785 | 5652 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5653 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
|
5654 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
|
5655 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
|
5656 the current item. |
| 102 | 5657 Example: > |
| 5658 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 5659 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 5660 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5661 Note that {expr2} is the result of an expression and is then |
| 102 | 5662 used as an expression again. Often it is good to use a |
| 158 | 5663 |literal-string| to avoid having to double backslashes. You |
| 5664 still have to double ' quotes | |
| 102 | 5665 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5666 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
|
5667 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
|
5668 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
|
5669 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
|
5670 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
|
5671 func KeyValue(key, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5672 return a:key . '-' . a:val |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5673 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5674 call map(myDict, function('KeyValue')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
5675 < 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
|
5676 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
|
5677 < 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
|
5678 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
|
5679 < |
| 685 | 5680 The operation is done in-place. If you want a |List| or |
| 5681 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 5682 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 5683 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5684 < 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
|
5685 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
|
5686 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
|
5687 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
|
5688 defined with the "abort" flag. |
| 95 | 5689 |
| 5690 | |
| 12785 | 5691 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 2610 | 5692 When {dict} is omitted or zero: Return the rhs of mapping |
| 5693 {name} in mode {mode}. The returned String has special | |
| 5694 characters translated like in the output of the ":map" command | |
| 5695 listing. | |
| 12785 | 5696 |
| 2610 | 5697 When there is no mapping for {name}, an empty String is |
| 5698 returned. | |
| 5699 | |
| 5700 The {name} can have special key names, like in the ":map" | |
| 5701 command. | |
| 5702 | |
| 644 | 5703 {mode} can be one of these strings: |
| 7 | 5704 "n" Normal |
| 2610 | 5705 "v" Visual (including Select) |
| 7 | 5706 "o" Operator-pending |
| 5707 "i" Insert | |
| 5708 "c" Cmd-line | |
| 2610 | 5709 "s" Select |
| 5710 "x" Visual | |
| 7 | 5711 "l" langmap |language-mapping| |
| 12499 | 5712 "t" Terminal-Job |
| 7 | 5713 "" Normal, Visual and Operator-pending |
| 644 | 5714 When {mode} is omitted, the modes for "" are used. |
| 2610 | 5715 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5716 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 5717 instead of mappings. |
| 2610 | 5718 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5719 When {dict} is there and it is |TRUE| return a dictionary |
| 2610 | 5720 containing all the information of the mapping with the |
| 5721 following items: | |
| 5722 "lhs" The {lhs} of the mapping. | |
| 5723 "rhs" The {rhs} of the mapping as typed. | |
| 5724 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 5725 "noremap" 1 if the {rhs} of the mapping is not remappable. |
| 2610 | 5726 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 5727 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 5728 "mode" Modes for which the mapping is defined. In | |
| 5729 addition to the modes mentioned above, these | |
| 5730 characters will be used: | |
| 5731 " " Normal, Visual and Operator-pending | |
| 5732 "!" Insert and Commandline mode | |
| 2642 | 5733 (|mapmode-ic|) |
| 2625 | 5734 "sid" The script local ID, used for <sid> mappings |
| 5735 (|<SID>|). | |
| 5555 | 5736 "nowait" Do not wait for other, longer mappings. |
| 5737 (|:map-<nowait>|). | |
| 2610 | 5738 |
| 7 | 5739 The mappings local to the current buffer are checked first, |
| 5740 then the global mappings. | |
| 626 | 5741 This function can be used to map a key even when it's already |
| 5742 mapped, and have it do the original mapping too. Sketch: > | |
| 5743 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 5744 | |
| 7 | 5745 |
| 12785 | 5746 mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 5747 Check if there is a mapping that matches with {name} in mode |
| 5748 {mode}. See |maparg()| for {mode} and special names in | |
| 5749 {name}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5750 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 5751 instead of mappings. |
| 7 | 5752 A match happens with a mapping that starts with {name} and |
| 5753 with a mapping which is equal to the start of {name}. | |
| 5754 | |
| 1621 | 5755 matches mapping "a" "ab" "abc" ~ |
| 7 | 5756 mapcheck("a") yes yes yes |
| 5757 mapcheck("abc") yes yes yes | |
| 5758 mapcheck("ax") yes no no | |
| 5759 mapcheck("b") no no no | |
| 5760 | |
| 5761 The difference with maparg() is that mapcheck() finds a | |
| 5762 mapping that matches with {name}, while maparg() only finds a | |
| 5763 mapping for {name} exactly. | |
| 5764 When there is no mapping that starts with {name}, an empty | |
| 5765 String is returned. If there is one, the rhs of that mapping | |
| 5766 is returned. If there are several mappings that start with | |
| 5767 {name}, the rhs of one of them is returned. | |
| 5768 The mappings local to the current buffer are checked first, | |
| 5769 then the global mappings. | |
| 5770 This function can be used to check if a mapping can be added | |
| 5771 without being ambiguous. Example: > | |
| 5772 :if mapcheck("_vv") == "" | |
| 5773 : map _vv :set guifont=7x13<CR> | |
| 5774 :endif | |
| 5775 < This avoids adding the "_vv" mapping when there already is a | |
| 5776 mapping for "_v" or for "_vvv". | |
| 5777 | |
| 12785 | 5778 match({expr}, {pat} [, {start} [, {count}]]) *match()* |
| 685 | 5779 When {expr} is a |List| then this returns the index of the |
| 5780 first item where {pat} matches. Each item is used as a | |
| 692 | 5781 String, |Lists| and |Dictionaries| are used as echoed. |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5782 Otherwise, {expr} is used as a String. The result is a |
| 95 | 5783 Number, which gives the index (byte offset) in {expr} where |
| 5784 {pat} matches. | |
| 685 | 5785 A match at the first character or |List| item returns zero. |
| 19 | 5786 If there is no match -1 is returned. |
| 2833 | 5787 For getting submatches see |matchlist()|. |
| 19 | 5788 Example: > |
| 95 | 5789 :echo match("testing", "ing") " results in 4 |
| 714 | 5790 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 5791 < See |string-match| for how {pat} is used. |
| 170 | 5792 *strpbrk()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5793 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 5794 :let sepidx = match(line, '[.,;: \t]') |
| 5795 < *strcasestr()* | |
| 5796 Vim doesn't have a strcasestr() function. But you can add | |
| 5797 "\c" to the pattern to ignore case: > | |
| 5798 :let idx = match(haystack, '\cneedle') | |
| 5799 < | |
| 95 | 5800 If {start} is given, the search starts from byte index |
| 685 | 5801 {start} in a String or item {start} in a |List|. |
| 7 | 5802 The result, however, is still the index counted from the |
| 236 | 5803 first character/item. Example: > |
| 7 | 5804 :echo match("testing", "ing", 2) |
| 5805 < result is again "4". > | |
| 5806 :echo match("testing", "ing", 4) | |
| 5807 < result is again "4". > | |
| 5808 :echo match("testing", "t", 2) | |
| 5809 < result is "3". | |
| 694 | 5810 For a String, if {start} > 0 then it is like the string starts |
| 703 | 5811 {start} bytes later, thus "^" will match at {start}. Except |
| 5812 when {count} is given, then it's like matches before the | |
| 5813 {start} byte are ignored (this is a bit complicated to keep it | |
| 5814 backwards compatible). | |
| 95 | 5815 For a String, if {start} < 0, it will be set to 0. For a list |
| 5816 the index is counted from the end. | |
| 697 | 5817 If {start} is out of range ({start} > strlen({expr}) for a |
| 5818 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 5819 |
| 694 | 5820 When {count} is given use the {count}'th match. When a match |
| 697 | 5821 is found in a String the search for the next one starts one |
| 694 | 5822 character further. Thus this example results in 1: > |
| 5823 echo match("testing", "..", 0, 2) | |
| 5824 < In a |List| the search continues in the next item. | |
| 703 | 5825 Note that when {count} is added the way {start} works changes, |
| 5826 see above. | |
| 694 | 5827 |
| 7 | 5828 See |pattern| for the patterns that are accepted. |
| 5829 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
|
5830 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 5831 done like 'magic' is set and 'cpoptions' is empty. |
| 5832 | |
| 1326 | 5833 *matchadd()* *E798* *E799* *E801* |
| 12785 | 5834 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 5835 Defines a pattern to be highlighted in the current window (a |
| 5836 "match"). It will be highlighted with {group}. Returns an | |
| 5837 identification number (ID), which can be used to delete the | |
| 5838 match using |matchdelete()|. | |
| 5466 | 5839 Matching is case sensitive and magic, unless case sensitivity |
| 5840 or magicness are explicitly overridden in {pattern}. The | |
| 5841 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
5842 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
|
5843 concealed. |
| 1326 | 5844 |
| 5845 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
|
5846 match. A match with a high priority will have its |
| 1326 | 5847 highlighting overrule that of a match with a lower priority. |
| 5848 A priority is specified as an integer (negative numbers are no | |
| 5849 exception). If the {priority} argument is not specified, the | |
| 5850 default priority is 10. The priority of 'hlsearch' is zero, | |
| 5851 hence all matches with a priority greater than zero will | |
| 5852 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 5853 mechanism, and regardless of the chosen priority a match will | |
| 5854 always overrule syntax highlighting. | |
| 5855 | |
| 5856 The optional {id} argument allows the request for a specific | |
| 5857 match ID. If a specified ID is already taken, an error | |
| 5858 message will appear and the match will not be added. An ID | |
| 5859 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 5860 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 5861 respectively. If the {id} argument is not specified or -1, |
| 1326 | 5862 |matchadd()| automatically chooses a free ID. |
| 5863 | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5864 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
|
5865 values. Currently this is used to specify a match specific |
| 6947 | 5866 conceal character that will be shown for |hl-Conceal| |
| 5867 highlighted matches. The dict can have the following members: | |
| 5868 | |
| 5869 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
|
5870 match (only for |hl-Conceal| highlighted |
| 6947 | 5871 matches, see |:syn-cchar|) |
| 5872 | |
| 1326 | 5873 The number of matches is not limited, as it is the case with |
| 5874 the |:match| commands. | |
| 5875 | |
| 5876 Example: > | |
| 5877 :highlight MyGroup ctermbg=green guibg=green | |
| 5878 :let m = matchadd("MyGroup", "TODO") | |
| 5879 < Deletion of the pattern: > | |
| 5880 :call matchdelete(m) | |
| 5881 | |
| 5882 < 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
|
5883 available from |getmatches()|. All matches can be deleted in |
| 1326 | 5884 one operation by |clearmatches()|. |
| 819 | 5885 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
5886 *matchaddpos()* |
| 12785 | 5887 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 5888 Same as |matchadd()|, but requires a list of positions {pos} |
| 5889 instead of a pattern. This command is faster than |matchadd()| | |
| 5890 because it does not require to handle regular expressions and | |
| 5891 sets buffer line boundaries to redraw screen. It is supposed | |
| 5892 to be used when fast match additions and deletions are | |
| 5893 required, for example to highlight matching parentheses. | |
| 5894 | |
| 5895 The list {pos} can contain one of these items: | |
| 6007 | 5896 - A number. This whole line will be highlighted. The first |
| 5979 | 5897 line has number 1. |
| 5898 - A list with one number, e.g., [23]. The whole line with this | |
| 5899 number will be highlighted. | |
| 5900 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 5901 the line number, the second one is the column number (first |
| 5902 column is 1, the value must correspond to the byte index as | |
| 5903 |col()| would return). The character at this position will | |
| 5904 be highlighted. | |
| 5979 | 5905 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 5906 the third number gives the length of the highlight in bytes. |
| 12785 | 5907 |
| 5979 | 5908 The maximum number of positions is 8. |
| 5909 | |
| 5910 Example: > | |
| 5911 :highlight MyGroup ctermbg=green guibg=green | |
| 5912 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 5913 < Deletion of the pattern: > | |
| 5914 :call matchdelete(m) | |
| 5915 | |
| 5916 < Matches added by |matchaddpos()| are returned by | |
| 5917 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
| 5918 value a list like the {pos} item. | |
| 5919 These matches cannot be set via |setmatches()|, however they | |
| 5920 can still be deleted by |clearmatches()|. | |
| 5921 | |
| 819 | 5922 matcharg({nr}) *matcharg()* |
| 856 | 5923 Selects the {nr} match item, as set with a |:match|, |
| 819 | 5924 |:2match| or |:3match| command. |
| 5925 Return a |List| with two elements: | |
| 5926 The name of the highlight group used | |
| 5927 The pattern used. | |
| 5928 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 5929 When there is no match item set returns ['', '']. | |
| 1326 | 5930 This is useful to save and restore a |:match|. |
| 5931 Highlighting matches using the |:match| commands are limited | |
| 5932 to three matches. |matchadd()| does not have this limitation. | |
| 5933 | |
| 5934 matchdelete({id}) *matchdelete()* *E802* *E803* | |
| 5935 Deletes a match with ID {id} previously defined by |matchadd()| | |
| 1621 | 5936 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 5937 otherwise -1. See example for |matchadd()|. All matches can |
| 5938 be deleted in one operation by |clearmatches()|. | |
| 819 | 5939 |
| 12785 | 5940 matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5941 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5942 after the match. Example: > |
| 7 | 5943 :echo matchend("testing", "ing") |
| 5944 < results in "7". | |
| 170 | 5945 *strspn()* *strcspn()* |
| 5946 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 5947 do it with matchend(): > | |
| 5948 :let span = matchend(line, '[a-zA-Z]') | |
| 5949 :let span = matchend(line, '[^a-zA-Z]') | |
| 5950 < Except that -1 is returned when there are no matches. | |
| 5951 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5952 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 5953 :echo matchend("testing", "ing", 2) |
| 5954 < results in "7". > | |
| 5955 :echo matchend("testing", "ing", 5) | |
| 5956 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5957 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 5958 |
| 12785 | 5959 matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5960 Same as |match()|, but return a |List|. The first item in the |
| 158 | 5961 list is the matched string, same as what matchstr() would |
| 5962 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 5963 in |:substitute|. When an optional submatch didn't match an |
| 5964 empty string is used. Example: > | |
| 5965 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 5966 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 5967 When there is no match an empty list is returned. |
| 5968 | |
| 12785 | 5969 matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()* |
| 1621 | 5970 Same as |match()|, but return the matched string. Example: > |
| 7 | 5971 :echo matchstr("testing", "ing") |
| 5972 < results in "ing". | |
| 5973 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5974 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 5975 :echo matchstr("testing", "ing", 2) |
| 5976 < results in "ing". > | |
| 5977 :echo matchstr("testing", "ing", 5) | |
| 5978 < result is "". | |
| 685 | 5979 When {expr} is a |List| then the matching item is returned. |
| 95 | 5980 The type isn't changed, it's not necessarily a String. |
| 7 | 5981 |
| 12785 | 5982 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
|
5983 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
|
5984 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
|
5985 :echo matchstrpos("testing", "ing") |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5986 < results in ["ing", 4, 7]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5987 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
|
5988 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
|
5989 :echo matchstrpos("testing", "ing", 2) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5990 < results in ["ing", 4, 7]. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5991 :echo matchstrpos("testing", "ing", 5) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5992 < result is ["", -1, -1]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5993 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
|
5994 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
|
5995 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
|
5996 :echo matchstrpos([1, '__x'], '\a') |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5997 < result is ["x", 1, 2, 3]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
5998 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
|
5999 |
| 87 | 6000 *max()* |
| 10734 | 6001 max({expr}) Return the maximum value of all items in {expr}. |
| 6002 {expr} can be a list or a dictionary. For a dictionary, | |
| 6003 it returns the maximum of all values in the dictionary. | |
| 6004 If {expr} is neither a list nor a dictionary, or one of the | |
| 6005 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
|
6006 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 6007 |
| 6008 *min()* | |
| 10734 | 6009 min({expr}) Return the minimum value of all items in {expr}. |
| 6010 {expr} can be a list or a dictionary. For a dictionary, | |
| 6011 it returns the minimum of all values in the dictionary. | |
| 6012 If {expr} is neither a list nor a dictionary, or one of the | |
| 6013 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
|
6014 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 6015 |
| 843 | 6016 *mkdir()* *E739* |
| 168 | 6017 mkdir({name} [, {path} [, {prot}]]) |
| 6018 Create directory {name}. | |
| 6019 If {path} is "p" then intermediate directories are created as | |
| 6020 necessary. Otherwise it must be "". | |
| 6021 If {prot} is given it is used to set the protection bits of | |
| 6022 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
|
6023 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 6024 for others. This is only used for the last part of {name}. |
| 6025 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 6026 with 0755. | |
| 6027 Example: > | |
| 6028 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
| 6029 < This function is not available in the |sandbox|. | |
| 168 | 6030 Not available on all systems. To check use: > |
| 6031 :if exists("*mkdir") | |
| 6032 < | |
| 7 | 6033 *mode()* |
| 1621 | 6034 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 6035 If [expr] is supplied and it evaluates to a non-zero Number or |
| 6036 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
|
6037 returned, otherwise only the first letter is returned. |
| 1621 | 6038 |
| 12254 | 6039 n Normal, Terminal-Normal |
| 1621 | 6040 no Operator-pending |
| 7 | 6041 v Visual by character |
| 6042 V Visual by line | |
| 6043 CTRL-V Visual blockwise | |
| 6044 s Select by character | |
| 6045 S Select by line | |
| 6046 CTRL-S Select blockwise | |
| 6047 i Insert | |
|
10787
09926123316b
patch 8.0.0283: mode() does not indicate Insert mode completion
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
6048 ic Insert mode completion |compl-generic| |
|
09926123316b
patch 8.0.0283: mode() does not indicate Insert mode completion
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
6049 ix Insert mode |i_CTRL-X| completion |
| 1621 | 6050 R Replace |R| |
|
10787
09926123316b
patch 8.0.0283: mode() does not indicate Insert mode completion
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
6051 Rc Replace mode completion |compl-generic| |
| 1621 | 6052 Rv Virtual Replace |gR| |
|
10787
09926123316b
patch 8.0.0283: mode() does not indicate Insert mode completion
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
6053 Rx Replace mode |i_CTRL-X| completion |
|
09926123316b
patch 8.0.0283: mode() does not indicate Insert mode completion
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
6054 c Command-line editing |
| 1621 | 6055 cv Vim Ex mode |gQ| |
| 6056 ce Normal Ex mode |Q| | |
| 7 | 6057 r Hit-enter prompt |
| 1621 | 6058 rm The -- more -- prompt |
| 6059 r? A |:confirm| query of some sort | |
| 6060 ! Shell or external command is executing | |
| 12254 | 6061 t Terminal-Job mode: keys go to the job |
| 1621 | 6062 This is useful in the 'statusline' option or when used |
| 6063 with |remote_expr()| In most other places it always returns | |
| 6064 "c" or "n". | |
| 6065 Also see |visualmode()|. | |
| 7 | 6066 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6067 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6068 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 6069 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6070 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6071 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
|
6072 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6073 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
|
6074 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6075 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
|
6076 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6077 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6078 :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
|
6079 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6080 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6081 < |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6082 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6083 |
| 7 | 6084 nextnonblank({lnum}) *nextnonblank()* |
| 6085 Return the line number of the first line at or below {lnum} | |
| 6086 that is not blank. Example: > | |
| 6087 if getline(nextnonblank(1)) =~ "Java" | |
| 6088 < When {lnum} is invalid or there is no non-blank line at or | |
| 6089 below it, zero is returned. | |
| 6090 See also |prevnonblank()|. | |
| 6091 | |
| 12785 | 6092 nr2char({expr} [, {utf8}]) *nr2char()* |
| 7 | 6093 Return a string with a single character, which has the number |
| 6094 value {expr}. Examples: > | |
| 6095 nr2char(64) returns "@" | |
| 6096 nr2char(32) returns " " | |
| 4051 | 6097 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 6098 Example for "utf-8": > | |
| 7 | 6099 nr2char(300) returns I with bow character |
| 4051 | 6100 < With {utf8} set to 1, always return utf-8 characters. |
| 6101 Note that a NUL character in the file is specified with | |
| 7 | 6102 nr2char(10), because NULs are represented with newline |
| 6103 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 6104 string, thus results in an empty string. |
| 7 | 6105 |
| 3214 | 6106 or({expr}, {expr}) *or()* |
| 6107 Bitwise OR on the two arguments. The arguments are converted | |
| 6108 to a number. A List, Dict or Float argument causes an error. | |
| 6109 Example: > | |
| 6110 :let bits = or(bits, 0x80) | |
| 6111 | |
| 6112 | |
| 819 | 6113 pathshorten({expr}) *pathshorten()* |
| 6114 Shorten directory names in the path {expr} and return the | |
| 6115 result. The tail, the file name, is kept as-is. The other | |
| 6116 components in the path are reduced to single letters. Leading | |
| 6117 '~' and '.' characters are kept. Example: > | |
| 6118 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 6119 < ~/.v/a/myfile.vim ~ | |
| 6120 It doesn't matter if the path exists or not. | |
| 6121 | |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6122 perleval({expr}) *perleval()* |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6123 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
|
6124 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
|
6125 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
|
6126 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
|
6127 reference to it. |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6128 Example: > |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6129 :echo perleval('[1 .. 4]') |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6130 < [1, 2, 3, 4] |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6131 {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
|
6132 |
| 1621 | 6133 pow({x}, {y}) *pow()* |
| 6134 Return the power of {x} to the exponent {y} as a |Float|. | |
| 6135 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 6136 Examples: > | |
| 6137 :echo pow(3, 3) | |
| 6138 < 27.0 > | |
| 6139 :echo pow(2, 16) | |
| 6140 < 65536.0 > | |
| 6141 :echo pow(32, 0.20) | |
| 6142 < 2.0 | |
| 6143 {only available when compiled with the |+float| feature} | |
| 12785 | 6144 |
| 667 | 6145 prevnonblank({lnum}) *prevnonblank()* |
| 6146 Return the line number of the first line at or above {lnum} | |
| 6147 that is not blank. Example: > | |
| 6148 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 6149 < When {lnum} is invalid or there is no non-blank line at or | |
| 6150 above it, zero is returned. | |
| 6151 Also see |nextnonblank()|. | |
| 6152 | |
| 6153 | |
| 449 | 6154 printf({fmt}, {expr1} ...) *printf()* |
| 6155 Return a String with {fmt}, where "%" items are replaced by | |
| 6156 the formatted form of their respective arguments. Example: > | |
| 452 | 6157 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 6158 < May result in: |
| 452 | 6159 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 6160 |
| 6161 Often used items are: | |
| 856 | 6162 %s string |
| 3914 | 6163 %6S string right-aligned in 6 display cells |
| 653 | 6164 %6s string right-aligned in 6 bytes |
| 1621 | 6165 %.9s string truncated to 9 bytes |
| 6166 %c single byte | |
| 6167 %d decimal number | |
| 6168 %5d decimal number padded with spaces to 5 characters | |
| 6169 %x hex number | |
| 6170 %04x hex number padded with zeros to at least 4 characters | |
| 6171 %X hex number using upper case letters | |
| 6172 %o octal number | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6173 %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
|
6174 %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
|
6175 %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
|
6176 %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
|
6177 %E floating point number as 1.23E3, INF, -INF or NAN |
| 1621 | 6178 %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
|
6179 %G floating point number, as %F or %E depending on value |
| 1621 | 6180 %% the % character itself |
| 449 | 6181 |
| 6182 Conversion specifications start with '%' and end with the | |
| 6183 conversion type. All other characters are copied unchanged to | |
| 6184 the result. | |
| 6185 | |
| 6186 The "%" starts a conversion specification. The following | |
| 452 | 6187 arguments appear in sequence: |
| 6188 | |
| 6189 % [flags] [field-width] [.precision] type | |
| 6190 | |
| 856 | 6191 flags |
| 452 | 6192 Zero or more of the following flags: |
| 6193 | |
| 449 | 6194 # The value should be converted to an "alternate |
| 6195 form". For c, d, and s conversions, this option | |
| 6196 has no effect. For o conversions, the precision | |
| 6197 of the number is increased to force the first | |
| 6198 character of the output string to a zero (except | |
| 6199 if a zero value is printed with an explicit | |
| 6200 precision of zero). | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6201 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
|
6202 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
|
6203 prepended to it. |
| 449 | 6204 For x and X conversions, a non-zero result has |
| 6205 the string "0x" (or "0X" for X conversions) | |
| 6206 prepended to it. | |
| 452 | 6207 |
| 449 | 6208 0 (zero) Zero padding. For all conversions the converted |
| 6209 value is padded on the left with zeros rather | |
| 6210 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
|
6211 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
|
6212 flag is ignored. |
| 452 | 6213 |
| 449 | 6214 - A negative field width flag; the converted value |
| 6215 is to be left adjusted on the field boundary. | |
| 6216 The converted value is padded on the right with | |
| 6217 blanks, rather than on the left with blanks or | |
| 6218 zeros. A - overrides a 0 if both are given. | |
| 452 | 6219 |
| 449 | 6220 ' ' (space) A blank should be left before a positive |
| 6221 number produced by a signed conversion (d). | |
| 452 | 6222 |
| 449 | 6223 + 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
|
6224 produced by a signed conversion. A + overrides |
| 449 | 6225 a space if both are used. |
| 452 | 6226 |
| 6227 field-width | |
| 6228 An optional decimal digit string specifying a minimum | |
| 653 | 6229 field width. If the converted value has fewer bytes |
| 6230 than the field width, it will be padded with spaces on | |
| 6231 the left (or right, if the left-adjustment flag has | |
| 6232 been given) to fill out the field width. | |
| 452 | 6233 |
| 6234 .precision | |
| 6235 An optional precision, in the form of a period '.' | |
| 6236 followed by an optional digit string. If the digit | |
| 6237 string is omitted, the precision is taken as zero. | |
| 6238 This gives the minimum number of digits to appear for | |
| 6239 d, o, x, and X conversions, or the maximum number of | |
| 653 | 6240 bytes to be printed from a string for s conversions. |
| 1621 | 6241 For floating point it is the number of digits after |
| 6242 the decimal point. | |
| 452 | 6243 |
| 6244 type | |
| 6245 A character that specifies the type of conversion to | |
| 6246 be applied, see below. | |
| 6247 | |
| 449 | 6248 A field width or precision, or both, may be indicated by an |
| 6249 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
|
6250 Number argument supplies the field width or precision. A |
| 449 | 6251 negative field width is treated as a left adjustment flag |
| 6252 followed by a positive field width; a negative precision is | |
| 6253 treated as though it were missing. Example: > | |
| 452 | 6254 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 6255 < This limits the length of the text used from "line" to |
| 452 | 6256 "width" bytes. |
| 449 | 6257 |
| 856 | 6258 The conversion specifiers and their meanings are: |
| 452 | 6259 |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6260 *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
|
6261 *printf-x* *printf-X* |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6262 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
|
6263 (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
|
6264 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
|
6265 "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
|
6266 "ABCDEF" are used for X conversions. |
| 452 | 6267 The precision, if any, gives the minimum number of |
| 6268 digits that must appear; if the converted value | |
| 6269 requires fewer digits, it is padded on the left with | |
| 6270 zeros. | |
| 6271 In no case does a non-existent or small field width | |
| 6272 cause truncation of a numeric field; if the result of | |
| 6273 a conversion is wider than the field width, the field | |
| 6274 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
|
6275 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
|
6276 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
|
6277 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
|
6278 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
|
6279 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
|
6280 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6281 i alias for d |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6282 D alias for ld |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6283 U alias for lu |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6284 O alias for lo |
| 452 | 6285 |
| 1621 | 6286 *printf-c* |
| 452 | 6287 c The Number argument is converted to a byte, and the |
| 6288 resulting character is written. | |
| 6289 | |
| 1621 | 6290 *printf-s* |
| 452 | 6291 s The text of the String argument is used. If a |
| 6292 precision is specified, no more bytes than the number | |
| 6293 specified are used. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6294 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
|
6295 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
|
6296 as ":echo". |
| 6583 | 6297 *printf-S* |
| 3914 | 6298 S The text of the String argument is used. If a |
| 6299 precision is specified, no more display cells than the | |
| 6300 number specified are used. Without the |+multi_byte| | |
| 6301 feature works just like 's'. | |
| 452 | 6302 |
| 1621 | 6303 *printf-f* *E807* |
| 12785 | 6304 f F The Float argument is converted into a string of the |
| 1621 | 6305 form 123.456. The precision specifies the number of |
| 6306 digits after the decimal point. When the precision is | |
| 6307 zero the decimal point is omitted. When the precision | |
| 6308 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
|
6309 (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
|
6310 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
|
6311 "0.0 / 0.0" results in "nan" with %f (NAN with %F). |
| 1621 | 6312 Example: > |
| 6313 echo printf("%.2f", 12.115) | |
| 6314 < 12.12 | |
| 6315 Note that roundoff depends on the system libraries. | |
| 6316 Use |round()| when in doubt. | |
| 6317 | |
| 6318 *printf-e* *printf-E* | |
| 6319 e E The Float argument is converted into a string of the | |
| 6320 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 6321 precision specifies the number of digits after the | |
| 6322 decimal point, like with 'f'. | |
| 6323 | |
| 6324 *printf-g* *printf-G* | |
| 6325 g G The Float argument is converted like with 'f' if the | |
| 6326 value is between 0.001 (inclusive) and 10000000.0 | |
| 6327 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 6328 for 'G'. When no precision is specified superfluous | |
| 6329 zeroes and '+' signs are removed, except for the zero | |
| 6330 immediately after the decimal point. Thus 10000000.0 | |
| 6331 results in 1.0e7. | |
| 6332 | |
| 6333 *printf-%* | |
| 449 | 6334 % A '%' is written. No argument is converted. The |
| 6335 complete conversion specification is "%%". | |
| 452 | 6336 |
| 1668 | 6337 When a Number argument is expected a String argument is also |
| 6338 accepted and automatically converted. | |
| 6339 When a Float or String argument is expected a Number argument | |
| 6340 is also accepted and automatically converted. | |
| 6341 Any other argument type results in an error message. | |
| 449 | 6342 |
| 459 | 6343 *E766* *E767* |
| 449 | 6344 The number of {exprN} arguments must exactly match the number |
| 6345 of "%" items. If there are not sufficient or too many | |
| 452 | 6346 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 6347 |
| 6348 | |
| 667 | 6349 pumvisible() *pumvisible()* |
| 6350 Returns non-zero when the popup menu is visible, zero | |
| 6351 otherwise. See |ins-completion-menu|. | |
| 712 | 6352 This can be used to avoid some things that would remove the |
| 6353 popup menu. | |
| 7 | 6354 |
| 3682 | 6355 py3eval({expr}) *py3eval()* |
| 6356 Evaluate Python expression {expr} and return its result | |
| 6357 converted to Vim data structures. | |
| 12785 | 6358 Numbers and strings are returned as they are (strings are |
| 6359 copied though, Unicode strings are additionally converted to | |
| 3682 | 6360 'encoding'). |
| 6361 Lists are represented as Vim |List| type. | |
| 12785 | 6362 Dictionaries are represented as Vim |Dictionary| type with |
| 3682 | 6363 keys converted to strings. |
| 6364 {only available when compiled with the |+python3| feature} | |
| 6365 | |
| 6366 *E858* *E859* | |
| 6367 pyeval({expr}) *pyeval()* | |
| 6368 Evaluate Python expression {expr} and return its result | |
| 6369 converted to Vim data structures. | |
| 12785 | 6370 Numbers and strings are returned as they are (strings are |
| 3682 | 6371 copied though). |
| 6372 Lists are represented as Vim |List| type. | |
| 12785 | 6373 Dictionaries are represented as Vim |Dictionary| type, |
| 3830 | 6374 non-string keys result in error. |
| 3682 | 6375 {only available when compiled with the |+python| feature} |
| 6376 | |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6377 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
|
6378 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
|
6379 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
|
6380 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
|
6381 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
|
6382 {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
|
6383 |+python3| feature} |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6384 |
| 114 | 6385 *E726* *E727* |
| 99 | 6386 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 6387 Returns a |List| with Numbers: |
| 99 | 6388 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 6389 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 6390 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 6391 {max}] (increasing {expr} with {stride} each time, not | |
| 6392 producing a value past {max}). | |
| 336 | 6393 When the maximum is one before the start the result is an |
| 6394 empty list. When the maximum is more than one before the | |
| 6395 start this is an error. | |
| 99 | 6396 Examples: > |
| 856 | 6397 range(4) " [0, 1, 2, 3] |
| 99 | 6398 range(2, 4) " [2, 3, 4] |
| 6399 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 6400 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 6401 range(0) " [] |
| 6402 range(2, 0) " error! | |
| 99 | 6403 < |
| 158 | 6404 *readfile()* |
| 168 | 6405 readfile({fname} [, {binary} [, {max}]]) |
| 685 | 6406 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
|
6407 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
|
6408 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
|
6409 (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
|
6410 All NUL characters are replaced with a NL character. |
| 6918 | 6411 When {binary} contains "b" binary mode is used: |
| 158 | 6412 - When the last line ends in a NL an extra empty list item is |
| 6413 added. | |
| 6414 - No CR characters are removed. | |
| 6415 Otherwise: | |
| 6416 - CR characters that appear before a NL are removed. | |
| 6417 - 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
|
6418 - 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
|
6419 removed from the text. |
| 168 | 6420 When {max} is given this specifies the maximum number of lines |
| 6421 to be read. Useful if you only want to check the first ten | |
| 6422 lines of a file: > | |
| 6423 :for line in readfile(fname, '', 10) | |
| 6424 : if line =~ 'Date' | echo line | endif | |
| 6425 :endfor | |
| 233 | 6426 < When {max} is negative -{max} lines from the end of the file |
| 6427 are returned, or as many as there are. | |
| 6428 When {max} is zero the result is an empty list. | |
| 168 | 6429 Note that without {max} the whole file is read into memory. |
| 6430 Also note that there is no recognition of encoding. Read a | |
| 6431 file into a buffer if you need to. | |
| 158 | 6432 When the file can't be opened an error message is given and |
| 6433 the result is an empty list. | |
| 6434 Also see |writefile()|. | |
| 6435 | |
| 794 | 6436 reltime([{start} [, {end}]]) *reltime()* |
| 6437 Return an item that represents a time value. The format of | |
| 6438 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
|
6439 |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
|
6440 to convert to a Float. |
| 794 | 6441 Without an argument it returns the current time. |
| 6442 With one argument is returns the time passed since the time | |
| 6443 specified in the argument. | |
| 843 | 6444 With two arguments it returns the time passed between {start} |
| 794 | 6445 and {end}. |
| 6446 The {start} and {end} arguments must be values returned by | |
| 6447 reltime(). | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
6448 {only available when compiled with the |+reltime| feature} |
| 794 | 6449 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6450 reltimefloat({time}) *reltimefloat()* |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6451 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
|
6452 Example: > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6453 let start = reltime() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6454 call MyFunction() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6455 let seconds = reltimefloat(reltime(start)) |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6456 < 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
|
6457 Also see |profiling|. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6458 {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
|
6459 |
| 794 | 6460 reltimestr({time}) *reltimestr()* |
| 6461 Return a String that represents the time value of {time}. | |
| 6462 This is the number of seconds, a dot and the number of | |
| 6463 microseconds. Example: > | |
| 6464 let start = reltime() | |
| 6465 call MyFunction() | |
| 6466 echo reltimestr(reltime(start)) | |
| 6467 < Note that overhead for the commands will be added to the time. | |
| 6468 The accuracy depends on the system. | |
| 1156 | 6469 Leading spaces are used to make the string align nicely. You |
| 6470 can use split() to remove it. > | |
| 6471 echo split(reltimestr(reltime(start)))[0] | |
| 6472 < 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
|
6473 {only available when compiled with the |+reltime| feature} |
| 794 | 6474 |
| 7 | 6475 *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
|
6476 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
|
6477 Send the {string} to {server}. The string is sent as an |
| 7 | 6478 expression and the result is returned after evaluation. |
| 714 | 6479 The result must be a String or a |List|. A |List| is turned |
| 6480 into a String by joining the items with a line break in | |
| 6481 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
|
6482 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
|
6483 of a variable and a {serverid} for later use with |
| 7 | 6484 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
|
6485 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
|
6486 seconds. Otherwise a timeout of 600 seconds is used. |
| 7 | 6487 See also |clientserver| |RemoteReply|. |
| 6488 This function is not available in the |sandbox|. | |
| 6489 {only available when compiled with the |+clientserver| feature} | |
| 6490 Note: Any errors will cause a local error message to be issued | |
| 6491 and the result will be the empty string. | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6492 |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6493 Variables will be evaluated in the global namespace, |
| 12785 | 6494 independent of a function currently being active. Except |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6495 when in debug mode, then local function variables and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6496 arguments can be evaluated. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6497 |
| 7 | 6498 Examples: > |
| 6499 :echo remote_expr("gvim", "2+2") | |
| 6500 :echo remote_expr("gvim1", "b:current_syntax") | |
| 6501 < | |
| 6502 | |
| 6503 remote_foreground({server}) *remote_foreground()* | |
| 6504 Move the Vim server with the name {server} to the foreground. | |
| 6505 This works like: > | |
| 6506 remote_expr({server}, "foreground()") | |
| 6507 < Except that on Win32 systems the client does the work, to work | |
| 6508 around the problem that the OS doesn't always allow the server | |
| 6509 to bring itself to the foreground. | |
| 574 | 6510 Note: This does not restore the window if it was minimized, |
| 6511 like foreground() does. | |
| 7 | 6512 This function is not available in the |sandbox|. |
| 6513 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 6514 Win32 console version} | |
| 6515 | |
| 6516 | |
| 6517 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 6518 Returns a positive number if there are available strings | |
| 6519 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
|
6520 {retvar} if specified. {retvar} must be a string with the |
| 7 | 6521 name of a variable. |
| 6522 Returns zero if none are available. | |
| 6523 Returns -1 if something is wrong. | |
| 6524 See also |clientserver|. | |
| 6525 This function is not available in the |sandbox|. | |
| 6526 {only available when compiled with the |+clientserver| feature} | |
| 6527 Examples: > | |
| 6528 :let repl = "" | |
| 6529 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 6530 | |
|
11211
71311d899b42
patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents:
11181
diff
changeset
|
6531 remote_read({serverid}, [{timeout}]) *remote_read()* |
| 7 | 6532 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
|
6533 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
|
6534 reply is available. |
| 7 | 6535 See also |clientserver|. |
| 6536 This function is not available in the |sandbox|. | |
| 6537 {only available when compiled with the |+clientserver| feature} | |
| 6538 Example: > | |
| 6539 :echo remote_read(id) | |
| 6540 < | |
| 6541 *remote_send()* *E241* | |
| 6542 remote_send({server}, {string} [, {idvar}]) | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6543 Send the {string} to {server}. The string is sent as input |
| 22 | 6544 keys and the function returns immediately. At the Vim server |
| 6545 the keys are not mapped |:map|. | |
| 667 | 6546 If {idvar} is present, it is taken as the name of a variable |
| 6547 and a {serverid} for later use with remote_read() is stored | |
| 6548 there. | |
| 7 | 6549 See also |clientserver| |RemoteReply|. |
| 6550 This function is not available in the |sandbox|. | |
| 6551 {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
|
6552 |
| 7 | 6553 Note: Any errors will be reported in the server and may mess |
| 6554 up the display. | |
| 6555 Examples: > | |
| 6556 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 6557 \ remote_read(serverid) | |
| 6558 | |
| 6559 :autocmd NONE RemoteReply * | |
| 6560 \ echo remote_read(expand("<amatch>")) | |
| 6561 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 6562 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 6563 < |
|
11177
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
6564 *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
|
6565 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
|
6566 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
|
6567 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
|
6568 {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
|
6569 |
| 79 | 6570 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 6571 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
|
6572 return the item. |
| 79 | 6573 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6574 return a List with these items. When {idx} points to the same |
| 79 | 6575 item as {end} a list with one item is returned. When {end} |
| 6576 points to an item before {idx} this is an error. | |
| 6577 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 6578 Example: > |
| 6579 :echo "last item: " . remove(mylist, -1) | |
| 79 | 6580 :call remove(mylist, 0, 9) |
| 99 | 6581 remove({dict}, {key}) |
| 6582 Remove the entry from {dict} with key {key}. Example: > | |
| 6583 :echo "removed " . remove(dict, "one") | |
| 6584 < If there is no {key} in {dict} this is an error. | |
| 6585 | |
| 6586 Use |delete()| to remove a file. | |
| 55 | 6587 |
| 7 | 6588 rename({from}, {to}) *rename()* |
| 6589 Rename the file by the name {from} to the name {to}. This | |
| 6590 should also work to move files across file systems. The | |
| 6591 result is a Number, which is 0 if the file was renamed | |
| 6592 successfully, and non-zero when the renaming failed. | |
| 1851 | 6593 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 6594 This function is not available in the |sandbox|. |
| 6595 | |
| 18 | 6596 repeat({expr}, {count}) *repeat()* |
| 6597 Repeat {expr} {count} times and return the concatenated | |
| 6598 result. Example: > | |
| 843 | 6599 :let separator = repeat('-', 80) |
| 18 | 6600 < When {count} is zero or negative the result is empty. |
| 685 | 6601 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
|
6602 {count} times. Example: > |
| 79 | 6603 :let longlist = repeat(['a', 'b'], 3) |
| 6604 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 6605 |
| 82 | 6606 |
| 7 | 6607 resolve({filename}) *resolve()* *E655* |
| 6608 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 6609 returns the path the shortcut points to in a simplified form. | |
| 6610 On Unix, repeat resolving symbolic links in all path | |
| 6611 components of {filename} and return the simplified result. | |
| 6612 To cope with link cycles, resolving of symbolic links is | |
| 6613 stopped after 100 iterations. | |
| 6614 On other systems, return the simplified {filename}. | |
| 6615 The simplification step is done as by |simplify()|. | |
| 6616 resolve() keeps a leading path component specifying the | |
| 6617 current directory (provided the result is still a relative | |
| 6618 path name) and also keeps a trailing path separator. | |
| 6619 | |
| 82 | 6620 *reverse()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6621 reverse({list}) Reverse the order of items in {list} in-place. Returns |
| 82 | 6622 {list}. |
| 6623 If you want a list to remain unmodified make a copy first: > | |
| 6624 :let revlist = reverse(copy(mylist)) | |
| 6625 | |
| 1621 | 6626 round({expr}) *round()* |
| 1668 | 6627 Round off {expr} to the nearest integral value and return it |
| 1621 | 6628 as a |Float|. If {expr} lies halfway between two integral |
| 6629 values, then use the larger one (away from zero). | |
| 6630 {expr} must evaluate to a |Float| or a |Number|. | |
| 6631 Examples: > | |
| 6632 echo round(0.456) | |
| 6633 < 0.0 > | |
| 6634 echo round(4.5) | |
| 6635 < 5.0 > | |
| 6636 echo round(-4.5) | |
| 6637 < -5.0 | |
| 6638 {only available when compiled with the |+float| feature} | |
| 3996 | 6639 |
| 12785 | 6640 screenattr({row}, {col}) *screenattr()* |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
6641 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
|
6642 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
|
6643 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6644 |
| 12785 | 6645 screenchar({row}, {col}) *screenchar()* |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6646 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
|
6647 [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
|
6648 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
|
6649 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
|
6650 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6651 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6652 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6653 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
|
6654 |
| 3996 | 6655 screencol() *screencol()* |
| 6656 The result is a Number, which is the current screen column of | |
| 6657 the cursor. The leftmost column has number 1. | |
| 6658 This function is mainly used for testing. | |
| 6659 | |
| 6660 Note: Always returns the current screen column, thus if used | |
| 6661 in a command (e.g. ":echo screencol()") it will return the | |
| 6662 column inside the command line, which is 1 when the command is | |
| 6663 executed. To get the cursor position in the file use one of | |
| 6664 the following mappings: > | |
| 6665 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 6666 nnoremap <silent> GG :echom screencol()<CR> | |
| 6667 < | |
| 6668 screenrow() *screenrow()* | |
| 6669 The result is a Number, which is the current screen row of the | |
| 6670 cursor. The top line has number one. | |
| 6671 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
|
6672 Alternatively you can use |winline()|. |
| 3996 | 6673 |
| 6674 Note: Same restrictions as with |screencol()|. | |
| 6675 | |
| 1496 | 6676 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
| 7 | 6677 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 6678 cursor position (you can use |cursor()| to set it). |
| 707 | 6679 |
| 3967 | 6680 When a match has been found its line number is returned. |
| 3312 | 6681 If there is no match a 0 is returned and the cursor doesn't |
| 6682 move. No error message is given. | |
| 6683 | |
| 7 | 6684 {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
|
6685 'b' search Backward instead of forward |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6686 'c' accept a match at the Cursor position |
| 712 | 6687 'e' move to the End of the match |
| 20 | 6688 '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
|
6689 '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
|
6690 '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
|
6691 '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
|
6692 '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
|
6693 'z' start searching at the cursor column instead of zero |
| 7 | 6694 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
| 6695 | |
| 444 | 6696 If the 's' flag is supplied, the ' mark is set, only if the |
| 6697 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 6698 flag. | |
| 6699 | |
| 1156 | 6700 'ignorecase', 'smartcase' and 'magic' are used. |
| 12785 | 6701 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
6702 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
|
6703 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
|
6704 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
|
6705 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
|
6706 one column further. |
| 1156 | 6707 |
| 692 | 6708 When the {stopline} argument is given then the search stops |
| 6709 after searching this line. This is useful to restrict the | |
| 6710 search to a range of lines. Examples: > | |
| 6711 let match = search('(', 'b', line("w0")) | |
| 6712 let end = search('END', '', line("w$")) | |
| 6713 < When {stopline} is used and it is not zero this also implies | |
| 6714 that the search does not wrap around the end of the file. | |
| 1496 | 6715 A zero value is equal to not giving the argument. |
| 6716 | |
| 6717 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
|
6718 more than this many milliseconds have passed. Thus when |
| 1496 | 6719 {timeout} is 500 the search stops after half a second. |
| 6720 The value must not be negative. A zero value is like not | |
| 6721 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
|
6722 {only available when compiled with the |+reltime| feature} |
| 692 | 6723 |
| 714 | 6724 *search()-sub-match* |
| 6725 With the 'p' flag the returned value is one more than the | |
| 6726 first sub-match in \(\). One if none of them matched but the | |
| 6727 whole pattern did match. | |
| 712 | 6728 To get the column number too use |searchpos()|. |
| 6729 | |
| 20 | 6730 The cursor will be positioned at the match, unless the 'n' |
| 707 | 6731 flag is used. |
| 7 | 6732 |
| 6733 Example (goes over all files in the argument list): > | |
| 6734 :let n = 1 | |
| 6735 :while n <= argc() " loop over all files in arglist | |
| 6736 : exe "argument " . n | |
| 6737 : " start at the last char in the file and wrap for the | |
| 6738 : " first search to find match at start of file | |
| 6739 : normal G$ | |
| 6740 : let flags = "w" | |
| 6741 : while search("foo", flags) > 0 | |
| 1621 | 6742 : s/foo/bar/g |
| 7 | 6743 : let flags = "W" |
| 6744 : endwhile | |
| 6745 : update " write the file if modified | |
| 6746 : let n = n + 1 | |
| 6747 :endwhile | |
| 6748 < | |
| 712 | 6749 Example for using some flags: > |
| 6750 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 6751 < This will search for the keywords "if", "else", and "endif" | |
| 6752 under or after the cursor. Because of the 'p' flag, it | |
| 6753 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 6754 if the search fails. With the cursor on the first word of the | |
| 6755 line: | |
| 6756 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 6757 the function returns 1. Without the 'c' flag, the function | |
| 6758 finds the "endif" and returns 3. The same thing happens | |
| 6759 without the 'e' flag if the cursor is on the "f" of "if". | |
| 6760 The 'n' flag tells the function not to move the cursor. | |
| 6761 | |
| 504 | 6762 |
| 523 | 6763 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 6764 Search for the declaration of {name}. | |
| 856 | 6765 |
| 523 | 6766 With a non-zero {global} argument it works like |gD|, find |
| 6767 first match in the file. Otherwise it works like |gd|, find | |
| 6768 first match in the function. | |
| 6769 | |
| 6770 With a non-zero {thisblock} argument matches in a {} block | |
| 6771 that ends before the cursor position are ignored. Avoids | |
| 6772 finding variable declarations only valid in another scope. | |
| 6773 | |
| 504 | 6774 Moves the cursor to the found match. |
| 6775 Returns zero for success, non-zero for failure. | |
| 6776 Example: > | |
| 6777 if searchdecl('myvar') == 0 | |
| 6778 echo getline('.') | |
| 6779 endif | |
| 6780 < | |
| 7 | 6781 *searchpair()* |
| 1496 | 6782 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 6783 [, {stopline} [, {timeout}]]]]) | |
| 7 | 6784 Search for the match of a nested start-end pair. This can be |
| 6785 used to find the "endif" that matches an "if", while other | |
| 6786 if/endif pairs in between are ignored. | |
| 677 | 6787 The search starts at the cursor. The default is to search |
| 6788 forward, include 'b' in {flags} to search backward. | |
| 6789 If a match is found, the cursor is positioned at it and the | |
| 6790 line number is returned. If no match is found 0 or -1 is | |
| 6791 returned and the cursor doesn't move. No error message is | |
| 6792 given. | |
| 7 | 6793 |
| 6794 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 6795 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 6796 {middle} is not empty, it is found when searching from either | |
| 6797 direction, but only when not in a nested start-end pair. A | |
| 6798 typical use is: > | |
| 6799 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 6800 < By leaving {middle} empty the "else" is skipped. | |
| 6801 | |
| 712 | 6802 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 6803 |search()|. Additionally: | |
| 7 | 6804 'r' Repeat until no more matches found; will find the |
| 1621 | 6805 outer pair. Implies the 'W' flag. |
| 6806 'm' Return number of matches instead of line number with | |
| 712 | 6807 the match; will be > 1 when 'r' is used. |
| 1621 | 6808 Note: it's nearly always a good idea to use the 'W' flag, to |
| 6809 avoid wrapping around the end of the file. | |
| 7 | 6810 |
| 6811 When a match for {start}, {middle} or {end} is found, the | |
| 6812 {skip} expression is evaluated with the cursor positioned on | |
| 6813 the start of the match. It should return non-zero if this | |
| 6814 match is to be skipped. E.g., because it is inside a comment | |
| 6815 or a string. | |
| 6816 When {skip} is omitted or empty, every match is accepted. | |
| 6817 When evaluating {skip} causes an error the search is aborted | |
| 6818 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
|
6819 {skip} can be a string, a lambda, a funcref or a partial. |
| 7 | 6820 |
| 1496 | 6821 For {stopline} and {timeout} see |search()|. |
| 692 | 6822 |
| 7 | 6823 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 6824 patterns are used like it's on. | |
| 6825 | |
| 6826 The search starts exactly at the cursor. A match with | |
| 6827 {start}, {middle} or {end} at the next character, in the | |
| 6828 direction of searching, is the first one found. Example: > | |
| 6829 if 1 | |
| 6830 if 2 | |
| 6831 endif 2 | |
| 6832 endif 1 | |
| 6833 < When starting at the "if 2", with the cursor on the "i", and | |
| 6834 searching forwards, the "endif 2" is found. When starting on | |
| 6835 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
|
6836 found. That's because the "if 2" will be found first, and |
| 7 | 6837 then this is considered to be a nested if/endif from "if 2" to |
| 6838 "endif 2". | |
| 6839 When searching backwards and {end} is more than one character, | |
| 6840 it may be useful to put "\zs" at the end of the pattern, so | |
| 6841 that when the cursor is inside a match with the end it finds | |
| 6842 the matching start. | |
| 6843 | |
| 6844 Example, to find the "endif" command in a Vim script: > | |
| 6845 | |
| 6846 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 6847 \ 'getline(".") =~ "^\\s*\""') | |
| 6848 | |
| 6849 < The cursor must be at or after the "if" for which a match is | |
| 6850 to be found. Note that single-quote strings are used to avoid | |
| 6851 having to double the backslashes. The skip expression only | |
| 6852 catches comments at the start of a line, not after a command. | |
| 6853 Also, a word "en" or "if" halfway a line is considered a | |
| 6854 match. | |
| 6855 Another example, to search for the matching "{" of a "}": > | |
| 6856 | |
| 6857 :echo searchpair('{', '', '}', 'bW') | |
| 6858 | |
| 6859 < This works when the cursor is at or before the "}" for which a | |
| 6860 match is to be found. To reject matches that syntax | |
| 6861 highlighting recognized as strings: > | |
| 6862 | |
| 6863 :echo searchpair('{', '', '}', 'bW', | |
| 6864 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 6865 < | |
| 667 | 6866 *searchpairpos()* |
| 1496 | 6867 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 6868 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6869 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 6870 column position of the match. The first element of the |List| |
| 6871 is the line number and the second element is the byte index of | |
| 667 | 6872 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
|
6873 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6874 |
| 667 | 6875 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 6876 < | |
| 6877 See |match-parens| for a bigger and more useful example. | |
| 6878 | |
| 1496 | 6879 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
| 692 | 6880 Same as |search()|, but returns a |List| with the line and |
| 685 | 6881 column position of the match. The first element of the |List| |
| 6882 is the line number and the second element is the byte index of | |
| 6883 the column position of the match. If no match is found, | |
| 6884 returns [0, 0]. | |
| 714 | 6885 Example: > |
| 6886 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 6887 | |
| 6888 < When the 'p' flag is given then there is an extra item with | |
| 6889 the sub-pattern match number |search()-sub-match|. Example: > | |
| 6890 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 6891 < In this example "submatch" is 2 when a lowercase letter is | |
| 6892 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 6893 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
6894 server2client({clientid}, {string}) *server2client()* |
| 7 | 6895 Send a reply string to {clientid}. The most recent {clientid} |
| 6896 that sent a string can be retrieved with expand("<client>"). | |
| 6897 {only available when compiled with the |+clientserver| feature} | |
| 6898 Note: | |
| 6899 This id has to be stored before the next command can be | |
| 236 | 6900 received. I.e. before returning from the received command and |
| 7 | 6901 before calling any commands that waits for input. |
| 6902 See also |clientserver|. | |
| 6903 Example: > | |
| 6904 :echo server2client(expand("<client>"), "HELLO") | |
| 6905 < | |
| 6906 serverlist() *serverlist()* | |
| 6907 Return a list of available server names, one per line. | |
| 6908 When there are no servers or the information is not available | |
| 6909 an empty string is returned. See also |clientserver|. | |
| 6910 {only available when compiled with the |+clientserver| feature} | |
| 6911 Example: > | |
| 6912 :echo serverlist() | |
| 6913 < | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6914 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
|
6915 Set line {lnum} to {text} in buffer {expr}. To insert |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6916 lines use |append()|. |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6917 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6918 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
|
6919 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6920 {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
|
6921 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
|
6922 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
|
6923 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6924 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
|
6925 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
|
6926 |
| 7 | 6927 setbufvar({expr}, {varname}, {val}) *setbufvar()* |
| 6928 Set option or local variable {varname} in buffer {expr} to | |
| 6929 {val}. | |
| 6930 This also works for a global or local window option, but it | |
| 6931 doesn't work for a global or local window variable. | |
| 6932 For a local window option the global value is unchanged. | |
| 6933 For the use of {expr}, see |bufname()| above. | |
| 6934 Note that the variable name without "b:" must be used. | |
| 6935 Examples: > | |
| 6936 :call setbufvar(1, "&mod", 1) | |
| 6937 :call setbufvar("todo", "myvar", "foobar") | |
| 6938 < This function is not available in the |sandbox|. | |
| 6939 | |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
6940 setcharsearch({dict}) *setcharsearch()* |
| 6991 | 6941 Set the current character search information to {dict}, |
| 6942 which contains one or more of the following entries: | |
| 6943 | |
| 6944 char character which will be used for a subsequent | |
| 6945 |,| or |;| command; an empty string clears the | |
| 6946 character search | |
| 6947 forward direction of character search; 1 for forward, | |
| 6948 0 for backward | |
| 6949 until type of character search; 1 for a |t| or |T| | |
| 6950 character search, 0 for an |f| or |F| | |
| 6951 character search | |
| 6952 | |
| 6953 This can be useful to save/restore a user's character search | |
| 6954 from a script: > | |
| 6955 :let prevsearch = getcharsearch() | |
| 6956 :" Perform a command which clobbers user's search | |
| 6957 :call setcharsearch(prevsearch) | |
| 6958 < Also see |getcharsearch()|. | |
| 6959 | |
| 7 | 6960 setcmdpos({pos}) *setcmdpos()* |
| 6961 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
|
6962 {pos}. The first position is 1. |
| 7 | 6963 Use |getcmdpos()| to obtain the current position. |
| 6964 Only works while editing the command line, thus you must use | |
| 99 | 6965 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 6966 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 6967 set after the command line is set to the expression. For | |
| 6968 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 6969 before inserting the resulting text. | |
| 7 | 6970 When the number is too big the cursor is put at the end of the |
| 6971 line. A number smaller than one has undefined results. | |
| 6972 Returns 0 when successful, 1 when not editing the command | |
| 6973 line. | |
| 6974 | |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6975 setfperm({fname}, {mode}) *setfperm()* *chmod* |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6976 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
|
6977 {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
|
6978 "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
|
6979 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
|
6980 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
|
6981 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
|
6982 characters are not supported. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6983 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6984 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
|
6985 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
|
6986 would do the same thing. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6987 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6988 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
|
6989 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6990 To read permissions see |getfperm()|. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6991 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
6992 |
| 1621 | 6993 setline({lnum}, {text}) *setline()* |
| 3312 | 6994 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
|
6995 lines use |append()|. To set lines in another buffer use |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6996 |setbufline()|. |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
6997 |
| 236 | 6998 {lnum} is used like with |getline()|. |
| 1621 | 6999 When {lnum} is just below the last line the {text} will be |
| 282 | 7000 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
|
7001 |
| 236 | 7002 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
|
7003 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
|
7004 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7005 Example: > |
| 7 | 7006 :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
|
7007 |
| 1621 | 7008 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 7009 will be set to the items in the list. Example: > |
| 7010 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 7011 < This is equivalent to: > | |
| 3465 | 7012 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 7013 : call setline(n, l) |
| 7014 :endfor | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
7015 |
| 7 | 7016 < Note: The '[ and '] marks are not set. |
| 7017 | |
| 12785 | 7018 setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()* |
| 647 | 7019 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
|
7020 {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
|
7021 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
|
7022 |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
7023 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
|
7024 modified. For an invalid window number {nr}, -1 is returned. |
| 1326 | 7025 Otherwise, same as |setqflist()|. |
| 7026 Also see |location-list|. | |
| 7027 | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7028 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
|
7029 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
|
7030 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
|
7031 |
| 1326 | 7032 setmatches({list}) *setmatches()* |
| 7033 Restores a list of matches saved by |getmatches()|. Returns 0 | |
| 1621 | 7034 if successful, otherwise -1. All current matches are cleared |
| 1326 | 7035 before the list is restored. See example for |getmatches()|. |
| 230 | 7036 |
| 707 | 7037 *setpos()* |
| 7038 setpos({expr}, {list}) | |
| 7039 Set the position for {expr}. Possible values: | |
| 7040 . the cursor | |
| 7041 'x mark x | |
| 7042 | |
| 5938 | 7043 {list} must be a |List| with four or five numbers: |
| 707 | 7044 [bufnum, lnum, col, off] |
| 5938 | 7045 [bufnum, lnum, col, off, curswant] |
| 707 | 7046 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7047 "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
|
7048 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
|
7049 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
|
7050 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
|
7051 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
|
7052 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
|
7053 since these are associated with a window, not a buffer. |
| 798 | 7054 Does not change the jumplist. |
| 707 | 7055 |
| 7056 "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
|
7057 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
|
7058 smaller than 1 then 1 is used. |
| 707 | 7059 |
| 7060 The "off" number is only used when 'virtualedit' is set. Then | |
| 7061 it is the offset in screen columns from the start of the | |
| 1266 | 7062 character. E.g., a position within a <Tab> or after the last |
| 707 | 7063 character. |
| 7064 | |
| 5938 | 7065 The "curswant" number is only used when setting the cursor |
| 7066 position. It sets the preferred column for when moving the | |
| 7067 cursor vertically. When the "curswant" number is missing the | |
| 7068 preferred column is not set. When it is present and setting a | |
| 7069 mark position it is not used. | |
| 7070 | |
| 5555 | 7071 Note that for '< and '> changing the line number may result in |
| 7072 the marks to be effectively be swapped, so that '< is always | |
| 7073 before '>. | |
| 7074 | |
| 1533 | 7075 Returns 0 when the position could be set, -1 otherwise. |
| 7076 An error message is given if {expr} is invalid. | |
| 7077 | |
| 5944 | 7078 Also see |getpos()| and |getcurpos()|. |
| 707 | 7079 |
| 1156 | 7080 This does not restore the preferred column for moving |
| 5938 | 7081 vertically; if you set the cursor position with this, |j| and |
| 7082 |k| motions will jump to previous columns! Use |cursor()| to | |
| 7083 also set the preferred column. Also see the "curswant" key in | |
| 7084 |winrestview()|. | |
| 1156 | 7085 |
| 12785 | 7086 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
|
7087 Create or replace or add to the quickfix list. |
| 12785 | 7088 |
|
12048
ebd313aa5a6c
patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents:
12045
diff
changeset
|
7089 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
|
7090 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
|
7091 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
|
7092 entries: |
| 230 | 7093 |
| 1065 | 7094 bufnr buffer number; must be the number of a valid |
| 1621 | 7095 buffer |
| 1065 | 7096 filename name of a file; only used when "bufnr" is not |
| 1621 | 7097 present or it is invalid. |
| 230 | 7098 lnum line number in the file |
| 233 | 7099 pattern search pattern used to locate the error |
| 230 | 7100 col column number |
| 233 | 7101 vcol when non-zero: "col" is visual column |
| 856 | 7102 when zero: "col" is byte index |
| 233 | 7103 nr error number |
| 230 | 7104 text description of the error |
| 233 | 7105 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
|
7106 valid recognized error message |
| 233 | 7107 |
| 7108 The "col", "vcol", "nr", "type" and "text" entries are | |
| 7109 optional. Either "lnum" or "pattern" entry can be used to | |
| 7110 locate a matching error line. | |
| 1065 | 7111 If the "filename" and "bufnr" entries are not present or |
| 7112 neither the "lnum" or "pattern" entries are present, then the | |
| 7113 item will not be handled as an error line. | |
| 230 | 7114 If both "pattern" and "lnum" are present then "pattern" will |
| 7115 be used. | |
|
11390
73cfcf11d983
patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents:
11347
diff
changeset
|
7116 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
|
7117 set when "bufnr" is a valid buffer or "filename" exists. |
| 2152 | 7118 If you supply an empty {list}, the quickfix list will be |
| 7119 cleared. | |
| 1065 | 7120 Note that the list is not exactly the same as what |
| 7121 |getqflist()| returns. | |
| 230 | 7122 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7123 {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
|
7124 '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
|
7125 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
|
7126 new list is created. |
| 12785 | 7127 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7128 '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
|
7129 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
|
7130 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
|
7131 :call setqflist([], 'r') |
| 12785 | 7132 < |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7133 '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
|
7134 freed. |
|
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7135 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
7136 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
|
7137 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
|
7138 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
|
7139 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
|
7140 set "nr" in {what} to "$". |
| 277 | 7141 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7142 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
|
7143 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
|
7144 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
|
7145 {what}: |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
7146 context any Vim type can be stored as a context |
|
12321
2779d593a706
patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents:
12319
diff
changeset
|
7147 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
|
7148 "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
|
7149 'errorformat' option 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
|
7150 id quickfix list identifier |quickfix-ID| |
|
11549
f5add45f9848
patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents:
11543
diff
changeset
|
7151 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
|
7152 argument. |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
7153 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
|
7154 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
|
7155 {nr} or {id}. Only a |List| value is supported. |
|
11502
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
7156 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
|
7157 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
|
7158 the last quickfix list |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7159 title quickfix list title text |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7160 Unsupported keys in {what} are ignored. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7161 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
|
7162 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
|
7163 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
|
7164 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
|
7165 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
|
7166 specify the list. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7167 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7168 Examples: > |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
7169 :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
|
7170 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'}) |
|
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
7171 :call setqflist([], 'a', {'id':myid, 'lines':["F1:10:L10"]}) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7172 < |
| 230 | 7173 Returns zero for success, -1 for failure. |
| 7174 | |
| 7175 This function can be used to create a quickfix list | |
| 7176 independent of the 'errorformat' setting. Use a command like | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11390
diff
changeset
|
7177 `:cc 1` to jump to the first position. |
| 230 | 7178 |
| 7179 | |
| 7 | 7180 *setreg()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
7181 setreg({regname}, {value} [, {options}]) |
| 7 | 7182 Set the register {regname} to {value}. |
| 12785 | 7183 {value} may be any value returned by |getreg()|, including |
| 5798 | 7184 a |List|. |
| 7 | 7185 If {options} contains "a" or {regname} is upper case, |
| 7186 then the value is appended. | |
| 2423 | 7187 {options} can also contain a register type specification: |
| 7 | 7188 "c" or "v" |characterwise| mode |
| 7189 "l" or "V" |linewise| mode | |
| 7190 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 7191 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 7192 used as the width of the selection - if it is not specified | |
| 7193 then the width of the block is set to the number of characters | |
| 1266 | 7194 in the longest line (counting a <Tab> as 1 character). |
| 7 | 7195 |
| 7196 If {options} contains no register settings, then the default | |
| 12785 | 7197 is to use character mode unless {value} ends in a <NL> for |
| 7198 string {value} and linewise mode for list {value}. Blockwise | |
| 5798 | 7199 mode is never selected automatically. |
| 7200 Returns zero for success, non-zero for failure. | |
| 7201 | |
| 7202 *E883* | |
| 12785 | 7203 Note: you may not use |List| containing more than one item to |
| 7204 set search and expression registers. Lists containing no | |
| 5798 | 7205 items act like empty strings. |
| 7 | 7206 |
| 7207 Examples: > | |
| 7208 :call setreg(v:register, @*) | |
| 7209 :call setreg('*', @%, 'ac') | |
| 7210 :call setreg('a', "1\n2\n3", 'b5') | |
| 7211 | |
| 7212 < 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
|
7213 register: > |
| 5798 | 7214 :let var_a = getreg('a', 1, 1) |
| 7 | 7215 :let var_amode = getregtype('a') |
| 7216 .... | |
| 7217 :call setreg('a', var_a, var_amode) | |
| 12785 | 7218 < Note: you may not reliably restore register value |
| 7219 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
|
7220 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
|
7221 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
|
7222 |
|
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
7223 You can also change the type of a register by appending |
| 7 | 7224 nothing: > |
| 7225 :call setreg('a', '', 'al') | |
| 7226 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7227 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7228 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
|
7229 |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7230 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
|
7231 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7232 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7233 |
| 831 | 7234 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 7235 Set option or local variable {varname} in window {winnr} to | |
| 7236 {val}. | |
| 7237 Tabs are numbered starting with one. For the current tabpage | |
| 7238 use |setwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
7239 {winnr} can be the window number or the |window-ID|. |
| 831 | 7240 When {winnr} is zero the current window is used. |
| 7 | 7241 This also works for a global or local buffer option, but it |
| 7242 doesn't work for a global or local buffer variable. | |
| 7243 For a local buffer option the global value is unchanged. | |
| 7244 Note that the variable name without "w:" must be used. | |
| 831 | 7245 Examples: > |
| 7246 :call settabwinvar(1, 1, "&list", 0) | |
| 7247 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 7248 < This function is not available in the |sandbox|. | |
| 7249 | |
| 7250 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
| 7251 Like |settabwinvar()| for the current tab page. | |
| 7 | 7252 Examples: > |
| 7253 :call setwinvar(1, "&list", 0) | |
| 7254 :call setwinvar(2, "myvar", "foobar") | |
| 7255 | |
| 4126 | 7256 sha256({string}) *sha256()* |
| 6647 | 7257 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 7258 checksum of {string}. |
| 7259 {only available when compiled with the |+cryptv| feature} | |
| 7260 | |
| 1661 | 7261 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7262 Escape {string} for use as a shell command argument. |
| 985 | 7263 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
| 1661 | 7264 will enclose {string} in double quotes and double all double |
| 985 | 7265 quotes within {string}. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
7266 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
|
7267 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
|
7268 |
| 1661 | 7269 When the {special} argument is present and it's a non-zero |
| 7270 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 7271 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 7272 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 7273 command. |
|
11502
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
7274 |
| 1698 | 7275 The "!" character will be escaped (again with a |non-zero-arg| |
| 7276 {special}) when 'shell' contains "csh" in the tail. That is | |
| 7277 because for csh and tcsh "!" is used for history replacement | |
| 7278 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
|
7279 |
|
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
7280 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
|
7281 escaped. When 'shell' containing "csh" in the tail it's |
| 1698 | 7282 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
|
7283 |
| 1661 | 7284 Example of use with a |:!| command: > |
| 7285 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 7286 < This results in a directory listing for the file under the | |
| 7287 cursor. Example of use with |system()|: > | |
| 7288 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 7289 < See also |::S|. |
| 985 | 7290 |
| 7291 | |
| 3875 | 7292 shiftwidth() *shiftwidth()* |
| 7293 Returns the effective value of 'shiftwidth'. This is the | |
| 7294 '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
|
7295 'tabstop' value. This function was introduced with patch |
|
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
7296 7.3.694 in 2012, everybody should have it by now. |
| 3875 | 7297 |
| 7298 | |
| 7 | 7299 simplify({filename}) *simplify()* |
| 7300 Simplify the file name as much as possible without changing | |
| 7301 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 7302 Unix) are not resolved. If the first path component in | |
| 7303 {filename} designates the current directory, this will be | |
| 7304 valid for the result as well. A trailing path separator is | |
| 7305 not removed either. | |
| 7306 Example: > | |
| 7307 simplify("./dir/.././/file/") == "./file/" | |
| 7308 < Note: The combination "dir/.." is only removed if "dir" is | |
| 7309 a searchable directory or does not exist. On Unix, it is also | |
| 7310 removed when "dir" is a symbolic link within the same | |
| 7311 directory. In order to resolve all the involved symbolic | |
| 7312 links before simplifying the path name, use |resolve()|. | |
| 7313 | |
| 82 | 7314 |
| 1621 | 7315 sin({expr}) *sin()* |
| 7316 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 7317 {expr} must evaluate to a |Float| or a |Number|. | |
| 7318 Examples: > | |
| 7319 :echo sin(100) | |
| 7320 < -0.506366 > | |
| 7321 :echo sin(-4.01) | |
| 7322 < 0.763301 | |
| 7323 {only available when compiled with the |+float| feature} | |
| 12785 | 7324 |
| 1621 | 7325 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7326 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7327 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
|
7328 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7329 {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
|
7330 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7331 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7332 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7333 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7334 < -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
|
7335 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7336 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7337 |
| 2902 | 7338 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 7339 Sort the items in {list} in-place. Returns {list}. |
| 12785 | 7340 |
| 5747 | 7341 If you want a list to remain unmodified make a copy first: > |
| 82 | 7342 :let sortedlist = sort(copy(mylist)) |
| 5968 | 7343 |
| 6009 | 7344 < When {func} is omitted, is empty or zero, then sort() uses the |
| 7345 string representation of each item to sort on. Numbers sort | |
| 7346 after Strings, |Lists| after Numbers. For sorting text in the | |
| 7347 current buffer use |:sort|. | |
| 7348 | |
| 6180 | 7349 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 7350 ignored. |
| 12785 | 7351 |
| 6009 | 7352 When {func} is given and it is 'n' then all items will be |
| 7353 sorted numerical (Implementation detail: This uses the | |
| 7354 strtod() function to parse numbers, Strings, Lists, Dicts and | |
| 7355 Funcrefs will be considered as being 0). | |
| 7356 | |
|
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
7357 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
|
7358 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
|
7359 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
|
7360 |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
7361 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
|
7362 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
|
7363 |
| 685 | 7364 When {func} is a |Funcref| or a function name, this function |
| 7365 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
|
7366 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
|
7367 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
|
7368 smaller if the first one sorts before the second one. |
| 5747 | 7369 |
| 7370 {dict} is for functions with the "dict" attribute. It will be | |
| 7371 used to set the local variable "self". |Dictionary-function| | |
| 7372 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7373 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
|
7374 string) will keep their relative position. E.g., when sorting |
| 6051 | 7375 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
|
7376 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7377 |
| 5747 | 7378 Also see |uniq()|. |
| 7379 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7380 Example: > |
| 82 | 7381 func MyCompare(i1, i2) |
| 7382 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 7383 endfunc | |
| 7384 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7385 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7386 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7387 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7388 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7389 endfunc |
| 344 | 7390 < |
| 374 | 7391 *soundfold()* |
| 7392 soundfold({word}) | |
| 7393 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 7394 language in 'spelllang' for the current window that supports |
| 375 | 7395 soundfolding. 'spell' must be set. When no sound folding is |
| 7396 possible the {word} is returned unmodified. | |
| 374 | 7397 This can be used for making spelling suggestions. Note that |
| 7398 the method can be quite slow. | |
| 7399 | |
| 344 | 7400 *spellbadword()* |
| 532 | 7401 spellbadword([{sentence}]) |
| 7402 Without argument: The result is the badly spelled word under | |
| 7403 or after the cursor. The cursor is moved to the start of the | |
| 7404 bad word. When no bad word is found in the cursor line the | |
| 7405 result is an empty string and the cursor doesn't move. | |
| 7406 | |
| 7407 With argument: The result is the first word in {sentence} that | |
| 7408 is badly spelled. If there are no spelling mistakes the | |
| 7409 result is an empty string. | |
| 7410 | |
| 7411 The return value is a list with two items: | |
| 7412 - The badly spelled word or an empty string. | |
| 7413 - The type of the spelling error: | |
| 856 | 7414 "bad" spelling mistake |
| 532 | 7415 "rare" rare word |
| 7416 "local" word only valid in another region | |
| 7417 "caps" word should start with Capital | |
| 7418 Example: > | |
| 7419 echo spellbadword("the quik brown fox") | |
| 7420 < ['quik', 'bad'] ~ | |
| 7421 | |
| 7422 The spelling information for the current window is used. The | |
| 7423 'spell' option must be set and the value of 'spelllang' is | |
| 7424 used. | |
| 344 | 7425 |
| 7426 *spellsuggest()* | |
| 537 | 7427 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 7428 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 7429 When {max} is given up to this number of suggestions are |
| 7430 returned. Otherwise up to 25 suggestions are returned. | |
| 7431 | |
| 537 | 7432 When the {capital} argument is given and it's non-zero only |
| 7433 suggestions with a leading capital will be given. Use this | |
| 7434 after a match with 'spellcapcheck'. | |
| 7435 | |
| 344 | 7436 {word} can be a badly spelled word followed by other text. |
| 7437 This allows for joining two words that were split. The | |
| 359 | 7438 suggestions also include the following text, thus you can |
| 7439 replace a line. | |
| 7440 | |
| 7441 {word} may also be a good word. Similar words will then be | |
| 537 | 7442 returned. {word} itself is not included in the suggestions, |
| 7443 although it may appear capitalized. | |
| 344 | 7444 |
| 7445 The spelling information for the current window is used. The | |
| 375 | 7446 'spell' option must be set and the values of 'spelllang' and |
| 7447 'spellsuggest' are used. | |
| 344 | 7448 |
| 82 | 7449 |
| 282 | 7450 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 7451 Make a |List| out of {expr}. When {pattern} is omitted or |
| 7452 empty each white-separated sequence of characters becomes an | |
| 7453 item. | |
| 82 | 7454 Otherwise the string is split where {pattern} matches, |
| 3920 | 7455 removing the matched characters. 'ignorecase' is not used |
| 7456 here, add \c to ignore case. |/\c| | |
| 282 | 7457 When the first or last item is empty it is omitted, unless the |
| 7458 {keepempty} argument is given and it's non-zero. | |
| 293 | 7459 Other empty items are kept when {pattern} matches at least one |
| 7460 character or when {keepempty} is non-zero. | |
| 82 | 7461 Example: > |
| 95 | 7462 :let words = split(getline('.'), '\W\+') |
| 282 | 7463 < To split a string in individual characters: > |
| 236 | 7464 :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
|
7465 < 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
|
7466 the end of the pattern: > |
| 258 | 7467 :echo split('abc:def:ghi', ':\zs') |
| 7468 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 7469 Splitting a table where the first element can be empty: > |
| 7470 :let items = split(line, ':', 1) | |
| 7471 < The opposite function is |join()|. | |
| 82 | 7472 |
| 7473 | |
| 1621 | 7474 sqrt({expr}) *sqrt()* |
| 7475 Return the non-negative square root of Float {expr} as a | |
| 7476 |Float|. | |
| 7477 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 7478 is negative the result is NaN (Not a Number). | |
| 7479 Examples: > | |
| 7480 :echo sqrt(100) | |
| 7481 < 10.0 > | |
| 7482 :echo sqrt(-4.01) | |
| 7483 < nan | |
| 1668 | 7484 "nan" may be different, it depends on system libraries. |
| 1621 | 7485 {only available when compiled with the |+float| feature} |
| 12785 | 7486 |
| 1621 | 7487 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7488 str2float({expr}) *str2float()* |
| 1621 | 7489 Convert String {expr} to a Float. This mostly works the same |
| 7490 as when using a floating point number in an expression, see | |
| 7491 |floating-point-format|. But it's a bit more permissive. | |
| 7492 E.g., "1e40" is accepted, while in an expression you need to | |
| 7493 write "1.0e40". | |
| 7494 Text after the number is silently ignored. | |
| 7495 The decimal point is always '.', no matter what the locale is | |
| 7496 set to. A comma ends the number: "12,345.67" is converted to | |
| 7497 12.0. You can strip out thousands separators with | |
| 7498 |substitute()|: > | |
| 7499 let f = str2float(substitute(text, ',', '', 'g')) | |
| 7500 < {only available when compiled with the |+float| feature} | |
| 7501 | |
| 7502 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7503 str2nr({expr} [, {base}]) *str2nr()* |
| 782 | 7504 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
|
7505 {base} is the conversion base, it can be 2, 8, 10 or 16. |
| 782 | 7506 When {base} is omitted base 10 is used. This also means that |
| 7507 a leading zero doesn't cause octal conversion to be used, as | |
| 7508 with the default String to Number conversion. | |
| 7509 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
|
7510 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
|
7511 {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
|
7512 leading "0b" or "0B" is ignored. |
| 782 | 7513 Text after the number is silently ignored. |
| 856 | 7514 |
| 782 | 7515 |
| 6884 | 7516 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7517 The result is a Number, which is the number of characters |
| 6884 | 7518 in String {expr}. |
| 7519 When {skipcc} is omitted or zero, composing characters are | |
| 7520 counted separately. | |
| 7521 When {skipcc} set to 1, Composing characters are ignored. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7522 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
| 12785 | 7523 |
| 6918 | 7524 {skipcc} is only available after 7.4.755. For backward |
| 7525 compatibility, you can define a wrapper function: > | |
| 7526 if has("patch-7.4.755") | |
| 7527 function s:strchars(str, skipcc) | |
| 7528 return strchars(a:str, a:skipcc) | |
| 7529 endfunction | |
| 7530 else | |
| 7531 function s:strchars(str, skipcc) | |
| 7532 if a:skipcc | |
| 7533 return strlen(substitute(a:str, ".", "x", "g")) | |
| 7534 else | |
| 7535 return strchars(a:str) | |
| 7536 endif | |
| 7537 endfunction | |
| 7538 endif | |
| 7539 < | |
| 12785 | 7540 strcharpart({src}, {start} [, {len}]) *strcharpart()* |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7541 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
|
7542 of byte index and length. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7543 When a character index is used where a character does not |
| 10617 | 7544 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
|
7545 strcharpart('abc', -1, 2) |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7546 < results in 'a'. |
| 6918 | 7547 |
| 12785 | 7548 strdisplaywidth({expr} [, {col}]) *strdisplaywidth()* |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7549 The result is a Number, which is the number of display cells |
| 6884 | 7550 String {expr} occupies on the screen when it starts at {col}. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7551 When {col} is omitted zero is used. Otherwise it is the |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7552 screen column where to start. This matters for Tab |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7553 characters. |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
7554 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
|
7555 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
|
7556 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7557 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7558 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7559 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7560 |
| 7 | 7561 strftime({format} [, {time}]) *strftime()* |
| 7562 The result is a String, which is a formatted date and time, as | |
| 7563 specified by the {format} string. The given {time} is used, | |
| 7564 or the current time if no time is given. The accepted | |
| 7565 {format} depends on your system, thus this is not portable! | |
| 7566 See the manual page of the C function strftime() for the | |
| 7567 format. The maximum length of the result is 80 characters. | |
| 7568 See also |localtime()| and |getftime()|. | |
| 7569 The language can be changed with the |:language| command. | |
| 7570 Examples: > | |
| 7571 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 7572 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 7573 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 7574 :echo strftime("%H:%M") 11:55 | |
| 7575 :echo strftime("%c", getftime("file.c")) | |
| 7576 Show mod time of file.c. | |
| 82 | 7577 < Not available on all systems. To check use: > |
| 7578 :if exists("*strftime") | |
| 7579 | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7580 strgetchar({str}, {index}) *strgetchar()* |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7581 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
|
7582 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
|
7583 separate characters here. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7584 Also see |strcharpart()| and |strchars()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7585 |
| 133 | 7586 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 7587 The result is a Number, which gives the byte index in | |
| 7588 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 7589 If {start} is specified, the search starts at index {start}. |
| 7590 This can be used to find a second match: > | |
| 2662 | 7591 :let colon1 = stridx(line, ":") |
| 7592 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 7593 < The search is done case-sensitive. |
| 205 | 7594 For pattern searches use |match()|. |
| 133 | 7595 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 7596 See also |strridx()|. |
| 7597 Examples: > | |
| 7 | 7598 :echo stridx("An Example", "Example") 3 |
| 7599 :echo stridx("Starting point", "Start") 0 | |
| 7600 :echo stridx("Starting point", "start") -1 | |
| 856 | 7601 < *strstr()* *strchr()* |
| 170 | 7602 stridx() works similar to the C function strstr(). When used |
| 7603 with a single character it works similar to strchr(). | |
| 7604 | |
| 55 | 7605 *string()* |
| 95 | 7606 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
| 1621 | 7607 Float, String or a composition of them, then the result can be |
| 7608 parsed back with |eval()|. | |
| 55 | 7609 {expr} type result ~ |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7610 String 'string' (single quotes are doubled) |
| 95 | 7611 Number 123 |
| 1621 | 7612 Float 123.123456 or 1.123456e8 |
| 99 | 7613 Funcref function('name') |
| 95 | 7614 List [item, item] |
| 323 | 7615 Dictionary {key: value, key: value} |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7616 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7617 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
|
7618 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
|
7619 will then fail. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7620 |
| 1156 | 7621 Also see |strtrans()|. |
| 55 | 7622 |
| 7 | 7623 *strlen()* |
| 7624 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 7625 {expr} in bytes. |
| 55 | 7626 If the argument is a Number it is first converted to a String. |
| 7627 For other types an error is given. | |
| 6870 | 7628 If you want to count the number of multi-byte characters use |
| 7629 |strchars()|. | |
| 7630 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 7631 |
| 12785 | 7632 strpart({src}, {start} [, {len}]) *strpart()* |
| 7 | 7633 The result is a String, which is part of {src}, starting from |
| 574 | 7634 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
|
7635 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
|
7636 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7637 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
|
7638 result in an error, the bytes are simply omitted. |
| 7 | 7639 If {len} is missing, the copy continues from {start} till the |
| 7640 end of the {src}. > | |
| 7641 strpart("abcdefg", 3, 2) == "de" | |
| 7642 strpart("abcdefg", -2, 4) == "ab" | |
| 7643 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 7644 strpart("abcdefg", 3) == "defg" |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7645 |
| 7 | 7646 < Note: To get the first character, {start} must be 0. For |
| 7647 example, to get three bytes under and after the cursor: > | |
| 823 | 7648 strpart(getline("."), col(".") - 1, 3) |
| 7 | 7649 < |
| 140 | 7650 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 7651 The result is a Number, which gives the byte index in | |
| 7652 {haystack} of the last occurrence of the String {needle}. | |
| 7653 When {start} is specified, matches beyond this index are | |
| 7654 ignored. This can be used to find a match before a previous | |
| 7655 match: > | |
| 7656 :let lastcomma = strridx(line, ",") | |
| 7657 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 7658 < The search is done case-sensitive. | |
| 133 | 7659 For pattern searches use |match()|. |
| 7660 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 7661 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 7662 See also |stridx()|. Examples: > |
| 7 | 7663 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 7664 < *strrchr()* |
| 170 | 7665 When used with a single character it works similar to the C |
| 7666 function strrchr(). | |
| 7667 | |
| 7 | 7668 strtrans({expr}) *strtrans()* |
| 7669 The result is a String, which is {expr} with all unprintable | |
| 7670 characters translated into printable characters |'isprint'|. | |
| 7671 Like they are shown in a window. Example: > | |
| 7672 echo strtrans(@a) | |
| 7673 < This displays a newline in register a as "^@" instead of | |
| 7674 starting a new line. | |
| 7675 | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7676 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7677 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
|
7678 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7679 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7680 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7681 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7682 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7683 |
| 12785 | 7684 submatch({nr} [, {list}]) *submatch()* *E935* |
| 2908 | 7685 Only for an expression in a |:substitute| command or |
| 7686 substitute() function. | |
| 7687 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 7688 is 0 the whole matched text is returned. | |
| 5794 | 7689 Note that a NL in the string can stand for a line break of a |
| 7690 multi-line match or a NUL character in the text. | |
| 2908 | 7691 Also see |sub-replace-expression|. |
| 5794 | 7692 |
| 12785 | 7693 If {list} is present and non-zero then submatch() returns |
| 7694 a list of strings, similar to |getline()| with two arguments. | |
| 5794 | 7695 NL characters in the text represent NUL characters in the |
| 7696 text. | |
| 7697 Only returns more than one item for |:substitute|, inside | |
| 7698 |substitute()| this list will always contain one or zero | |
| 7699 items, since there are no real line breaks. | |
| 7700 | |
|
10245
d76ccdacb41e
commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
7701 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
|
7702 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
|
7703 |
| 12968 | 7704 Examples: > |
| 7 | 7705 :s/\d\+/\=submatch(0) + 1/ |
| 12968 | 7706 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '') |
| 7 | 7707 < This finds the first number in the line and adds one to it. |
| 7708 A line break is included as a newline character. | |
| 7709 | |
| 7710 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
| 7711 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 7712 the first match of {pat} is replaced with {sub}. |
| 7713 When {flags} is "g", all matches of {pat} in {expr} are | |
| 7714 replaced. Otherwise {flags} should be "". | |
| 12785 | 7715 |
| 2908 | 7716 This works like the ":substitute" command (without any flags). |
| 7717 But the matching with {pat} is always done like the 'magic' | |
| 7718 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 7719 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 7720 if you want to ignore or match case and ignore 'ignorecase'. | |
| 7721 'smartcase' is not used. See |string-match| for how {pat} is | |
| 7722 used. | |
| 2908 | 7723 |
| 7724 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 7725 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
|
7726 |sub-replace-special|. For example, to replace something with |
| 7 | 7727 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 7728 |
| 7 | 7729 When {pat} does not match in {expr}, {expr} is returned |
| 7730 unmodified. | |
| 2908 | 7731 |
| 7 | 7732 Example: > |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7733 :let &path = substitute(&path, ",\\=[^,]*$", "", "") |
| 7 | 7734 < 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
|
7735 :echo substitute("testing", ".*", "\\U\\0", "") |
| 7 | 7736 < results in "TESTING". |
| 2908 | 7737 |
| 7738 When {sub} starts with "\=", the remainder is interpreted as | |
| 7739 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
|
7740 :echo substitute(s, '%\(\x\x\)', |
| 2833 | 7741 \ '\=nr2char("0x" . submatch(1))', 'g') |
| 7 | 7742 |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7743 < 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
|
7744 optional argument. Example: > |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7745 :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
|
7746 < 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
|
7747 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
|
7748 |submatch()| returns. Example: > |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7749 :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
|
7750 |
| 32 | 7751 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 7752 The result is a Number, which is the syntax ID at the position |
| 32 | 7753 {lnum} and {col} in the current window. |
| 7 | 7754 The syntax ID can be used with |synIDattr()| and |
| 7755 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 7756 |
| 32 | 7757 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 7758 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
|
7759 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
|
7760 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
|
7761 zero. |
| 419 | 7762 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
7763 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
|
7764 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
|
7765 the effective color. When {trans} is |FALSE|, the transparent |
| 7 | 7766 item is returned. This is useful when wanting to know which |
| 7767 syntax item is effective (e.g. inside parens). | |
| 7768 Warning: This function can be very slow. Best speed is | |
| 7769 obtained by going through the file in forward direction. | |
| 7770 | |
| 7771 Example (echoes the name of the syntax item under the cursor): > | |
| 7772 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 7773 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
7774 |
| 7 | 7775 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 7776 The result is a String, which is the {what} attribute of | |
| 7777 syntax ID {synID}. This can be used to obtain information | |
| 7778 about a syntax item. | |
| 7779 {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
|
7780 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 7781 used, the attributes for the currently active highlighting are |
| 7782 used (GUI, cterm or term). | |
| 7783 Use synIDtrans() to follow linked highlight groups. | |
| 7784 {what} result | |
| 7785 "name" the name of the syntax item | |
| 7786 "fg" foreground color (GUI: color name used to set | |
| 7787 the color, cterm: color number as a string, | |
| 7788 term: empty string) | |
| 1755 | 7789 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7790 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7791 |highlight-font| |
| 1755 | 7792 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 7793 "fg#" like "fg", but for the GUI and the GUI is |
| 7794 running the name in "#RRGGBB" form | |
| 7795 "bg#" like "fg#" for "bg" | |
| 1755 | 7796 "sp#" like "fg#" for "sp" |
| 7 | 7797 "bold" "1" if bold |
| 7798 "italic" "1" if italic | |
| 7799 "reverse" "1" if reverse | |
| 7800 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7801 "standout" "1" if standout |
| 7 | 7802 "underline" "1" if underlined |
| 205 | 7803 "undercurl" "1" if undercurled |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12311
diff
changeset
|
7804 "strike" "1" if strikethrough |
| 7 | 7805 |
| 7806 Example (echoes the color of the syntax item under the | |
| 7807 cursor): > | |
| 7808 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 7809 < | |
| 7810 synIDtrans({synID}) *synIDtrans()* | |
| 7811 The result is a Number, which is the translated syntax ID of | |
| 7812 {synID}. This is the syntax group ID of what is being used to | |
| 7813 highlight the character. Highlight links given with | |
| 7814 ":highlight link" are followed. | |
| 7815 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7816 synconcealed({lnum}, {col}) *synconcealed()* |
|
11553
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
7817 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
|
7818 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
|
7819 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
|
7820 region, 1 if it is. |
|
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
7821 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
|
7822 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
|
7823 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
|
7824 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
|
7825 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
|
7826 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
|
7827 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
|
7828 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
|
7829 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
|
7830 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
|
7831 the text is "123456" and both "23" and "45" are concealed |
|
52e3a77c097b
patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents:
11561
diff
changeset
|
7832 and replace by the character "X", then: |
|
52e3a77c097b
patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents:
11561
diff
changeset
|
7833 call returns ~ |
| 12254 | 7834 synconcealed(lnum, 1) [0, '', 0] |
| 7835 synconcealed(lnum, 2) [1, 'X', 1] | |
| 7836 synconcealed(lnum, 3) [1, 'X', 1] | |
| 7837 synconcealed(lnum, 4) [1, 'X', 2] | |
| 7838 synconcealed(lnum, 5) [1, 'X', 2] | |
| 7839 synconcealed(lnum, 6) [0, '', 0] | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7840 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7841 |
| 1500 | 7842 synstack({lnum}, {col}) *synstack()* |
| 7843 Return a |List|, which is the stack of syntax items at the | |
| 7844 position {lnum} and {col} in the current window. Each item in | |
| 7845 the List is an ID like what |synID()| returns. | |
| 7846 The first item in the List is the outer region, following are | |
| 7847 items contained in that one. The last one is what |synID()| | |
| 7848 returns, unless not the whole item is highlighted or it is a | |
| 7849 transparent item. | |
| 7850 This function is useful for debugging a syntax file. | |
| 7851 Example that shows the syntax stack under the cursor: > | |
| 7852 for id in synstack(line("."), col(".")) | |
| 7853 echo synIDattr(id, "name") | |
| 7854 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
7855 < 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
|
7856 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
7857 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
|
7858 valid positions. |
| 1500 | 7859 |
| 24 | 7860 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 7861 Get the output of the shell command {expr} as a string. See |
| 7862 |systemlist()| to get the output as a List. | |
| 5806 | 7863 |
| 12785 | 7864 When {input} is given and is a string this string is written |
| 7865 to a file and passed as stdin to the command. The string is | |
| 7866 written as-is, you need to take care of using the correct line | |
| 5806 | 7867 separators yourself. |
| 7868 If {input} is given and is a |List| it is written to the file | |
| 7869 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 7870 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
|
7871 list items converted to NULs). |
|
7232cd9f8a7c
commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
7872 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
|
7873 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
|
7874 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
|
7875 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
|
7876 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
7877 Pipes are not used, the 'shelltemp' option is not used. |
| 5806 | 7878 |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
7879 When prepended by |:silent| the terminal will not be set to |
| 6183 | 7880 cooked mode. This is meant to be used for commands that do |
| 7881 not need the user to type. It avoids stray characters showing | |
| 7882 up on the screen which require |CTRL-L| to remove. > | |
| 7883 :silent let f = system('ls *.vim') | |
| 7884 < | |
| 12785 | 7885 Note: Use |shellescape()| or |::S| with |expand()| or |
| 7886 |fnamemodify()| to escape special characters in a command | |
| 7887 argument. Newlines in {expr} may cause the command to fail. | |
| 7888 The characters in 'shellquote' and 'shellxquote' may also | |
| 5690 | 7889 cause trouble. |
| 7 | 7890 This is not to be used for interactive commands. |
| 1661 | 7891 |
| 7 | 7892 The result is a String. Example: > |
| 1661 | 7893 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 7894 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 7895 |
| 7896 < To make the result more system-independent, the shell output | |
| 7897 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 7898 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 7899 To avoid the string being truncated at a NUL, all NUL |
| 7900 characters are replaced with SOH (0x01). | |
| 7901 | |
| 7 | 7902 The command executed is constructed using several options: |
| 7903 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 7904 ({tmp} is an automatically generated file name). | |
| 7905 For Unix and OS/2 braces are put around {expr} to allow for | |
| 7906 concatenated commands. | |
| 7907 | |
| 794 | 7908 The command will be executed in "cooked" mode, so that a |
| 7909 CTRL-C will interrupt the command (on Unix at least). | |
| 7910 | |
| 7 | 7911 The resulting error code can be found in |v:shell_error|. |
| 7912 This function will fail in |restricted-mode|. | |
| 625 | 7913 |
| 7914 Note that any wrong value in the options mentioned above may | |
| 7915 make the function fail. It has also been reported to fail | |
| 7916 when using a security agent application. | |
| 7 | 7917 Unlike ":!cmd" there is no automatic check for changed files. |
| 7918 Use |:checktime| to force a check. | |
| 7919 | |
| 205 | 7920 |
| 5808 | 7921 systemlist({expr} [, {input}]) *systemlist()* |
| 12785 | 7922 Same as |system()|, but returns a |List| with lines (parts of |
| 7923 output separated by NL) with NULs transformed into NLs. Output | |
| 7924 is the same as |readfile()| will output with {binary} argument | |
|
10548
74effdaa369e
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10522
diff
changeset
|
7925 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
|
7926 characters. |
| 5808 | 7927 |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
7928 Returns an empty string on error. |
| 5808 | 7929 |
| 7930 | |
| 677 | 7931 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 7932 The result is a |List|, where each item is the number of the |
| 677 | 7933 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
|
7934 {arg} specifies the number of the tab page to be used. When |
| 677 | 7935 omitted the current tab page is used. |
| 7936 When {arg} is invalid the number zero is returned. | |
| 7937 To get a list of all buffers in all tabs use this: > | |
| 3445 | 7938 let buflist = [] |
| 677 | 7939 for i in range(tabpagenr('$')) |
| 3445 | 7940 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 7941 endfor |
| 7942 < Note that a buffer may appear in more than one window. | |
| 7943 | |
| 7944 | |
| 7945 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 7946 The result is a Number, which is the number of the current |
| 7947 tab page. The first tab page has number 1. | |
| 7948 When the optional argument is "$", the number of the last tab | |
| 7949 page is returned (the tab page count). | |
| 7950 The number can be used with the |:tab| command. | |
| 7951 | |
| 7952 | |
| 5763 | 7953 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7954 Like |winnr()| but for tab page {tabarg}. |
| 677 | 7955 {tabarg} specifies the number of tab page to be used. |
| 7956 {arg} is used like with |winnr()|: | |
| 7957 - When omitted the current window number is returned. This is | |
| 7958 the window which will be used when going to this tab page. | |
| 7959 - When "$" the number of windows is returned. | |
| 7960 - When "#" the previous window nr is returned. | |
| 7961 Useful examples: > | |
| 7962 tabpagewinnr(1) " current window of tab page 1 | |
| 7963 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 7964 < When {tabarg} is invalid zero is returned. | |
| 7965 | |
| 805 | 7966 *tagfiles()* |
| 7967 tagfiles() Returns a |List| with the file names used to search for tags | |
| 7968 for the current buffer. This is the 'tags' option expanded. | |
| 7969 | |
| 7970 | |
| 12785 | 7971 taglist({expr} [, {filename}]) *taglist()* |
| 205 | 7972 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
|
7973 |
|
d3415ec1cdaf
patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents:
11211
diff
changeset
|
7974 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
|
7975 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
|
7976 {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
|
7977 |
| 438 | 7978 Each list item is a dictionary with at least the following |
| 7979 entries: | |
| 648 | 7980 name Name of the tag. |
| 7981 filename Name of the file where the tag is | |
| 1156 | 7982 defined. It is either relative to the |
| 7983 current directory or a full path. | |
| 205 | 7984 cmd Ex command used to locate the tag in |
| 7985 the file. | |
| 648 | 7986 kind Type of the tag. The value for this |
| 205 | 7987 entry depends on the language specific |
| 1156 | 7988 kind values. Only available when |
| 7989 using a tags file generated by | |
| 7990 Exuberant ctags or hdrtag. | |
| 648 | 7991 static A file specific tag. Refer to |
| 205 | 7992 |static-tag| for more information. |
| 1156 | 7993 More entries may be present, depending on the content of the |
| 7994 tags file: access, implementation, inherits and signature. | |
| 7995 Refer to the ctags documentation for information about these | |
| 7996 fields. For C code the fields "struct", "class" and "enum" | |
| 7997 may appear, they give the name of the entity the tag is | |
| 7998 contained in. | |
| 452 | 7999 |
| 11062 | 8000 The ex-command "cmd" can be either an ex search pattern, a |
| 216 | 8001 line number or a line number followed by a byte number. |
| 205 | 8002 |
| 8003 If there are no matching tags, then an empty list is returned. | |
| 8004 | |
| 8005 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 8006 used in {expr}. This also make the function work faster. |
| 8007 Refer to |tag-regexp| for more information about the tag | |
| 8008 search regular expression pattern. | |
| 205 | 8009 |
| 8010 Refer to |'tags'| for information about how the tags file is | |
| 8011 located by Vim. Refer to |tags-file-format| for the format of | |
| 8012 the tags file generated by the different ctags tools. | |
| 8013 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8014 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8015 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
|
8016 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8017 {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
|
8018 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8019 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8020 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8021 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8022 < -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
|
8023 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8024 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8025 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8026 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8027 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
|
8028 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8029 {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
|
8030 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8031 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8032 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8033 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8034 < -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
|
8035 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8036 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8037 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8038 tempname() *tempname()* *temp-file-name* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8039 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
|
8040 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
|
8041 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
|
8042 :let tmpfile = tempname() |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8043 :exe "redir > " . tmpfile |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8044 < 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
|
8045 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
|
8046 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
|
8047 |
|
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
|
8048 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
|
8049 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
|
8050 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
|
8051 {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
|
8052 {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
|
8053 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8054 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
|
8055 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
|
8056 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
|
8057 bold |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8058 italic |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8059 underline |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8060 strike |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8061 reverse |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8062 {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
|
8063 |
|
11876
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
8064 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
|
8065 Get the cursor position of terminal {buf}. Returns a list with |
| 12499 | 8066 two numbers and a dictionary: [row, col, dict]. |
| 8067 | |
| 8068 "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
|
8069 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
|
8070 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
|
8071 |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
8072 "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
|
8073 "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
|
8074 is hidden. |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
8075 "blink" 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
|
8076 is hidden. |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
8077 "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
|
8078 for a vertical bar. |
|
11876
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
8079 |
|
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
8080 {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
|
8081 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
|
8082 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
|
8083 {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
|
8084 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8085 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
|
8086 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
|
8087 {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
|
8088 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
|
8089 {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
|
8090 |
|
11904
40322e8f07e7
patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents:
11882
diff
changeset
|
8091 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
|
8092 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
|
8093 {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
|
8094 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8095 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
|
8096 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
|
8097 returned. |
|
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8098 {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
|
8099 |
|
12025
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
8100 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
|
8101 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
|
8102 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
|
8103 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
|
8104 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
|
8105 < is equal to: > |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
8106 `getline(N + term_getscrolled(buf)) |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
8107 < (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
|
8108 |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
8109 {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
|
8110 {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
|
8111 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8112 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
|
8113 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
|
8114 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
|
8115 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
|
8116 |
|
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
|
8117 {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
|
8118 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
|
8119 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
|
8120 {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
|
8121 |
|
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
|
8122 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
|
8123 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
|
8124 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
|
8125 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
|
8126 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
|
8127 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
|
8128 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
|
8129 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
8130 {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
|
8131 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
|
8132 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
|
8133 {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
|
8134 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
8135 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
|
8136 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
|
8137 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
|
8138 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
8139 {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
|
8140 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
|
8141 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
|
8142 {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
|
8143 |
|
12389
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
8144 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
|
8145 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
|
8146 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
|
8147 |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
8148 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
|
8149 (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
|
8150 (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
|
8151 {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
|
8152 |
|
11874
d444e087b8fd
patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents:
11846
diff
changeset
|
8153 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
|
8154 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
|
8155 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
|
8156 {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
|
8157 |
|
11904
40322e8f07e7
patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents:
11882
diff
changeset
|
8158 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
|
8159 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
|
8160 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
|
8161 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8162 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
|
8163 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
|
8164 returned. |
|
11874
d444e087b8fd
patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents:
11846
diff
changeset
|
8165 |
| 12785 | 8166 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
|
8167 "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
|
8168 "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
|
8169 "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
|
8170 "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
|
8171 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
|
8172 "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
|
8173 {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
|
8174 |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8175 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
|
8176 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
|
8177 {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
|
8178 |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8179 {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
|
8180 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
|
8181 {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
|
8182 |
| 12499 | 8183 term_setsize({buf}, {expr}) *term_setsize()* |
| 8184 Not implemented yet. | |
| 8185 {only available when compiled with the |+terminal| feature} | |
| 8186 | |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8187 term_start({cmd}, {options}) *term_start()* |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8188 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
|
8189 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8190 {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
|
8191 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
|
8192 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
|
8193 command like gdb. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8194 |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8195 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
|
8196 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
|
8197 message. |
|
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8198 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
|
8199 |
|
11967
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8200 {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
|
8201 |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
|
8202 are supported: |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8203 all timeout options |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8204 "stoponexit" |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8205 "callback", "out_cb", "err_cb" |
|
11967
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8206 "exit_cb", "close_cb" |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8207 "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
|
8208 "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
|
8209 "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
|
8210 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
|
8211 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
|
8212 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
|
8213 |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8214 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
|
8215 "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
|
8216 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
|
8217 "term_rows" vertical size to use for the terminal, |
|
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8218 instead of using 'termsize' |
|
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8219 "term_cols" horizontal size to use for the terminal, |
|
12076
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
8220 instead of using 'termsize' |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8221 "vertical" split the window vertically |
|
12060
a879814b8a37
patch 8.0.0910: cannot create a terminal in the current window
Christian Brabandt <cb@256bit.org>
parents:
12056
diff
changeset
|
8222 "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
|
8223 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
|
8224 cannot be |abandon|ed |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8225 "hidden" do not open a window |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8226 "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
|
8227 "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
|
8228 "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
|
8229 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
|
8230 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
|
8231 "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
|
8232 "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
|
8233 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
|
8234 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
|
8235 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
|
8236 "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
|
8237 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
|
8238 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
|
8239 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
|
8240 "exit". A CR is always added. |
|
12072
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
8241 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8242 {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
|
8243 |
|
12007
64b822c4f7ae
patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents:
12003
diff
changeset
|
8244 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
|
8245 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
|
8246 {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
|
8247 {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
|
8248 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
|
8249 {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
|
8250 |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
8251 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
|
8252 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
|
8253 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
|
8254 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
|
8255 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
|
8256 |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
8257 test_autochdir() *test_autochdir()* |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
8258 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
|
8259 startup has finished. |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
8260 |
|
12337
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
8261 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
|
8262 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
|
8263 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
|
8264 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
|
8265 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8266 test_garbagecollect_now() *test_garbagecollect_now()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8267 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
|
8268 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
|
8269 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
|
8270 any function. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8271 |
|
11006
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8272 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
|
8273 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
|
8274 instead. |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8275 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
|
8276 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
|
8277 following code). |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8278 {expr} is used literally, not as a pattern. |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8279 There is currently no way to revert this. |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8280 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8281 test_null_channel() *test_null_channel()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8282 Return a Channel that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8283 {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
|
8284 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8285 test_null_dict() *test_null_dict()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8286 Return a Dict that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8287 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8288 test_null_job() *test_null_job()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8289 Return a Job that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8290 {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
|
8291 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8292 test_null_list() *test_null_list()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8293 Return a List that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8294 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8295 test_null_partial() *test_null_partial()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8296 Return a Partial that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8297 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8298 test_null_string() *test_null_string()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8299 Return a String that is null. Only useful for testing. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8300 |
| 11160 | 8301 test_override({name}, {val}) *test_override()* |
| 8302 Overrides certain parts of Vims internal processing to be able | |
| 8303 to run tests. Only to be used for testing Vim! | |
| 8304 The override is enabled when {val} is non-zero and removed | |
| 8305 when {val} is zero. | |
| 12785 | 8306 Current supported values for name are: |
| 11160 | 8307 |
| 8308 name effect when {val} is non-zero ~ | |
| 8309 redraw disable the redrawing() function | |
| 8310 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
|
8311 starting reset the "starting" variable, see below |
| 11160 | 8312 ALL clear all overrides ({val} is not used) |
| 8313 | |
|
11587
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
8314 "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
|
8315 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
|
8316 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
|
8317 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
|
8318 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
|
8319 When using: > |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
8320 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
|
8321 < 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
|
8322 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
|
8323 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
8324 test_settime({expr}) *test_settime()* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
8325 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
|
8326 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
|
8327 for undo. |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
8328 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
|
8329 error message. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
8330 {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
|
8331 normal behavior is restored. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8332 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8333 *timer_info()* |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8334 timer_info([{id}]) |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8335 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
|
8336 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
|
8337 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
|
8338 returned. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8339 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
|
8340 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8341 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
|
8342 these items: |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8343 "id" the timer ID |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8344 "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
|
8345 "remaining" time until the timer fires |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8346 "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
|
8347 -1 means forever |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8348 "callback" the callback |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8349 "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
|
8350 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8351 {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
|
8352 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8353 timer_pause({timer}, {paused}) *timer_pause()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8354 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
|
8355 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
|
8356 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
|
8357 has passed. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8358 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8359 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
|
8360 for a short time. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8361 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8362 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
|
8363 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
|
8364 See |non-zero-arg|. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8365 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8366 {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
|
8367 |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
8368 *timer_start()* *timer* *timers* |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8369 timer_start({time}, {callback} [, {options}]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8370 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
|
8371 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8372 {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
|
8373 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
|
8374 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
|
8375 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8376 {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
|
8377 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
|
8378 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
|
8379 waiting for input. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8380 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8381 {options} is a dictionary. Supported entries: |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8382 "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
|
8383 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
|
8384 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
|
8385 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
|
8386 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
|
8387 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
|
8388 messages. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8389 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8390 Example: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8391 func MyHandler(timer) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8392 echo 'Handler called' |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8393 endfunc |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8394 let timer = timer_start(500, 'MyHandler', |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8395 \ {'repeat': 3}) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8396 < 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
|
8397 intervals. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8398 |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8399 {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
|
8400 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
8401 timer_stop({timer}) *timer_stop()* |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
8402 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
|
8403 {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
|
8404 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
|
8405 |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8406 {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
|
8407 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8408 timer_stopall() *timer_stopall()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8409 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
|
8410 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
|
8411 no timers there is no error. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8412 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8413 {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
|
8414 |
| 7 | 8415 tolower({expr}) *tolower()* |
| 8416 The result is a copy of the String given, with all uppercase | |
| 8417 characters turned into lowercase (just like applying |gu| to | |
| 8418 the string). | |
| 8419 | |
| 8420 toupper({expr}) *toupper()* | |
| 8421 The result is a copy of the String given, with all lowercase | |
| 8422 characters turned into uppercase (just like applying |gU| to | |
| 8423 the string). | |
| 8424 | |
| 15 | 8425 tr({src}, {fromstr}, {tostr}) *tr()* |
| 8426 The result is a copy of the {src} string with all characters | |
| 8427 which appear in {fromstr} replaced by the character in that | |
| 8428 position in the {tostr} string. Thus the first character in | |
| 8429 {fromstr} is translated into the first character in {tostr} | |
| 8430 and so on. Exactly like the unix "tr" command. | |
| 8431 This code also deals with multibyte characters properly. | |
| 8432 | |
| 8433 Examples: > | |
| 8434 echo tr("hello there", "ht", "HT") | |
| 8435 < returns "Hello THere" > | |
| 8436 echo tr("<blob>", "<>", "{}") | |
| 8437 < returns "{blob}" | |
| 8438 | |
| 1621 | 8439 trunc({expr}) *trunc()* |
| 1668 | 8440 Return the largest integral value with magnitude less than or |
| 1621 | 8441 equal to {expr} as a |Float| (truncate towards zero). |
| 8442 {expr} must evaluate to a |Float| or a |Number|. | |
| 8443 Examples: > | |
| 8444 echo trunc(1.456) | |
| 8445 < 1.0 > | |
| 8446 echo trunc(-5.456) | |
| 8447 < -5.0 > | |
| 8448 echo trunc(4.0) | |
| 8449 < 4.0 | |
| 8450 {only available when compiled with the |+float| feature} | |
| 12785 | 8451 |
| 87 | 8452 *type()* |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8453 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
|
8454 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
|
8455 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
|
8456 Number: 0 |v:t_number| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8457 String: 1 |v:t_string| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8458 Funcref: 2 |v:t_func| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8459 List: 3 |v:t_list| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8460 Dictionary: 4 |v:t_dict| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8461 Float: 5 |v:t_float| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8462 Boolean: 6 |v:t_bool| (v:false and v:true) |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8463 None 7 |v:t_none| (v:null and v:none) |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8464 Job 8 |v:t_job| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8465 Channel 9 |v:t_channel| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8466 For backward compatibility, this method can be used: > |
| 87 | 8467 :if type(myvar) == type(0) |
| 8468 :if type(myvar) == type("") | |
| 8469 :if type(myvar) == type(function("tr")) | |
| 8470 :if type(myvar) == type([]) | |
| 153 | 8471 :if type(myvar) == type({}) |
| 1621 | 8472 :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
|
8473 :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
|
8474 :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
|
8475 < 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
|
8476 :if exists('v:t_number') |
| 7 | 8477 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8478 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8479 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
|
8480 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
|
8481 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
|
8482 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
8483 {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
|
8484 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
8485 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
|
8486 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
|
8487 Useful in combination with |:wundo| and |:rundo|. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8488 When compiled without the +persistent_undo option this always |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8489 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8490 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8491 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8492 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
|
8493 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8494 "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
|
8495 "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
|
8496 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
|
8497 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
|
8498 "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
|
8499 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
|
8500 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8501 "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
|
8502 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
8503 "save_cur" Number of the current position in the undo |
| 12785 | 8504 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8505 "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
|
8506 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
|
8507 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8508 "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
|
8509 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8510 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8511 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
|
8512 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
|
8513 "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
|
8514 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8515 "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
|
8516 |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
|
8517 "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
|
8518 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
|
8519 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
|
8520 "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
|
8521 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
|
8522 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
|
8523 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
|
8524 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
|
8525 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8526 "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
|
8527 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
|
8528 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
|
8529 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8530 "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
|
8531 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
|
8532 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8533 |
| 5747 | 8534 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 8535 Remove second and succeeding copies of repeated adjacent | |
| 8536 {list} items in-place. Returns {list}. If you want a list | |
| 8537 to remain unmodified make a copy first: > | |
| 8538 :let newlist = uniq(copy(mylist)) | |
| 8539 < The default compare function uses the string representation of | |
| 8540 each item. For the use of {func} and {dict} see |sort()|. | |
| 8541 | |
| 140 | 8542 values({dict}) *values()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8543 Return a |List| with all the values of {dict}. The |List| is |
| 685 | 8544 in arbitrary order. |
| 140 | 8545 |
| 8546 | |
| 7 | 8547 virtcol({expr}) *virtcol()* |
| 8548 The result is a Number, which is the screen column of the file | |
| 8549 position given with {expr}. That is, the last screen position | |
| 8550 occupied by the character at that position, when the screen | |
| 8551 would be of unlimited width. When there is a <Tab> at the | |
| 8552 position, the returned Number will be the column at the end of | |
| 8553 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 8554 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 8555 For the byte position use |col()|. |
| 8556 For the use of {expr} see |col()|. | |
| 8557 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 8558 "off" is the offset in screen columns from the start of the |
| 1266 | 8559 character. E.g., a position within a <Tab> or after the last |
| 2965 | 8560 character. When "off" is omitted zero is used. |
| 7 | 8561 When Virtual editing is active in the current mode, a position |
| 8562 beyond the end of the line can be returned. |'virtualedit'| | |
| 8563 The accepted positions are: | |
| 8564 . the cursor position | |
| 8565 $ the end of the cursor line (the result is the | |
| 8566 number of displayed characters in the cursor line | |
| 8567 plus one) | |
| 8568 'x position of mark x (if the mark is not set, 0 is | |
| 8569 returned) | |
| 6447 | 8570 v In Visual mode: the start of the Visual area (the |
| 8571 cursor is the end). When not in Visual mode | |
| 8572 returns the cursor position. Differs from |'<| in | |
| 8573 that it's updated right away. | |
| 7 | 8574 Note that only marks in the current file can be used. |
| 8575 Examples: > | |
| 8576 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 8577 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 8578 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
|
8579 < The first column is 1. 0 is returned for an error. |
| 1156 | 8580 A more advanced example that echoes the maximum length of |
| 8581 all lines: > | |
| 8582 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 8583 | |
| 7 | 8584 |
| 8585 visualmode([expr]) *visualmode()* | |
| 8586 The result is a String, which describes the last Visual mode | |
| 856 | 8587 used in the current buffer. Initially it returns an empty |
| 8588 string, but once Visual mode has been used, it returns "v", | |
| 8589 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 8590 character-wise, line-wise, or block-wise Visual mode | |
| 8591 respectively. | |
| 7 | 8592 Example: > |
| 8593 :exe "normal " . visualmode() | |
| 8594 < This enters the same Visual mode as before. It is also useful | |
| 8595 in scripts if you wish to act differently depending on the | |
| 8596 Visual mode that was used. | |
| 1621 | 8597 If Visual mode is active, use |mode()| to get the Visual mode |
| 8598 (e.g., in a |:vmap|). | |
| 1661 | 8599 If [expr] is supplied and it evaluates to a non-zero Number or |
| 8600 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
|
8601 the old value is returned. See |non-zero-arg|. |
| 7 | 8602 |
| 4151 | 8603 wildmenumode() *wildmenumode()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
8604 Returns |TRUE| when the wildmenu is active and |FALSE| |
| 4151 | 8605 otherwise. See 'wildmenu' and 'wildmode'. |
| 8606 This can be used in mappings to handle the 'wildcharm' option | |
| 8607 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 8608 | |
| 8609 For example to make <c-j> work like <down> in wildmode, use: > | |
| 8610 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 8611 < | |
| 8612 (Note, this needs the 'wildcharm' option set appropriately). | |
| 8613 | |
| 8614 | |
|
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
8615 win_findbuf({bufnr}) *win_findbuf()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8616 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
|
8617 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
|
8618 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8619 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
|
8620 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
|
8621 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
|
8622 With {win} this is the window number. The top window has |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8623 number 1. Use `win_getid(winnr())` for the current window. |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8624 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
|
8625 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
|
8626 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
|
8627 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8628 win_gotoid({expr}) *win_gotoid()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8629 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
|
8630 tabpage. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8631 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
|
8632 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8633 win_id2tabwin({expr}) *win_id2tabwin()* |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8634 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
|
8635 with ID {expr}: [tabnr, winnr]. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8636 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
|
8637 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8638 win_id2win({expr}) *win_id2win()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8639 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
|
8640 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
|
8641 |
|
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
|
8642 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
|
8643 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
|
8644 numbers: [row, col]. The first window always has position |
|
2d817fd289ba
patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
8645 [1, 1]. |
|
2d817fd289ba
patch 8.0.1364: there is no easy way to get the window position
Christian Brabandt <cb@256bit.org>
parents:
12968
diff
changeset
|
8646 {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
|
8647 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
|
8648 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
|
8649 |
| 7 | 8650 *winbufnr()* |
| 8651 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
|
8652 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
|
8653 the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8654 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
|
8655 window is returned. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8656 When window {nr} doesn't exist, -1 is returned. |
| 7 | 8657 Example: > |
| 8658 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 8659 < | |
| 8660 *wincol()* | |
| 8661 wincol() The result is a Number, which is the virtual column of the | |
| 8662 cursor in the window. This is counting screen cells from the | |
| 8663 left side of the window. The leftmost column is one. | |
| 8664 | |
| 8665 winheight({nr}) *winheight()* | |
| 8666 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
|
8667 {nr} can be the window number or the |window-ID|. |
| 7 | 8668 When {nr} is zero, the height of the current window is |
| 8669 returned. When window {nr} doesn't exist, -1 is returned. | |
| 8670 An existing window always has a height of zero or more. | |
| 12499 | 8671 This excludes any window toolbar line. |
| 7 | 8672 Examples: > |
| 8673 :echo "The current window has " . winheight(0) . " lines." | |
| 8674 < | |
| 8675 *winline()* | |
| 8676 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
|
8677 in the window. This is counting screen lines from the top of |
| 7 | 8678 the window. The first line is one. |
| 531 | 8679 If the cursor was moved the view on the file will be updated |
| 8680 first, this may cause a scroll. | |
| 7 | 8681 |
| 8682 *winnr()* | |
| 20 | 8683 winnr([{arg}]) The result is a Number, which is the number of the current |
| 8684 window. The top window has number 1. | |
| 8685 When the optional argument is "$", the number of the | |
| 3967 | 8686 last window is returned (the window count). > |
| 8687 let window_count = winnr('$') | |
| 8688 < When the optional argument is "#", the number of the last | |
| 20 | 8689 accessed window is returned (where |CTRL-W_p| goes to). |
| 1156 | 8690 If there is no previous window or it is in another tab page 0 |
| 8691 is returned. | |
| 20 | 8692 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 8693 |:wincmd|. | |
| 10734 | 8694 Also see |tabpagewinnr()| and |win_getid()|. |
| 7 | 8695 |
| 8696 *winrestcmd()* | |
| 8697 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 8698 the current window sizes. Only works properly when no windows | |
| 712 | 8699 are opened or closed and the current window and tab page is |
| 8700 unchanged. | |
| 7 | 8701 Example: > |
| 8702 :let cmd = winrestcmd() | |
| 8703 :call MessWithWindowSizes() | |
| 8704 :exe cmd | |
| 712 | 8705 < |
| 8706 *winrestview()* | |
| 8707 winrestview({dict}) | |
| 8708 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 8709 the view of the current window. | |
| 5940 | 8710 Note: The {dict} does not have to contain all values, that are |
| 8711 returned by |winsaveview()|. If values are missing, those | |
| 8712 settings won't be restored. So you can use: > | |
| 8713 :call winrestview({'curswant': 4}) | |
| 8714 < | |
| 8715 This will only set the curswant value (the column the cursor | |
| 8716 wants to move on vertical movements) of the cursor to column 5 | |
| 8717 (yes, that is 5), while all other settings will remain the | |
| 8718 same. This is useful, if you set the cursor position manually. | |
| 8719 | |
| 712 | 8720 If you have changed the values the result is unpredictable. |
| 8721 If the window size changed the result won't be the same. | |
| 8722 | |
| 8723 *winsaveview()* | |
| 8724 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 8725 the view of the current window. Use |winrestview()| to | |
| 8726 restore the view. | |
| 8727 This is useful if you have a mapping that jumps around in the | |
| 8728 buffer and you want to go back to the original view. | |
| 8729 This does not save fold information. Use the 'foldenable' | |
| 798 | 8730 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
|
8731 not opened when moving around. This may have side effects. |
| 712 | 8732 The return value includes: |
| 8733 lnum cursor line number | |
| 5940 | 8734 col cursor column (Note: the first column |
| 8735 zero, as opposed to what getpos() | |
| 8736 returns) | |
| 712 | 8737 coladd cursor column offset for 'virtualedit' |
| 8738 curswant column for vertical movement | |
| 8739 topline first line in the window | |
| 8740 topfill filler lines, only in diff mode | |
| 8741 leftcol first column displayed | |
| 8742 skipcol columns skipped | |
| 8743 Note that no option values are saved. | |
| 8744 | |
| 7 | 8745 |
| 8746 winwidth({nr}) *winwidth()* | |
| 8747 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
|
8748 {nr} can be the window number or the |window-ID|. |
| 7 | 8749 When {nr} is zero, the width of the current window is |
| 8750 returned. When window {nr} doesn't exist, -1 is returned. | |
| 8751 An existing window always has a width of zero or more. | |
| 8752 Examples: > | |
| 8753 :echo "The current window has " . winwidth(0) . " columns." | |
| 8754 :if winwidth(0) <= 50 | |
|
12857
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
8755 : 50 wincmd | |
| 7 | 8756 :endif |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
8757 < 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
|
8758 option. |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
8759 |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
8760 |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8761 wordcount() *wordcount()* |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8762 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
|
8763 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
|
8764 |g_CTRL-G| |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8765 The return value includes: |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8766 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
|
8767 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
|
8768 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
|
8769 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
|
8770 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8771 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
|
8772 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8773 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
|
8774 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8775 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
|
8776 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8777 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
|
8778 (only in Visual mode) |
| 12254 | 8779 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
|
8780 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8781 |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
8782 |
| 158 | 8783 *writefile()* |
| 6341 | 8784 writefile({list}, {fname} [, {flags}]) |
| 685 | 8785 Write |List| {list} to file {fname}. Each list item is |
| 158 | 8786 separated with a NL. Each list item must be a String or |
| 8787 Number. | |
| 6341 | 8788 When {flags} contains "b" then binary mode is used: There will |
| 158 | 8789 not be a NL after the last list item. An empty item at the |
| 8790 end does cause the last line in the file to end in a NL. | |
| 6341 | 8791 |
| 8792 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
|
8793 appended to the file: > |
| 6341 | 8794 :call writefile(["foo"], "event.log", "a") |
| 8795 :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
|
8796 < |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
8797 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
|
8798 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
|
8799 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
|
8800 crashes. |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
8801 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
|
8802 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
|
8803 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
|
8804 when 'fsync' is set. |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
8805 |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
8806 All NL characters are replaced with a NUL character. |
| 158 | 8807 Inserting CR characters needs to be done before passing {list} |
| 8808 to writefile(). | |
| 8809 An existing file is overwritten, if possible. | |
| 8810 When the write fails -1 is returned, otherwise 0. There is an | |
| 8811 error message if the file can't be created or when writing | |
| 8812 fails. | |
| 8813 Also see |readfile()|. | |
| 8814 To copy a file byte for byte: > | |
| 8815 :let fl = readfile("foo", "b") | |
| 8816 :call writefile(fl, "foocopy", "b") | |
| 3214 | 8817 |
| 8818 | |
| 8819 xor({expr}, {expr}) *xor()* | |
| 8820 Bitwise XOR on the two arguments. The arguments are converted | |
| 8821 to a number. A List, Dict or Float argument causes an error. | |
| 8822 Example: > | |
| 8823 :let bits = xor(bits, 0x80) | |
| 3256 | 8824 < |
| 3214 | 8825 |
| 7 | 8826 |
| 8827 *feature-list* | |
| 6009 | 8828 There are four types of features: |
| 7 | 8829 1. Features that are only supported when they have been enabled when Vim |
| 8830 was compiled |+feature-list|. Example: > | |
| 8831 :if has("cindent") | |
| 8832 2. Features that are only supported when certain conditions have been met. | |
| 8833 Example: > | |
| 8834 :if has("gui_running") | |
| 8835 < *has-patch* | |
| 5814 | 8836 3. Included patches. The "patch123" feature means that patch 123 has been |
| 8837 included. Note that this form does not check the version of Vim, you need | |
| 8838 to inspect |v:version| for that. | |
| 8839 Example (checking version 6.2.148 or later): > | |
| 7 | 8840 :if v:version > 602 || v:version == 602 && has("patch148") |
| 5814 | 8841 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 8842 included. | |
| 8843 | |
| 8844 4. Beyond a certain version or at a certain version and including a specific | |
| 5862 | 8845 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
| 8846 later, or it is version 7.4 and patch 237 was included. | |
| 8847 Note that this only works for patch 7.4.237 and later, before that you | |
| 8848 need to use the example above that checks v:version. Example: > | |
| 8849 :if has("patch-7.4.248") | |
| 5814 | 8850 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 1156 | 8851 included. |
| 7 | 8852 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8853 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
|
8854 use: `if exists('+shellslash')` |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8855 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
8856 |
| 5340 | 8857 acl Compiled with |ACL| support. |
| 7 | 8858 all_builtin_terms Compiled with all builtin terminals enabled. |
| 8859 amiga Amiga version of Vim. | |
| 8860 arabic Compiled with Arabic support |Arabic|. | |
| 8861 arp Compiled with ARP support (Amiga). | |
| 613 | 8862 autocmd Compiled with autocommand support. |autocommand| |
|
12837
963cdeb42c41
patch 8.0.1295: cannot automatically get a server name in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
8863 autoservername Automatically enable |clientserver| |
| 7 | 8864 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 8865 balloon_multiline GUI supports multiline balloons. |
| 7 | 8866 beos BeOS version of Vim. |
| 8867 browse Compiled with |:browse| support, and browse() will | |
| 8868 work. | |
| 3682 | 8869 browsefilter Compiled with support for |browsefilter|. |
| 7 | 8870 builtin_terms Compiled with some builtin terminals. |
| 8871 byte_offset Compiled with support for 'o' in 'statusline' | |
| 8872 cindent Compiled with 'cindent' support. | |
| 8873 clientserver Compiled with remote invocation support |clientserver|. | |
| 8874 clipboard Compiled with 'clipboard' support. | |
| 8875 cmdline_compl Compiled with |cmdline-completion| support. | |
| 8876 cmdline_hist Compiled with |cmdline-history| support. | |
| 8877 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 8878 comments Compiled with |'comments'| support. | |
| 2681 | 8879 compatible Compiled to be very Vi compatible. |
| 7 | 8880 cryptv Compiled with encryption support |encryption|. |
| 8881 cscope Compiled with |cscope| support. | |
| 8882 debug Compiled with "DEBUG" defined. | |
| 8883 dialog_con Compiled with console dialog support. | |
| 8884 dialog_gui Compiled with GUI dialog support. | |
| 8885 diff Compiled with |vimdiff| and 'diff' support. | |
| 8886 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
|
8887 directx Compiled with support for DirectX and 'renderoptions'. |
| 7 | 8888 dnd Compiled with support for the "~ register |quote_~|. |
| 8889 ebcdic Compiled on a machine with ebcdic character set. | |
| 8890 emacs_tags Compiled with support for Emacs tags. | |
| 8891 eval Compiled with expression evaluation support. Always | |
| 8892 true, of course! | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7788
diff
changeset
|
8893 ex_extra |+ex_extra|, always true now |
| 7 | 8894 extra_search Compiled with support for |'incsearch'| and |
| 8895 |'hlsearch'| | |
| 8896 farsi Compiled with Farsi support |farsi|. | |
| 8897 file_in_path Compiled with support for |gf| and |<cfile>| | |
| 168 | 8898 filterpipe When 'shelltemp' is off pipes are used for shell |
| 8899 read/write/filter commands | |
| 7 | 8900 find_in_path Compiled with support for include file searches |
| 8901 |+find_in_path|. | |
| 1621 | 8902 float Compiled with support for |Float|. |
| 7 | 8903 fname_case Case in file names matters (for Amiga, MS-DOS, and |
| 8904 Windows this is not present). | |
| 8905 folding Compiled with |folding| support. | |
| 8906 footer Compiled with GUI footer support. |gui-footer| | |
| 8907 fork Compiled to use fork()/exec() instead of system(). | |
| 8908 gettext Compiled with message translation |multi-lang| | |
| 8909 gui Compiled with GUI enabled. | |
| 8910 gui_athena Compiled with Athena GUI. | |
| 2681 | 8911 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 8912 gui_gtk Compiled with GTK+ GUI (any version). |
| 8913 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
|
8914 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
| 7 | 8915 gui_mac Compiled with Macintosh GUI. |
| 8916 gui_motif Compiled with Motif GUI. | |
| 8917 gui_photon Compiled with Photon GUI. | |
| 2681 | 8918 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 8919 gui_win32 Compiled with MS Windows Win32 GUI. |
| 8920 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
| 8921 hangul_input Compiled with Hangul input support. |hangul| | |
| 8922 iconv Can use iconv() for conversion. | |
| 8923 insert_expand Compiled with support for CTRL-X expansion commands in | |
| 8924 Insert mode. | |
| 8925 jumplist Compiled with |jumplist| support. | |
| 8926 keymap Compiled with 'keymap' support. | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
8927 lambda Compiled with |lambda| support. |
| 7 | 8928 langmap Compiled with 'langmap' support. |
| 8929 libcall Compiled with |libcall()| support. | |
| 5995 | 8930 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 8931 'breakindent' support. | |
| 7 | 8932 lispindent Compiled with support for lisp indenting. |
| 8933 listcmds Compiled with commands for the buffer list |:files| | |
| 8934 and the argument list |arglist|. | |
| 8935 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
|
8936 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
|
8937 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
|
8938 macunix Synonym for osxdarwin |
| 7 | 8939 menu Compiled with support for |:menu|. |
| 8940 mksession Compiled with support for |:mksession|. | |
| 8941 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
| 8942 mouse Compiled with support mouse. | |
| 8943 mouse_dec Compiled with support for Dec terminal mouse. | |
| 8944 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
| 8945 mouse_netterm Compiled with support for netterm mouse. | |
| 8946 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 8947 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 8948 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 8949 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 8950 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 8951 mouseshape Compiled with support for 'mouseshape'. |
| 1768 | 8952 multi_byte Compiled with support for 'encoding' |
| 8953 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
| 7 | 8954 multi_byte_ime Compiled with support for IME input method. |
| 8955 multi_lang Compiled with support for multiple languages. | |
| 14 | 8956 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 8957 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 8958 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
|
8959 num64 Compiled with 64-bit |Number| support. |
| 7 | 8960 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
|
8961 osx Compiled for macOS cf. mac |
|
351cf7c67bbe
patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents:
12632
diff
changeset
|
8962 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
|
8963 packages Compiled with |packages| support. |
| 7 | 8964 path_extra Compiled with up/downwards search in 'path' and 'tags' |
| 8965 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
|
8966 persistent_undo Compiled with support for persistent undo history. |
| 7 | 8967 postscript Compiled with PostScript file printing. |
| 8968 printer Compiled with |:hardcopy| support. | |
| 170 | 8969 profile Compiled with |:profile| support. |
| 2826 | 8970 python Compiled with Python 2.x interface. |has-python| |
| 8971 python3 Compiled with Python 3.x interface. |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
|
8972 pythonx Compiled with |python_x| interface. |has-pythonx| |
| 7 | 8973 qnx QNX version of Vim. |
| 8974 quickfix Compiled with |quickfix| support. | |
| 857 | 8975 reltime Compiled with |reltime()| support. |
| 7 | 8976 rightleft Compiled with 'rightleft' support. |
| 8977 ruby Compiled with Ruby interface |ruby|. | |
| 8978 scrollbind Compiled with 'scrollbind' support. | |
| 8979 showcmd Compiled with 'showcmd' support. | |
| 8980 signs Compiled with |:sign| support. | |
| 8981 smartindent Compiled with 'smartindent' support. | |
| 2681 | 8982 spell Compiled with spell checking support |spell|. |
| 1989 | 8983 startuptime Compiled with |--startuptime| support. |
| 7 | 8984 statusline Compiled with support for 'statusline', 'rulerformat' |
| 8985 and special formats of 'titlestring' and 'iconstring'. | |
| 8986 sun_workshop Compiled with support for Sun |workshop|. | |
| 314 | 8987 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 8988 syntax_items There are active syntax highlighting items for the |
| 8989 current buffer. | |
| 8990 system Compiled to use system() instead of fork()/exec(). | |
| 8991 tag_binary Compiled with binary searching in tags files | |
| 8992 |tag-binary-search|. | |
| 8993 tag_old_static Compiled with support for old static tags | |
| 8994 |tag-old-static|. | |
| 8995 tag_any_white Compiled with support for any white characters in tags | |
| 8996 files |tag-any-white|. | |
| 8997 tcl Compiled with Tcl interface. | |
|
9076
9305a1251e51
commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
8998 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
|
8999 terminal Compiled with |terminal| support. |
| 7 | 9000 terminfo Compiled with terminfo instead of termcap. |
| 9001 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 9002 textobjects Compiled with support for |text-objects|. | |
| 9003 tgetent Compiled with tgetent support, able to use a termcap | |
| 9004 or terminfo file. | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9005 timers Compiled with |timer_start()| support. |
| 7 | 9006 title Compiled with window title support |'title'|. |
| 9007 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
|
9008 ttyin input is a terminal (tty) |
|
65e0537a4560
commit https://github.com/vim/vim/commit/2cab0e191055a8145ccd46cd52869fbb9798b971
Christian Brabandt <cb@256bit.org>
parents:
10348
diff
changeset
|
9009 ttyout output is a terminal (tty) |
| 12499 | 9010 unix Unix version of Vim. *+unix* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9011 unnamedplus Compiled with support for "unnamedplus" in 'clipboard' |
| 7 | 9012 user_commands User-defined commands. |
| 2681 | 9013 vertsplit Compiled with vertically split windows |:vsplit|. |
| 2581 | 9014 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
|
9015 *vim_starting* |
| 2681 | 9016 viminfo Compiled with viminfo support. |
| 7 | 9017 virtualedit Compiled with 'virtualedit' option. |
| 9018 visual Compiled with Visual mode. | |
| 9019 visualextra Compiled with extra Visual mode commands. | |
| 9020 |blockwise-operators|. | |
| 9021 vms VMS version of Vim. | |
| 9022 vreplace Compiled with |gR| and |gr| commands. | |
| 9023 wildignore Compiled with 'wildignore' option. | |
| 9024 wildmenu Compiled with 'wildmenu' option. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
9025 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
|
9026 64 bits) |
| 2681 | 9027 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 9028 win64 Win64 version of Vim (MS-Windows 64 bit). |
| 9029 win95 Win32 version for MS-Windows 95/98/ME. | |
| 2681 | 9030 winaltkeys Compiled with 'winaltkeys' option. |
| 9031 windows Compiled with support for more than one window. | |
| 7 | 9032 writebackup Compiled with 'writebackup' default on. |
| 9033 xfontset Compiled with X fontset support |xfontset|. | |
| 9034 xim Compiled with X input method support |xim|. | |
| 5340 | 9035 xpm Compiled with pixmap support. |
| 9036 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 9037 backward compatibility. Use "xpm" instead.) | |
| 7 | 9038 xsmp Compiled with X session management support. |
| 9039 xsmp_interact Compiled with interactive X session management support. | |
| 9040 xterm_clipboard Compiled with support for xterm clipboard. | |
| 9041 xterm_save Compiled with support for saving and restoring the | |
| 9042 xterm screen. | |
| 9043 x11 Compiled with X11 support. | |
| 9044 | |
| 9045 *string-match* | |
| 9046 Matching a pattern in a String | |
| 9047 | |
| 9048 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 9049 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 9050 everything works in the same way. The difference is that a String is handled | |
| 9051 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 9052 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 9053 with ".". Example: > | |
| 9054 :let a = "aaaa\nxxxx" | |
| 9055 :echo matchstr(a, "..\n..") | |
| 9056 aa | |
| 9057 xx | |
| 9058 :echo matchstr(a, "a.x") | |
| 9059 a | |
| 9060 x | |
| 9061 | |
| 9062 Don't forget that "^" will only match at the first character of the String and | |
| 9063 "$" at the last character of the string. They don't match after or before a | |
| 9064 "\n". | |
| 9065 | |
| 9066 ============================================================================== | |
| 9067 5. Defining functions *user-functions* | |
| 9068 | |
| 9069 New functions can be defined. These can be called just like builtin | |
| 9070 functions. The function executes a sequence of Ex commands. Normal mode | |
| 9071 commands can be executed with the |:normal| command. | |
| 9072 | |
| 9073 The function name must start with an uppercase letter, to avoid confusion with | |
| 9074 builtin functions. To prevent from using the same name in different scripts | |
| 9075 avoid obvious, short names. A good habit is to start the function name with | |
| 9076 the name of the script, e.g., "HTMLcolor()". | |
| 9077 | |
| 504 | 9078 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 9079 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 9080 |
| 9081 *local-function* | |
| 9082 A function local to a script must start with "s:". A local script function | |
| 9083 can only be called from within the script and from functions, user commands | |
| 9084 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 9085 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 9086 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 9087 There are only script-local functions, no buffer-local or window-local |
| 9088 functions. | |
| 7 | 9089 |
| 9090 *:fu* *:function* *E128* *E129* *E123* | |
| 9091 :fu[nction] List all functions and their arguments. | |
| 9092 | |
| 9093 :fu[nction] {name} List function {name}. | |
| 685 | 9094 {name} can also be a |Dictionary| entry that is a |
| 9095 |Funcref|: > | |
| 114 | 9096 :function dict.init |
| 504 | 9097 |
| 9098 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 9099 Example that lists all functions ending with "File": > | |
| 9100 :function /File$ | |
| 482 | 9101 < |
| 9102 *:function-verbose* | |
| 9103 When 'verbose' is non-zero, listing a function will also display where it was | |
| 9104 last defined. Example: > | |
| 9105 | |
| 9106 :verbose function SetFileTypeSH | |
| 9107 function SetFileTypeSH(name) | |
| 9108 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 9109 < | |
| 484 | 9110 See |:verbose-cmd| for more information. |
| 482 | 9111 |
| 5862 | 9112 *E124* *E125* *E853* *E884* |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9113 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9114 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
|
9115 the function follows in the next lines, until the |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9116 matching |:endfunction|. |
| 12785 | 9117 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9118 The name must be made of alphanumeric characters and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9119 '_', and must start with a capital or "s:" (see |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9120 above). Note that using "b:" or "g:" is not allowed. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9121 (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
|
9122 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
|
9123 Before that patch no error was given). |
| 114 | 9124 |
| 685 | 9125 {name} can also be a |Dictionary| entry that is a |
| 9126 |Funcref|: > | |
| 114 | 9127 :function dict.init(arg) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9128 < "dict" must be an existing dictionary. The entry |
| 114 | 9129 "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
|
9130 is required to overwrite an existing function. The |
| 114 | 9131 result is a |Funcref| to a numbered function. The |
| 9132 function can only be used with a |Funcref| and will be | |
| 9133 deleted if there are no more references to it. | |
| 7 | 9134 *E127* *E122* |
| 9135 When a function by this name already exists and [!] is | |
| 9136 not used an error message is given. When [!] is used, | |
| 9137 an existing function is silently replaced. Unless it | |
| 9138 is currently being executed, that 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
|
9139 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
|
9140 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
|
9141 which is hard to debug. |
| 133 | 9142 |
| 9143 For the {arguments} see |function-argument|. | |
| 9144 | |
| 5618 | 9145 *:func-range* *a:firstline* *a:lastline* |
| 7 | 9146 When the [range] argument is added, the function is |
| 9147 expected to take care of a range itself. The range is | |
| 9148 passed as "a:firstline" and "a:lastline". If [range] | |
| 9149 is excluded, ":{range}call" will call the function for | |
| 9150 each line in the range, with the cursor on the start | |
| 9151 of each line. See |function-range-example|. | |
| 3967 | 9152 The cursor is still moved to the first line of the |
| 9153 range, as is the case with all Ex commands. | |
| 5618 | 9154 *:func-abort* |
| 7 | 9155 When the [abort] argument is added, the function will |
| 9156 abort as soon as an error is detected. | |
| 5618 | 9157 *:func-dict* |
| 102 | 9158 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
|
9159 be invoked through an entry in a |Dictionary|. The |
| 102 | 9160 local variable "self" will then be set to the |
| 9161 dictionary. See |Dictionary-function|. | |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9162 *:func-closure* *E932* |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9163 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
|
9164 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
|
9165 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
|
9166 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
|
9167 remains referenced even after Foo() returns: > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9168 :function! Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9169 : let x = 0 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9170 : function! Bar() closure |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9171 : let x += 1 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9172 : return x |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9173 : endfunction |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
9174 : return funcref('Bar') |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9175 :endfunction |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9176 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9177 :let F = Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9178 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9179 < 1 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9180 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9181 < 2 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9182 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9183 < 3 |
| 7 | 9184 |
| 1621 | 9185 *function-search-undo* |
| 653 | 9186 The last used search pattern and the redo command "." |
| 1621 | 9187 will not be changed by the function. This also |
| 9188 implies that the effect of |:nohlsearch| is undone | |
| 9189 when the function returns. | |
| 653 | 9190 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
9191 *: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
|
9192 :endf[unction] [argument] |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9193 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
|
9194 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
|
9195 |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9196 [argument] can be: |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9197 | 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
|
9198 \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
|
9199 " 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
|
9200 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
|
9201 '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
|
9202 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
|
9203 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
|
9204 ignored. |
| 7 | 9205 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
9206 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
|
9207 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
|
9208 :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
|
9209 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
9210 *: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
|
9211 :delf[unction][!] {name} |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9212 Delete function {name}. |
| 685 | 9213 {name} can also be a |Dictionary| entry that is a |
| 9214 |Funcref|: > | |
| 114 | 9215 :delfunc dict.init |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9216 < This will remove the "init" entry from "dict". The |
| 114 | 9217 function is deleted if there are no more references to |
| 9218 it. | |
|
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9219 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
|
9220 exist. |
| 7 | 9221 *:retu* *:return* *E133* |
| 9222 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 9223 evaluated and returned as the result of the function. | |
| 9224 If "[expr]" is not given, the number 0 is returned. | |
| 9225 When a function ends without an explicit ":return", | |
| 9226 the number 0 is returned. | |
| 9227 Note that there is no check for unreachable lines, | |
| 9228 thus there is no warning if commands follow ":return". | |
| 9229 | |
| 9230 If the ":return" is used after a |:try| but before the | |
| 9231 matching |:finally| (if present), the commands | |
| 9232 following the ":finally" up to the matching |:endtry| | |
| 9233 are executed first. This process applies to all | |
| 9234 nested ":try"s inside the function. The function | |
| 9235 returns at the outermost ":endtry". | |
| 9236 | |
| 133 | 9237 *function-argument* *a:var* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9238 An argument can be defined by giving its name. In the function this can then |
| 133 | 9239 be used as "a:name" ("a:" for argument). |
| 1156 | 9240 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 9241 Up to 20 arguments can be given, separated by commas. After the named |
| 9242 arguments an argument "..." can be specified, which means that more arguments | |
| 9243 may optionally be following. In the function the extra arguments can be used | |
| 9244 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 9245 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 9246 that "a:1" is the same as "a:000[0]". | |
| 148 | 9247 *E742* |
| 9248 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
|
9249 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
|
9250 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
|
9251 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
|
9252 change a |List| or |Dictionary| use |:lockvar|. |
| 133 | 9253 |
| 9254 When not using "...", the number of arguments in a function call must be equal | |
| 9255 to the number of named arguments. When using "...", the number of arguments | |
| 9256 may be larger. | |
| 9257 | |
| 9258 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
|
9259 still supply the () then. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9260 |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9261 It is allowed to define another function inside a function |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9262 body. |
| 133 | 9263 |
| 9264 *local-variables* | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
9265 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
|
9266 function returns. Global variables need to be accessed with "g:". |
| 7 | 9267 |
| 9268 Example: > | |
| 9269 :function Table(title, ...) | |
| 9270 : echohl Title | |
| 9271 : echo a:title | |
| 9272 : echohl None | |
| 140 | 9273 : echo a:0 . " items:" |
| 9274 : for s in a:000 | |
| 9275 : echon ' ' . s | |
| 9276 : endfor | |
| 7 | 9277 :endfunction |
| 9278 | |
| 9279 This function can then be called with: > | |
| 140 | 9280 call Table("Table", "line1", "line2") |
| 9281 call Table("Empty Table") | |
| 7 | 9282 |
| 1156 | 9283 To return more than one value, return a |List|: > |
| 9284 :function Compute(n1, n2) | |
| 7 | 9285 : if a:n2 == 0 |
| 1156 | 9286 : return ["fail", 0] |
| 7 | 9287 : endif |
| 1156 | 9288 : return ["ok", a:n1 / a:n2] |
| 7 | 9289 :endfunction |
| 9290 | |
| 9291 This function can then be called with: > | |
| 1156 | 9292 :let [success, div] = Compute(102, 6) |
| 7 | 9293 :if success == "ok" |
| 9294 : echo div | |
| 9295 :endif | |
| 1156 | 9296 < |
| 786 | 9297 *:cal* *:call* *E107* *E117* |
| 7 | 9298 :[range]cal[l] {name}([arguments]) |
| 9299 Call a function. The name of the function and its arguments | |
| 9300 are as specified with |:function|. Up to 20 arguments can be | |
| 1156 | 9301 used. The returned value is discarded. |
| 7 | 9302 Without a range and for functions that accept a range, the |
| 9303 function is called once. When a range is given the cursor is | |
| 9304 positioned at the start of the first line before executing the | |
| 9305 function. | |
| 9306 When a range is given and the function doesn't handle it | |
| 9307 itself, the function is executed for each line in the range, | |
| 9308 with the cursor in the first column of that line. The cursor | |
| 9309 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
|
9310 call). The arguments are re-evaluated for each line. Thus |
| 7 | 9311 this works: |
| 9312 *function-range-example* > | |
| 9313 :function Mynumber(arg) | |
| 9314 : echo line(".") . " " . a:arg | |
| 9315 :endfunction | |
| 9316 :1,5call Mynumber(getline(".")) | |
| 9317 < | |
| 9318 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 9319 can be used to do something different at the start or end of | |
| 9320 the range. | |
| 9321 | |
| 9322 Example of a function that handles the range itself: > | |
| 9323 | |
| 9324 :function Cont() range | |
| 9325 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 9326 :endfunction | |
| 9327 :4,8call Cont() | |
| 9328 < | |
| 9329 This function inserts the continuation character "\" in front | |
| 9330 of all the lines in the range, except the first one. | |
| 9331 | |
| 1156 | 9332 When the function returns a composite value it can be further |
| 9333 dereferenced, but the range will not be used then. Example: > | |
| 9334 :4,8call GetDict().method() | |
| 9335 < Here GetDict() gets the range but method() does not. | |
| 9336 | |
| 7 | 9337 *E132* |
| 9338 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 9339 option. | |
| 9340 | |
| 161 | 9341 |
| 9342 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 9343 *autoload-functions* |
| 9344 When using many or large functions, it's possible to automatically define them | |
| 161 | 9345 only when they are used. There are two methods: with an autocommand and with |
| 9346 the "autoload" directory in 'runtimepath'. | |
| 9347 | |
| 9348 | |
| 9349 Using an autocommand ~ | |
| 9350 | |
| 170 | 9351 This is introduced in the user manual, section |41.14|. |
| 9352 | |
| 161 | 9353 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 9354 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
|
9355 That makes Vim startup faster. The autocommand should then load the same file |
| 161 | 9356 again, setting a variable to skip the |:finish| command. |
| 9357 | |
| 9358 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 9359 function(s) to be defined. Example: > | |
| 7 | 9360 |
| 9361 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 9362 | |
| 9363 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 9364 "BufNet". Also see |FuncUndefined|. | |
| 9365 | |
| 161 | 9366 |
| 9367 Using an autoload script ~ | |
| 168 | 9368 *autoload* *E746* |
| 170 | 9369 This is introduced in the user manual, section |41.15|. |
| 9370 | |
| 161 | 9371 Using a script in the "autoload" directory is simpler, but requires using |
| 9372 exactly the right file name. A function that can be autoloaded has a name | |
| 9373 like this: > | |
| 9374 | |
| 270 | 9375 :call filename#funcname() |
| 161 | 9376 |
| 9377 When such a function is called, and it is not defined yet, Vim will search the | |
| 9378 "autoload" directories in 'runtimepath' for a script file called | |
| 9379 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 9380 then define the function like this: > | |
| 9381 | |
| 270 | 9382 function filename#funcname() |
| 161 | 9383 echo "Done!" |
| 9384 endfunction | |
| 9385 | |
| 530 | 9386 The file name and the name used before the # in the function must match |
| 161 | 9387 exactly, and the defined function must have the name exactly as it will be |
| 9388 called. | |
| 9389 | |
| 270 | 9390 It is possible to use subdirectories. Every # in the function name works like |
| 9391 a path separator. Thus when calling a function: > | |
| 9392 | |
| 9393 :call foo#bar#func() | |
| 161 | 9394 |
| 9395 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 9396 | |
| 168 | 9397 This also works when reading a variable that has not been set yet: > |
| 9398 | |
| 270 | 9399 :let l = foo#bar#lvar |
| 168 | 9400 |
| 557 | 9401 However, when the autoload script was already loaded it won't be loaded again |
| 9402 for an unknown variable. | |
| 9403 | |
| 168 | 9404 When assigning a value to such a variable nothing special happens. This can |
| 9405 be used to pass settings to the autoload script before it's loaded: > | |
| 9406 | |
| 270 | 9407 :let foo#bar#toggle = 1 |
| 9408 :call foo#bar#func() | |
| 168 | 9409 |
| 164 | 9410 Note that when you make a mistake and call a function that is supposed to be |
| 9411 defined in an autoload script, but the script doesn't actually define the | |
| 9412 function, the script will be sourced every time you try to call the function. | |
| 168 | 9413 And you will get an error message every time. |
| 9414 | |
| 9415 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 9416 other and vice versa, before the used function is defined, it won't work. |
| 168 | 9417 Avoid using the autoload functionality at the toplevel. |
| 161 | 9418 |
| 794 | 9419 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 9420 |vimball| utility. Also read the user manual |distribute-script|. | |
| 9421 | |
| 7 | 9422 ============================================================================== |
| 9423 6. Curly braces names *curly-braces-names* | |
| 9424 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9425 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
|
9426 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
|
9427 wrapped in braces {} like this: > |
| 7 | 9428 my_{adjective}_variable |
| 9429 | |
| 9430 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 9431 that in place of the expression, and re-interprets the whole as a variable | |
| 9432 name. So in the above example, if the variable "adjective" was set to | |
| 9433 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 9434 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 9435 | |
| 9436 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
|
9437 value. For example, the statement > |
| 7 | 9438 echo my_{&background}_message |
| 9439 | |
| 9440 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 9441 on the current value of 'background'. | |
| 9442 | |
| 9443 You can use multiple brace pairs: > | |
| 9444 echo my_{adverb}_{adjective}_message | |
| 9445 ..or even nest them: > | |
| 9446 echo my_{ad{end_of_word}}_message | |
| 9447 where "end_of_word" is either "verb" or "jective". | |
| 9448 | |
| 9449 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 9450 variable name, e.g. this is invalid: > |
| 7 | 9451 :let foo='a + b' |
| 9452 :echo c{foo}d | |
| 9453 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 9454 | |
| 9455 *curly-braces-function-names* | |
| 9456 You can call and define functions by an evaluated name in a similar way. | |
| 9457 Example: > | |
| 9458 :let func_end='whizz' | |
| 9459 :call my_func_{func_end}(parameter) | |
| 9460 | |
| 9461 This would call the function "my_func_whizz(parameter)". | |
| 9462 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9463 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9464 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9465 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9466 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9467 |
| 7 | 9468 ============================================================================== |
| 9469 7. Commands *expression-commands* | |
| 9470 | |
| 9471 :let {var-name} = {expr1} *:let* *E18* | |
| 9472 Set internal variable {var-name} to the result of the | |
| 9473 expression {expr1}. The variable will get the type | |
| 9474 from the {expr}. If {var-name} didn't exist yet, it | |
| 9475 is created. | |
| 9476 | |
| 85 | 9477 :let {var-name}[{idx}] = {expr1} *E689* |
| 9478 Set a list item to the result of the expression | |
| 9479 {expr1}. {var-name} must refer to a list and {idx} | |
| 9480 must be a valid index in that list. For nested list | |
| 9481 the index can be repeated. | |
| 1621 | 9482 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
|
9483 This cannot be used to set a byte in a String. You |
| 1621 | 9484 can do that like this: > |
| 9485 :let var = var[0:2] . 'X' . var[4:] | |
| 9486 < | |
| 114 | 9487 *E711* *E719* |
| 9488 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 9489 Set a sequence of items in a |List| to the result of |
| 9490 the expression {expr1}, which must be a list with the | |
| 87 | 9491 correct number of items. |
| 9492 {idx1} can be omitted, zero is used instead. | |
| 9493 {idx2} can be omitted, meaning the end of the list. | |
| 9494 When the selected range of items is partly past the | |
| 9495 end of the list, items will be added. | |
| 9496 | |
| 153 | 9497 *:let+=* *:let-=* *:let.=* *E734* |
| 114 | 9498 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 9499 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
| 9500 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
| 9501 These fail if {var} was not set yet and when the type | |
| 9502 of {var} and {expr1} don't fit the operator. | |
| 9503 | |
| 9504 | |
| 7 | 9505 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 9506 Set environment variable {env-name} to the result of | |
| 9507 the expression {expr1}. The type is always String. | |
| 114 | 9508 :let ${env-name} .= {expr1} |
| 9509 Append {expr1} to the environment variable {env-name}. | |
| 9510 If the environment variable didn't exist yet this | |
| 9511 works like "=". | |
| 7 | 9512 |
| 9513 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 9514 Write the result of the expression {expr1} in register | |
| 9515 {reg-name}. {reg-name} must be a single letter, and | |
| 9516 must be the name of a writable register (see | |
| 9517 |registers|). "@@" can be used for the unnamed | |
| 9518 register, "@/" for the search pattern. | |
| 9519 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 9520 register will be linewise, otherwise it will be set to | |
| 9521 characterwise. | |
| 9522 This can be used to clear the last search pattern: > | |
| 9523 :let @/ = "" | |
| 9524 < This is different from searching for an empty string, | |
| 9525 that would match everywhere. | |
| 9526 | |
| 114 | 9527 :let @{reg-name} .= {expr1} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9528 Append {expr1} to register {reg-name}. If the |
| 114 | 9529 register was empty it's like setting it to {expr1}. |
| 9530 | |
| 1156 | 9531 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 9532 Set option {option-name} to the result of the |
| 68 | 9533 expression {expr1}. A String or Number value is |
| 9534 always converted to the type of the option. | |
| 7 | 9535 For an option local to a window or buffer the effect |
| 9536 is just like using the |:set| command: both the local | |
| 555 | 9537 value and the global value are changed. |
| 68 | 9538 Example: > |
| 9539 :let &path = &path . ',/usr/local/include' | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9540 < This also works for terminal codes in the form t_xx. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9541 But only for alphanumerical names. Example: > |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9542 :let &t_k1 = "\<Esc>[234;" |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9543 < 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
|
9544 a terminal key code, there is no error. |
| 7 | 9545 |
| 114 | 9546 :let &{option-name} .= {expr1} |
| 9547 For a string option: Append {expr1} to the value. | |
| 9548 Does not insert a comma like |:set+=|. | |
| 9549 | |
| 9550 :let &{option-name} += {expr1} | |
| 9551 :let &{option-name} -= {expr1} | |
| 9552 For a number or boolean option: Add or subtract | |
| 9553 {expr1}. | |
| 9554 | |
| 7 | 9555 :let &l:{option-name} = {expr1} |
| 114 | 9556 :let &l:{option-name} .= {expr1} |
| 9557 :let &l:{option-name} += {expr1} | |
| 9558 :let &l:{option-name} -= {expr1} | |
| 7 | 9559 Like above, but only set the local value of an option |
| 9560 (if there is one). Works like |:setlocal|. | |
| 9561 | |
| 9562 :let &g:{option-name} = {expr1} | |
| 114 | 9563 :let &g:{option-name} .= {expr1} |
| 9564 :let &g:{option-name} += {expr1} | |
| 9565 :let &g:{option-name} -= {expr1} | |
| 7 | 9566 Like above, but only set the global value of an option |
| 9567 (if there is one). Works like |:setglobal|. | |
| 9568 | |
| 85 | 9569 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 9570 {expr1} must evaluate to a |List|. The first item in |
| 68 | 9571 the list is assigned to {name1}, the second item to |
| 9572 {name2}, etc. | |
| 9573 The number of names must match the number of items in | |
| 685 | 9574 the |List|. |
| 68 | 9575 Each name can be one of the items of the ":let" |
| 9576 command as mentioned above. | |
| 9577 Example: > | |
| 9578 :let [s, item] = GetItem(s) | |
| 114 | 9579 < Detail: {expr1} is evaluated first, then the |
| 9580 assignments are done in sequence. This matters if | |
| 9581 {name2} depends on {name1}. Example: > | |
| 9582 :let x = [0, 1] | |
| 9583 :let i = 0 | |
| 9584 :let [i, x[i]] = [1, 2] | |
| 9585 :echo x | |
| 9586 < The result is [0, 2]. | |
| 9587 | |
| 9588 :let [{name1}, {name2}, ...] .= {expr1} | |
| 9589 :let [{name1}, {name2}, ...] += {expr1} | |
| 9590 :let [{name1}, {name2}, ...] -= {expr1} | |
| 9591 Like above, but append/add/subtract the value for each | |
| 685 | 9592 |List| item. |
| 68 | 9593 |
| 9594 :let [{name}, ..., ; {lastname}] = {expr1} | |
| 685 | 9595 Like |:let-unpack| above, but the |List| may have more |
| 114 | 9596 items than there are names. A list of the remaining |
| 9597 items is assigned to {lastname}. If there are no | |
| 9598 remaining items {lastname} is set to an empty list. | |
| 68 | 9599 Example: > |
| 9600 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 9601 < | |
| 114 | 9602 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 9603 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 9604 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 9605 Like above, but append/add/subtract the value for each | |
| 685 | 9606 |List| item. |
| 2596 | 9607 |
| 9608 *E121* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9609 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 9610 variable names may be given. Special names recognized |
| 9611 here: *E738* | |
| 777 | 9612 g: global variables |
| 9613 b: local buffer variables | |
| 9614 w: local window variables | |
| 819 | 9615 t: local tab page variables |
| 777 | 9616 s: script-local variables |
| 9617 l: local function variables | |
| 123 | 9618 v: Vim variables. |
| 7 | 9619 |
| 55 | 9620 :let List the values of all variables. The type of the |
| 9621 variable is indicated before the value: | |
| 9622 <nothing> String | |
| 9623 # Number | |
| 856 | 9624 * Funcref |
| 7 | 9625 |
| 148 | 9626 |
| 1156 | 9627 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 9628 Remove the internal variable {name}. Several variable |
| 9629 names can be given, they are all removed. The name | |
| 685 | 9630 may also be a |List| or |Dictionary| item. |
| 7 | 9631 With [!] no error message is given for non-existing |
| 9632 variables. | |
| 685 | 9633 One or more items from a |List| can be removed: > |
| 108 | 9634 :unlet list[3] " remove fourth item |
| 9635 :unlet list[3:] " remove fourth item to last | |
| 685 | 9636 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 9637 :unlet dict['two'] |
| 9638 :unlet dict.two | |
| 1668 | 9639 < This is especially useful to clean up used global |
| 9640 variables and script-local variables (these are not | |
| 9641 deleted when the script ends). Function-local | |
| 9642 variables are automatically deleted when the function | |
| 9643 ends. | |
| 7 | 9644 |
| 148 | 9645 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 9646 Lock the internal variable {name}. Locking means that | |
| 9647 it can no longer be changed (until it is unlocked). | |
| 9648 A locked variable can be deleted: > | |
| 9649 :lockvar v | |
| 9650 :let v = 'asdf' " fails! | |
| 9651 :unlet v | |
|
10908
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
9652 < *E741* *E940* |
| 148 | 9653 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
|
9654 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
|
9655 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
|
9656 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
|
9657 variable {name}". |
| 148 | 9658 |
| 685 | 9659 [depth] is relevant when locking a |List| or |
| 9660 |Dictionary|. It specifies how deep the locking goes: | |
| 9661 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 9662 cannot add or remove items, but can |
| 9663 still change their values. | |
| 9664 2 Also lock the values, cannot change | |
| 685 | 9665 the items. If an item is a |List| or |
| 9666 |Dictionary|, cannot add or remove | |
| 148 | 9667 items, but can still change the |
| 9668 values. | |
| 685 | 9669 3 Like 2 but for the |List| / |
| 9670 |Dictionary| in the |List| / | |
| 9671 |Dictionary|, one level deeper. | |
| 9672 The default [depth] is 2, thus when {name} is a |List| | |
| 9673 or |Dictionary| the values cannot be changed. | |
| 148 | 9674 *E743* |
| 9675 For unlimited depth use [!] and omit [depth]. | |
| 9676 However, there is a maximum depth of 100 to catch | |
| 9677 loops. | |
| 9678 | |
| 685 | 9679 Note that when two variables refer to the same |List| |
| 9680 and you lock one of them, the |List| will also be | |
| 819 | 9681 locked when used through the other variable. |
| 9682 Example: > | |
| 148 | 9683 :let l = [0, 1, 2, 3] |
| 9684 :let cl = l | |
| 9685 :lockvar l | |
| 9686 :let cl[1] = 99 " won't work! | |
| 9687 < You may want to make a copy of a list to avoid this. | |
| 9688 See |deepcopy()|. | |
| 9689 | |
| 9690 | |
| 9691 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 9692 Unlock the internal variable {name}. Does the | |
| 9693 opposite of |:lockvar|. | |
| 9694 | |
| 9695 | |
| 7 | 9696 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
| 9697 :en[dif] Execute the commands until the next matching ":else" | |
| 9698 or ":endif" if {expr1} evaluates to non-zero. | |
| 9699 | |
| 9700 From Vim version 4.5 until 5.0, every Ex command in | |
| 9701 between the ":if" and ":endif" is ignored. These two | |
| 9702 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
|
9703 backward compatible way. Nesting was allowed. Note |
| 7 | 9704 that any ":else" or ":elseif" was ignored, the "else" |
| 9705 part was not executed either. | |
| 9706 | |
| 9707 You can use this to remain compatible with older | |
| 9708 versions: > | |
| 9709 :if version >= 500 | |
| 9710 : version-5-specific-commands | |
| 9711 :endif | |
| 9712 < The commands still need to be parsed to find the | |
| 9713 "endif". Sometimes an older Vim has a problem with a | |
| 9714 new command. For example, ":silent" is recognized as | |
| 9715 a ":substitute" command. In that case ":execute" can | |
| 9716 avoid problems: > | |
| 9717 :if version >= 600 | |
| 9718 : execute "silent 1,$delete" | |
| 9719 :endif | |
| 9720 < | |
| 9721 NOTE: The ":append" and ":insert" commands don't work | |
| 9722 properly in between ":if" and ":endif". | |
| 9723 | |
| 9724 *:else* *:el* *E581* *E583* | |
| 9725 :el[se] Execute the commands until the next matching ":else" | |
| 9726 or ":endif" if they previously were not being | |
| 9727 executed. | |
| 9728 | |
| 9729 *:elseif* *:elsei* *E582* *E584* | |
| 9730 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 9731 is no extra ":endif". | |
| 9732 | |
| 9733 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 9734 *E170* *E585* *E588* *E733* |
| 7 | 9735 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 9736 as long as {expr1} evaluates to non-zero. | |
| 9737 When an error is detected from a command inside the | |
| 9738 loop, execution continues after the "endwhile". | |
| 75 | 9739 Example: > |
| 9740 :let lnum = 1 | |
| 9741 :while lnum <= line("$") | |
| 9742 :call FixLine(lnum) | |
| 9743 :let lnum = lnum + 1 | |
| 9744 :endwhile | |
| 9745 < | |
| 7 | 9746 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 9747 properly inside a ":while" and ":for" loop. |
| 75 | 9748 |
| 114 | 9749 :for {var} in {list} *:for* *E690* *E732* |
| 75 | 9750 :endfo[r] *:endfo* *:endfor* |
| 9751 Repeat the commands between ":for" and ":endfor" for | |
| 158 | 9752 each item in {list}. Variable {var} is set to the |
| 79 | 9753 value of each item. |
| 9754 When an error is detected for a command inside the | |
| 75 | 9755 loop, execution continues after the "endfor". |
| 464 | 9756 Changing {list} inside the loop affects what items are |
| 9757 used. Make a copy if this is unwanted: > | |
| 79 | 9758 :for item in copy(mylist) |
| 9759 < When not making a copy, Vim stores a reference to the | |
| 9760 next item in the list, before executing the commands | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9761 with the current item. Thus the current item can be |
| 79 | 9762 removed without effect. Removing any later item means |
| 9763 it will not be found. Thus the following example | |
| 9764 works (an inefficient way to make a list empty): > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9765 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9766 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9767 endfor |
| 87 | 9768 < Note that reordering the list (e.g., with sort() or |
| 9769 reverse()) may have unexpected effects. | |
| 75 | 9770 |
| 9771 :for [{var1}, {var2}, ...] in {listlist} | |
| 9772 :endfo[r] | |
| 9773 Like ":for" above, but each item in {listlist} must be | |
| 9774 a list, of which each item is assigned to {var1}, | |
| 9775 {var2}, etc. Example: > | |
| 9776 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 9777 :echo getline(lnum)[col] | |
| 9778 :endfor | |
| 9779 < | |
| 7 | 9780 *:continue* *:con* *E586* |
| 75 | 9781 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 9782 to the start of the loop. | |
| 9783 If it is used after a |:try| inside the loop but | |
| 9784 before the matching |:finally| (if present), the | |
| 9785 commands following the ":finally" up to the matching | |
| 9786 |:endtry| are executed first. This process applies to | |
| 9787 all nested ":try"s inside the loop. The outermost | |
| 9788 ":endtry" then jumps back to the start of the loop. | |
| 7 | 9789 |
| 9790 *:break* *:brea* *E587* | |
| 75 | 9791 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 9792 the command after the matching ":endwhile" or | |
| 9793 ":endfor". | |
| 9794 If it is used after a |:try| inside the loop but | |
| 9795 before the matching |:finally| (if present), the | |
| 9796 commands following the ":finally" up to the matching | |
| 9797 |:endtry| are executed first. This process applies to | |
| 9798 all nested ":try"s inside the loop. The outermost | |
| 9799 ":endtry" then jumps to the command after the loop. | |
| 7 | 9800 |
| 9801 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 9802 :endt[ry] Change the error handling for the commands between | |
| 9803 ":try" and ":endtry" including everything being | |
| 9804 executed across ":source" commands, function calls, | |
| 9805 or autocommand invocations. | |
| 9806 | |
| 9807 When an error or interrupt is detected and there is | |
| 9808 a |:finally| command following, execution continues | |
| 9809 after the ":finally". Otherwise, or when the | |
| 9810 ":endtry" is reached thereafter, the next | |
| 9811 (dynamically) surrounding ":try" is checked for | |
| 9812 a corresponding ":finally" etc. Then the script | |
| 9813 processing is terminated. (Whether a function | |
| 9814 definition has an "abort" argument does not matter.) | |
| 9815 Example: > | |
| 9816 :try | edit too much | finally | echo "cleanup" | endtry | |
| 9817 :echo "impossible" " not reached, script terminated above | |
| 9818 < | |
| 9819 Moreover, an error or interrupt (dynamically) inside | |
| 9820 ":try" and ":endtry" is converted to an exception. It | |
| 9821 can be caught as if it were thrown by a |:throw| | |
| 9822 command (see |:catch|). In this case, the script | |
| 9823 processing is not terminated. | |
| 9824 | |
| 9825 The value "Vim:Interrupt" is used for an interrupt | |
| 9826 exception. An error in a Vim command is converted | |
| 9827 to a value of the form "Vim({command}):{errmsg}", | |
| 9828 other errors are converted to a value of the form | |
| 9829 "Vim:{errmsg}". {command} is the full command name, | |
| 9830 and {errmsg} is the message that is displayed if the | |
| 9831 error exception is not caught, always beginning with | |
| 9832 the error number. | |
| 9833 Examples: > | |
| 9834 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
| 9835 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 9836 < | |
| 9837 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9838 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 9839 |:finally|, or |:endtry| that belongs to the same |
| 9840 |:try| as the ":catch" are executed when an exception | |
| 9841 matching {pattern} is being thrown and has not yet | |
| 9842 been caught by a previous ":catch". Otherwise, these | |
| 9843 commands are skipped. | |
| 9844 When {pattern} is omitted all errors are caught. | |
| 9845 Examples: > | |
| 9846 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
| 9847 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
| 9848 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
| 9849 :catch /^Vim(write):/ " catch all errors in :write | |
| 9850 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
| 9851 :catch /my-exception/ " catch user exception | |
| 9852 :catch /.*/ " catch everything | |
| 9853 :catch " same as /.*/ | |
| 9854 < | |
| 9855 Another character can be used instead of / around the | |
| 9856 {pattern}, so long as it does not have a special | |
| 9857 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 9858 {pattern}. | |
| 5814 | 9859 Information about the exception is available in |
| 9860 |v:exception|. Also see |throw-variables|. | |
| 7 | 9861 NOTE: It is not reliable to ":catch" the TEXT of |
| 9862 an error message because it may vary in different | |
| 9863 locales. | |
| 9864 | |
| 9865 *:fina* *:finally* *E606* *E607* | |
| 9866 :fina[lly] The following commands until the matching |:endtry| | |
| 9867 are executed whenever the part between the matching | |
| 9868 |:try| and the ":finally" is left: either by falling | |
| 9869 through to the ":finally" or by a |:continue|, | |
| 9870 |:break|, |:finish|, or |:return|, or by an error or | |
| 9871 interrupt or exception (see |:throw|). | |
| 9872 | |
| 9873 *:th* *:throw* *E608* | |
| 9874 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 9875 If the ":throw" is used after a |:try| but before the | |
| 9876 first corresponding |:catch|, commands are skipped | |
| 9877 until the first ":catch" matching {expr1} is reached. | |
| 9878 If there is no such ":catch" or if the ":throw" is | |
| 9879 used after a ":catch" but before the |:finally|, the | |
| 9880 commands following the ":finally" (if present) up to | |
| 9881 the matching |:endtry| are executed. If the ":throw" | |
| 9882 is after the ":finally", commands up to the ":endtry" | |
| 9883 are skipped. At the ":endtry", this process applies | |
| 9884 again for the next dynamically surrounding ":try" | |
| 9885 (which may be found in a calling function or sourcing | |
| 9886 script), until a matching ":catch" has been found. | |
| 9887 If the exception is not caught, the command processing | |
| 9888 is terminated. | |
| 9889 Example: > | |
| 9890 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 9891 < Note that "catch" may need to be on a separate line |
| 9892 for when an error causes the parsing to skip the whole | |
| 9893 line and not see the "|" that separates the commands. | |
| 7 | 9894 |
| 9895 *:ec* *:echo* | |
| 9896 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 9897 first {expr1} starts on a new line. | |
| 9898 Also see |:comment|. | |
| 9899 Use "\n" to start a new line. Use "\r" to move the | |
| 9900 cursor to the first column. | |
| 9901 Uses the highlighting set by the |:echohl| command. | |
| 9902 Cannot be followed by a comment. | |
| 9903 Example: > | |
| 9904 :echo "the value of 'shell' is" &shell | |
| 1156 | 9905 < *:echo-redraw* |
| 9906 A later redraw may make the message disappear again. | |
| 9907 And since Vim mostly postpones redrawing until it's | |
| 9908 finished with a sequence of commands this happens | |
| 9909 quite often. To avoid that a command from before the | |
| 9910 ":echo" causes a redraw afterwards (redraws are often | |
| 9911 postponed until you type something), force a redraw | |
| 9912 with the |:redraw| command. Example: > | |
| 7 | 9913 :new | redraw | echo "there is a new window" |
| 9914 < | |
| 9915 *:echon* | |
| 9916 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 9917 |:comment|. | |
| 9918 Uses the highlighting set by the |:echohl| command. | |
| 9919 Cannot be followed by a comment. | |
| 9920 Example: > | |
| 9921 :echon "the value of 'shell' is " &shell | |
| 9922 < | |
| 9923 Note the difference between using ":echo", which is a | |
| 9924 Vim command, and ":!echo", which is an external shell | |
| 9925 command: > | |
| 9926 :!echo % --> filename | |
| 9927 < The arguments of ":!" are expanded, see |:_%|. > | |
| 9928 :!echo "%" --> filename or "filename" | |
| 9929 < Like the previous example. Whether you see the double | |
| 9930 quotes or not depends on your 'shell'. > | |
| 9931 :echo % --> nothing | |
| 9932 < The '%' is an illegal character in an expression. > | |
| 9933 :echo "%" --> % | |
| 9934 < This just echoes the '%' character. > | |
| 9935 :echo expand("%") --> filename | |
| 9936 < This calls the expand() function to expand the '%'. | |
| 9937 | |
| 9938 *:echoh* *:echohl* | |
| 9939 :echoh[l] {name} Use the highlight group {name} for the following | |
| 9940 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 9941 for the |input()| prompt. Example: > | |
| 9942 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 9943 < Don't forget to set the group back to "None", | |
| 9944 otherwise all following echo's will be highlighted. | |
| 9945 | |
| 9946 *:echom* *:echomsg* | |
| 9947 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 9948 message in the |message-history|. | |
| 9949 Spaces are placed between the arguments as with the | |
| 9950 |:echo| command. But unprintable characters are | |
| 9951 displayed, not interpreted. | |
| 1156 | 9952 The parsing works slightly different from |:echo|, |
| 9953 more like |:execute|. All the expressions are first | |
| 9954 evaluated and concatenated before echoing anything. | |
| 9955 The expressions must evaluate to a Number or String, a | |
| 9956 Dictionary or List causes an error. | |
| 7 | 9957 Uses the highlighting set by the |:echohl| command. |
| 9958 Example: > | |
| 9959 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 9960 < See |:echo-redraw| to avoid the message disappearing |
| 9961 when the screen is redrawn. | |
| 7 | 9962 *:echoe* *:echoerr* |
| 9963 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 9964 message in the |message-history|. When used in a | |
| 9965 script or function the line number will be added. | |
| 9966 Spaces are placed between the arguments as with the | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9967 :echo command. When used inside a try conditional, |
| 7 | 9968 the message is raised as an error exception instead |
| 9969 (see |try-echoerr|). | |
| 9970 Example: > | |
| 9971 :echoerr "This script just failed!" | |
| 9972 < If you just want a highlighted message use |:echohl|. | |
| 9973 And to get a beep: > | |
| 9974 :exe "normal \<Esc>" | |
| 9975 < | |
| 9976 *:exe* *:execute* | |
| 9977 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 9978 of {expr1} as an Ex command. |
| 9979 Multiple arguments are concatenated, with a space in | |
| 9980 between. To avoid the extra space use the "." | |
| 9981 operator to concatenate strings into one argument. | |
| 9982 {expr1} is used as the processed command, command line | |
| 9983 editing keys are not recognized. | |
| 7 | 9984 Cannot be followed by a comment. |
| 9985 Examples: > | |
| 2152 | 9986 :execute "buffer" nextbuf |
| 9987 :execute "normal" count . "w" | |
| 7 | 9988 < |
| 9989 ":execute" can be used to append a command to commands | |
| 9990 that don't accept a '|'. Example: > | |
| 9991 :execute '!ls' | echo "theend" | |
| 9992 | |
| 9993 < ":execute" is also a nice way to avoid having to type | |
| 9994 control characters in a Vim script for a ":normal" | |
| 9995 command: > | |
| 9996 :execute "normal ixxx\<Esc>" | |
| 9997 < This has an <Esc> character, see |expr-string|. | |
| 9998 | |
| 1621 | 9999 Be careful to correctly escape special characters in |
| 10000 file names. The |fnameescape()| function can be used | |
| 1661 | 10001 for Vim commands, |shellescape()| for |:!| commands. |
| 10002 Examples: > | |
| 1621 | 10003 :execute "e " . fnameescape(filename) |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
10004 :execute "!ls " . shellescape(filename, 1) |
| 1621 | 10005 < |
| 7 | 10006 Note: The executed string may be any command-line, but |
| 5763 | 10007 starting or ending "if", "while" and "for" does not |
| 10008 always work, because when commands are skipped the | |
| 10009 ":execute" is not evaluated and Vim loses track of | |
| 10010 where blocks start and end. Also "break" and | |
| 10011 "continue" should not be inside ":execute". | |
| 10012 This example does not work, because the ":execute" is | |
| 10013 not evaluated and Vim does not see the "while", and | |
| 10014 gives an error for finding an ":endwhile": > | |
| 10015 :if 0 | |
| 10016 : execute 'while i > 5' | |
| 10017 : echo "test" | |
| 10018 : endwhile | |
| 10019 :endif | |
| 7 | 10020 < |
| 10021 It is allowed to have a "while" or "if" command | |
| 10022 completely in the executed string: > | |
| 10023 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 10024 < | |
| 10025 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10026 *:exe-comment* |
| 7 | 10027 ":execute", ":echo" and ":echon" cannot be followed by |
| 10028 a comment directly, because they see the '"' as the | |
| 10029 start of a string. But, you can use '|' followed by a | |
| 10030 comment. Example: > | |
| 10031 :echo "foo" | "this is a comment | |
| 10032 | |
| 10033 ============================================================================== | |
| 10034 8. Exception handling *exception-handling* | |
| 10035 | |
| 10036 The Vim script language comprises an exception handling feature. This section | |
| 10037 explains how it can be used in a Vim script. | |
| 10038 | |
| 10039 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 10040 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 10041 exception by using the ":throw" command, see |throw-catch|. | |
| 10042 | |
| 10043 | |
| 10044 TRY CONDITIONALS *try-conditionals* | |
| 10045 | |
| 10046 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 10047 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 10048 a finally clause (to be executed for cleanup). | |
| 10049 A try conditional begins with a |:try| command and ends at the matching | |
| 10050 |:endtry| command. In between, you can use a |:catch| command to start | |
| 10051 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 10052 be none or multiple catch clauses, but there is at most one finally clause, | |
| 10053 which must not be followed by any catch clauses. The lines before the catch | |
| 10054 clauses and the finally clause is called a try block. > | |
| 10055 | |
| 10056 :try | |
| 1621 | 10057 : ... |
| 10058 : ... TRY BLOCK | |
| 10059 : ... | |
| 7 | 10060 :catch /{pattern}/ |
| 1621 | 10061 : ... |
| 10062 : ... CATCH CLAUSE | |
| 10063 : ... | |
| 7 | 10064 :catch /{pattern}/ |
| 1621 | 10065 : ... |
| 10066 : ... CATCH CLAUSE | |
| 10067 : ... | |
| 7 | 10068 :finally |
| 1621 | 10069 : ... |
| 10070 : ... FINALLY CLAUSE | |
| 10071 : ... | |
| 7 | 10072 :endtry |
| 10073 | |
| 10074 The try conditional allows to watch code for exceptions and to take the | |
| 10075 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 10076 from the try block and also the catch clauses may cause cleanup actions. | |
| 10077 When no exception is thrown during execution of the try block, the control | |
| 10078 is transferred to the finally clause, if present. After its execution, the | |
| 10079 script continues with the line following the ":endtry". | |
| 10080 When an exception occurs during execution of the try block, the remaining | |
| 10081 lines in the try block are skipped. The exception is matched against the | |
| 10082 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 10083 after the first matching ":catch" is taken, other catch clauses are not | |
| 10084 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 10085 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 10086 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 10087 continues in the following line as usual. | |
| 10088 When an exception that does not match any of the patterns specified by the | |
| 10089 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 10090 that try conditional and none of the catch clauses is executed. Only the | |
| 10091 finally clause, if present, is taken. The exception pends during execution of | |
| 10092 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 10093 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 10094 see |try-nesting|. | |
| 10095 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
|
10096 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 10097 not matched against the patterns in any of the ":catch" commands of the same |
| 10098 try conditional and none of its catch clauses is taken. If there is, however, | |
| 10099 a finally clause, it is executed, and the exception pends during its | |
| 10100 execution. The commands following the ":endtry" are not executed. The new | |
| 10101 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 10102 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
|
10103 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 10104 clause has been taken because of an exception from the try block or one of the |
| 10105 catch clauses, the original (pending) exception is discarded. The commands | |
| 10106 following the ":endtry" are not executed, and the exception from the finally | |
| 10107 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 10108 | |
| 10109 The finally clause is also executed, when a ":break" or ":continue" for | |
| 10110 a ":while" loop enclosing the complete try conditional is executed from the | |
| 10111 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 10112 from the try block or a catch clause of a try conditional in a function or | |
| 10113 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 10114 ":finish" pends during execution of the finally clause and is resumed when the | |
| 10115 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 10116 from the finally clause. | |
| 10117 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 10118 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 10119 clause, the rest of the finally clause is skipped, and the ":break", | |
| 10120 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 10121 clause has been taken because of an exception or an earlier ":break", | |
| 10122 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 10123 this pending exception or command is discarded. | |
| 10124 | |
| 10125 For examples see |throw-catch| and |try-finally|. | |
| 10126 | |
| 10127 | |
| 10128 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 10129 | |
| 10130 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 10131 conditional can be put into the try block, a catch clause, or the finally | |
| 10132 clause of another try conditional. If the inner try conditional does not | |
| 10133 catch an exception thrown in its try block or throws a new exception from one | |
| 10134 of its catch clauses or its finally clause, the outer try conditional is | |
| 10135 checked according to the rules above. If the inner try conditional is in the | |
| 10136 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
|
10137 otherwise only the finally clause is executed. It does not matter for |
| 7 | 10138 nesting, whether the inner try conditional is directly contained in the outer |
| 10139 one, or whether the outer one sources a script or calls a function containing | |
| 10140 the inner try conditional. | |
| 10141 | |
| 10142 When none of the active try conditionals catches an exception, just their | |
| 10143 finally clauses are executed. Thereafter, the script processing terminates. | |
| 10144 An error message is displayed in case of an uncaught exception explicitly | |
| 10145 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 10146 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 10147 as usual. | |
| 10148 | |
| 10149 For examples see |throw-catch|. | |
| 10150 | |
| 10151 | |
| 10152 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 10153 | |
| 10154 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 10155 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 10156 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 10157 finished. When using a verbosity level of at least 14, things pending in | |
| 10158 a finally clause are also shown. This information is also given in debug mode | |
| 10159 (see |debug-scripts|). | |
| 10160 | |
| 10161 | |
| 10162 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 10163 | |
| 10164 You can throw any number or string as an exception. Use the |:throw| command | |
| 10165 and pass the value to be thrown as argument: > | |
| 10166 :throw 4711 | |
| 10167 :throw "string" | |
| 10168 < *throw-expression* | |
| 10169 You can also specify an expression argument. The expression is then evaluated | |
| 10170 first, and the result is thrown: > | |
| 10171 :throw 4705 + strlen("string") | |
| 10172 :throw strpart("strings", 0, 6) | |
| 10173 | |
| 10174 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 10175 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 10176 The ":throw" command then does not throw a new exception. | |
| 10177 Example: > | |
| 10178 | |
| 10179 :function! Foo(arg) | |
| 10180 : try | |
| 10181 : throw a:arg | |
| 10182 : catch /foo/ | |
| 10183 : endtry | |
| 10184 : return 1 | |
| 10185 :endfunction | |
| 10186 : | |
| 10187 :function! Bar() | |
| 10188 : echo "in Bar" | |
| 10189 : return 4710 | |
| 10190 :endfunction | |
| 10191 : | |
| 10192 :throw Foo("arrgh") + Bar() | |
| 10193 | |
| 10194 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 10195 executed. > | |
| 10196 :throw Foo("foo") + Bar() | |
| 10197 however displays "in Bar" and throws 4711. | |
| 10198 | |
| 10199 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
|
10200 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 10201 exception is then propagated to the caller of the command. |
| 10202 Example: > | |
| 10203 | |
| 10204 :if Foo("arrgh") | |
| 10205 : echo "then" | |
| 10206 :else | |
| 10207 : echo "else" | |
| 10208 :endif | |
| 10209 | |
| 10210 Here neither of "then" or "else" is displayed. | |
| 10211 | |
| 10212 *catch-order* | |
| 10213 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 10214 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 10215 command can be specified as a pattern argument. The subsequent catch clause | |
| 10216 gets executed when a matching exception is caught. | |
| 10217 Example: > | |
| 10218 | |
| 10219 :function! Foo(value) | |
| 10220 : try | |
| 10221 : throw a:value | |
| 10222 : catch /^\d\+$/ | |
| 10223 : echo "Number thrown" | |
| 10224 : catch /.*/ | |
| 10225 : echo "String thrown" | |
| 10226 : endtry | |
| 10227 :endfunction | |
| 10228 : | |
| 10229 :call Foo(0x1267) | |
| 10230 :call Foo('string') | |
| 10231 | |
| 10232 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 10233 An exception is matched against the ":catch" commands in the order they are | |
| 10234 specified. Only the first match counts. So you should place the more | |
| 10235 specific ":catch" first. The following order does not make sense: > | |
| 10236 | |
| 10237 : catch /.*/ | |
| 10238 : echo "String thrown" | |
| 10239 : catch /^\d\+$/ | |
| 10240 : echo "Number thrown" | |
| 10241 | |
| 10242 The first ":catch" here matches always, so that the second catch clause is | |
| 10243 never taken. | |
| 10244 | |
| 10245 *throw-variables* | |
| 10246 If you catch an exception by a general pattern, you may access the exact value | |
| 10247 in the variable |v:exception|: > | |
| 10248 | |
| 10249 : catch /^\d\+$/ | |
| 10250 : echo "Number thrown. Value is" v:exception | |
| 10251 | |
| 10252 You may also be interested where an exception was thrown. This is stored in | |
| 10253 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 10254 exception most recently caught as long it is not finished. | |
| 10255 Example: > | |
| 10256 | |
| 10257 :function! Caught() | |
| 10258 : if v:exception != "" | |
| 10259 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 10260 : else | |
| 10261 : echo 'Nothing caught' | |
| 10262 : endif | |
| 10263 :endfunction | |
| 10264 : | |
| 10265 :function! Foo() | |
| 10266 : try | |
| 10267 : try | |
| 10268 : try | |
| 10269 : throw 4711 | |
| 10270 : finally | |
| 10271 : call Caught() | |
| 10272 : endtry | |
| 10273 : catch /.*/ | |
| 10274 : call Caught() | |
| 10275 : throw "oops" | |
| 10276 : endtry | |
| 10277 : catch /.*/ | |
| 10278 : call Caught() | |
| 10279 : finally | |
| 10280 : call Caught() | |
| 10281 : endtry | |
| 10282 :endfunction | |
| 10283 : | |
| 10284 :call Foo() | |
| 10285 | |
| 10286 This displays > | |
| 10287 | |
| 10288 Nothing caught | |
| 10289 Caught "4711" in function Foo, line 4 | |
| 10290 Caught "oops" in function Foo, line 10 | |
| 10291 Nothing caught | |
| 10292 | |
| 10293 A practical example: The following command ":LineNumber" displays the line | |
| 10294 number in the script or function where it has been used: > | |
| 10295 | |
| 10296 :function! LineNumber() | |
| 10297 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 10298 :endfunction | |
| 10299 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 10300 < | |
| 10301 *try-nested* | |
| 10302 An exception that is not caught by a try conditional can be caught by | |
| 10303 a surrounding try conditional: > | |
| 10304 | |
| 10305 :try | |
| 10306 : try | |
| 10307 : throw "foo" | |
| 10308 : catch /foobar/ | |
| 10309 : echo "foobar" | |
| 10310 : finally | |
| 10311 : echo "inner finally" | |
| 10312 : endtry | |
| 10313 :catch /foo/ | |
| 10314 : echo "foo" | |
| 10315 :endtry | |
| 10316 | |
| 10317 The inner try conditional does not catch the exception, just its finally | |
| 10318 clause is executed. The exception is then caught by the outer try | |
| 10319 conditional. The example displays "inner finally" and then "foo". | |
| 10320 | |
| 10321 *throw-from-catch* | |
| 10322 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 10323 catch clause: > | |
| 10324 | |
| 10325 :function! Foo() | |
| 10326 : throw "foo" | |
| 10327 :endfunction | |
| 10328 : | |
| 10329 :function! Bar() | |
| 10330 : try | |
| 10331 : call Foo() | |
| 10332 : catch /foo/ | |
| 10333 : echo "Caught foo, throw bar" | |
| 10334 : throw "bar" | |
| 10335 : endtry | |
| 10336 :endfunction | |
| 10337 : | |
| 10338 :try | |
| 10339 : call Bar() | |
| 10340 :catch /.*/ | |
| 10341 : echo "Caught" v:exception | |
| 10342 :endtry | |
| 10343 | |
| 10344 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 10345 | |
| 10346 *rethrow* | |
| 10347 There is no real rethrow in the Vim script language, but you may throw | |
| 10348 "v:exception" instead: > | |
| 10349 | |
| 10350 :function! Bar() | |
| 10351 : try | |
| 10352 : call Foo() | |
| 10353 : catch /.*/ | |
| 10354 : echo "Rethrow" v:exception | |
| 10355 : throw v:exception | |
| 10356 : endtry | |
| 10357 :endfunction | |
| 10358 < *try-echoerr* | |
| 10359 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 10360 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 10361 Trying so causes an error exception. You should throw your own exception | |
| 10362 denoting the situation. If you want to cause a Vim error exception containing | |
| 10363 the original error exception value, you can use the |:echoerr| command: > | |
| 10364 | |
| 10365 :try | |
| 10366 : try | |
| 10367 : asdf | |
| 10368 : catch /.*/ | |
| 10369 : echoerr v:exception | |
| 10370 : endtry | |
| 10371 :catch /.*/ | |
| 10372 : echo v:exception | |
| 10373 :endtry | |
| 10374 | |
| 10375 This code displays | |
| 10376 | |
| 1621 | 10377 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 10378 |
| 10379 | |
| 10380 CLEANUP CODE *try-finally* | |
| 10381 | |
| 10382 Scripts often change global settings and restore them at their end. If the | |
| 10383 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
|
10384 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 10385 a script when an error occurs or you explicitly throw an exception without |
| 10386 catching it. You can solve these problems by using a try conditional with | |
| 10387 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 10388 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 10389 (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
|
10390 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 10391 clause has been executed.) |
| 10392 Example: > | |
| 10393 | |
| 10394 :try | |
| 10395 : let s:saved_ts = &ts | |
| 10396 : set ts=17 | |
| 10397 : | |
| 10398 : " Do the hard work here. | |
| 10399 : | |
| 10400 :finally | |
| 10401 : let &ts = s:saved_ts | |
| 10402 : unlet s:saved_ts | |
| 10403 :endtry | |
| 10404 | |
| 10405 This method should be used locally whenever a function or part of a script | |
| 10406 changes global settings which need to be restored on failure or normal exit of | |
| 10407 that function or script part. | |
| 10408 | |
| 10409 *break-finally* | |
| 10410 Cleanup code works also when the try block or a catch clause is left by | |
| 10411 a ":continue", ":break", ":return", or ":finish". | |
| 10412 Example: > | |
| 10413 | |
| 10414 :let first = 1 | |
| 10415 :while 1 | |
| 10416 : try | |
| 10417 : if first | |
| 10418 : echo "first" | |
| 10419 : let first = 0 | |
| 10420 : continue | |
| 10421 : else | |
| 10422 : throw "second" | |
| 10423 : endif | |
| 10424 : catch /.*/ | |
| 10425 : echo v:exception | |
| 10426 : break | |
| 10427 : finally | |
| 10428 : echo "cleanup" | |
| 10429 : endtry | |
| 10430 : echo "still in while" | |
| 10431 :endwhile | |
| 10432 :echo "end" | |
| 10433 | |
| 10434 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 10435 | |
| 10436 :function! Foo() | |
| 10437 : try | |
| 10438 : return 4711 | |
| 10439 : finally | |
| 10440 : echo "cleanup\n" | |
| 10441 : endtry | |
| 10442 : echo "Foo still active" | |
| 10443 :endfunction | |
| 10444 : | |
| 10445 :echo Foo() "returned by Foo" | |
| 10446 | |
| 10447 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
|
10448 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 10449 return value.) |
| 10450 | |
| 10451 *except-from-finally* | |
| 10452 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 10453 a finally clause is possible, but not recommended since it abandons the | |
| 10454 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 10455 exceptions might get raised from a finally clause. | |
| 10456 Example where an error in the finally clause stops an interrupt from | |
| 10457 working correctly: > | |
| 10458 | |
| 10459 :try | |
| 10460 : try | |
| 10461 : echo "Press CTRL-C for interrupt" | |
| 10462 : while 1 | |
| 10463 : endwhile | |
| 10464 : finally | |
| 10465 : unlet novar | |
| 10466 : endtry | |
| 10467 :catch /novar/ | |
| 10468 :endtry | |
| 10469 :echo "Script still running" | |
| 10470 :sleep 1 | |
| 10471 | |
| 10472 If you need to put commands that could fail into a finally clause, you should | |
| 10473 think about catching or ignoring the errors in these commands, see | |
| 10474 |catch-errors| and |ignore-errors|. | |
| 10475 | |
| 10476 | |
| 10477 CATCHING ERRORS *catch-errors* | |
| 10478 | |
| 10479 If you want to catch specific errors, you just have to put the code to be | |
| 10480 watched in a try block and add a catch clause for the error message. The | |
| 10481 presence of the try conditional causes all errors to be converted to an | |
| 10482 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 10483 the right pattern for the ":catch" command, you have to know how the format of | |
| 10484 the error exception is. | |
| 10485 Error exceptions have the following format: > | |
| 10486 | |
| 10487 Vim({cmdname}):{errmsg} | |
| 10488 or > | |
| 10489 Vim:{errmsg} | |
| 10490 | |
| 10491 {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
|
10492 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 10493 when the error occurs outside try conditionals. It always begins with |
| 10494 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 10495 a space. | |
| 10496 | |
| 10497 Examples: | |
| 10498 | |
| 10499 The command > | |
| 10500 :unlet novar | |
| 10501 normally produces the error message > | |
| 10502 E108: No such variable: "novar" | |
| 10503 which is converted inside try conditionals to an exception > | |
| 10504 Vim(unlet):E108: No such variable: "novar" | |
| 10505 | |
| 10506 The command > | |
| 10507 :dwim | |
| 10508 normally produces the error message > | |
| 10509 E492: Not an editor command: dwim | |
| 10510 which is converted inside try conditionals to an exception > | |
| 10511 Vim:E492: Not an editor command: dwim | |
| 10512 | |
| 10513 You can catch all ":unlet" errors by a > | |
| 10514 :catch /^Vim(unlet):/ | |
| 10515 or all errors for misspelled command names by a > | |
| 10516 :catch /^Vim:E492:/ | |
| 10517 | |
| 10518 Some error messages may be produced by different commands: > | |
| 10519 :function nofunc | |
| 10520 and > | |
| 10521 :delfunction nofunc | |
| 10522 both produce the error message > | |
| 10523 E128: Function name must start with a capital: nofunc | |
| 10524 which is converted inside try conditionals to an exception > | |
| 10525 Vim(function):E128: Function name must start with a capital: nofunc | |
| 10526 or > | |
| 10527 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 10528 respectively. You can catch the error by its number independently on the | |
| 10529 command that caused it if you use the following pattern: > | |
| 10530 :catch /^Vim(\a\+):E128:/ | |
| 10531 | |
| 10532 Some commands like > | |
| 10533 :let x = novar | |
| 10534 produce multiple error messages, here: > | |
| 10535 E121: Undefined variable: novar | |
| 10536 E15: Invalid expression: novar | |
| 10537 Only the first is used for the exception value, since it is the most specific | |
| 10538 one (see |except-several-errors|). So you can catch it by > | |
| 10539 :catch /^Vim(\a\+):E121:/ | |
| 10540 | |
| 10541 You can catch all errors related to the name "nofunc" by > | |
| 10542 :catch /\<nofunc\>/ | |
| 10543 | |
| 10544 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 10545 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 10546 | |
| 10547 You can catch all Vim errors by the pattern > | |
| 10548 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 10549 < | |
| 10550 *catch-text* | |
| 10551 NOTE: You should never catch the error message text itself: > | |
| 10552 :catch /No such variable/ | |
| 6647 | 10553 only works in the English locale, but not when the user has selected |
| 7 | 10554 a different language by the |:language| command. It is however helpful to |
| 10555 cite the message text in a comment: > | |
| 10556 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 10557 | |
| 10558 | |
| 10559 IGNORING ERRORS *ignore-errors* | |
| 10560 | |
| 10561 You can ignore errors in a specific Vim command by catching them locally: > | |
| 10562 | |
| 10563 :try | |
| 10564 : write | |
| 10565 :catch | |
| 10566 :endtry | |
| 10567 | |
| 10568 But you are strongly recommended NOT to use this simple form, since it could | |
| 10569 catch more than you want. With the ":write" command, some autocommands could | |
| 10570 be executed and cause errors not related to writing, for instance: > | |
| 10571 | |
| 10572 :au BufWritePre * unlet novar | |
| 10573 | |
| 10574 There could even be such errors you are not responsible for as a script | |
| 10575 writer: a user of your script might have defined such autocommands. You would | |
| 10576 then hide the error from the user. | |
| 10577 It is much better to use > | |
| 10578 | |
| 10579 :try | |
| 10580 : write | |
| 10581 :catch /^Vim(write):/ | |
| 10582 :endtry | |
| 10583 | |
| 10584 which only catches real write errors. So catch only what you'd like to ignore | |
| 10585 intentionally. | |
| 10586 | |
| 10587 For a single command that does not cause execution of autocommands, you could | |
| 10588 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 10589 command: > | |
| 10590 :silent! nunmap k | |
| 10591 This works also when a try conditional is active. | |
| 10592 | |
| 10593 | |
| 10594 CATCHING INTERRUPTS *catch-interrupt* | |
| 10595 | |
| 10596 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
|
10597 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 10598 script is not terminated, then. |
| 10599 Example: > | |
| 10600 | |
| 10601 :function! TASK1() | |
| 10602 : sleep 10 | |
| 10603 :endfunction | |
| 10604 | |
| 10605 :function! TASK2() | |
| 10606 : sleep 20 | |
| 10607 :endfunction | |
| 10608 | |
| 10609 :while 1 | |
| 10610 : let command = input("Type a command: ") | |
| 10611 : try | |
| 10612 : if command == "" | |
| 10613 : continue | |
| 10614 : elseif command == "END" | |
| 10615 : break | |
| 10616 : elseif command == "TASK1" | |
| 10617 : call TASK1() | |
| 10618 : elseif command == "TASK2" | |
| 10619 : call TASK2() | |
| 10620 : else | |
| 10621 : echo "\nIllegal command:" command | |
| 10622 : continue | |
| 10623 : endif | |
| 10624 : catch /^Vim:Interrupt$/ | |
| 10625 : echo "\nCommand interrupted" | |
| 10626 : " Caught the interrupt. Continue with next prompt. | |
| 10627 : endtry | |
| 10628 :endwhile | |
| 10629 | |
| 10630 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
|
10631 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 10632 |
| 10633 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 10634 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 10635 command on that line. See |debug-scripts|. | |
| 10636 | |
| 10637 | |
| 10638 CATCHING ALL *catch-all* | |
| 10639 | |
| 10640 The commands > | |
| 10641 | |
| 10642 :catch /.*/ | |
| 10643 :catch // | |
| 10644 :catch | |
| 10645 | |
| 10646 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 10647 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 10648 a script in order to catch unexpected things. | |
| 10649 Example: > | |
| 10650 | |
| 10651 :try | |
| 10652 : | |
| 10653 : " do the hard work here | |
| 10654 : | |
| 10655 :catch /MyException/ | |
| 10656 : | |
| 10657 : " handle known problem | |
| 10658 : | |
| 10659 :catch /^Vim:Interrupt$/ | |
| 10660 : echo "Script interrupted" | |
| 10661 :catch /.*/ | |
| 10662 : echo "Internal error (" . v:exception . ")" | |
| 10663 : echo " - occurred at " . v:throwpoint | |
| 10664 :endtry | |
| 10665 :" end of script | |
| 10666 | |
| 10667 Note: Catching all might catch more things than you want. Thus, you are | |
| 10668 strongly encouraged to catch only for problems that you can really handle by | |
| 10669 specifying a pattern argument to the ":catch". | |
| 10670 Example: Catching all could make it nearly impossible to interrupt a script | |
| 10671 by pressing CTRL-C: > | |
| 10672 | |
| 10673 :while 1 | |
| 10674 : try | |
| 10675 : sleep 1 | |
| 10676 : catch | |
| 10677 : endtry | |
| 10678 :endwhile | |
| 10679 | |
| 10680 | |
| 10681 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 10682 | |
| 10683 Exceptions may be used during execution of autocommands. Example: > | |
| 10684 | |
| 10685 :autocmd User x try | |
| 10686 :autocmd User x throw "Oops!" | |
| 10687 :autocmd User x catch | |
| 10688 :autocmd User x echo v:exception | |
| 10689 :autocmd User x endtry | |
| 10690 :autocmd User x throw "Arrgh!" | |
| 10691 :autocmd User x echo "Should not be displayed" | |
| 10692 : | |
| 10693 :try | |
| 10694 : doautocmd User x | |
| 10695 :catch | |
| 10696 : echo v:exception | |
| 10697 :endtry | |
| 10698 | |
| 10699 This displays "Oops!" and "Arrgh!". | |
| 10700 | |
| 10701 *except-autocmd-Pre* | |
| 10702 For some commands, autocommands get executed before the main action of the | |
| 10703 command takes place. If an exception is thrown and not caught in the sequence | |
| 10704 of autocommands, the sequence and the command that caused its execution are | |
| 10705 abandoned and the exception is propagated to the caller of the command. | |
| 10706 Example: > | |
| 10707 | |
| 10708 :autocmd BufWritePre * throw "FAIL" | |
| 10709 :autocmd BufWritePre * echo "Should not be displayed" | |
| 10710 : | |
| 10711 :try | |
| 10712 : write | |
| 10713 :catch | |
| 10714 : echo "Caught:" v:exception "from" v:throwpoint | |
| 10715 :endtry | |
| 10716 | |
| 10717 Here, the ":write" command does not write the file currently being edited (as | |
| 10718 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 10719 autocommand abandons the ":write". The exception is then caught and the | |
| 10720 script displays: > | |
| 10721 | |
| 10722 Caught: FAIL from BufWrite Auto commands for "*" | |
| 10723 < | |
| 10724 *except-autocmd-Post* | |
| 10725 For some commands, autocommands get executed after the main action of the | |
| 10726 command has taken place. If this main action fails and the command is inside | |
| 10727 an active try conditional, the autocommands are skipped and an error exception | |
| 10728 is thrown that can be caught by the caller of the command. | |
| 10729 Example: > | |
| 10730 | |
| 10731 :autocmd BufWritePost * echo "File successfully written!" | |
| 10732 : | |
| 10733 :try | |
| 10734 : write /i/m/p/o/s/s/i/b/l/e | |
| 10735 :catch | |
| 10736 : echo v:exception | |
| 10737 :endtry | |
| 10738 | |
| 10739 This just displays: > | |
| 10740 | |
| 10741 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 10742 | |
| 10743 If you really need to execute the autocommands even when the main action | |
| 10744 fails, trigger the event from the catch clause. | |
| 10745 Example: > | |
| 10746 | |
| 10747 :autocmd BufWritePre * set noreadonly | |
| 10748 :autocmd BufWritePost * set readonly | |
| 10749 : | |
| 10750 :try | |
| 10751 : write /i/m/p/o/s/s/i/b/l/e | |
| 10752 :catch | |
| 10753 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 10754 :endtry | |
| 10755 < | |
| 10756 You can also use ":silent!": > | |
| 10757 | |
| 10758 :let x = "ok" | |
| 10759 :let v:errmsg = "" | |
| 10760 :autocmd BufWritePost * if v:errmsg != "" | |
| 10761 :autocmd BufWritePost * let x = "after fail" | |
| 10762 :autocmd BufWritePost * endif | |
| 10763 :try | |
| 10764 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 10765 :catch | |
| 10766 :endtry | |
| 10767 :echo x | |
| 10768 | |
| 10769 This displays "after fail". | |
| 10770 | |
| 10771 If the main action of the command does not fail, exceptions from the | |
| 10772 autocommands will be catchable by the caller of the command: > | |
| 10773 | |
| 10774 :autocmd BufWritePost * throw ":-(" | |
| 10775 :autocmd BufWritePost * echo "Should not be displayed" | |
| 10776 : | |
| 10777 :try | |
| 10778 : write | |
| 10779 :catch | |
| 10780 : echo v:exception | |
| 10781 :endtry | |
| 10782 < | |
| 10783 *except-autocmd-Cmd* | |
| 10784 For some commands, the normal action can be replaced by a sequence of | |
| 10785 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 10786 of the command. | |
| 10787 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
|
10788 had actually been written when the exception occurred. You need to tell it in |
| 7 | 10789 some way. > |
| 10790 | |
| 10791 :if !exists("cnt") | |
| 10792 : let cnt = 0 | |
| 10793 : | |
| 10794 : autocmd BufWriteCmd * if &modified | |
| 10795 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 10796 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 10797 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 10798 : autocmd BufWriteCmd * endif | |
| 10799 : autocmd BufWriteCmd * write | set nomodified | |
| 10800 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 10801 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 10802 : autocmd BufWriteCmd * endif | |
| 10803 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 10804 : autocmd BufWriteCmd * endif | |
| 10805 :endif | |
| 10806 : | |
| 10807 :try | |
| 10808 : write | |
| 10809 :catch /^BufWriteCmdError$/ | |
| 10810 : if &modified | |
| 10811 : echo "Error on writing (file contents not changed)" | |
| 10812 : else | |
| 10813 : echo "Error after writing" | |
| 10814 : endif | |
| 10815 :catch /^Vim(write):/ | |
| 10816 : echo "Error on writing" | |
| 10817 :endtry | |
| 10818 | |
| 10819 When this script is sourced several times after making changes, it displays | |
| 10820 first > | |
| 10821 File successfully written! | |
| 10822 then > | |
| 10823 Error on writing (file contents not changed) | |
| 10824 then > | |
| 10825 Error after writing | |
| 10826 etc. | |
| 10827 | |
| 10828 *except-autocmd-ill* | |
| 10829 You cannot spread a try conditional over autocommands for different events. | |
| 10830 The following code is ill-formed: > | |
| 10831 | |
| 10832 :autocmd BufWritePre * try | |
| 10833 : | |
| 10834 :autocmd BufWritePost * catch | |
| 10835 :autocmd BufWritePost * echo v:exception | |
| 10836 :autocmd BufWritePost * endtry | |
| 10837 : | |
| 10838 :write | |
| 10839 | |
| 10840 | |
| 10841 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 10842 | |
| 10843 Some programming languages allow to use hierarchies of exception classes or to | |
| 10844 pass additional information with the object of an exception class. You can do | |
| 10845 similar things in Vim. | |
| 10846 In order to throw an exception from a hierarchy, just throw the complete | |
| 10847 class name with the components separated by a colon, for instance throw the | |
| 10848 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 10849 When you want to pass additional information with your exception class, add | |
| 10850 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 10851 for an error when writing "myfile". | |
| 10852 With the appropriate patterns in the ":catch" command, you can catch for | |
| 10853 base classes or derived classes of your hierarchy. Additional information in | |
| 10854 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 10855 Example: > | |
| 10856 | |
| 10857 :function! CheckRange(a, func) | |
| 10858 : if a:a < 0 | |
| 10859 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 10860 : endif | |
| 10861 :endfunction | |
| 10862 : | |
| 10863 :function! Add(a, b) | |
| 10864 : call CheckRange(a:a, "Add") | |
| 10865 : call CheckRange(a:b, "Add") | |
| 10866 : let c = a:a + a:b | |
| 10867 : if c < 0 | |
| 10868 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 10869 : endif | |
| 10870 : return c | |
| 10871 :endfunction | |
| 10872 : | |
| 10873 :function! Div(a, b) | |
| 10874 : call CheckRange(a:a, "Div") | |
| 10875 : call CheckRange(a:b, "Div") | |
| 10876 : if (a:b == 0) | |
| 10877 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 10878 : endif | |
| 10879 : return a:a / a:b | |
| 10880 :endfunction | |
| 10881 : | |
| 10882 :function! Write(file) | |
| 10883 : try | |
| 1621 | 10884 : execute "write" fnameescape(a:file) |
| 7 | 10885 : catch /^Vim(write):/ |
| 10886 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 10887 : endtry | |
| 10888 :endfunction | |
| 10889 : | |
| 10890 :try | |
| 10891 : | |
| 10892 : " something with arithmetics and I/O | |
| 10893 : | |
| 10894 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 10895 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 10896 : echo "Range error in" function | |
| 10897 : | |
| 10898 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 10899 : echo "Math error" | |
| 10900 : | |
| 10901 :catch /^EXCEPT:IO/ | |
| 10902 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 10903 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 10904 : if file !~ '^/' | |
| 10905 : let file = dir . "/" . file | |
| 10906 : endif | |
| 10907 : echo 'I/O error for "' . file . '"' | |
| 10908 : | |
| 10909 :catch /^EXCEPT/ | |
| 10910 : echo "Unspecified error" | |
| 10911 : | |
| 10912 :endtry | |
| 10913 | |
| 10914 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 10915 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 10916 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 10917 Vim error exceptions are parameterized with the name of the command that | |
| 10918 failed, if known. See |catch-errors|. | |
| 10919 | |
| 10920 | |
| 10921 PECULIARITIES | |
| 10922 *except-compat* | |
| 10923 The exception handling concept requires that the command sequence causing the | |
| 10924 exception is aborted immediately and control is transferred to finally clauses | |
| 10925 and/or a catch clause. | |
| 10926 | |
| 10927 In the Vim script language there are cases where scripts and functions | |
| 10928 continue after an error: in functions without the "abort" flag or in a command | |
| 10929 after ":silent!", control flow goes to the following line, and outside | |
| 10930 functions, control flow goes to the line following the outermost ":endwhile" | |
| 10931 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 10932 (thus, requiring the immediate abortion). | |
| 10933 | |
| 10934 This problem has been solved by converting errors to exceptions and using | |
| 10935 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
|
10936 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
|
10937 be caught only from an active try conditional. If you want an immediate |
| 7 | 10938 termination without catching the error, just use a try conditional without |
| 10939 catch clause. (You can cause cleanup code being executed before termination | |
| 10940 by specifying a finally clause.) | |
| 10941 | |
| 10942 When no try conditional is active, the usual abortion and continuation | |
| 10943 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 10944 scripts written for Vim 6.1 and earlier. | |
| 10945 | |
| 10946 However, when sourcing an existing script that does not use exception handling | |
| 10947 commands (or when calling one of its functions) from inside an active try | |
| 10948 conditional of a new script, you might change the control flow of the existing | |
| 10949 script on error. You get the immediate abortion on error and can catch the | |
| 10950 error in the new script. If however the sourced script suppresses error | |
| 10951 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
|
10952 |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
|
10953 not converted to an exception. (See |:silent|.) So the only remaining cause |
| 7 | 10954 where this happens is for scripts that don't care about errors and produce |
| 10955 error messages. You probably won't want to use such code from your new | |
| 10956 scripts. | |
| 10957 | |
| 10958 *except-syntax-err* | |
| 10959 Syntax errors in the exception handling commands are never caught by any of | |
| 10960 the ":catch" commands of the try conditional they belong to. Its finally | |
| 10961 clauses, however, is executed. | |
| 10962 Example: > | |
| 10963 | |
| 10964 :try | |
| 10965 : try | |
| 10966 : throw 4711 | |
| 10967 : catch /\(/ | |
| 10968 : echo "in catch with syntax error" | |
| 10969 : catch | |
| 10970 : echo "inner catch-all" | |
| 10971 : finally | |
| 10972 : echo "inner finally" | |
| 10973 : endtry | |
| 10974 :catch | |
| 10975 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 10976 : finally | |
| 10977 : echo "outer finally" | |
| 10978 :endtry | |
| 10979 | |
| 10980 This displays: > | |
| 10981 inner finally | |
| 10982 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 10983 outer finally | |
| 10984 The original exception is discarded and an error exception is raised, instead. | |
| 10985 | |
| 10986 *except-single-line* | |
| 10987 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 10988 a single line, but then syntax errors may make it difficult to recognize the | |
| 10989 "catch" line, thus you better avoid this. | |
| 10990 Example: > | |
| 10991 :try | unlet! foo # | catch | endtry | |
| 10992 raises an error exception for the trailing characters after the ":unlet!" | |
| 10993 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 10994 error exception is discarded and the "E488: Trailing characters" message gets | |
| 10995 displayed. | |
| 10996 | |
| 10997 *except-several-errors* | |
| 10998 When several errors appear in a single command, the first error message is | |
| 10999 usually the most specific one and therefor converted to the error exception. | |
| 11000 Example: > | |
| 11001 echo novar | |
| 11002 causes > | |
| 11003 E121: Undefined variable: novar | |
| 11004 E15: Invalid expression: novar | |
| 11005 The value of the error exception inside try conditionals is: > | |
| 11006 Vim(echo):E121: Undefined variable: novar | |
| 11007 < *except-syntax-error* | |
| 11008 But when a syntax error is detected after a normal error in the same command, | |
| 11009 the syntax error is used for the exception being thrown. | |
| 11010 Example: > | |
| 11011 unlet novar # | |
| 11012 causes > | |
| 11013 E108: No such variable: "novar" | |
| 11014 E488: Trailing characters | |
| 11015 The value of the error exception inside try conditionals is: > | |
| 11016 Vim(unlet):E488: Trailing characters | |
| 11017 This is done because the syntax error might change the execution path in a way | |
| 11018 not intended by the user. Example: > | |
| 11019 try | |
| 11020 try | unlet novar # | catch | echo v:exception | endtry | |
| 11021 catch /.*/ | |
| 11022 echo "outer catch:" v:exception | |
| 11023 endtry | |
| 11024 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 11025 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 11026 | |
| 11027 ============================================================================== | |
| 11028 9. Examples *eval-examples* | |
| 11029 | |
| 1156 | 11030 Printing in Binary ~ |
| 7 | 11031 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
11032 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 11033 :func Nr2Bin(nr) |
| 7 | 11034 : let n = a:nr |
| 11035 : let r = "" | |
| 11036 : while n | |
| 1156 | 11037 : let r = '01'[n % 2] . r |
| 11038 : let n = n / 2 | |
| 7 | 11039 : endwhile |
| 11040 : return r | |
| 11041 :endfunc | |
| 11042 | |
| 1156 | 11043 :" The function String2Bin() converts each character in a string to a |
| 11044 :" binary string, separated with dashes. | |
| 11045 :func String2Bin(str) | |
| 7 | 11046 : let out = '' |
| 1156 | 11047 : for ix in range(strlen(a:str)) |
| 11048 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 11049 : endfor | |
| 11050 : return out[1:] | |
| 7 | 11051 :endfunc |
| 11052 | |
| 11053 Example of its use: > | |
| 1156 | 11054 :echo Nr2Bin(32) |
| 11055 result: "100000" > | |
| 11056 :echo String2Bin("32") | |
| 11057 result: "110011-110010" | |
| 11058 | |
| 11059 | |
| 11060 Sorting lines ~ | |
| 11061 | |
| 11062 This example sorts lines with a specific compare function. > | |
| 11063 | |
| 11064 :func SortBuffer() | |
| 11065 : let lines = getline(1, '$') | |
| 11066 : call sort(lines, function("Strcmp")) | |
| 11067 : call setline(1, lines) | |
| 7 | 11068 :endfunction |
| 11069 | |
| 1156 | 11070 As a one-liner: > |
| 11071 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 11072 | |
| 11073 | |
| 11074 scanf() replacement ~ | |
| 7 | 11075 *sscanf* |
| 11076 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 11077 line, you can use matchstr() and substitute() to do it. This example shows | |
| 11078 how to get the file name, line number and column number out of a line like | |
| 11079 "foobar.txt, 123, 45". > | |
| 11080 :" Set up the match bit | |
| 11081 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 11082 :"get the part matching the whole expression | |
| 11083 :let l = matchstr(line, mx) | |
| 11084 :"get each item out of the match | |
| 11085 :let file = substitute(l, mx, '\1', '') | |
| 11086 :let lnum = substitute(l, mx, '\2', '') | |
| 11087 :let col = substitute(l, mx, '\3', '') | |
| 11088 | |
| 11089 The input is in the variable "line", the results in the variables "file", | |
| 11090 "lnum" and "col". (idea from Michael Geddes) | |
| 11091 | |
| 1156 | 11092 |
| 11093 getting the scriptnames in a Dictionary ~ | |
| 11094 *scriptnames-dictionary* | |
| 11095 The |:scriptnames| command can be used to get a list of all script files that | |
| 11096 have been sourced. There is no equivalent function or variable for this | |
| 11097 (because it's rarely needed). In case you need to manipulate the list this | |
| 11098 code can be used: > | |
| 11099 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 11100 let scriptnames_output = '' | |
| 11101 redir => scriptnames_output | |
| 11102 silent scriptnames | |
| 11103 redir END | |
| 12785 | 11104 |
| 1621 | 11105 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 11106 " "scripts" dictionary. |
| 11107 let scripts = {} | |
| 11108 for line in split(scriptnames_output, "\n") | |
| 11109 " Only do non-blank lines. | |
| 11110 if line =~ '\S' | |
| 11111 " Get the first number in the line. | |
| 1621 | 11112 let nr = matchstr(line, '\d\+') |
| 1156 | 11113 " Get the file name, remove the script number " 123: ". |
| 1621 | 11114 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 11115 " Add an item to the Dictionary |
| 1621 | 11116 let scripts[nr] = name |
| 1156 | 11117 endif |
| 11118 endfor | |
| 11119 unlet scriptnames_output | |
| 11120 | |
| 7 | 11121 ============================================================================== |
| 11122 10. No +eval feature *no-eval-feature* | |
| 11123 | |
| 11124 When the |+eval| feature was disabled at compile time, none of the expression | |
| 11125 evaluation commands are available. To prevent this from causing Vim scripts | |
| 11126 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 11127 recognized, though the argument of the ":if" and everything between the ":if" | |
| 11128 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 11129 only if the commands are at the start of the line. The ":else" command is not | |
| 11130 recognized. | |
| 11131 | |
| 11132 Example of how to avoid executing commands when the |+eval| feature is | |
| 11133 missing: > | |
| 11134 | |
| 11135 :if 1 | |
| 11136 : echo "Expression evaluation is compiled in" | |
| 11137 :else | |
| 11138 : echo "You will _never_ see this message" | |
| 11139 :endif | |
| 11140 | |
| 11347 | 11141 To execute a command only when the |+eval| feature is disabled requires a trick, |
| 11142 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
|
11143 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11144 silent! while 0 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11145 set history=111 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11146 silent! endwhile |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11147 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11148 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
|
11149 "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
|
11150 silently ignored, and the command is executed. |
| 11347 | 11151 |
| 7 | 11152 ============================================================================== |
| 11153 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
| 11154 | |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
11155 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
|
11156 '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
|
11157 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
|
11158 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
|
11159 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 11160 The sandbox is also used for the |:sandbox| command. |
| 7 | 11161 |
| 11162 These items are not allowed in the sandbox: | |
| 11163 - changing the buffer text | |
| 11164 - defining or changing mapping, autocommands, functions, user commands | |
| 11165 - setting certain options (see |option-summary|) | |
| 1156 | 11166 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 11167 - executing a shell command |
| 11168 - reading or writing a file | |
| 11169 - jumping to another buffer or editing a file | |
| 625 | 11170 - executing Python, Perl, etc. commands |
| 29 | 11171 This is not guaranteed 100% secure, but it should block most attacks. |
| 11172 | |
| 11173 *:san* *:sandbox* | |
| 401 | 11174 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 11175 option that may have been set from a modeline, e.g. |
| 11176 'foldexpr'. | |
| 11177 | |
| 634 | 11178 *sandbox-option* |
| 11179 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 11180 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 11181 restrictive, thus this only happens when the option was set from an insecure |
| 11182 location. Insecure in this context are: | |
| 843 | 11183 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 11184 - while executing in the sandbox |
| 11185 - value coming from a modeline | |
| 11186 | |
| 11187 Note that when in the sandbox and saving an option value and restoring it, the | |
| 11188 option will still be marked as it was set in the sandbox. | |
| 11189 | |
| 11190 ============================================================================== | |
| 11191 12. Textlock *textlock* | |
| 11192 | |
| 11193 In a few situations it is not allowed to change the text in the buffer, jump | |
| 11194 to another window and some other things that might confuse or break what Vim | |
| 11195 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
|
11196 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 11197 happen any moment the mouse cursor is resting at some position. |
| 11198 | |
| 11199 This is not allowed when the textlock is active: | |
| 11200 - changing the buffer text | |
| 11201 - jumping to another buffer or window | |
| 11202 - editing another file | |
| 11203 - closing a window or quitting Vim | |
| 11204 - etc. | |
| 11205 | |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11206 ============================================================================== |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11207 13. Testing *testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11208 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11209 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
|
11210 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
|
11211 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11212 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
|
11213 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
|
11214 test_something.in old style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11215 test_something.vim new style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11216 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11217 *new-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11218 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
|
11219 |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
|
11220 place. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11221 *old-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11222 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
|
11223 without the |+eval| feature. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11224 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11225 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
|
11226 |
| 7 | 11227 |
| 11228 vim:tw=78:ts=8:ft=help:norl: |