Mercurial > vim
annotate runtime/doc/eval.txt @ 13740:f309afff6f25 v8.0.1742
patch 8.0.1742: cannot get a list of all the jobs
commit https://github.com/vim/vim/commit/e1fc51558dc14906a8d9f6a6e7bb1ac2a6ba8f3d
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat Apr 21 19:49:08 2018 +0200
patch 8.0.1742: cannot get a list of all the jobs
Problem: Cannot get a list of all the jobs. Cannot get the command of
the job.
Solution: When job_info() is called without an argument return a list of
jobs. Otherwise, include the command that the job is running.
(Yegappan Lakshmanan)
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Sat, 21 Apr 2018 20:00:07 +0200 |
| parents | a62eeee5f116 |
| children | 87012d2b17b5 |
| rev | line source |
|---|---|
| 13735 | 1 *eval.txt* For Vim version 8.0. Last change: 2018 Apr 20 |
| 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 |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1249 while they already exist in the function scope. They remain valid even after |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1250 the function returns: > |
|
9686
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 |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1259 Note that the variables must exist in the outer scope before the lamba is |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1260 defined for this to work. See also |:func-closure|. |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1261 |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1262 Lambda and closure support can be checked with: > |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1263 if has('lambda') |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1264 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1265 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
|
1266 :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
|
1267 < [2, 3, 4] > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1268 :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
|
1269 < [1, 2, 3, 4, 7] |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1270 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1271 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
|
1272 :let timer = timer_start(500, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1273 \ {-> execute("echo 'Handler called'", "")}, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1274 \ {'repeat': 3}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1275 < Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1276 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1277 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1278 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1279 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
|
1280 |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1281 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1282 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
|
1283 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
|
1284 :function {'<lambda>42'} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1285 See also: |numbered-function| |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1286 |
| 7 | 1287 ============================================================================== |
| 2596 | 1288 3. Internal variable *internal-variables* *E461* |
| 1289 | |
| 7 | 1290 An internal variable name can be made up of letters, digits and '_'. But it |
| 1291 cannot start with a digit. It's also possible to use curly braces, see | |
| 1292 |curly-braces-names|. | |
| 1293 | |
| 1294 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1295 An internal variable is explicitly destroyed with the ":unlet" command |
| 1296 |:unlet|. | |
| 1297 Using a name that is not an internal variable or refers to a variable that has | |
| 1298 been destroyed results in an error. | |
| 7 | 1299 |
| 1300 There are several name spaces for variables. Which one is to be used is | |
| 1301 specified by what is prepended: | |
| 1302 | |
| 1303 (nothing) In a function: local to a function; otherwise: global | |
| 1304 |buffer-variable| b: Local to the current buffer. | |
| 1305 |window-variable| w: Local to the current window. | |
| 819 | 1306 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1307 |global-variable| g: Global. |
| 1308 |local-variable| l: Local to a function. | |
| 1309 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1310 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1311 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1312 |
| 685 | 1313 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1314 delete all script-local variables: > | |
| 133 | 1315 :for k in keys(s:) |
| 1316 : unlet s:[k] | |
| 1317 :endfor | |
| 1318 < | |
| 4358 | 1319 *buffer-variable* *b:var* *b:* |
| 7 | 1320 A variable name that is preceded with "b:" is local to the current buffer. |
| 1321 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1322 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1323 |:bdelete|. | |
| 1324 | |
| 1325 One local buffer variable is predefined: | |
| 4264 | 1326 *b:changedtick* *changetick* |
| 7 | 1327 b:changedtick The total number of changes to the current buffer. It is |
| 1328 incremented for each change. An undo command is also a change | |
| 1329 in this case. This can be used to perform an action only when | |
| 1330 the buffer has changed. Example: > | |
| 1331 :if my_changedtick != b:changedtick | |
| 1621 | 1332 : let my_changedtick = b:changedtick |
| 1333 : call My_Update() | |
| 7 | 1334 :endif |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1335 < You cannot change or delete the b:changedtick variable. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1336 |
| 4358 | 1337 *window-variable* *w:var* *w:* |
| 7 | 1338 A variable name that is preceded with "w:" is local to the current window. It |
| 1339 is deleted when the window is closed. | |
| 1340 | |
| 4437 | 1341 *tabpage-variable* *t:var* *t:* |
| 819 | 1342 A variable name that is preceded with "t:" is local to the current tab page, |
| 1343 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
|
1344 without the |+windows| feature} |
| 819 | 1345 |
| 4358 | 1346 *global-variable* *g:var* *g:* |
| 7 | 1347 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
|
1348 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1349 place if you like. |
| 1350 | |
| 4358 | 1351 *local-variable* *l:var* *l:* |
| 7 | 1352 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1353 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1354 you may run into reserved variable names. For example "count". By itself it | |
| 1355 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1356 same name. | |
| 7 | 1357 |
| 1358 *script-variable* *s:var* | |
| 1359 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1360 accessed from outside of the scripts, thus are local to the script. | |
| 1361 | |
| 1362 They can be used in: | |
| 1363 - commands executed while the script is sourced | |
| 1364 - functions defined in the script | |
| 1365 - autocommands defined in the script | |
| 1366 - functions and autocommands defined in functions and autocommands which were | |
| 1367 defined in the script (recursively) | |
| 1368 - user defined commands defined in the script | |
| 1369 Thus not in: | |
| 1370 - other scripts sourced from this one | |
| 1371 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1372 - menus |
| 7 | 1373 - etc. |
| 1374 | |
| 1156 | 1375 Script variables can be used to avoid conflicts with global variable names. |
| 1376 Take this example: > | |
| 7 | 1377 |
| 1378 let s:counter = 0 | |
| 1379 function MyCounter() | |
| 1380 let s:counter = s:counter + 1 | |
| 1381 echo s:counter | |
| 1382 endfunction | |
| 1383 command Tick call MyCounter() | |
| 1384 | |
| 1385 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1386 that script will not be changed, only the "s:counter" in the script where | |
| 1387 "Tick" was defined is used. | |
| 1388 | |
| 1389 Another example that does the same: > | |
| 1390 | |
| 1391 let s:counter = 0 | |
| 1392 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1393 | |
| 1394 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1395 script variables is set to the script where the function or command was |
| 7 | 1396 defined. |
| 1397 | |
| 1398 The script variables are also available when a function is defined inside a | |
| 1399 function that is defined in a script. Example: > | |
| 1400 | |
| 1401 let s:counter = 0 | |
| 1402 function StartCounting(incr) | |
| 1403 if a:incr | |
| 1404 function MyCounter() | |
| 1405 let s:counter = s:counter + 1 | |
| 1406 endfunction | |
| 1407 else | |
| 1408 function MyCounter() | |
| 1409 let s:counter = s:counter - 1 | |
| 1410 endfunction | |
| 1411 endif | |
| 1412 endfunction | |
| 1413 | |
| 1414 This defines the MyCounter() function either for counting up or counting down | |
| 1415 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1416 called, the s:counter variable will be accessible in MyCounter(). | |
| 1417 | |
| 1418 When the same script is sourced again it will use the same script variables. | |
| 1419 They will remain valid as long as Vim is running. This can be used to | |
| 1420 maintain a counter: > | |
| 1421 | |
| 1422 if !exists("s:counter") | |
| 1423 let s:counter = 1 | |
| 1424 echo "script executed for the first time" | |
| 1425 else | |
| 1426 let s:counter = s:counter + 1 | |
| 1427 echo "script executed " . s:counter . " times now" | |
| 1428 endif | |
| 1429 | |
| 1430 Note that this means that filetype plugins don't get a different set of script | |
| 1431 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1432 | |
| 1433 | |
| 4358 | 1434 Predefined Vim variables: *vim-variable* *v:var* *v:* |
| 7 | 1435 |
| 189 | 1436 *v:beval_col* *beval_col-variable* |
| 1437 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1438 This is the byte index in the |v:beval_lnum| line. | |
| 1439 Only valid while evaluating the 'balloonexpr' option. | |
| 1440 | |
| 1441 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1442 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1443 valid while evaluating the 'balloonexpr' option. | |
| 1444 | |
| 1445 *v:beval_lnum* *beval_lnum-variable* | |
| 1446 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1447 valid while evaluating the 'balloonexpr' option. | |
| 1448 | |
| 1449 *v:beval_text* *beval_text-variable* | |
| 374 | 1450 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1451 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1452 but a dot and "->" before the position is included. When on a | |
| 1453 ']' the text before it is used, including the matching '[' and | |
| 189 | 1454 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
|
1455 highlighted text is used. Also see |<cexpr>|. |
| 189 | 1456 Only valid while evaluating the 'balloonexpr' option. |
| 1457 | |
| 1458 *v:beval_winnr* *beval_winnr-variable* | |
| 1459 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1460 valid while evaluating the 'balloonexpr' option. The first |
| 1461 window has number zero (unlike most other places where a | |
| 1462 window gets a number). | |
| 189 | 1463 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1464 *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
|
1465 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
|
1466 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
|
1467 |
| 844 | 1468 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1469 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
|
1470 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
|
1471 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1472 |
| 7 | 1473 *v:charconvert_from* *charconvert_from-variable* |
| 1474 v:charconvert_from | |
| 1475 The name of the character encoding of a file to be converted. | |
| 1476 Only valid while evaluating the 'charconvert' option. | |
| 1477 | |
| 1478 *v:charconvert_to* *charconvert_to-variable* | |
| 1479 v:charconvert_to | |
| 1480 The name of the character encoding of a file after conversion. | |
| 1481 Only valid while evaluating the 'charconvert' option. | |
| 1482 | |
| 1483 *v:cmdarg* *cmdarg-variable* | |
| 1484 v:cmdarg This variable is used for two purposes: | |
| 1485 1. The extra arguments given to a file read/write command. | |
| 1486 Currently these are "++enc=" and "++ff=". This variable is | |
| 1487 set before an autocommand event for a file read/write | |
| 1488 command is triggered. There is a leading space to make it | |
| 1489 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
|
1490 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1491 included here, because it will be executed anyway. |
| 1492 2. When printing a PostScript file with ":hardcopy" this is | |
| 1493 the argument for the ":hardcopy" command. This can be used | |
| 1494 in 'printexpr'. | |
| 1495 | |
| 1496 *v:cmdbang* *cmdbang-variable* | |
| 1497 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1498 was used the value is 1, otherwise it is 0. Note that this | |
| 1499 can only be used in autocommands. For user commands |<bang>| | |
| 1500 can be used. | |
| 1501 | |
| 6909 | 1502 *v:completed_item* *completed_item-variable* |
| 1503 v:completed_item | |
| 1504 |Dictionary| containing the |complete-items| for the most | |
| 1505 recently completed word after |CompleteDone|. The | |
| 1506 |Dictionary| is empty if the completion failed. | |
| 1507 | |
| 7 | 1508 *v:count* *count-variable* |
| 1509 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
|
1510 to get the count before a mapping. Read-only. Example: > |
| 7 | 1511 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1512 < Note: The <C-U> is required to remove the line range that you | |
| 1513 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1514 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1515 just like what happens in the command, "d6w" for the example. |
| 667 | 1516 Also used for evaluating the 'formatexpr' option. |
| 7 | 1517 "count" also works, for backwards compatibility. |
| 1518 | |
| 1519 *v:count1* *count1-variable* | |
| 1520 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1521 used. | |
| 1522 | |
| 1523 *v:ctype* *ctype-variable* | |
| 1524 v:ctype The current locale setting for characters of the runtime | |
| 1525 environment. This allows Vim scripts to be aware of the | |
| 1526 current locale encoding. Technical: it's the value of | |
| 1527 LC_CTYPE. When not using a locale the value is "C". | |
| 1528 This variable can not be set directly, use the |:language| | |
| 1529 command. | |
| 1530 See |multi-lang|. | |
| 1531 | |
| 1532 *v:dying* *dying-variable* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1533 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1534 one. When multiple signals are caught the number increases. |
| 1535 Can be used in an autocommand to check if Vim didn't | |
| 1536 terminate normally. {only works on Unix} | |
| 1537 Example: > | |
| 1538 :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
|
1539 < 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
|
1540 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
|
1541 |
| 7 | 1542 *v:errmsg* *errmsg-variable* |
| 1543 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1544 Example: > | |
| 1545 :let v:errmsg = "" | |
| 1546 :silent! next | |
| 1547 :if v:errmsg != "" | |
| 1548 : ... handle error | |
| 1549 < "errmsg" also works, for backwards compatibility. | |
| 1550 | |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1551 *v:errors* *errors-variable* |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1552 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
|
1553 This is a list of strings. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1554 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
|
1555 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
|
1556 :let v:errors = [] |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1557 < 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
|
1558 list by the assert function. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1559 |
|
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1560 *v:event* *event-variable* |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1561 v:event Dictionary containing information about the current |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1562 |autocommand|. The dictionary is emptied when the |autocommand| |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1563 finishes, please refer to |dict-identity| for how to get an |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1564 independent copy of it. |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1565 |
| 7 | 1566 *v:exception* *exception-variable* |
| 1567 v:exception The value of the exception most recently caught and not | |
| 1568 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1569 Example: > | |
| 1570 :try | |
| 1571 : throw "oops" | |
| 1572 :catch /.*/ | |
| 1573 : echo "caught" v:exception | |
| 1574 :endtry | |
| 1575 < Output: "caught oops". | |
| 1576 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1577 *v:false* *false-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1578 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
|
1579 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1580 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
|
1581 echo v:false |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1582 < v:false ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1583 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
|
1584 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1585 |
| 179 | 1586 *v:fcs_reason* *fcs_reason-variable* |
| 1587 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1588 Can be used in an autocommand to decide what to do and/or what | |
| 1589 to set v:fcs_choice to. Possible values: | |
| 1590 deleted file no longer exists | |
| 1591 conflict file contents, mode or timestamp was | |
| 1592 changed and buffer is modified | |
| 1593 changed file contents has changed | |
| 1594 mode mode of file changed | |
| 1595 time only file timestamp changed | |
| 1596 | |
| 1597 *v:fcs_choice* *fcs_choice-variable* | |
| 1598 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1599 triggered. Can be used in an autocommand to tell Vim what to | |
| 1600 do with the affected buffer: | |
| 1601 reload Reload the buffer (does not work if | |
| 1602 the file was deleted). | |
| 1603 ask Ask the user what to do, as if there | |
| 1604 was no autocommand. Except that when | |
| 1605 only the timestamp changed nothing | |
| 1606 will happen. | |
| 1607 <empty> Nothing, the autocommand should do | |
| 1608 everything that needs to be done. | |
| 1609 The default is empty. If another (invalid) value is used then | |
| 1610 Vim behaves like it is empty, there is no warning message. | |
| 1611 | |
| 7 | 1612 *v:fname_in* *fname_in-variable* |
| 579 | 1613 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1614 option used for ~ |
| 1615 'charconvert' file to be converted | |
| 1616 'diffexpr' original file | |
| 1617 'patchexpr' original file | |
| 1618 'printexpr' file to be printed | |
| 593 | 1619 And set to the swap file name for |SwapExists|. |
| 7 | 1620 |
| 1621 *v:fname_out* *fname_out-variable* | |
| 1622 v:fname_out The name of the output file. Only valid while | |
| 1623 evaluating: | |
| 1624 option used for ~ | |
| 1625 'charconvert' resulting converted file (*) | |
| 1626 'diffexpr' output of diff | |
| 1627 'patchexpr' resulting patched file | |
| 1628 (*) 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
|
1629 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1630 for a read command (e.g., ":e file") it will be a temporary |
| 1631 file and different from v:fname_in. | |
| 1632 | |
| 1633 *v:fname_new* *fname_new-variable* | |
| 1634 v:fname_new The name of the new version of the file. Only valid while | |
| 1635 evaluating 'diffexpr'. | |
| 1636 | |
| 1637 *v:fname_diff* *fname_diff-variable* | |
| 1638 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1639 evaluating 'patchexpr'. | |
| 1640 | |
| 1641 *v:folddashes* *folddashes-variable* | |
| 1642 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1643 fold. | |
| 29 | 1644 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1645 |
| 1646 *v:foldlevel* *foldlevel-variable* | |
| 1647 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1648 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1649 |
| 1650 *v:foldend* *foldend-variable* | |
| 1651 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 1652 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1653 |
| 1654 *v:foldstart* *foldstart-variable* | |
| 1655 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 1656 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1657 |
| 5460 | 1658 *v:hlsearch* *hlsearch-variable* |
| 12785 | 1659 v:hlsearch Variable that indicates whether search highlighting is on. |
| 6413 | 1660 Setting it makes sense only if 'hlsearch' is enabled which |
| 1661 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
|
1662 like the |:nohlsearch| command, setting it to one acts like > |
| 5460 | 1663 let &hlsearch = &hlsearch |
| 6918 | 1664 < Note that the value is restored when returning from a |
| 1665 function. |function-search-undo|. | |
| 1666 | |
| 11 | 1667 *v:insertmode* *insertmode-variable* |
| 1668 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 1669 events. Values: | |
| 1670 i Insert mode | |
| 1671 r Replace mode | |
| 1672 v Virtual Replace mode | |
| 1673 | |
| 102 | 1674 *v:key* *key-variable* |
| 685 | 1675 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 1676 evaluating the expression used with |map()| and |filter()|. |
| 1677 Read-only. | |
| 1678 | |
| 7 | 1679 *v:lang* *lang-variable* |
| 1680 v:lang The current locale setting for messages of the runtime | |
| 1681 environment. This allows Vim scripts to be aware of the | |
| 1682 current language. Technical: it's the value of LC_MESSAGES. | |
| 1683 The value is system dependent. | |
| 1684 This variable can not be set directly, use the |:language| | |
| 1685 command. | |
| 1686 It can be different from |v:ctype| when messages are desired | |
| 1687 in a different language than what is used for character | |
| 1688 encoding. See |multi-lang|. | |
| 1689 | |
| 1690 *v:lc_time* *lc_time-variable* | |
| 1691 v:lc_time The current locale setting for time messages of the runtime | |
| 1692 environment. This allows Vim scripts to be aware of the | |
| 1693 current language. Technical: it's the value of LC_TIME. | |
| 1694 This variable can not be set directly, use the |:language| | |
| 1695 command. See |multi-lang|. | |
| 1696 | |
| 1697 *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
|
1698 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
|
1699 '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
|
1700 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
|
1701 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
|
1702 |sandbox|. |
| 7 | 1703 |
| 1029 | 1704 *v:mouse_win* *mouse_win-variable* |
| 1705 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 1706 First window has number 1, like with |winnr()|. The value is | |
| 1707 zero when there was no mouse button click. | |
| 1708 | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1709 *v:mouse_winid* *mouse_winid-variable* |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1710 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
|
1711 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
|
1712 |
| 1029 | 1713 *v:mouse_lnum* *mouse_lnum-variable* |
| 1714 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 1715 This is the text line number, not the screen line number. The | |
| 1716 value is zero when there was no mouse button click. | |
| 1717 | |
| 1718 *v:mouse_col* *mouse_col-variable* | |
| 1719 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 1720 This is the screen column number, like with |virtcol()|. The | |
| 1721 value is zero when there was no mouse button click. | |
| 1722 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1723 *v:none* *none-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1724 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
|
1725 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1726 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
|
1727 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
|
1728 echo v:none |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1729 < v:none ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1730 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
|
1731 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1732 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1733 *v:null* *null-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1734 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
|
1735 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
1736 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
|
1737 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
|
1738 echo v:null |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1739 < v:null ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1740 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
|
1741 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1742 |
| 1733 | 1743 *v:oldfiles* *oldfiles-variable* |
| 1744 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 1745 startup. These are the files that Vim remembers marks for. | |
| 1746 The length of the List is limited by the ' argument of the | |
| 1747 'viminfo' option (default is 100). | |
| 5618 | 1748 When the |viminfo| file is not used the List is empty. |
| 1733 | 1749 Also see |:oldfiles| and |c_#<|. |
| 1750 The List can be modified, but this has no effect on what is | |
| 1751 stored in the |viminfo| file later. If you use values other | |
| 1752 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
|
1753 {only when compiled with the |+viminfo| feature} |
| 1733 | 1754 |
| 6935 | 1755 *v:option_new* |
| 1756 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 1757 autocommand. | |
| 1758 *v:option_old* | |
| 1759 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
| 1760 autocommand. | |
| 1761 *v:option_type* | |
| 1762 v:option_type Scope of the set command. Valid while executing an | |
| 1763 |OptionSet| autocommand. Can be either "global" or "local" | |
| 1490 | 1764 *v:operator* *operator-variable* |
| 1765 v:operator The last operator given in Normal mode. This is a single | |
| 1766 character except for commands starting with <g> or <z>, | |
| 1767 in which case it is two characters. Best used alongside | |
| 1768 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 1769 Operator-pending mode and then use the operator, e.g.: > | |
| 1770 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 1771 < The value remains set until another operator is entered, thus | |
| 1772 don't expect it to be empty. | |
| 1773 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 1774 commands. | |
| 1775 Read-only. | |
| 1776 | |
| 7 | 1777 *v:prevcount* *prevcount-variable* |
| 1778 v:prevcount The count given for the last but one Normal mode command. | |
| 1779 This is the v:count value of the previous command. Useful if | |
| 1490 | 1780 you want to cancel Visual or Operator-pending mode and then |
| 1781 use the count, e.g.: > | |
| 7 | 1782 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 1783 < Read-only. | |
| 1784 | |
| 170 | 1785 *v:profiling* *profiling-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1786 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 1787 See |profiling|. |
| 1788 | |
| 7 | 1789 *v:progname* *progname-variable* |
| 1790 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 1791 invoked. Allows you to do special initialisations for |view|, |
| 1792 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 1793 Read-only. |
| 1794 | |
| 5780 | 1795 *v:progpath* *progpath-variable* |
| 1796 v:progpath Contains the command with which Vim was invoked, including the | |
| 1797 path. Useful if you want to message a Vim server using a | |
| 1798 |--remote-expr|. | |
| 5782 | 1799 To get the full path use: > |
| 1800 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
|
1801 < 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
|
1802 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
|
1803 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
|
1804 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
|
1805 ".exe" is not added to v:progpath. |
| 5780 | 1806 Read-only. |
| 1807 | |
| 7 | 1808 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1809 v:register The name of the register in effect for the current normal mode |
| 3492 | 1810 command (regardless of whether that command actually used a |
| 1811 register). Or for the currently executing normal mode mapping | |
| 1812 (use this in custom commands that take a register). | |
| 1813 If none is supplied it is the default register '"', unless | |
| 1814 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 1815 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
1816 Also see |getreg()| and |setreg()| |
| 7 | 1817 |
| 540 | 1818 *v:scrollstart* *scrollstart-variable* |
| 1819 v:scrollstart String describing the script or function that caused the | |
| 1820 screen to scroll up. It's only set when it is empty, thus the | |
| 1821 first reason is remembered. It is set to "Unknown" for a | |
| 1822 typed command. | |
| 1823 This can be used to find out why your script causes the | |
| 1824 hit-enter prompt. | |
| 1825 | |
| 7 | 1826 *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
|
1827 v:servername The resulting registered |client-server-name| if any. |
| 7 | 1828 Read-only. |
| 1829 | |
| 12785 | 1830 |
| 1621 | 1831 v:searchforward *v:searchforward* *searchforward-variable* |
| 1832 Search direction: 1 after a forward search, 0 after a | |
| 1833 backward search. It is reset to forward when directly setting | |
| 1834 the last search pattern, see |quote/|. | |
| 1835 Note that the value is restored when returning from a | |
| 1836 function. |function-search-undo|. | |
| 1837 Read-write. | |
| 1838 | |
| 7 | 1839 *v:shell_error* *shell_error-variable* |
| 1840 v:shell_error Result of the last shell command. When non-zero, the last | |
| 1841 shell command had an error. When zero, there was no problem. | |
| 1842 This only works when the shell returns the error code to Vim. | |
| 1843 The value -1 is often used when the command could not be | |
| 1844 executed. Read-only. | |
| 1845 Example: > | |
| 1846 :!mv foo bar | |
| 1847 :if v:shell_error | |
| 1848 : echo 'could not rename "foo" to "bar"!' | |
| 1849 :endif | |
| 1850 < "shell_error" also works, for backwards compatibility. | |
| 1851 | |
| 1852 *v:statusmsg* *statusmsg-variable* | |
| 1853 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 1854 | |
| 579 | 1855 *v:swapname* *swapname-variable* |
| 1856 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 1857 the swap file found. Read-only. | |
| 1858 | |
| 1859 *v:swapchoice* *swapchoice-variable* | |
| 1860 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 1861 for handling an existing swap file: | |
| 1862 'o' Open read-only | |
| 1863 'e' Edit anyway | |
| 1864 'r' Recover | |
| 1865 'd' Delete swapfile | |
| 1866 'q' Quit | |
| 1867 'a' Abort | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1868 The value should be a single-character string. An empty value |
| 579 | 1869 results in the user being asked, as would happen when there is |
| 1870 no SwapExists autocommand. The default is empty. | |
| 1871 | |
| 590 | 1872 *v:swapcommand* *swapcommand-variable* |
| 625 | 1873 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 1874 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
|
1875 another Vim open the file and jump to the right place. For |
| 590 | 1876 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 1877 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 1878 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
1879 *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
|
1880 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
|
1881 *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
|
1882 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
|
1883 *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
|
1884 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
|
1885 *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
|
1886 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
|
1887 *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
|
1888 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
|
1889 *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
|
1890 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
|
1891 *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
|
1892 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
|
1893 *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
|
1894 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
|
1895 *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
|
1896 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
|
1897 *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
|
1898 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
|
1899 |
| 7 | 1900 *v:termresponse* *termresponse-variable* |
| 1901 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
|
1902 termcap entry. It is set when Vim receives an escape sequence |
| 7 | 1903 that starts with ESC [ or CSI and ends in a 'c', with only |
| 1904 digits, ';' and '.' in between. | |
| 1905 When this option is set, the TermResponse autocommand event is | |
| 1906 fired, so that you can react to the response from the | |
| 1907 terminal. | |
| 1908 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp | |
| 1909 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the | |
| 1910 patch level (since this was introduced in patch 95, it's | |
| 1911 always 95 or bigger). Pc is always zero. | |
| 1912 {only when compiled with |+termresponse| feature} | |
| 1913 | |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1914 *v:termblinkresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1915 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
|
1916 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
|
1917 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
|
1918 |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1919 *v:termstyleresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1920 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
|
1921 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
|
1922 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
|
1923 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
1924 *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
|
1925 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
|
1926 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
|
1927 background color is, see 'background'. |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1928 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
1929 *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
|
1930 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
|
1931 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
|
1932 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
|
1933 |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1934 *v:termu7resp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
1935 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
|
1936 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
|
1937 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
|
1938 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
1939 *v:testing* *testing-variable* |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
1940 v:testing Must be set before using `test_garbagecollect_now()`. |
| 11160 | 1941 Also, when set certain error messages won't be shown for 2 |
| 12785 | 1942 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
|
1943 |
| 7 | 1944 *v:this_session* *this_session-variable* |
| 1945 v:this_session Full filename of the last loaded or saved session file. See | |
| 1946 |:mksession|. It is allowed to set this variable. When no | |
| 1947 session file has been saved, this variable is empty. | |
| 1948 "this_session" also works, for backwards compatibility. | |
| 1949 | |
| 1950 *v:throwpoint* *throwpoint-variable* | |
| 1951 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
|
1952 finished was thrown. Not set when commands are typed. See |
| 7 | 1953 also |v:exception| and |throw-variables|. |
| 1954 Example: > | |
| 1955 :try | |
| 1956 : throw "oops" | |
| 1957 :catch /.*/ | |
| 1958 : echo "Exception from" v:throwpoint | |
| 1959 :endtry | |
| 1960 < Output: "Exception from test.vim, line 2" | |
| 1961 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1962 *v:true* *true-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1963 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
|
1964 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1965 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
|
1966 echo v:true |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1967 < v:true ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1968 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
|
1969 value. Read-only. |
| 102 | 1970 *v:val* *val-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1971 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 1972 valid while evaluating the expression used with |map()| and |
| 102 | 1973 |filter()|. Read-only. |
| 1974 | |
| 7 | 1975 *v:version* *version-variable* |
| 1976 v:version Version number of Vim: Major version number times 100 plus | |
| 1977 minor version number. Version 5.0 is 500. Version 5.1 (5.01) | |
| 1978 is 501. Read-only. "version" also works, for backwards | |
| 1979 compatibility. | |
| 1980 Use |has()| to check if a certain patch was included, e.g.: > | |
| 5786 | 1981 if has("patch-7.4.123") |
| 7 | 1982 < Note that patch numbers are specific to the version, thus both |
| 1983 version 5.0 and 5.1 may have a patch 123, but these are | |
| 1984 completely different. | |
| 1985 | |
|
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1986 *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
|
1987 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
|
1988 before |VimEnter| autocommands are triggered. |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
1989 |
| 7 | 1990 *v:warningmsg* *warningmsg-variable* |
| 1991 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 1992 | |
| 2609 | 1993 *v:windowid* *windowid-variable* |
| 1994 v:windowid When any X11 based GUI is running or when running in a | |
| 1995 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 1996 set to the window ID. |
| 1997 When an MS-Windows GUI is running this will be set to the | |
| 1998 window handle. | |
| 1999 Otherwise the value is zero. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2000 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
|
2001 see |window-ID|. |
| 2609 | 2002 |
| 7 | 2003 ============================================================================== |
| 2004 4. Builtin Functions *functions* | |
| 2005 | |
| 2006 See |function-list| for a list grouped by what the function is used for. | |
| 2007 | |
| 236 | 2008 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 2009 |
| 2010 USAGE RESULT DESCRIPTION ~ | |
| 2011 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2012 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
|
2013 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
|
2014 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
|
2015 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
|
2016 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
|
2017 append({lnum}, {list}) Number append lines {list} below line {lnum} |
| 7 | 2018 argc() Number number of files in the argument list |
| 55 | 2019 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
|
2020 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
|
2021 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
|
2022 argv() List the argument list |
|
13272
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2023 assert_beeps({cmd}) none assert {cmd} causes a beep |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2024 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
|
2025 none assert {exp} is equal to {act} |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2026 assert_equalfile({fname-one}, {fname-two}) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2027 none assert file contents is equal |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2028 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
|
2029 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
|
2030 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
|
2031 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
|
2032 none assert {actual} is false |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2033 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
|
2034 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
|
2035 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
|
2036 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
|
2037 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
|
2038 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
|
2039 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
|
2040 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
|
2041 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
|
2042 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
|
2043 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
|
2044 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
|
2045 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
|
2046 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
|
2047 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
|
2048 browse({save}, {title}, {initdir}, {default}) |
| 7 | 2049 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
|
2050 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
|
2051 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
|
2052 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
|
2053 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
|
2054 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
|
2055 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
|
2056 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
|
2057 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
|
2058 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
|
2059 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
|
2060 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
|
2061 call({func}, {arglist} [, {dict}]) |
| 102 | 2062 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
|
2063 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
|
2064 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
|
2065 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
|
2066 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
|
2067 ch_evalexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2068 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
|
2069 ch_evalraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2070 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
|
2071 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
|
2072 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
|
2073 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
|
2074 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
|
2075 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
|
2076 ch_open({address} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2077 Channel open a channel to {address} |
|
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2078 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
|
2079 ch_readraw({handle} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2080 String read raw from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2081 ch_sendexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2082 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
|
2083 ch_sendraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2084 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
|
2085 ch_setoptions({handle}, {options}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2086 none set options for {handle} |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2087 ch_status({handle} [, {options}]) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2088 String status of channel {handle} |
| 1621 | 2089 changenr() Number current change number |
| 12785 | 2090 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
|
2091 cindent({lnum}) Number C indent for line {lnum} |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
2092 clearmatches() none clear all matches |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2093 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
|
2094 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
|
2095 complete_add({expr}) Number add completion match |
| 1621 | 2096 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
|
2097 confirm({msg} [, {choices} [, {default} [, {type}]]]) |
| 7 | 2098 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
|
2099 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
|
2100 cos({expr}) Float cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2101 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
|
2102 count({list}, {expr} [, {ic} [, {start}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2103 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
|
2104 cscope_connection([{num}, {dbpath} [, {prepend}]]) |
| 7 | 2105 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
|
2106 cursor({lnum}, {col} [, {off}]) |
| 6385 | 2107 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
|
2108 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
|
2109 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
|
2110 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
|
2111 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
|
2112 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
|
2113 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
|
2114 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
|
2115 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
|
2116 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
|
2117 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
|
2118 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
|
2119 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
|
2120 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
|
2121 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
|
2122 extend({expr1}, {expr2} [, {expr3}]) |
| 824 | 2123 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
|
2124 exp({expr}) Float exponential of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2125 expand({expr} [, {nosuf} [, {list}]]) |
| 3398 | 2126 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
|
2127 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
|
2128 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
|
2129 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
|
2130 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
|
2131 {expr2} is 0 |
| 12785 | 2132 finddir({name} [, {path} [, {count}]]) |
| 824 | 2133 String find directory {name} in {path} |
| 12785 | 2134 findfile({name} [, {path} [, {count}]]) |
| 824 | 2135 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
|
2136 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
|
2137 floor({expr}) Float round {expr} down |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2138 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
|
2139 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
|
2140 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
|
2141 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
|
2142 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
|
2143 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
|
2144 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
|
2145 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
|
2146 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
|
2147 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2148 Funcref reference to function {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2149 function({name} [, {arglist}] [, {dict}]) |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2150 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
|
2151 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
|
2152 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
|
2153 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
|
2154 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
|
2155 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
|
2156 getbufline({expr}, {lnum} [, {end}]) |
| 435 | 2157 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
|
2158 getbufvar({expr}, {varname} [, {def}]) |
| 4157 | 2159 any variable {varname} in buffer {expr} |
|
13280
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
2160 getchangelist({expr}) List list of change list items |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2161 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
|
2162 getcharmod() Number modifiers for the last typed character |
| 7013 | 2163 getcharsearch() Dict last character search |
| 7 | 2164 getcmdline() String return the current command-line |
| 2165 getcmdpos() Number return cursor position in command-line | |
| 6153 | 2166 getcmdtype() String return current command-line type |
| 2167 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
|
2168 getcompletion({pat}, {type} [, {filtered}]) |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
2169 List list of cmdline completion matches |
| 5944 | 2170 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
|
2171 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
|
2172 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
|
2173 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
|
2174 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
|
2175 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
|
2176 getftype({fname}) String description of type of file {fname} |
|
13246
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
2177 getjumplist([{winnr} [, {tabnr}]]) |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
2178 List list of jump list items |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2179 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
|
2180 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer |
| 12785 | 2181 getloclist({nr} [, {what}]) List list of location list items |
| 1326 | 2182 getmatches() List list of current matches |
| 1548 | 2183 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
|
2184 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
|
2185 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
|
2186 getreg([{regname} [, 1 [, {list}]]]) |
| 5796 | 2187 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
|
2188 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
|
2189 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
|
2190 gettabvar({nr}, {varname} [, {def}]) |
| 4157 | 2191 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
|
2192 gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) |
| 831 | 2193 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
|
2194 getwininfo([{winid}]) List list of windows |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
2195 getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
2196 getwinposx() Number X coord in pixels of the Vim window |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
2197 getwinposy() Number Y coord in pixels of the Vim window |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2198 getwinvar({nr}, {varname} [, {def}]) |
| 4157 | 2199 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
|
2200 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 2201 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
|
2202 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
|
2203 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 2204 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
|
2205 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
|
2206 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
|
2207 haslocaldir([{winnr} [, {tabnr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2208 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
|
2209 hasmapto({what} [, {mode} [, {abbr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2210 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
|
2211 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
|
2212 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
|
2213 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
|
2214 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
|
2215 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
|
2216 hlID({name}) Number syntax ID of highlight group {name} |
| 7 | 2217 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
|
2218 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
|
2219 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
|
2220 index({list}, {expr} [, {start} [, {ic}]]) |
| 95 | 2221 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
|
2222 input({prompt} [, {text} [, {completion}]]) |
| 531 | 2223 String get input from the user |
|
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
2224 inputdialog({prompt} [, {text} [, {completion}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2225 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
|
2226 inputlist({textlist}) Number let the user pick from a choice list |
| 55 | 2227 inputrestore() Number restore typeahead |
| 2228 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
|
2229 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
|
2230 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
|
2231 invert({expr}) Number bitwise invert |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2232 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
|
2233 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
|
2234 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
|
2235 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
|
2236 job_getchannel({job}) Channel get the channel handle for {job} |
|
13740
f309afff6f25
patch 8.0.1742: cannot get a list of all the jobs
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
2237 job_info([{job}]) Dict get information about {job} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2238 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
|
2239 job_start({command} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2240 Job start a job |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2241 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
|
2242 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
|
2243 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
|
2244 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
|
2245 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
|
2246 json_decode({string}) any decode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2247 json_encode({expr}) String encode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2248 keys({dict}) List keys in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2249 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
|
2250 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
|
2251 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
|
2252 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
|
2253 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
|
2254 lispindent({lnum}) Number Lisp indent for line {lnum} |
| 7 | 2255 localtime() Number current time |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2256 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
|
2257 log10({expr}) Float logarithm of Float {expr} to base 10 |
| 12785 | 2258 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
|
2259 map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr} |
| 12785 | 2260 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 2261 String or Dict |
| 2262 rhs of mapping {name} in mode {mode} | |
| 12785 | 2263 mapcheck({name} [, {mode} [, {abbr}]]) |
| 782 | 2264 String check for mappings matching {name} |
| 12785 | 2265 match({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2266 Number position where {pat} matches in {expr} |
| 12785 | 2267 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 2268 Number highlight {pattern} with {group} |
| 12785 | 2269 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 2270 Number highlight positions with {group} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2271 matcharg({nr}) List arguments of |:match| |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2272 matchdelete({id}) Number delete match identified by {id} |
| 12785 | 2273 matchend({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2274 Number position where {pat} ends in {expr} |
| 12785 | 2275 matchlist({expr}, {pat} [, {start} [, {count}]]) |
| 158 | 2276 List match and submatches of {pat} in {expr} |
| 12785 | 2277 matchstr({expr}, {pat} [, {start} [, {count}]]) |
| 19 | 2278 String {count}'th match of {pat} in {expr} |
| 12785 | 2279 matchstrpos({expr}, {pat} [, {start} [, {count}]]) |
|
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
2280 List {count}'th match of {pat} in {expr} |
| 10734 | 2281 max({expr}) Number maximum value of items in {expr} |
| 2282 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
|
2283 mkdir({name} [, {path} [, {prot}]]) |
| 168 | 2284 Number create directory {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2285 mode([expr]) String current editing mode |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2286 mzeval({expr}) any evaluate |MzScheme| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2287 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} |
| 12785 | 2288 nr2char({expr} [, {utf8}]) String single char with ASCII/UTF8 value {expr} |
| 13051 | 2289 option_restore({list}) none restore options saved by option_save() |
| 2290 option_save({list}) List save options values | |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2291 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
|
2292 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
|
2293 perleval({expr}) any evaluate |Perl| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2294 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
|
2295 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
|
2296 printf({fmt}, {expr1}...) String format text |
| 1621 | 2297 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
|
2298 pyeval({expr}) any evaluate |Python| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2299 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
|
2300 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
|
2301 range({expr} [, {max} [, {stride}]]) |
| 99 | 2302 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
|
2303 readfile({fname} [, {binary} [, {max}]]) |
| 168 | 2304 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
|
2305 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
|
2306 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
|
2307 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
|
2308 remote_expr({server}, {string} [, {idvar} [, {timeout}]]) |
| 7 | 2309 String send expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2310 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
|
2311 remote_peek({serverid} [, {retvar}]) |
| 7 | 2312 Number check for reply string |
|
11229
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2313 remote_read({serverid} [, {timeout}]) |
|
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2314 String read reply string |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2315 remote_send({server}, {string} [, {idvar}]) |
| 7 | 2316 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
|
2317 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
|
2318 String send key sequence |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
2319 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
|
2320 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
|
2321 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
|
2322 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
|
2323 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
|
2324 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
|
2325 round({expr}) Float round off {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2326 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
|
2327 screenchar({row}, {col}) Number character at screen position |
| 3986 | 2328 screencol() Number current cursor column |
| 2329 screenrow() Number current cursor row | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2330 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 1496 | 2331 Number search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2332 searchdecl({name} [, {global} [, {thisblock}]]) |
| 1621 | 2333 Number search for variable declaration |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2334 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 2335 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
|
2336 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 2337 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
|
2338 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) |
| 667 | 2339 List search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2340 server2client({clientid}, {string}) |
| 7 | 2341 Number send reply string |
| 2342 serverlist() String get a list of available servers | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
2343 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
|
2344 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
|
2345 {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2346 setbufvar({expr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2347 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
|
2348 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
|
2349 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
|
2350 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
|
2351 setline({lnum}, {line}) Number set line {lnum} to {line} |
| 12785 | 2352 setloclist({nr}, {list} [, {action} [, {what}]]) |
| 647 | 2353 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
|
2354 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
|
2355 setpos({expr}, {list}) Number set the {expr} position to {list} |
| 12785 | 2356 setqflist({list} [, {action} [, {what}]]) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2357 Number modify quickfix list using {list} |
| 12785 | 2358 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
|
2359 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
|
2360 settabwinvar({tabnr}, {winnr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2361 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
|
2362 page {tabnr} to {val} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2363 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
|
2364 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
|
2365 shellescape({string} [, {special}]) |
| 1661 | 2366 String escape {string} for use as shell |
| 985 | 2367 command argument |
| 3875 | 2368 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
|
2369 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
|
2370 sin({expr}) Float sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2371 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
|
2372 sort({list} [, {func} [, {dict}]]) |
| 2902 | 2373 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
|
2374 soundfold({word}) String sound-fold {word} |
| 344 | 2375 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
|
2376 spellsuggest({word} [, {max} [, {capital}]]) |
| 537 | 2377 List spelling suggestions |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2378 split({expr} [, {pat} [, {keepempty}]]) |
| 685 | 2379 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
|
2380 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
|
2381 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
|
2382 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
|
2383 strchars({expr} [, {skipcc}]) Number character length of the String {expr} |
| 12785 | 2384 strcharpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2385 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
|
2386 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} |
| 12785 | 2387 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
|
2388 strgetchar({str}, {index}) Number get char {index} from {str} |
| 12785 | 2389 stridx({haystack}, {needle} [, {start}]) |
| 133 | 2390 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
|
2391 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
|
2392 strlen({expr}) Number length of the String {expr} |
| 12785 | 2393 strpart({str}, {start} [, {len}]) |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2394 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
|
2395 strridx({haystack}, {needle} [, {start}]) |
| 140 | 2396 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
|
2397 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
|
2398 strwidth({expr}) Number display cell length of the String {expr} |
| 12785 | 2399 submatch({nr} [, {list}]) String or List |
| 5794 | 2400 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
|
2401 substitute({expr}, {pat}, {sub}, {flags}) |
| 7 | 2402 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
|
2403 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
|
2404 synIDattr({synID}, {what} [, {mode}]) |
| 7 | 2405 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
|
2406 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
|
2407 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
|
2408 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
|
2409 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
|
2410 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
|
2411 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
|
2412 tabpagenr([{arg}]) Number number of current or last tab page |
| 12785 | 2413 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page |
| 2414 taglist({expr} [, {filename}]) List list of tags matching {expr} | |
| 1621 | 2415 tagfiles() List tags files used |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2416 tan({expr}) Float tangent of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2417 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
|
2418 tempname() String name for a temporary file |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2419 term_dumpdiff({filename}, {filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2420 Number display difference between two dumps |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2421 term_dumpload({filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2422 Number displaying a screen dump |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
2423 term_dumpwrite({buf}, {filename} [, {options}]) |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2424 none dump terminal window contents |
|
12035
a3ed3d236839
patch 8.0.0898: can't use the alternate screen in a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12031
diff
changeset
|
2425 term_getaltscreen({buf}) Number get the alternate screen flag |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
2426 term_getansicolors({buf}) List get ANSI palette in GUI color mode |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
2427 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
|
2428 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
|
2429 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
|
2430 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
|
2431 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
|
2432 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
|
2433 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
|
2434 term_gettitle({buf}) String get the title of a terminal |
| 12785 | 2435 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
|
2436 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
|
2437 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
|
2438 term_sendkeys({buf}, {keys}) none send keystrokes to a terminal |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
2439 term_setansicolors({buf}, {colors}) |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
2440 none set ANSI palette in GUI color mode |
| 13735 | 2441 term_setkill({buf}, {how}) none set signal to stop job in terminal |
| 13437 | 2442 term_setrestore({buf}, {command}) none set command to restore terminal |
| 13735 | 2443 term_setsize({buf}, {rows}, {cols}) |
| 2444 none set the size of a terminal | |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
2445 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
|
2446 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
|
2447 test_alloc_fail({id}, {countdown}, {repeat}) |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2448 none make memory allocation fail |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
2449 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
|
2450 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
|
2451 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
|
2452 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
|
2453 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
|
2454 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
|
2455 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
|
2456 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
|
2457 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
|
2458 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
|
2459 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
|
2460 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
|
2461 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
|
2462 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
|
2463 timer_start({time}, {callback} [, {options}]) |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
2464 Number create a timer |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2465 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
|
2466 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
|
2467 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
|
2468 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
|
2469 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 15 | 2470 to chars in {tostr} |
| 13735 | 2471 trim({text}[, {mask}]) String trim characters in {mask} from {text} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2472 trunc({expr}) Float truncate Float {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2473 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
|
2474 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
|
2475 undotree() List undo file tree |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2476 uniq({list} [, {func} [, {dict}]]) |
| 5747 | 2477 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
|
2478 values({dict}) List values in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2479 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
|
2480 visualmode([expr]) String last visual mode used |
| 4151 | 2481 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
|
2482 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
|
2483 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
|
2484 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
|
2485 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
|
2486 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
|
2487 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
|
2488 winbufnr({nr}) Number buffer number of window {nr} |
| 7 | 2489 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
|
2490 winheight({nr}) Number height of window {nr} |
| 7 | 2491 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
|
2492 winnr([{expr}]) Number number of current window |
| 55 | 2493 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
|
2494 winrestview({dict}) none restore view of current window |
| 712 | 2495 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
|
2496 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
|
2497 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
|
2498 writefile({list}, {fname} [, {flags}]) |
| 158 | 2499 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
|
2500 xor({expr}, {expr}) Number bitwise XOR |
| 7 | 2501 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
2502 |
| 1621 | 2503 abs({expr}) *abs()* |
| 2504 Return the absolute value of {expr}. When {expr} evaluates to | |
| 2505 a |Float| abs() returns a |Float|. When {expr} can be | |
| 2506 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 2507 abs() gives an error message and returns -1. | |
| 2508 Examples: > | |
| 2509 echo abs(1.456) | |
| 2510 < 1.456 > | |
| 2511 echo abs(-5.456) | |
| 2512 < 5.456 > | |
| 2513 echo abs(-4) | |
| 2514 < 4 | |
| 2515 {only available when compiled with the |+float| feature} | |
| 2516 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2517 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2518 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2519 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
|
2520 |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
|
2521 {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
|
2522 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2523 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2524 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2525 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2526 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2527 < 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
|
2528 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2529 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2530 |
| 82 | 2531 add({list}, {expr}) *add()* |
| 685 | 2532 Append the item {expr} to |List| {list}. Returns the |
| 2533 resulting |List|. Examples: > | |
| 82 | 2534 :let alist = add([1, 2, 3], item) |
| 2535 :call add(mylist, "woodstock") | |
| 685 | 2536 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 2537 item. Use |extend()| to concatenate |Lists|. |
| 85 | 2538 Use |insert()| to add an item at another position. |
| 55 | 2539 |
| 82 | 2540 |
| 3214 | 2541 and({expr}, {expr}) *and()* |
| 2542 Bitwise AND on the two arguments. The arguments are converted | |
| 2543 to a number. A List, Dict or Float argument causes an error. | |
| 2544 Example: > | |
| 2545 :let flag = and(bits, 0x80) | |
| 2546 | |
| 2547 | |
| 82 | 2548 append({lnum}, {expr}) *append()* |
| 685 | 2549 When {expr} is a |List|: Append each item of the |List| as a |
| 2550 text line below line {lnum} in the current buffer. | |
| 153 | 2551 Otherwise append {expr} as one text line below line {lnum} in |
| 2552 the current buffer. | |
| 2553 {lnum} can be zero to insert a line before the first one. | |
| 82 | 2554 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
|
2555 0 for success. Example: > |
| 55 | 2556 :let failed = append(line('$'), "# THE END") |
| 82 | 2557 :let failed = append(0, ["Chapter 1", "the beginning"]) |
| 55 | 2558 < |
| 7 | 2559 *argc()* |
| 2560 argc() The result is the number of files in the argument list of the | |
| 2561 current window. See |arglist|. | |
| 2562 | |
| 2563 *argidx()* | |
| 2564 argidx() The result is the current index in the argument list. 0 is | |
| 2565 the first file. argc() - 1 is the last one. See |arglist|. | |
| 2566 | |
| 5942 | 2567 *arglistid()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
2568 arglistid([{winnr} [, {tabnr}]]) |
| 5942 | 2569 Return the argument list ID. This is a number which |
| 2570 identifies the argument list being used. Zero is used for the | |
| 6153 | 2571 global argument list. See |arglist|. |
| 2572 Return -1 if the arguments are invalid. | |
| 5942 | 2573 |
| 2574 Without arguments use the current window. | |
| 2575 With {winnr} only use this window in the current tab page. | |
| 2576 With {winnr} and {tabnr} use the window in the specified tab | |
| 2577 page. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2578 {winnr} can be the window number or the |window-ID|. |
| 5942 | 2579 |
| 7 | 2580 *argv()* |
| 818 | 2581 argv([{nr}]) The result is the {nr}th file in the argument list of the |
| 7 | 2582 current window. See |arglist|. "argv(0)" is the first one. |
| 2583 Example: > | |
| 2584 :let i = 0 | |
| 2585 :while i < argc() | |
| 1621 | 2586 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 2587 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 2588 : let i = i + 1 | |
| 2589 :endwhile | |
| 818 | 2590 < Without the {nr} argument a |List| with the whole |arglist| is |
| 2591 returned. | |
| 2592 | |
|
13272
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2593 assert_beeps({cmd}) *assert_beeps()* |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2594 Run {cmd} and add an error message to |v:errors| if it does |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2595 NOT produce a beep or visual bell. |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2596 Also see |assert_fails()|. |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2597 |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2598 *assert_equal()* |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2599 assert_equal({expected}, {actual} [, {msg}]) |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2600 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
|
2601 added to |v:errors|. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2602 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
|
2603 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
|
2604 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
|
2605 always matters. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2606 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
|
2607 {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
|
2608 Example: > |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2609 assert_equal('foo', 'bar') |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2610 < 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
|
2611 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
|
2612 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2613 *assert_equalfile()* |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2614 assert_equalfile({fname-one}, {fname-two}) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2615 When the files {fname-one} and {fname-two} do not contain |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2616 exactly the same text an error message is added to |v:errors|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2617 When {fname-one} or {fname-two} does not exist the error will |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2618 mention that. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2619 Mainly useful with |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2620 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2621 assert_exception({error} [, {msg}]) *assert_exception()* |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2622 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
|
2623 message is added to |v:errors|. |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2624 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
|
2625 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
|
2626 with translations: > |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2627 try |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2628 commandthatfails |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2629 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
|
2630 catch |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2631 call assert_exception('E492:') |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2632 endtry |
|
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2633 |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2634 assert_fails({cmd} [, {error}]) *assert_fails()* |
|
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2635 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
|
2636 NOT produce an error. |
|
10348
c78513465e6e
commit https://github.com/vim/vim/commit/25de4c232d580583feadae11ab34e3cc6333c350
Christian Brabandt <cb@256bit.org>
parents:
10301
diff
changeset
|
2637 When {error} is given it must match in |v:errmsg|. |
|
13272
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2638 Note that beeping is not considered an error, and some failing |
|
abaebba89fd4
patch 8.0.1510: cannot test if a command causes a beep
Christian Brabandt <cb@256bit.org>
parents:
13246
diff
changeset
|
2639 commands only beep. Use |assert_beeps()| for those. |
|
7593
87e607fb6853
commit https://github.com/vim/vim/commit/a260b87d9da17f605666630f18c1ed909c2b8bae
Christian Brabandt <cb@256bit.org>
parents:
7584
diff
changeset
|
2640 |
|
7584
9b7de205336d
commit https://github.com/vim/vim/commit/a803c7f94070f94b831fdfd1984f288c8b825b5d
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
2641 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
|
2642 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
|
2643 |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
|
2644 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
|
2645 number the assert fails. |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2646 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
|
2647 "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
|
2648 |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2649 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
|
2650 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
|
2651 {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
|
2652 |v:errors|. |
|
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2653 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
|
2654 "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
|
2655 produced. |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
2656 |
|
8749
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2657 *assert_match()* |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2658 assert_match({pattern}, {actual} [, {msg}]) |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2659 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
|
2660 added to |v:errors|. |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2661 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2662 {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
|
2663 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
|
2664 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
|
2665 |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2666 {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
|
2667 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
|
2668 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
|
2669 |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2670 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
|
2671 "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
|
2672 Example: > |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2673 assert_match('^f.*o$', 'foobar') |
|
65a5a18d3acf
commit https://github.com/vim/vim/commit/ea6553bec340920d8a09c7210cdc2d218e25ace2
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
2674 < 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
|
2675 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
|
2676 |
|
8831
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2677 *assert_notequal()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2678 assert_notequal({expected}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2679 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
|
2680 |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
|
2681 |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2682 *assert_notmatch()* |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2683 assert_notmatch({pattern}, {actual} [, {msg}]) |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2684 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
|
2685 |v:errors| when {pattern} matches {actual}. |
|
6f41d68aa68e
commit https://github.com/vim/vim/commit/b50e5f56861deb867478997397f7c784a7043233
Christian Brabandt <cb@256bit.org>
parents:
8795
diff
changeset
|
2686 |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2687 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
|
2688 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
|
2689 |
|
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2690 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
|
2691 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
|
2692 |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
|
2693 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
|
2694 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
|
2695 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
|
2696 got {actual}" is produced. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
2697 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2698 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
2699 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
|
2700 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
|
2701 {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
|
2702 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2703 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2704 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2705 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2706 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2707 < -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
|
2708 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2709 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2710 |
| 1621 | 2711 atan({expr}) *atan()* |
| 2712 Return the principal value of the arc tangent of {expr}, in | |
| 2713 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 2714 {expr} must evaluate to a |Float| or a |Number|. | |
| 2715 Examples: > | |
| 2716 :echo atan(100) | |
| 2717 < 1.560797 > | |
| 2718 :echo atan(-4.01) | |
| 2719 < -1.326405 | |
| 2720 {only available when compiled with the |+float| feature} | |
| 2721 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2722 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2723 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2724 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
|
2725 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
|
2726 {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
|
2727 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2728 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2729 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2730 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2731 < 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
|
2732 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2733 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2734 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
|
2735 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
|
2736 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
|
2737 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
|
2738 split with |balloon_split()|. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2739 |
| 11062 | 2740 Example: > |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2741 func GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2742 " initiate getting the content |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2743 return '' |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2744 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2745 set balloonexpr=GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2746 |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2747 func BalloonCallback(result) |
| 11062 | 2748 call balloon_show(a:result) |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2749 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2750 < |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
2751 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
|
2752 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
|
2753 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
|
2754 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
|
2755 empty string or a placeholder. |
| 11062 | 2756 |
| 2757 When showing a balloon is not possible nothing happens, no | |
| 2758 error message. | |
|
12885
10cb5c3df3f5
patch 8.0.1319: can't build GUI on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12883
diff
changeset
|
2759 {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
|
2760 +balloon_eval_term feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2761 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2762 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
|
2763 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
|
2764 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
|
2765 show debugger output. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2766 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
|
2767 {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
|
2768 feature} |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
2769 |
| 7 | 2770 *browse()* |
| 2771 browse({save}, {title}, {initdir}, {default}) | |
| 2772 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
|
2773 returns |TRUE| (only in some GUI versions). |
| 7 | 2774 The input fields are: |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2775 {save} when |TRUE|, select file to write |
| 7 | 2776 {title} title for the requester |
| 2777 {initdir} directory to start browsing in | |
| 2778 {default} default file name | |
| 2779 When the "Cancel" button is hit, something went wrong, or | |
| 2780 browsing is not possible, an empty string is returned. | |
| 2781 | |
| 29 | 2782 *browsedir()* |
| 2783 browsedir({title}, {initdir}) | |
| 2784 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
|
2785 "has("browse")" returns |TRUE| (only in some GUI versions). |
| 29 | 2786 On systems where a directory browser is not supported a file |
| 2787 browser is used. In that case: select a file in the directory | |
| 2788 to be used. | |
| 2789 The input fields are: | |
| 2790 {title} title for the requester | |
| 2791 {initdir} directory to start browsing in | |
| 2792 When the "Cancel" button is hit, something went wrong, or | |
| 2793 browsing is not possible, an empty string is returned. | |
| 2794 | |
| 7 | 2795 bufexists({expr}) *bufexists()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2796 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2797 {expr} exists. |
| 9 | 2798 If the {expr} argument is a number, buffer numbers are used. |
| 12909 | 2799 Number zero is the alternate buffer for the current window. |
| 2800 | |
| 7 | 2801 If the {expr} argument is a string it must match a buffer name |
| 9 | 2802 exactly. The name can be: |
| 2803 - Relative to the current directory. | |
| 2804 - A full path. | |
| 1621 | 2805 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 2806 - A URL name. |
| 7 | 2807 Unlisted buffers will be found. |
| 2808 Note that help files are listed by their short name in the | |
| 2809 output of |:buffers|, but bufexists() requires using their | |
| 2810 long name to be able to find them. | |
| 1621 | 2811 bufexists() may report a buffer exists, but to use the name |
| 2812 with a |:buffer| command you may need to use |expand()|. Esp | |
| 2813 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 2814 Use "bufexists(0)" to test for the existence of an alternate |
| 2815 file name. | |
| 2816 *buffer_exists()* | |
| 2817 Obsolete name: buffer_exists(). | |
| 2818 | |
| 2819 buflisted({expr}) *buflisted()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2820 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2821 {expr} exists and is listed (has the 'buflisted' option set). |
| 9 | 2822 The {expr} argument is used like with |bufexists()|. |
| 7 | 2823 |
| 2824 bufloaded({expr}) *bufloaded()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2825 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 2826 {expr} exists and is loaded (shown in a window or hidden). |
| 9 | 2827 The {expr} argument is used like with |bufexists()|. |
| 7 | 2828 |
| 2829 bufname({expr}) *bufname()* | |
| 2830 The result is the name of a buffer, as it is displayed by the | |
| 2831 ":ls" command. | |
| 2832 If {expr} is a Number, that buffer number's name is given. | |
| 2833 Number zero is the alternate buffer for the current window. | |
| 2834 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
|
2835 with the buffer names. This is always done like 'magic' is |
| 7 | 2836 set and 'cpoptions' is empty. When there is more than one |
| 2837 match an empty string is returned. | |
| 2838 "" or "%" can be used for the current buffer, "#" for the | |
| 2839 alternate buffer. | |
| 2840 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 2841 or middle of the buffer name is accepted. If you only want a |
| 2842 full match then put "^" at the start and "$" at the end of the | |
| 2843 pattern. | |
| 7 | 2844 Listed buffers are found first. If there is a single match |
| 2845 with a listed buffer, that one is returned. Next unlisted | |
| 2846 buffers are searched for. | |
| 2847 If the {expr} is a String, but you want to use it as a buffer | |
| 2848 number, force it to be a Number by adding zero to it: > | |
| 2849 :echo bufname("3" + 0) | |
| 2850 < If the buffer doesn't exist, or doesn't have a name, an empty | |
| 2851 string is returned. > | |
| 2852 bufname("#") alternate buffer name | |
| 2853 bufname(3) name of buffer 3 | |
| 2854 bufname("%") name of current buffer | |
| 2855 bufname("file2") name of buffer where "file2" matches. | |
| 2856 < *buffer_name()* | |
| 2857 Obsolete name: buffer_name(). | |
| 2858 | |
| 2859 *bufnr()* | |
| 707 | 2860 bufnr({expr} [, {create}]) |
| 2861 The result is the number of a buffer, as it is displayed by | |
| 7 | 2862 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 2863 above. |
| 2864 If the buffer doesn't exist, -1 is returned. Or, if the | |
| 2865 {create} argument is present and not zero, a new, unlisted, | |
| 2866 buffer is created and its number is returned. | |
| 7 | 2867 bufnr("$") is the last buffer: > |
| 2868 :let last_buffer = bufnr("$") | |
| 2869 < The result is a Number, which is the highest buffer number | |
| 2870 of existing buffers. Note that not all buffers with a smaller | |
| 2871 number necessarily exist, because ":bwipeout" may have removed | |
| 2872 them. Use bufexists() to test for the existence of a buffer. | |
| 2873 *buffer_number()* | |
| 2874 Obsolete name: buffer_number(). | |
| 2875 *last_buffer_nr()* | |
| 2876 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 2877 | |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2878 bufwinid({expr}) *bufwinid()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2879 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
|
2880 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
|
2881 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
|
2882 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
|
2883 |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2884 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
|
2885 < |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
2886 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
|
2887 |
| 7 | 2888 bufwinnr({expr}) *bufwinnr()* |
| 2889 The result is a Number, which is the number of the first | |
| 2890 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
|
2891 see |bufname()| above. If buffer {expr} doesn't exist or |
| 7 | 2892 there is no such window, -1 is returned. Example: > |
| 2893 | |
| 2894 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 2895 | |
| 2896 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 2897 |:wincmd|. | |
| 1156 | 2898 Only deals with the current tab page. |
| 7 | 2899 |
| 2900 byte2line({byte}) *byte2line()* | |
| 2901 Return the line number that contains the character at byte | |
| 2902 count {byte} in the current buffer. This includes the | |
| 2903 end-of-line character, depending on the 'fileformat' option | |
| 2904 for the current buffer. The first character has byte count | |
| 2905 one. | |
| 2906 Also see |line2byte()|, |go| and |:goto|. | |
| 2907 {not available when compiled without the |+byte_offset| | |
| 2908 feature} | |
| 2909 | |
| 18 | 2910 byteidx({expr}, {nr}) *byteidx()* |
| 2911 Return byte index of the {nr}'th character in the string | |
| 2912 {expr}. Use zero for the first character, it returns zero. | |
| 2913 This function is only useful when there are multibyte | |
| 2914 characters, otherwise the returned value is equal to {nr}. | |
| 5413 | 2915 Composing characters are not counted separately, their byte |
| 2916 length is added to the preceding base character. See | |
| 2917 |byteidxcomp()| below for counting composing characters | |
| 2918 separately. | |
| 18 | 2919 Example : > |
| 2920 echo matchstr(str, ".", byteidx(str, 3)) | |
| 2921 < will display the fourth character. Another way to do the | |
| 2922 same: > | |
| 2923 let s = strpart(str, byteidx(str, 3)) | |
| 2924 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
|
2925 < Also see |strgetchar()| and |strcharpart()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2926 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2927 If there are less than {nr} characters -1 is returned. |
| 18 | 2928 If there are exactly {nr} characters the length of the string |
| 5413 | 2929 in bytes is returned. |
| 2930 | |
| 2931 byteidxcomp({expr}, {nr}) *byteidxcomp()* | |
| 2932 Like byteidx(), except that a composing character is counted | |
| 2933 as a separate character. Example: > | |
| 2934 let s = 'e' . nr2char(0x301) | |
| 2935 echo byteidx(s, 1) | |
| 2936 echo byteidxcomp(s, 1) | |
| 2937 echo byteidxcomp(s, 2) | |
| 2938 < The first and third echo result in 3 ('e' plus composing | |
| 2939 character is 3 bytes), the second echo results in 1 ('e' is | |
| 2940 one byte). | |
| 2941 Only works different from byteidx() when 'encoding' is set to | |
| 2942 a Unicode encoding. | |
| 18 | 2943 |
| 102 | 2944 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 2945 Call function {func} with the items in |List| {arglist} as |
| 79 | 2946 arguments. |
| 685 | 2947 {func} can either be a |Funcref| or the name of a function. |
| 79 | 2948 a:firstline and a:lastline are set to the cursor line. |
| 2949 Returns the return value of the called function. | |
| 102 | 2950 {dict} is for functions with the "dict" attribute. It will be |
| 2951 used to set the local variable "self". |Dictionary-function| | |
| 79 | 2952 |
| 1621 | 2953 ceil({expr}) *ceil()* |
| 2954 Return the smallest integral value greater than or equal to | |
| 2955 {expr} as a |Float| (round up). | |
| 2956 {expr} must evaluate to a |Float| or a |Number|. | |
| 2957 Examples: > | |
| 2958 echo ceil(1.456) | |
| 2959 < 2.0 > | |
| 2960 echo ceil(-5.456) | |
| 2961 < -5.0 > | |
| 2962 echo ceil(4.0) | |
| 2963 < 4.0 | |
| 2964 {only available when compiled with the |+float| feature} | |
| 2965 | |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2966 ch_canread({handle}) *ch_canread()* |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2967 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
|
2968 {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
|
2969 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2970 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
|
2971 e.g. from a timer. |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2972 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2973 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
|
2974 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
|
2975 |
|
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2976 {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
|
2977 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2978 ch_close({handle}) *ch_close()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2979 Close {handle}. See |channel-close|. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
2980 {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
|
2981 A close callback is not invoked. |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
2982 |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
2983 {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
|
2984 |
|
d4b7232fc63a
commit https://github.com/vim/vim/commit/0874a83e9be1b39fdb217f02b427bf1d6133a4d8
Christian Brabandt <cb@256bit.org>
parents:
10051
diff
changeset
|
2985 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
|
2986 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
|
2987 {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
|
2988 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
|
2989 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
2990 {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
|
2991 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2992 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
|
2993 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
|
2994 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
|
2995 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
|
2996 {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
|
2997 *E917* |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
2998 {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
|
2999 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
|
3000 for this specific request. |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3001 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3002 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
|
3003 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
|
3004 empty string. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3005 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3006 {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
|
3007 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3008 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
|
3009 Send {string} over {handle}. |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3010 {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
|
3011 |
|
8285
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3012 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
|
3013 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
|
3014 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
|
3015 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
|
3016 is removed. |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
3017 Note that Vim does not know when the text received on a raw |
| 12785 | 3018 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
|
3019 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
|
3020 See |channel-use|. |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3021 |
|
e05e28dcb590
commit https://github.com/vim/vim/commit/8b1862a31639becadcbbca5dc2eaa92db73e8e5f
Christian Brabandt <cb@256bit.org>
parents:
8275
diff
changeset
|
3022 {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
|
3023 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3024 ch_getbufnr({handle}, {what}) *ch_getbufnr()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3025 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
|
3026 {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
|
3027 {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
|
3028 socket output. |
|
ac0c43e7af20
commit https://github.com/vim/vim/commit/c7f0ebc6d1e1cdaed816b88a0d6092c5ace615eb
Christian Brabandt <cb@256bit.org>
parents:
8285
diff
changeset
|
3029 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
|
3030 {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
|
3031 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3032 ch_getjob({channel}) *ch_getjob()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3033 Get the Job associated with {channel}. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3034 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
|
3035 will result in "fail". |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3036 |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3037 {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
|
3038 |+job| features} |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3039 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3040 ch_info({handle}) *ch_info()* |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3041 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
|
3042 items are: |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3043 "id" number of the channel |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3044 "status" "open", "buffered" or "closed", like |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3045 ch_status() |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3046 When opened with ch_open(): |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3047 "hostname" the hostname of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3048 "port" the port of the address |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3049 "sock_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3050 "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
|
3051 "sock_io" "socket" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3052 "sock_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3053 When opened with job_start(): |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3054 "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
|
3055 "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
|
3056 "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
|
3057 "out_timeout" timeout in msec |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3058 "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
|
3059 "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
|
3060 "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
|
3061 "err_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3062 "in_status" "open" or "closed" |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3063 "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
|
3064 "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
|
3065 "in_timeout" timeout in msec |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
3066 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3067 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
|
3068 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
|
3069 |ch_logfile()|. |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3070 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
|
3071 message. |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10422
diff
changeset
|
3072 {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
|
3073 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
|
3074 |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3075 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
|
3076 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
|
3077 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
|
3078 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3079 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
|
3080 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
|
3081 |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3082 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
|
3083 "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
|
3084 |
|
12025
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
3085 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
|
3086 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
|
3087 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
|
3088 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
|
3089 |
|
8392
1bf1b88968a2
commit https://github.com/vim/vim/commit/328da0dcb7be34b594725eef6dc98d3ea6516d69
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
3090 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3091 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
|
3092 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
|
3093 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
|
3094 |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3095 {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
|
3096 "localhost:8765". |
|
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
3097 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3098 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
|
3099 See |channel-open-options|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3100 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3101 {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
|
3102 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3103 ch_read({handle} [, {options}]) *ch_read()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3104 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
|
3105 {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
|
3106 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
|
3107 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
|
3108 See |channel-more|. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3109 {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
|
3110 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3111 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
|
3112 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
|
3113 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
|
3114 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
|
3115 See |channel-more|. |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3116 {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
|
3117 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3118 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
|
3119 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
|
3120 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
|
3121 with a raw channel. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
3122 See |channel-use|. *E912* |
|
10422
e664ee056a84
commit https://github.com/vim/vim/commit/4b785f69c0616dba5d3f38e8ce4b5398cec89407
Christian Brabandt <cb@256bit.org>
parents:
10404
diff
changeset
|
3123 {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
|
3124 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3125 {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
|
3126 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3127 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
|
3128 Send {string} over {handle}. |
|
7992
78106b0f2c56
commit https://github.com/vim/vim/commit/cbebd4879cc78e670d79b2c57dc33d7b911c962a
Christian Brabandt <cb@256bit.org>
parents:
7967
diff
changeset
|
3129 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
|
3130 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
|
3131 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
|
3132 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
|
3133 is removed. |
|
18a3f0f05244
commit https://github.com/vim/vim/commit/910b8aac5dc4693c4508b7acd2cef0bbfac04242
Christian Brabandt <cb@256bit.org>
parents:
8078
diff
changeset
|
3134 See |channel-use|. |
|
7895
bff95e0d8885
commit https://github.com/vim/vim/commit/f57969a20a4398f56e3028a6cc1102f9f9286ccf
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3135 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
3136 {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
|
3137 |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3138 ch_setoptions({handle}, {options}) *ch_setoptions()* |
|
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
3139 Set options on {handle}: |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3140 "callback" the channel callback |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3141 "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
|
3142 "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
|
3143 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
|
3144 {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
|
3145 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3146 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
|
3147 lost. |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
3148 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3149 These options cannot be changed: |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3150 "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
|
3151 |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3152 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
|
3153 Return the status of {handle}: |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3154 "fail" failed to open the channel |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
3155 "open" channel can be used |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
3156 "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
|
3157 "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
|
3158 {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
|
3159 "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
|
3160 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
|
3161 |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3162 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
|
3163 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
|
3164 "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
|
3165 ch_status(job, {"part": "err"}) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
3166 < |
| 11062 | 3167 changenr() *changenr()* |
| 3168 Return the number of the most recent change. This is the same | |
| 3169 number as what is displayed with |:undolist| and can be used | |
| 3170 with the |:undo| command. | |
| 3171 When a change was made it is the number of that change. After | |
| 3172 redo it is the number of the redone change. After undo it is | |
| 3173 one less than the number of the undone change. | |
| 3174 | |
| 12785 | 3175 char2nr({expr} [, {utf8}]) *char2nr()* |
| 11062 | 3176 Return number value of the first char in {expr}. Examples: > |
| 3177 char2nr(" ") returns 32 | |
| 3178 char2nr("ABC") returns 65 | |
| 3179 < When {utf8} is omitted or zero, the current 'encoding' is used. | |
| 3180 Example for "utf-8": > | |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
3181 char2nr("á") returns 225 |
|
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
3182 char2nr("á"[0]) returns 195 |
| 11062 | 3183 < With {utf8} set to 1, always treat as utf-8 characters. |
| 3184 A combining character is a separate character. | |
| 3185 |nr2char()| does the opposite. | |
| 3186 | |
| 3187 cindent({lnum}) *cindent()* | |
| 3188 Get the amount of indent for line {lnum} according the C | |
| 3189 indenting rules, as with 'cindent'. | |
| 3190 The indent is counted in spaces, the value of 'tabstop' is | |
| 3191 relevant. {lnum} is used just like in |getline()|. | |
| 3192 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 3193 feature, -1 is returned. | |
| 3194 See |C-indenting|. | |
| 3195 | |
| 3196 clearmatches() *clearmatches()* | |
| 3197 Clears all matches previously defined by |matchadd()| and the | |
| 3198 |:match| commands. | |
| 3199 | |
| 3200 *col()* | |
| 3201 col({expr}) The result is a Number, which is the byte index of the column | |
| 3202 position given with {expr}. The accepted positions are: | |
| 3203 . the cursor position | |
| 3204 $ the end of the cursor line (the result is the | |
| 3205 number of bytes in the cursor line plus one) | |
| 3206 'x position of mark x (if the mark is not set, 0 is | |
| 3207 returned) | |
| 3208 v In Visual mode: the start of the Visual area (the | |
| 3209 cursor is the end). When not in Visual mode | |
| 3210 returns the cursor position. Differs from |'<| in | |
| 3211 that it's updated right away. | |
| 3212 Additionally {expr} can be [lnum, col]: a |List| with the line | |
| 3213 and column number. Most useful when the column is "$", to get | |
| 3214 the last column of a specific line. When "lnum" or "col" is | |
| 3215 out of range then col() returns zero. | |
| 3216 To get the line number use |line()|. To get both use | |
| 3217 |getpos()|. | |
| 3218 For the screen column position use |virtcol()|. | |
| 3219 Note that only marks in the current file can be used. | |
| 3220 Examples: > | |
| 3221 col(".") column of cursor | |
| 3222 col("$") length of cursor line plus one | |
| 3223 col("'t") column of mark t | |
| 3224 col("'" . markname) column of mark markname | |
| 3225 < The first column is 1. 0 is returned for an error. | |
| 3226 For an uppercase mark the column may actually be in another | |
| 3227 buffer. | |
| 3228 For the cursor position, when 'virtualedit' is active, the | |
| 3229 column is one higher if the cursor is after the end of the | |
| 3230 line. This can be used to obtain the column in Insert mode: > | |
| 3231 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 3232 \<C-O>:set ve=all<CR> | |
| 3233 \<C-O>:echo col(".") . "\n" <Bar> | |
| 3234 \let &ve = save_ve<CR> | |
| 3235 < | |
| 3236 | |
| 3237 complete({startcol}, {matches}) *complete()* *E785* | |
| 3238 Set the matches for Insert mode completion. | |
| 3239 Can only be used in Insert mode. You need to use a mapping | |
| 3240 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O | |
| 3241 or with an expression mapping. | |
| 3242 {startcol} is the byte offset in the line where the completed | |
| 3243 text start. The text up to the cursor is the original text | |
| 3244 that will be replaced by the matches. Use col('.') for an | |
| 3245 empty string. "col('.') - 1" will replace one character by a | |
| 3246 match. | |
| 3247 {matches} must be a |List|. Each |List| item is one match. | |
| 3248 See |complete-items| for the kind of items that are possible. | |
| 3249 Note that the after calling this function you need to avoid | |
| 3250 inserting anything that would cause completion to stop. | |
| 3251 The match can be selected with CTRL-N and CTRL-P as usual with | |
| 3252 Insert mode completion. The popup menu will appear if | |
| 3253 specified, see |ins-completion-menu|. | |
| 3254 Example: > | |
| 3255 inoremap <F5> <C-R>=ListMonths()<CR> | |
| 3256 | |
| 3257 func! ListMonths() | |
| 3258 call complete(col('.'), ['January', 'February', 'March', | |
| 3259 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 3260 \ 'October', 'November', 'December']) | |
| 3261 return '' | |
| 3262 endfunc | |
| 3263 < This isn't very useful, but it shows how it works. Note that | |
| 3264 an empty string is returned to avoid a zero being inserted. | |
| 3265 | |
| 3266 complete_add({expr}) *complete_add()* | |
| 3267 Add {expr} to the list of matches. Only to be used by the | |
| 3268 function specified with the 'completefunc' option. | |
| 3269 Returns 0 for failure (empty string or out of memory), | |
| 3270 1 when the match was added, 2 when the match was already in | |
| 3271 the list. | |
| 3272 See |complete-functions| for an explanation of {expr}. It is | |
| 3273 the same as one item in the list that 'omnifunc' would return. | |
| 3274 | |
| 3275 complete_check() *complete_check()* | |
| 3276 Check for a key typed while looking for completion matches. | |
| 3277 This is to be used when looking for matches takes some time. | |
| 3278 Returns |TRUE| when searching for matches is to be aborted, | |
| 3279 zero otherwise. | |
| 3280 Only to be used by the function specified with the | |
| 3281 'completefunc' option. | |
| 3282 | |
| 3283 *confirm()* | |
| 3284 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
| 3285 Confirm() offers the user a dialog, from which a choice can be | |
| 3286 made. It returns the number of the choice. For the first | |
| 3287 choice this is 1. | |
| 3288 Note: confirm() is only supported when compiled with dialog | |
| 3289 support, see |+dialog_con| and |+dialog_gui|. | |
| 3290 | |
| 3291 {msg} is displayed in a |dialog| with {choices} as the | |
| 3292 alternatives. When {choices} is missing or empty, "&OK" is | |
| 3293 used (and translated). | |
| 3294 {msg} is a String, use '\n' to include a newline. Only on | |
| 3295 some systems the string is wrapped when it doesn't fit. | |
| 3296 | |
| 3297 {choices} is a String, with the individual choices separated | |
| 3298 by '\n', e.g. > | |
| 3299 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 3300 < The letter after the '&' is the shortcut key for that choice. | |
| 3301 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 3302 not need to be the first letter: > | |
| 3303 confirm("file has been modified", "&Save\nSave &All") | |
| 3304 < For the console, the first letter of each choice is used as | |
| 3305 the default shortcut key. | |
| 3306 | |
| 3307 The optional {default} argument is the number of the choice | |
| 3308 that is made if the user hits <CR>. Use 1 to make the first | |
| 3309 choice the default one. Use 0 to not set a default. If | |
| 3310 {default} is omitted, 1 is used. | |
| 3311 | |
| 3312 The optional {type} argument gives the type of dialog. This | |
| 3313 is only used for the icon of the GTK, Mac, Motif and Win32 | |
| 3314 GUI. It can be one of these values: "Error", "Question", | |
| 3315 "Info", "Warning" or "Generic". Only the first character is | |
| 3316 relevant. When {type} is omitted, "Generic" is used. | |
| 3317 | |
| 3318 If the user aborts the dialog by pressing <Esc>, CTRL-C, | |
| 3319 or another valid interrupt key, confirm() returns 0. | |
| 3320 | |
| 3321 An example: > | |
| 3322 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 3323 :if choice == 0 | |
| 3324 : echo "make up your mind!" | |
| 3325 :elseif choice == 3 | |
| 3326 : echo "tasteful" | |
| 3327 :else | |
| 3328 : echo "I prefer bananas myself." | |
| 3329 :endif | |
| 3330 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 3331 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 3332 the buttons are always put vertically. Otherwise, confirm() | |
| 3333 tries to put the buttons in one horizontal line. If they | |
| 3334 don't fit, a vertical layout is used anyway. For some systems | |
| 3335 the horizontal layout is always used. | |
| 3336 | |
| 55 | 3337 *copy()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3338 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3339 different from using {expr} directly. |
| 685 | 3340 When {expr} is a |List| a shallow copy is created. This means |
| 3341 that the original |List| can be changed without changing the | |
| 1621 | 3342 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
|
3343 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
|
3344 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
|
3345 Also see |deepcopy()|. |
| 55 | 3346 |
| 1621 | 3347 cos({expr}) *cos()* |
| 3348 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 3349 {expr} must evaluate to a |Float| or a |Number|. | |
| 3350 Examples: > | |
| 3351 :echo cos(100) | |
| 3352 < 0.862319 > | |
| 3353 :echo cos(-4.01) | |
| 3354 < -0.646043 | |
| 3355 {only available when compiled with the |+float| feature} | |
| 3356 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3357 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3358 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3359 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
|
3360 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3361 {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
|
3362 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3363 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3364 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3365 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3366 < -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
|
3367 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3368 |
| 12785 | 3369 |
| 102 | 3370 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 3371 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
|
3372 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
|
3373 |
| 102 | 3374 If {start} is given then start with the item with this index. |
| 685 | 3375 {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
|
3376 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3377 When {ic} is given and it's |TRUE| then case is ignored. |
| 79 | 3378 |
|
11828
5a07a3ff56c1
patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents:
11763
diff
changeset
|
3379 When {comp} is a string then the number of not overlapping |
|
13070
17720967656c
patch 8.0.1410: hang when using count() with an empty string
Christian Brabandt <cb@256bit.org>
parents:
13062
diff
changeset
|
3380 occurrences of {expr} is returned. Zero is returned when |
|
17720967656c
patch 8.0.1410: hang when using count() with an empty string
Christian Brabandt <cb@256bit.org>
parents:
13062
diff
changeset
|
3381 {expr} is an empty string. |
| 79 | 3382 |
| 7 | 3383 *cscope_connection()* |
| 3384 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 3385 Checks for the existence of a |cscope| connection. If no | |
| 3386 parameters are specified, then the function returns: | |
| 3387 0, if cscope was not available (not compiled in), or | |
| 3388 if there are no cscope connections; | |
| 3389 1, if there is at least one cscope connection. | |
| 3390 | |
| 3391 If parameters are specified, then the value of {num} | |
| 3392 determines how existence of a cscope connection is checked: | |
| 3393 | |
| 3394 {num} Description of existence check | |
| 3395 ----- ------------------------------ | |
| 3396 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 3397 1 Ignore {prepend}, and use partial string matches for | |
| 3398 {dbpath}. | |
| 3399 2 Ignore {prepend}, and use exact string matches for | |
| 3400 {dbpath}. | |
| 3401 3 Use {prepend}, use partial string matches for both | |
| 3402 {dbpath} and {prepend}. | |
| 3403 4 Use {prepend}, use exact string matches for both | |
| 3404 {dbpath} and {prepend}. | |
| 3405 | |
| 3406 Note: All string comparisons are case sensitive! | |
| 3407 | |
| 3408 Examples. Suppose we had the following (from ":cs show"): > | |
| 3409 | |
| 3410 # pid database name prepend path | |
| 3411 0 27664 cscope.out /usr/local | |
| 3412 < | |
| 3413 Invocation Return Val ~ | |
| 3414 ---------- ---------- > | |
| 3415 cscope_connection() 1 | |
| 3416 cscope_connection(1, "out") 1 | |
| 3417 cscope_connection(2, "out") 0 | |
| 3418 cscope_connection(3, "out") 0 | |
| 3419 cscope_connection(3, "out", "local") 1 | |
| 3420 cscope_connection(4, "out") 0 | |
| 3421 cscope_connection(4, "out", "local") 0 | |
| 3422 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 3423 < | |
| 703 | 3424 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 3425 cursor({list}) | |
| 1156 | 3426 Positions the cursor at the column (byte count) {col} in the |
| 3427 line {lnum}. The first column is one. | |
| 5938 | 3428 |
| 703 | 3429 When there is one argument {list} this is used as a |List| |
| 5938 | 3430 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
|
3431 [{lnum}, {col}] |
| 5938 | 3432 [{lnum}, {col}, {off}] |
| 3433 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 3434 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 3435 but without the first item. |
| 5938 | 3436 |
| 7 | 3437 Does not change the jumplist. |
| 3438 If {lnum} is greater than the number of lines in the buffer, | |
| 3439 the cursor will be positioned at the last line in the buffer. | |
| 3440 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 3441 If {col} is greater than the number of bytes in the line, |
| 7 | 3442 the cursor will be positioned at the last character in the |
| 3443 line. | |
| 3444 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 3445 If {curswant} is given it is used to set the preferred column |
| 6180 | 3446 for vertical movement. Otherwise {col} is used. |
| 6385 | 3447 |
| 703 | 3448 When 'virtualedit' is used {off} specifies the offset in |
| 3449 screen columns from the start of the character. E.g., a | |
| 1266 | 3450 position within a <Tab> or after the last character. |
| 1851 | 3451 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 3452 |
| 55 | 3453 |
| 12785 | 3454 deepcopy({expr} [, {noref}]) *deepcopy()* *E698* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3455 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3456 different from using {expr} directly. |
| 685 | 3457 When {expr} is a |List| a full copy is created. This means |
| 3458 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
|
3459 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
|
3460 |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
|
3461 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
|
3462 the original |List|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
3463 A |Dictionary| is copied in a similar way as a |List|. |
| 685 | 3464 When {noref} is omitted or zero a contained |List| or |
| 3465 |Dictionary| is only copied once. All references point to | |
| 3466 this single copy. With {noref} set to 1 every occurrence of a | |
| 3467 |List| or |Dictionary| results in a new copy. This also means | |
| 3468 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 3469 *E724* |
| 3470 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 3471 that refers back to a higher level making a deep copy with |
| 3472 {noref} set to 1 will fail. | |
| 55 | 3473 Also see |copy()|. |
| 3474 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3475 delete({fname} [, {flags}]) *delete()* |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3476 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
|
3477 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
|
3478 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3479 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
|
3480 {fname}. This fails when directory {fname} is not empty. |
| 12785 | 3481 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3482 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
|
3483 {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
|
3484 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
|
3485 that is being used. |
|
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
10000
diff
changeset
|
3486 |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
3487 A symbolic link itself is deleted, not what it points to. |
| 12785 | 3488 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
3489 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
|
3490 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
|
3491 |
| 685 | 3492 Use |remove()| to delete an item from a |List|. |
| 4229 | 3493 To delete a line from the buffer use |:delete|. Use |:exe| |
| 3494 when the line number is in a variable. | |
| 7 | 3495 |
| 3496 *did_filetype()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3497 did_filetype() Returns |TRUE| when autocommands are being executed and the |
| 7 | 3498 FileType event has been triggered at least once. Can be used |
| 3499 to avoid triggering the FileType event again in the scripts | |
| 3500 that detect the file type. |FileType| | |
| 11473 | 3501 Returns |FALSE| when `:setf FALLBACK` was used. |
| 7 | 3502 When editing another file, the counter is reset, thus this |
| 3503 really checks if the FileType event has been triggered for the | |
| 3504 current buffer. This allows an autocommand that starts | |
| 3505 editing another buffer to set 'filetype' and load a syntax | |
| 3506 file. | |
| 3507 | |
| 32 | 3508 diff_filler({lnum}) *diff_filler()* |
| 3509 Returns the number of filler lines above line {lnum}. | |
| 3510 These are the lines that were inserted at this point in | |
| 3511 another diff'ed window. These filler lines are shown in the | |
| 3512 display but don't exist in the buffer. | |
| 3513 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3514 line, "'m" mark m, etc. | |
| 3515 Returns 0 if the current window is not in diff mode. | |
| 3516 | |
| 3517 diff_hlID({lnum}, {col}) *diff_hlID()* | |
| 3518 Returns the highlight ID for diff mode at line {lnum} column | |
| 3519 {col} (byte index). When the current line does not have a | |
| 3520 diff change zero is returned. | |
| 3521 {lnum} is used like with |getline()|. Thus "." is the current | |
| 3522 line, "'m" mark m, etc. | |
| 3523 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 3524 line. | |
| 3525 The highlight ID can be used with |synIDattr()| to obtain | |
| 3526 syntax information about the highlighting. | |
| 3527 | |
| 85 | 3528 empty({expr}) *empty()* |
| 3529 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
|
3530 - 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
|
3531 items. |
| 12785 | 3532 - 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
|
3533 - 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
|
3534 - |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
|
3535 - 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
|
3536 - 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
|
3537 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
3538 For a long |List| this is much faster than comparing the |
| 685 | 3539 length with zero. |
| 85 | 3540 |
| 7 | 3541 escape({string}, {chars}) *escape()* |
| 3542 Escape the characters in {chars} that occur in {string} with a | |
| 3543 backslash. Example: > | |
| 3544 :echo escape('c:\program files\vim', ' \') | |
| 3545 < results in: > | |
| 3546 c:\\program\ files\\vim | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
3547 < Also see |shellescape()| and |fnameescape()|. |
| 1621 | 3548 |
| 3549 *eval()* | |
| 95 | 3550 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 3551 turn the result of |string()| back into the original value. | |
| 1621 | 3552 This works for Numbers, Floats, Strings and composites of |
| 3553 them. Also works for |Funcref|s that refer to existing | |
| 3554 functions. | |
| 95 | 3555 |
| 7 | 3556 eventhandler() *eventhandler()* |
| 3557 Returns 1 when inside an event handler. That is that Vim got | |
| 3558 interrupted while waiting for the user to type a character, | |
| 3559 e.g., when dropping a file on Vim. This means interactive | |
| 3560 commands cannot be used. Otherwise zero is returned. | |
| 3561 | |
| 3562 executable({expr}) *executable()* | |
| 3563 This function checks if an executable with the name {expr} | |
| 3564 exists. {expr} must be the name of the program without any | |
| 10 | 3565 arguments. |
| 3566 executable() uses the value of $PATH and/or the normal | |
| 3567 searchpath for programs. *PATHEXT* | |
| 3568 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can | |
| 3569 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
|
3570 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
|
3571 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is |
| 10 | 3572 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
|
3573 the name without an extension. When 'shell' looks like a |
| 10 | 3574 Unix shell, then the name is also tried without adding an |
| 3575 extension. | |
| 3576 On MS-DOS and MS-Windows it only checks if the file exists and | |
| 3577 is not a directory, not if it's really executable. | |
| 819 | 3578 On MS-Windows an executable in the same directory as Vim is |
| 3579 always found. Since this directory is added to $PATH it | |
| 3580 should also work to execute it |win32-PATH|. | |
| 7 | 3581 The result is a Number: |
| 3582 1 exists | |
| 3583 0 does not exist | |
| 3584 -1 not implemented on this system | |
| 3585 | |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3586 execute({command} [, {silent}]) *execute()* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3587 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
|
3588 string. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3589 {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
|
3590 lines are executed one by one. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3591 This is equivalent to: > |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3592 redir => var |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3593 {command} |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3594 redir END |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3595 < |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3596 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
|
3597 "" no `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3598 "silent" `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3599 "silent!" `:silent!` used |
| 11062 | 3600 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
|
3601 `: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
|
3602 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
|
3603 *E930* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3604 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
|
3605 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3606 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
|
3607 split(execute('args'), "\n") |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3608 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
3609 < 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
|
3610 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
|
3611 |
| 5782 | 3612 exepath({expr}) *exepath()* |
| 3613 If {expr} is an executable and is either an absolute path, a | |
| 3614 relative path or found in $PATH, return the full path. | |
| 3615 Note that the current directory is used when {expr} starts | |
| 3616 with "./", which may be a problem for Vim: > | |
| 3617 echo exepath(v:progpath) | |
| 5814 | 3618 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 3619 an empty string is returned. |
| 3620 | |
| 7 | 3621 *exists()* |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3622 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
|
3623 zero otherwise. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3624 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3625 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
|
3626 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
|
3627 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3628 The {expr} argument is a string, which contains one of these: |
| 7 | 3629 &option-name Vim option (only checks if it exists, |
| 3630 not if it really works) | |
| 3631 +option-name Vim option that works. | |
| 3632 $ENVNAME environment variable (could also be | |
| 3633 done by comparing with an empty | |
| 3634 string) | |
| 3635 *funcname built-in function (see |functions|) | |
| 3636 or user defined function (see | |
| 5862 | 3637 |user-functions|). Also works for a |
| 3638 variable that is a Funcref. | |
| 7 | 3639 varname internal variable (see |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3640 |internal-variables|). Also works |
| 685 | 3641 for |curly-braces-names|, |Dictionary| |
| 3642 entries, |List| items, etc. Beware | |
| 1668 | 3643 that evaluating an index may cause an |
| 3644 error message for an invalid | |
| 3645 expression. E.g.: > | |
| 3646 :let l = [1, 2, 3] | |
| 3647 :echo exists("l[5]") | |
| 3648 < 0 > | |
| 3649 :echo exists("l[xx]") | |
| 3650 < E121: Undefined variable: xx | |
| 3651 0 | |
| 7 | 3652 :cmdname Ex command: built-in command, user |
| 3653 command or command modifier |:command|. | |
| 3654 Returns: | |
| 3655 1 for match with start of a command | |
| 3656 2 full match with a command | |
| 3657 3 matches several user commands | |
| 3658 To check for a supported command | |
| 3659 always check the return value to be 2. | |
| 864 | 3660 :2match The |:2match| command. |
| 3661 :3match The |:3match| command. | |
| 7 | 3662 #event autocommand defined for this event |
| 3663 #event#pattern autocommand defined for this event and | |
| 3664 pattern (the pattern is taken | |
| 3665 literally and compared to the | |
| 3666 autocommand patterns character by | |
| 3667 character) | |
| 613 | 3668 #group autocommand group exists |
| 3669 #group#event autocommand defined for this group and | |
| 3670 event. | |
| 3671 #group#event#pattern | |
| 856 | 3672 autocommand defined for this group, |
| 613 | 3673 event and pattern. |
| 615 | 3674 ##event autocommand for this event is |
| 3675 supported. | |
| 7 | 3676 |
| 3677 Examples: > | |
| 3678 exists("&shortname") | |
| 3679 exists("$HOSTNAME") | |
| 3680 exists("*strftime") | |
| 3681 exists("*s:MyFunc") | |
| 3682 exists("bufcount") | |
| 3683 exists(":Make") | |
| 613 | 3684 exists("#CursorHold") |
| 7 | 3685 exists("#BufReadPre#*.gz") |
| 613 | 3686 exists("#filetypeindent") |
| 3687 exists("#filetypeindent#FileType") | |
| 3688 exists("#filetypeindent#FileType#*") | |
| 615 | 3689 exists("##ColorScheme") |
| 7 | 3690 < There must be no space between the symbol (&/$/*/#) and the |
| 3691 name. | |
| 867 | 3692 There must be no extra characters after the name, although in |
| 3693 a few cases this is ignored. That may become more strict in | |
| 3694 the future, thus don't count on it! | |
| 3695 Working example: > | |
| 3696 exists(":make") | |
| 3697 < NOT working example: > | |
| 3698 exists(":make install") | |
| 859 | 3699 |
| 3700 < Note that the argument must be a string, not the name of the | |
| 3701 variable itself. For example: > | |
| 7 | 3702 exists(bufcount) |
| 3703 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 3704 but gets the value of "bufcount", and checks if that exists. |
| 7 | 3705 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3706 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3707 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
|
3708 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3709 {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
|
3710 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3711 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3712 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3713 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3714 < 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
|
3715 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3716 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3717 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3718 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 3719 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
|
3720 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
3721 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3722 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
|
3723 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
|
3724 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
|
3725 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
|
3726 file name contains a space] |
| 7 | 3727 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3728 If the expansion fails, the result is an empty string. A name |
| 4869 | 3729 for a non-existing file is not included, unless {expr} does |
| 3730 not start with '%', '#' or '<', see below. | |
| 7 | 3731 |
| 3732 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 3733 like for the |cmdline-special| variables with their associated | |
| 3734 modifiers. Here is a short overview: | |
| 3735 | |
| 3736 % current file name | |
| 3737 # alternate file name | |
| 3738 #n alternate file name n | |
| 3739 <cfile> file name under the cursor | |
| 3740 <afile> autocmd file name | |
| 3741 <abuf> autocmd buffer number (as a String!) | |
| 3742 <amatch> autocmd matched name | |
| 5734 | 3743 <sfile> sourced script file or function name |
| 2662 | 3744 <slnum> sourced script file line number |
| 7 | 3745 <cword> word under the cursor |
| 3746 <cWORD> WORD under the cursor | |
| 3747 <client> the {clientid} of the last received | |
| 3748 message |server2client()| | |
| 3749 Modifiers: | |
| 3750 :p expand to full path | |
| 3751 :h head (last path component removed) | |
| 3752 :t tail (last path component only) | |
| 3753 :r root (one extension removed) | |
| 3754 :e extension only | |
| 3755 | |
| 3756 Example: > | |
| 3757 :let &tags = expand("%:p:h") . "/tags" | |
| 3758 < Note that when expanding a string that starts with '%', '#' or | |
| 3759 '<', any following text is ignored. This does NOT work: > | |
| 3760 :let doesntwork = expand("%:h.bak") | |
| 3761 < Use this: > | |
| 3762 :let doeswork = expand("%:h") . ".bak" | |
| 3763 < Also note that expanding "<cfile>" and others only returns the | |
| 3764 referenced file name without further expansion. If "<cfile>" | |
| 3765 is "~/.cshrc", you need to do another expand() to have the | |
| 3766 "~/" expanded into the path of the home directory: > | |
| 3767 :echo expand(expand("<cfile>")) | |
| 3768 < | |
| 3769 There cannot be white space between the variables and the | |
| 3770 following modifier. The |fnamemodify()| function can be used | |
| 3771 to modify normal file names. | |
| 3772 | |
| 3773 When using '%' or '#', and the current or alternate file name | |
| 3774 is not defined, an empty string is used. Using "%:p" in a | |
| 3775 buffer with no name, results in the current directory, with a | |
| 3776 '/' added. | |
| 3777 | |
| 3778 When {expr} does not start with '%', '#' or '<', it is | |
| 3779 expanded like a file name is expanded on the command line. | |
| 3780 '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
|
3781 {nosuf} argument is given and it is |TRUE|. |
| 3398 | 3782 Names for non-existing files are included. The "**" item can |
| 3783 be used to search in a directory tree. For example, to find | |
| 3784 all "README" files in the current directory and below: > | |
| 444 | 3785 :echo expand("**/README") |
| 3786 < | |
| 7 | 3787 Expand() can also be used to expand variables and environment |
| 3788 variables that are only known in a shell. But this can be | |
| 6180 | 3789 slow, because a shell may be used to do the expansion. See |
| 3790 |expr-env-expand|. | |
| 7 | 3791 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
|
3792 names. When an environment variable cannot be expanded, it is |
| 7 | 3793 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 3794 "$FOOBAR". | |
| 3795 | |
| 3796 See |glob()| for finding existing files. See |system()| for | |
| 3797 getting the raw output of an external command. | |
| 3798 | |
| 102 | 3799 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 3800 {expr1} and {expr2} must be both |Lists| or both |
| 3801 |Dictionaries|. | |
| 3802 | |
| 3803 If they are |Lists|: Append {expr2} to {expr1}. | |
| 102 | 3804 If {expr3} is given insert the items of {expr2} before item |
| 3805 {expr3} in {expr1}. When {expr3} is zero insert before the | |
| 3806 first item. When {expr3} is equal to len({expr1}) then | |
| 3807 {expr2} is appended. | |
| 79 | 3808 Examples: > |
| 3809 :echo sort(extend(mylist, [7, 5])) | |
| 3810 :call extend(mylist, [2, 3], 1) | |
| 1699 | 3811 < When {expr1} is the same List as {expr2} then the number of |
| 3812 items copied is equal to the original length of the List. | |
| 3813 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 3814 (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
|
3815 Use |add()| to concatenate one item to a list. To concatenate |
| 82 | 3816 two lists into a new list use the + operator: > |
| 79 | 3817 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 3818 < |
| 692 | 3819 If they are |Dictionaries|: |
| 102 | 3820 Add all entries from {expr2} to {expr1}. |
| 3821 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 3822 used to decide what to do: | |
| 3823 {expr3} = "keep": keep the value of {expr1} | |
| 3824 {expr3} = "force": use the value of {expr2} | |
| 856 | 3825 {expr3} = "error": give an error message *E737* |
| 102 | 3826 When {expr3} is omitted then "force" is assumed. |
| 3827 | |
| 3828 {expr1} is changed when {expr2} is not empty. If necessary | |
| 3829 make a copy of {expr1} first. | |
| 3830 {expr2} remains unchanged. | |
| 6823 | 3831 When {expr1} is locked and {expr2} is not empty the operation |
| 3832 fails. | |
| 102 | 3833 Returns {expr1}. |
| 3834 | |
| 79 | 3835 |
| 842 | 3836 feedkeys({string} [, {mode}]) *feedkeys()* |
| 3837 Characters in {string} are queued for processing as if they | |
| 6549 | 3838 come from a mapping or were typed by the user. |
| 3839 By default the string is added to the end of the typeahead | |
| 3840 buffer, thus if a mapping is still being executed the | |
| 3841 characters come after them. Use the 'i' flag to insert before | |
| 3842 other characters, they will be executed next, before any | |
| 3843 characters from a mapping. | |
| 842 | 3844 The function does not wait for processing of keys contained in |
| 3845 {string}. | |
| 3846 To include special keys into {string}, use double-quotes | |
| 3847 and "\..." notation |expr-quote|. For example, | |
| 1215 | 3848 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 3849 feedkeys('\<CR>') pushes 5 characters. |
| 3850 If {mode} is absent, keys are remapped. | |
| 3851 {mode} is a String, which can contain these character flags: | |
| 843 | 3852 'm' Remap keys. This is default. |
| 3853 'n' Do not remap keys. | |
| 3854 't' Handle keys as if typed; otherwise they are handled as | |
| 3855 if coming from a mapping. This matters for undo, | |
| 3856 opening folds, etc. | |
| 6549 | 3857 '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
|
3858 '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
|
3859 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
|
3860 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
|
3861 (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
|
3862 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
|
3863 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
|
3864 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
|
3865 script continues. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3866 '!' 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
|
3867 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
|
3868 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
|
3869 |
| 842 | 3870 Return value is always 0. |
| 3871 | |
| 7 | 3872 filereadable({file}) *filereadable()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3873 The result is a Number, which is |TRUE| when a file with the |
| 7 | 3874 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
|
3875 or is a directory, the result is |FALSE|. {file} is any |
| 7 | 3876 expression, which is used as a String. |
| 1156 | 3877 If you don't care about the file being readable you can use |
| 3878 |glob()|. | |
| 7 | 3879 *file_readable()* |
| 3880 Obsolete name: file_readable(). | |
| 3881 | |
| 95 | 3882 |
| 1156 | 3883 filewritable({file}) *filewritable()* |
| 3884 The result is a Number, which is 1 when a file with the | |
| 3885 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 3886 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 3887 directory, and we can write to it, the result is 2. |
| 3888 | |
| 3889 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3890 filter({expr1}, {expr2}) *filter()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3891 {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
|
3892 For each item in {expr1} evaluate {expr2} and when the result |
| 685 | 3893 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
|
3894 {expr2} must be a |string| or |Funcref|. |
| 12785 | 3895 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
3896 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
|
3897 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
|
3898 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
|
3899 the current item. |
| 102 | 3900 Examples: > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3901 call filter(mylist, 'v:val !~ "OLD"') |
| 102 | 3902 < 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
|
3903 call filter(mydict, 'v:key >= 8') |
| 102 | 3904 < 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
|
3905 call filter(var, 0) |
| 685 | 3906 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 3907 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3908 Note that {expr2} is the result of expression and is then |
| 102 | 3909 used as an expression again. Often it is good to use a |
| 3910 |literal-string| to avoid having to double backslashes. | |
| 3911 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3912 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
|
3913 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
|
3914 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
|
3915 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
|
3916 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
|
3917 func Odd(idx, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3918 return a:idx % 2 == 1 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3919 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3920 call filter(mylist, function('Odd')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
3921 < 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
|
3922 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
|
3923 < 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
|
3924 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
|
3925 < |
| 685 | 3926 The operation is done in-place. If you want a |List| or |
| 3927 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 3928 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 3929 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
3930 < 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
|
3931 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
|
3932 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
|
3933 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
|
3934 defined with the "abort" flag. |
| 95 | 3935 |
| 3936 | |
| 12785 | 3937 finddir({name} [, {path} [, {count}]]) *finddir()* |
| 1095 | 3938 Find directory {name} in {path}. Supports both downwards and |
| 3939 upwards recursive directory searches. See |file-searching| | |
| 3940 for the syntax of {path}. | |
| 3941 Returns the path of the first found match. When the found | |
| 3942 directory is below the current directory a relative path is | |
| 3943 returned. Otherwise a full path is returned. | |
| 19 | 3944 If {path} is omitted or empty then 'path' is used. |
| 3945 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 3946 {name} in {path} instead of the first one. |
| 809 | 3947 When {count} is negative return all the matches in a |List|. |
| 19 | 3948 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
|
3949 {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
|
3950 feature} |
| 794 | 3951 |
| 12785 | 3952 findfile({name} [, {path} [, {count}]]) *findfile()* |
| 794 | 3953 Just like |finddir()|, but find a file instead of a directory. |
| 3954 Uses 'suffixesadd'. | |
| 19 | 3955 Example: > |
| 3956 :echo findfile("tags.vim", ".;") | |
| 1156 | 3957 < Searches from the directory of the current file upwards until |
| 3958 it finds the file "tags.vim". | |
| 7 | 3959 |
| 1621 | 3960 float2nr({expr}) *float2nr()* |
| 3961 Convert {expr} to a Number by omitting the part after the | |
| 3962 decimal point. | |
| 3963 {expr} must evaluate to a |Float| or a Number. | |
| 3964 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
|
3965 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
|
3966 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
|
3967 -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
|
3968 64-bit Number support is enabled, -0x8000000000000000). |
| 1621 | 3969 Examples: > |
| 3970 echo float2nr(3.95) | |
| 3971 < 3 > | |
| 3972 echo float2nr(-23.45) | |
| 3973 < -23 > | |
| 3974 echo float2nr(1.0e100) | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3975 < 2147483647 (or 9223372036854775807) > |
| 1621 | 3976 echo float2nr(-1.0e150) |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
3977 < -2147483647 (or -9223372036854775807) > |
| 1621 | 3978 echo float2nr(1.0e-100) |
| 3979 < 0 | |
| 3980 {only available when compiled with the |+float| feature} | |
| 3981 | |
| 3982 | |
| 3983 floor({expr}) *floor()* | |
| 3984 Return the largest integral value less than or equal to | |
| 3985 {expr} as a |Float| (round down). | |
| 3986 {expr} must evaluate to a |Float| or a |Number|. | |
| 3987 Examples: > | |
| 3988 echo floor(1.856) | |
| 3989 < 1.0 > | |
| 3990 echo floor(-5.456) | |
| 3991 < -6.0 > | |
| 3992 echo floor(4.0) | |
| 3993 < 4.0 | |
| 3994 {only available when compiled with the |+float| feature} | |
| 12785 | 3995 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3996 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3997 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3998 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3999 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4000 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
|
4001 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
|
4002 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
|
4003 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
|
4004 {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
|
4005 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4006 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4007 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4008 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4009 < -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
|
4010 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4011 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4012 |
| 1586 | 4013 fnameescape({string}) *fnameescape()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4014 Escape {string} for use as file name command argument. All |
| 1586 | 4015 characters that have a special meaning, such as '%' and '|' |
| 4016 are escaped with a backslash. | |
| 1621 | 4017 For most systems the characters escaped are |
| 4018 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 4019 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 4020 A leading '+' and '>' is also escaped (special after |:edit| |
| 4021 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 4022 Example: > |
| 1700 | 4023 :let fname = '+some str%nge|name' |
| 1586 | 4024 :exe "edit " . fnameescape(fname) |
| 4025 < results in executing: > | |
| 1700 | 4026 edit \+some\ str\%nge\|name |
| 1586 | 4027 |
| 7 | 4028 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 4029 Modify file name {fname} according to {mods}. {mods} is a | |
| 4030 string of characters like it is used for file names on the | |
| 4031 command line. See |filename-modifiers|. | |
| 4032 Example: > | |
| 4033 :echo fnamemodify("main.c", ":p:h") | |
| 4034 < results in: > | |
| 4035 /home/mool/vim/vim/src | |
| 1621 | 4036 < Note: Environment variables don't work in {fname}, use |
| 7 | 4037 |expand()| first then. |
| 4038 | |
| 4039 foldclosed({lnum}) *foldclosed()* | |
| 4040 The result is a Number. If the line {lnum} is in a closed | |
| 4041 fold, the result is the number of the first line in that fold. | |
| 4042 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4043 | |
| 4044 foldclosedend({lnum}) *foldclosedend()* | |
| 4045 The result is a Number. If the line {lnum} is in a closed | |
| 4046 fold, the result is the number of the last line in that fold. | |
| 4047 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4048 | |
| 4049 foldlevel({lnum}) *foldlevel()* | |
| 4050 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
|
4051 in the current buffer. For nested folds the deepest level is |
| 7 | 4052 returned. If there is no fold at line {lnum}, zero is |
| 4053 returned. It doesn't matter if the folds are open or closed. | |
| 4054 When used while updating folds (from 'foldexpr') -1 is | |
| 4055 returned for lines where folds are still to be updated and the | |
| 4056 foldlevel is unknown. As a special case the level of the | |
| 4057 previous line is usually available. | |
| 4058 | |
| 4059 *foldtext()* | |
| 4060 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 4061 the default function used for the 'foldtext' option and should | |
| 4062 only be called from evaluating 'foldtext'. It uses the | |
| 4063 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 4064 The returned string looks like this: > | |
| 4065 +-- 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
|
4066 < 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
|
4067 "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
|
4068 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
|
4069 "//" 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
|
4070 '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
|
4071 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
|
4072 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
|
4073 setting. |
| 7 | 4074 {not available when compiled without the |+folding| feature} |
| 4075 | |
| 29 | 4076 foldtextresult({lnum}) *foldtextresult()* |
| 4077 Returns the text that is displayed for the closed fold at line | |
| 4078 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 4079 When there is no closed fold at {lnum} an empty string is | |
| 4080 returned. | |
| 4081 {lnum} is used like with |getline()|. Thus "." is the current | |
| 4082 line, "'m" mark m, etc. | |
| 4083 Useful when exporting folded text, e.g., to HTML. | |
| 4084 {not available when compiled without the |+folding| feature} | |
| 4085 | |
| 7 | 4086 *foreground()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4087 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 4088 a client to a Vim server. |remote_send()| |
| 4089 On Win32 systems this might not work, the OS does not always | |
| 4090 allow a window to bring itself to the foreground. Use | |
| 4091 |remote_foreground()| instead. | |
| 4092 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 4093 Win32 console version} | |
| 4094 | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4095 *funcref()* |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4096 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4097 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
|
4098 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
|
4099 function {name} is redefined later. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4100 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4101 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
|
4102 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
|
4103 function. |
| 82 | 4104 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4105 *function()* *E700* *E922* *E923* |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4106 function({name} [, {arglist}] [, {dict}]) |
| 685 | 4107 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
|
4108 {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
|
4109 internal function. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4110 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4111 {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
|
4112 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
|
4113 argument is not allowed. E.g.: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4114 let FuncWithArg = function(dict.Func, [arg]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4115 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
|
4116 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4117 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
|
4118 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
|
4119 same function. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4120 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4121 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
|
4122 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
|
4123 the Funcref and will be used when the Funcref is called. |
| 12785 | 4124 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4125 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
|
4126 arguments. Example: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4127 func Callback(arg1, arg2, name) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4128 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4129 let Func = function('Callback', ['one', 'two']) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4130 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4131 call Func('name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4132 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4133 call Callback('one', 'two', 'name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4134 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4135 < 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
|
4136 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
|
4137 arguments. Example: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4138 func Callback(arg1, arg2, name) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4139 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4140 let Func = function('Callback', ['one']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4141 let Func2 = function(Func, ['two']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4142 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4143 call Func2('name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4144 < Invokes the function as with: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4145 call Callback('one', 'two', 'name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4146 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4147 < 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
|
4148 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
|
4149 function Callback() dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4150 echo "called for " . self.name |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4151 endfunction |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4152 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4153 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4154 let Func = function('Callback', context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4155 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4156 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
|
4157 < 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
|
4158 arguments, these two are equivalent: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4159 let Func = function('Callback', context) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4160 let Func = context.Callback |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4161 |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4162 < 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
|
4163 function Callback(arg1, count) dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4164 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4165 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4166 let Func = function('Callback', ['one'], context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4167 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4168 call Func(500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4169 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4170 call context.Callback('one', 500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4171 |
| 82 | 4172 |
| 3224 | 4173 garbagecollect([{atexit}]) *garbagecollect()* |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4174 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
|
4175 that have circular references. |
| 12785 | 4176 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4177 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
|
4178 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
|
4179 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
|
4180 circular references are always freed when they become unused. |
| 685 | 4181 This is useful if you have deleted a very big |List| and/or |
| 4182 |Dictionary| with circular references in a script that runs | |
| 4183 for a long time. | |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4184 |
| 3224 | 4185 When the optional {atexit} argument is one, garbage |
| 1405 | 4186 collection will also be done when exiting Vim, if it wasn't |
| 4187 done before. This is useful when checking for memory leaks. | |
| 370 | 4188 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
4189 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
|
4190 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
|
4191 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
|
4192 |test_garbagecollect_now()|. |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4193 |
| 140 | 4194 get({list}, {idx} [, {default}]) *get()* |
| 685 | 4195 Get item {idx} from |List| {list}. When this item is not |
| 82 | 4196 available return {default}. Return zero when {default} is |
| 4197 omitted. | |
| 102 | 4198 get({dict}, {key} [, {default}]) |
| 685 | 4199 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 4200 item is not available return {default}. Return zero when |
| 4201 {default} is omitted. | |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4202 get({func}, {what}) |
|
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
4203 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
|
4204 {what} are: |
| 11062 | 4205 "name" The function name |
| 4206 "func" The function | |
| 4207 "dict" The dictionary | |
| 4208 "args" The list with arguments | |
| 102 | 4209 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4210 *getbufinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4211 getbufinfo([{expr}]) |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4212 getbufinfo([{dict}]) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4213 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
|
4214 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4215 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
|
4216 returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4217 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4218 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
|
4219 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
|
4220 be specified in {dict}: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4221 buflisted include only listed buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4222 bufloaded include only loaded buffers. |
|
13020
58cce40c965b
patch 8.0.1386: cannot select modified buffers with getbufinfo()
Christian Brabandt <cb@256bit.org>
parents:
13016
diff
changeset
|
4223 bufmodified include only modified buffers. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4224 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4225 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
|
4226 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
|
4227 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
|
4228 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
|
4229 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4230 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
|
4231 entries: |
|
9904
24900147aa44
commit https://github.com/vim/vim/commit/339288377072f66ec88e21903e75a82d23ffbf4f
Christian Brabandt <cb@256bit.org>
parents:
9894
diff
changeset
|
4232 bufnr buffer number. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4233 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
|
4234 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
|
4235 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
|
4236 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
|
4237 lnum current line number in buffer. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4238 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
|
4239 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
|
4240 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
|
4241 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
|
4242 the following fields: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4243 id sign identifier |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4244 lnum line number |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4245 name sign name |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4246 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
|
4247 buffer-local variables. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4248 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
|
4249 buffer |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4250 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4251 Examples: > |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4252 for buf in getbufinfo() |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4253 echo buf.name |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4254 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4255 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
|
4256 if buf.changed |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4257 .... |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4258 endif |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4259 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4260 < |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4261 To get buffer-local options use: > |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4262 getbufvar({bufnr}, '&') |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4263 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4264 < |
| 435 | 4265 *getbufline()* |
| 4266 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 4267 Return a |List| with the lines starting from {lnum} to {end} |
| 4268 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 4269 |List| with only the line {lnum} is returned. | |
| 435 | 4270 |
| 4271 For the use of {expr}, see |bufname()| above. | |
| 4272 | |
| 448 | 4273 For {lnum} and {end} "$" can be used for the last line of the |
| 4274 buffer. Otherwise a number must be used. | |
| 435 | 4275 |
| 4276 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 4277 lines in the buffer, an empty |List| is returned. |
| 435 | 4278 |
| 4279 When {end} is greater than the number of lines in the buffer, | |
| 4280 it is treated as {end} is set to the number of lines in the | |
| 685 | 4281 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 4282 returned. |
| 4283 | |
| 448 | 4284 This function works only for loaded buffers. For unloaded and |
| 685 | 4285 non-existing buffers, an empty |List| is returned. |
| 435 | 4286 |
| 4287 Example: > | |
| 4288 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 4289 |
| 4157 | 4290 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 4291 The result is the value of option or local buffer variable |
| 4292 {varname} in buffer {expr}. Note that the name without "b:" | |
| 4293 must be used. | |
| 1668 | 4294 When {varname} is empty returns a dictionary with all the |
| 4295 buffer-local variables. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4296 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
|
4297 the buffer-local options. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4298 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
|
4299 a buffer-local option. |
| 216 | 4300 This also works for a global or buffer-local option, but it |
| 4301 doesn't work for a global variable, window-local variable or | |
| 4302 window-local option. | |
| 82 | 4303 For the use of {expr}, see |bufname()| above. |
| 4157 | 4304 When the buffer or variable doesn't exist {def} or an empty |
| 4305 string is returned, there is no error message. | |
| 82 | 4306 Examples: > |
| 4307 :let bufmodified = getbufvar(1, "&mod") | |
| 4308 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
| 4309 < | |
|
13280
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4310 getchangelist({expr}) *getchangelist()* |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4311 Returns the |changelist| for the buffer {expr}. For the use |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4312 of {expr}, see |bufname()| above. If buffer {expr} doesn't |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4313 exist, an empty list is returned. |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4314 |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4315 The returned list contains two entries: a list with the change |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4316 locations and the current position in the list. Each |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4317 entry in the change list is a dictionary with the following |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4318 entries: |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4319 col column number |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4320 coladd column offset for 'virtualedit' |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4321 lnum line number |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4322 If buffer {expr} is the current buffer, then the current |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4323 position refers to the position in the list. For other |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4324 buffers, it is set to the length of the list. |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
4325 |
| 7 | 4326 getchar([expr]) *getchar()* |
| 867 | 4327 Get a single character from the user or input stream. |
| 7 | 4328 If [expr] is omitted, wait until a character is available. |
| 4329 If [expr] is 0, only get a character when one is available. | |
| 867 | 4330 Return zero otherwise. |
| 7 | 4331 If [expr] is 1, only check if a character is available, it is |
| 867 | 4332 not consumed. Return zero if no character available. |
| 4333 | |
| 5555 | 4334 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
|
4335 special key is returned. If it is a single character, the |
| 867 | 4336 result is a number. Use nr2char() to convert it to a String. |
| 4337 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
|
4338 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
|
4339 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
|
4340 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
|
4341 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
|
4342 that is not included in the character. |
| 867 | 4343 |
| 5968 | 4344 When [expr] is 0 and Esc is typed, there will be a short delay |
| 4345 while Vim waits to see if this is the start of an escape | |
| 4346 sequence. | |
| 4347 | |
| 5555 | 4348 When [expr] is 1 only the first byte is returned. For a |
| 872 | 4349 one-byte character it is the character itself as a number. |
| 4350 Use nr2char() to convert it to a String. | |
| 867 | 4351 |
| 3224 | 4352 Use getcharmod() to obtain any additional modifiers. |
| 4353 | |
| 1029 | 4354 When the user clicks a mouse button, the mouse event will be |
| 4355 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
|
4356 |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
|
4357 example positions the mouse as it would normally happen: > |
| 1029 | 4358 let c = getchar() |
| 1621 | 4359 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 4360 exe v:mouse_win . "wincmd w" |
| 4361 exe v:mouse_lnum | |
| 4362 exe "normal " . v:mouse_col . "|" | |
| 4363 endif | |
| 4364 < | |
| 10734 | 4365 When using bracketed paste only the first character is |
| 4366 returned, the rest of the pasted text is dropped. | |
| 4367 |xterm-bracketed-paste|. | |
| 4368 | |
| 7 | 4369 There is no prompt, you will somehow have to make clear to the |
| 4370 user that a character has to be typed. | |
| 4371 There is no mapping for the character. | |
| 4372 Key codes are replaced, thus when the user presses the <Del> | |
| 4373 key you get the code for the <Del> key, not the raw character | |
| 4374 sequence. Examples: > | |
| 4375 getchar() == "\<Del>" | |
| 4376 getchar() == "\<S-Left>" | |
| 4377 < This example redefines "f" to ignore case: > | |
| 4378 :nmap f :call FindChar()<CR> | |
| 4379 :function FindChar() | |
| 4380 : let c = nr2char(getchar()) | |
| 4381 : while col('.') < col('$') - 1 | |
| 4382 : normal l | |
| 4383 : if getline('.')[col('.') - 1] ==? c | |
| 4384 : break | |
| 4385 : endif | |
| 4386 : endwhile | |
| 4387 :endfunction | |
| 6421 | 4388 < |
| 6647 | 4389 You may also receive synthetic characters, such as |
| 6421 | 4390 |<CursorHold>|. Often you will want to ignore this and get |
| 4391 another character: > | |
| 4392 :function GetKey() | |
| 4393 : let c = getchar() | |
| 4394 : while c == "\<CursorHold>" | |
| 4395 : let c = getchar() | |
| 4396 : endwhile | |
| 4397 : return c | |
| 4398 :endfunction | |
| 7 | 4399 |
| 4400 getcharmod() *getcharmod()* | |
| 4401 The result is a Number which is the state of the modifiers for | |
| 4402 the last obtained character with getchar() or in another way. | |
| 4403 These values are added together: | |
| 4404 2 shift | |
| 4405 4 control | |
| 4406 8 alt (meta) | |
| 3224 | 4407 16 meta (when it's different from ALT) |
| 4408 32 mouse double click | |
| 4409 64 mouse triple click | |
| 4410 96 mouse quadruple click (== 32 + 64) | |
| 4411 128 command (Macintosh only) | |
| 7 | 4412 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
|
4413 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4414 without a modifier. |
| 7 | 4415 |
| 6991 | 4416 getcharsearch() *getcharsearch()* |
| 4417 Return the current character search information as a {dict} | |
| 4418 with the following entries: | |
| 4419 | |
| 4420 char character previously used for a character | |
| 4421 search (|t|, |f|, |T|, or |F|); empty string | |
| 4422 if no character search has been performed | |
| 4423 forward direction of character search; 1 for forward, | |
| 4424 0 for backward | |
| 4425 until type of character search; 1 for a |t| or |T| | |
| 4426 character search, 0 for an |f| or |F| | |
| 4427 character search | |
| 4428 | |
| 4429 This can be useful to always have |;| and |,| search | |
| 4430 forward/backward regardless of the direction of the previous | |
| 4431 character search: > | |
| 4432 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 4433 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 4434 < Also see |setcharsearch()|. | |
| 4435 | |
| 7 | 4436 getcmdline() *getcmdline()* |
| 4437 Return the current command-line. Only works when the command | |
| 4438 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 4439 |c_CTRL-R_=|. | |
| 4440 Example: > | |
| 4441 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 4442 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 7 | 4443 |
| 95 | 4444 getcmdpos() *getcmdpos()* |
| 7 | 4445 Return the position of the cursor in the command line as a |
| 4446 byte count. The first column is 1. | |
| 4447 Only works when editing the command line, thus requires use of | |
| 3456 | 4448 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4449 Returns 0 otherwise. | |
| 531 | 4450 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 4451 | |
| 4452 getcmdtype() *getcmdtype()* | |
| 4453 Return the current command-line type. Possible return values | |
| 4454 are: | |
| 532 | 4455 : normal Ex command |
| 4456 > debug mode command |debug-mode| | |
| 4457 / forward search command | |
| 4458 ? backward search command | |
| 4459 @ |input()| command | |
| 4460 - |:insert| or |:append| command | |
| 6213 | 4461 = |i_CTRL-R_=| |
| 531 | 4462 Only works when editing the command line, thus requires use of |
| 3456 | 4463 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 4464 Returns an empty string otherwise. | |
| 531 | 4465 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 4466 |
| 6153 | 4467 getcmdwintype() *getcmdwintype()* |
| 4468 Return the current |command-line-window| type. Possible return | |
| 4469 values are the same as |getcmdtype()|. Returns an empty string | |
| 4470 when not in the command-line window. | |
| 4471 | |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4472 getcompletion({pat}, {type} [, {filtered}]) *getcompletion()* |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4473 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
|
4474 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
|
4475 supported: |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4476 |
|
13551
1fd0f8392946
patch 8.0.1649: no completion for argument list commands
Christian Brabandt <cb@256bit.org>
parents:
13513
diff
changeset
|
4477 arglist file names in argument list |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4478 augroup autocmd groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4479 buffer buffer names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4480 behave :behave suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4481 color color schemes |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4482 command Ex command (and arguments) |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4483 compiler compilers |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4484 cscope |:cscope| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4485 dir directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4486 environment environment variable names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4487 event autocommand events |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4488 expression Vim expression |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4489 file file and directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4490 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
|
4491 filetype filetype names |'filetype'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4492 function function name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4493 help help subjects |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4494 highlight highlight groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4495 history :history suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4496 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
|
4497 mapclear buffer argument |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4498 mapping mapping name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4499 menu menus |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
4500 messages |:messages| suboptions |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4501 option options |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
4502 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
|
4503 shellcmd Shell command |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4504 sign |:sign| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4505 syntax syntax file names |'syntax'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4506 syntime |:syntime| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4507 tag tags |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4508 tag_listfiles tags, file names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4509 user user names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4510 var user variables |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4511 |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4512 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
|
4513 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
|
4514 |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
|
4515 |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
4516 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
|
4517 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
|
4518 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
|
4519 |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
4520 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
|
4521 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
|
4522 |
| 5944 | 4523 *getcurpos()* |
| 4524 getcurpos() Get the position of the cursor. This is like getpos('.'), but | |
| 4525 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
|
4526 [bufnum, lnum, col, off, curswant] ~ |
| 5944 | 4527 The "curswant" number is the preferred column when moving the |
| 11347 | 4528 cursor vertically. Also see |getpos()|. |
| 4529 | |
| 5944 | 4530 This can be used to save and restore the cursor position: > |
| 4531 let save_cursor = getcurpos() | |
| 4532 MoveTheCursorAround | |
| 4533 call setpos('.', save_cursor) | |
| 11347 | 4534 < Note that this only works within the window. See |
| 4535 |winrestview()| for restoring more state. | |
| 7 | 4536 *getcwd()* |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4537 getcwd([{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4538 The result is a String, which is the name of the current |
| 7 | 4539 working directory. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4540 Without arguments, for the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4541 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4542 With {winnr} return the local current directory of this window |
|
13229
93efa1de7abb
patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
4543 in the current tab page. {winnr} can be the window number or |
|
93efa1de7abb
patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
4544 the |window-ID|. |
|
93efa1de7abb
patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
4545 If {winnr} is -1 return the name of the global working |
|
93efa1de7abb
patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
4546 directory. See also |haslocaldir()|. |
|
93efa1de7abb
patch 8.0.1489: there is no easy way to get the global directory
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
4547 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4548 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
|
4549 the window in the specified tab page. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
4550 Return an empty string if the arguments are invalid. |
| 7 | 4551 |
| 4552 getfsize({fname}) *getfsize()* | |
| 4553 The result is a Number, which is the size in bytes of the | |
| 4554 given file {fname}. | |
| 4555 If {fname} is a directory, 0 is returned. | |
| 4556 If the file {fname} can't be found, -1 is returned. | |
| 1293 | 4557 If the size of {fname} is too big to fit in a Number then -2 |
| 4558 is returned. | |
| 7 | 4559 |
| 37 | 4560 getfontname([{name}]) *getfontname()* |
| 4561 Without an argument returns the name of the normal font being | |
| 4562 used. Like what is used for the Normal highlight group | |
| 4563 |hl-Normal|. | |
| 4564 With an argument a check is done whether {name} is a valid | |
| 4565 font name. If not then an empty string is returned. | |
| 4566 Otherwise the actual font name is returned, or {name} if the | |
| 4567 GUI does not support obtaining the real name. | |
| 824 | 4568 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 4569 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 4570 function just after the GUI has started. | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
4571 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
|
4572 a valid name does not work. |
| 37 | 4573 |
| 20 | 4574 getfperm({fname}) *getfperm()* |
| 4575 The result is a String, which is the read, write, and execute | |
| 4576 permissions of the given file {fname}. | |
| 4577 If {fname} does not exist or its directory cannot be read, an | |
| 4578 empty string is returned. | |
| 4579 The result is of the form "rwxrwxrwx", where each group of | |
| 4580 "rwx" flags represent, in turn, the permissions of the owner | |
| 4581 of the file, the group the file belongs to, and other users. | |
| 4582 If a user does not have a given permission the flag for this | |
| 3750 | 4583 is replaced with the string "-". Examples: > |
| 20 | 4584 :echo getfperm("/etc/passwd") |
| 3750 | 4585 :echo getfperm(expand("~/.vimrc")) |
| 20 | 4586 < This will hopefully (from a security point of view) display |
| 4587 the string "rw-r--r--" or even "rw-------". | |
| 205 | 4588 |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10237
diff
changeset
|
4589 For setting permissions use |setfperm()|. |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
4590 |
| 7 | 4591 getftime({fname}) *getftime()* |
| 4592 The result is a Number, which is the last modification time of | |
| 4593 the given file {fname}. The value is measured as seconds | |
| 4594 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 4595 |localtime()| and |strftime()|. | |
| 4596 If the file {fname} can't be found -1 is returned. | |
| 4597 | |
| 20 | 4598 getftype({fname}) *getftype()* |
| 4599 The result is a String, which is a description of the kind of | |
| 4600 file of the given file {fname}. | |
| 4601 If {fname} does not exist an empty string is returned. | |
| 4602 Here is a table over different kinds of files and their | |
| 4603 results: | |
| 4604 Normal file "file" | |
| 4605 Directory "dir" | |
| 4606 Symbolic link "link" | |
| 4607 Block device "bdev" | |
| 4608 Character device "cdev" | |
| 4609 Socket "socket" | |
| 4610 FIFO "fifo" | |
| 4611 All other "other" | |
| 4612 Example: > | |
| 4613 getftype("/home") | |
| 4614 < Note that a type such as "link" will only be returned on | |
| 4615 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
|
4616 "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
|
4617 directory returns "dir" instead of "link". |
| 20 | 4618 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
4619 getjumplist([{winnr} [, {tabnr}]]) *getjumplist()* |
|
13246
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4620 Returns the |jumplist| for the specified window. |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4621 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4622 Without arguments use the current window. |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4623 With {winnr} only use this window in the current tab page. |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4624 {winnr} can also be a |window-ID|. |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4625 With {winnr} and {tabnr} use the window in the specified tab |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4626 page. |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4627 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4628 The returned list contains two entries: a list with the jump |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4629 locations and the last used jump position number in the list. |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4630 Each entry in the jump location list is a dictionary with |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4631 the following entries: |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4632 bufnr buffer number |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4633 col column number |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4634 coladd column offset for 'virtualedit' |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4635 filename filename if available |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4636 lnum line number |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
4637 |
| 7 | 4638 *getline()* |
| 82 | 4639 getline({lnum} [, {end}]) |
| 4640 Without {end} the result is a String, which is line {lnum} | |
| 4641 from the current buffer. Example: > | |
| 7 | 4642 getline(1) |
| 4643 < When {lnum} is a String that doesn't start with a | |
| 4644 digit, line() is called to translate the String into a Number. | |
| 4645 To get the line under the cursor: > | |
| 4646 getline(".") | |
| 4647 < When {lnum} is smaller than 1 or bigger than the number of | |
| 4648 lines in the buffer, an empty string is returned. | |
| 4649 | |
| 685 | 4650 When {end} is given the result is a |List| where each item is |
| 4651 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 4652 including line {end}. |
| 4653 {end} is used in the same way as {lnum}. | |
| 4654 Non-existing lines are silently omitted. | |
| 685 | 4655 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 4656 Example: > |
| 4657 :let start = line('.') | |
| 4658 :let end = search("^$") - 1 | |
| 4659 :let lines = getline(start, end) | |
| 4660 | |
| 1156 | 4661 < To get lines from another buffer see |getbufline()| |
| 4662 | |
| 12785 | 4663 getloclist({nr} [, {what}]) *getloclist()* |
| 647 | 4664 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
|
4665 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
|
4666 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
|
4667 |
| 647 | 4668 For a location list window, the displayed location list is |
| 648 | 4669 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
|
4670 returned. Otherwise, same as |getqflist()|. |
| 82 | 4671 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4672 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
|
4673 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
|
4674 |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
|
4675 |
| 1326 | 4676 getmatches() *getmatches()* |
| 4677 Returns a |List| with all matches previously defined by | |
| 4678 |matchadd()| and the |:match| commands. |getmatches()| is | |
| 4679 useful in combination with |setmatches()|, as |setmatches()| | |
| 4680 can restore a list of matches saved by |getmatches()|. | |
| 4681 Example: > | |
| 4682 :echo getmatches() | |
| 4683 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 4684 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 4685 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 4686 :let m = getmatches() | |
| 4687 :call clearmatches() | |
| 4688 :echo getmatches() | |
| 4689 < [] > | |
| 4690 :call setmatches(m) | |
| 4691 :echo getmatches() | |
| 4692 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 4693 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 4694 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 4695 :unlet m | |
| 4696 < | |
| 5968 | 4697 *getpid()* |
| 4698 getpid() Return a Number which is the process ID of the Vim process. | |
| 4699 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
|
4700 exits. On MS-DOS it's always zero. |
| 5968 | 4701 |
| 4702 *getpos()* | |
| 4703 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 4704 see |line()|. For getting the cursor position see | |
| 4705 |getcurpos()|. | |
| 4706 The result is a |List| with four numbers: | |
| 4707 [bufnum, lnum, col, off] | |
| 4708 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 4709 is the buffer number of the mark. | |
| 4710 "lnum" and "col" are the position in the buffer. The first | |
| 4711 column is 1. | |
| 4712 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 4713 it is the offset in screen columns from the start of the | |
| 4714 character. E.g., a position within a <Tab> or after the last | |
| 4715 character. | |
| 4716 Note that for '< and '> Visual mode matters: when it is "V" | |
| 4717 (visual line mode) the column of '< is zero and the column of | |
| 4718 '> is a large number. | |
| 4719 This can be used to save and restore the position of a mark: > | |
| 4720 let save_a_mark = getpos("'a") | |
| 4721 ... | |
| 6421 | 4722 call setpos("'a", save_a_mark) |
| 5968 | 4723 < Also see |getcurpos()| and |setpos()|. |
| 4724 | |
| 1326 | 4725 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4726 getqflist([{what}]) *getqflist()* |
| 230 | 4727 Returns a list with all the current quickfix errors. Each |
| 4728 list item is a dictionary with these entries: | |
| 4729 bufnr number of buffer that has the file name, use | |
| 4730 bufname() to get the name | |
| 4731 lnum line number in the buffer (first line is 1) | |
| 4732 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
|
4733 vcol |TRUE|: "col" is visual column |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4734 |FALSE|: "col" is byte index |
| 230 | 4735 nr error number |
| 1065 | 4736 pattern search pattern used to locate the error |
| 230 | 4737 text description of the error |
| 4738 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
|
4739 valid |TRUE|: recognized error message |
| 230 | 4740 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4741 When there is no error list or it's empty, an empty list is |
| 1065 | 4742 returned. Quickfix list entries with non-existing buffer |
| 4743 number are returned with "bufnr" set to zero. | |
| 515 | 4744 |
| 230 | 4745 Useful application: Find pattern matches in multiple files and |
| 4746 do something with them: > | |
| 4747 :vimgrep /theword/jg *.c | |
| 4748 :for d in getqflist() | |
| 4749 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 4750 :endfor | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4751 < |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4752 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
|
4753 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
|
4754 following string items are supported in {what}: |
|
13062
6479dadcf214
patch 8.0.1406: difficult to track changes to a quickfix list
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
4755 changedtick get the total number of changes made |
|
6479dadcf214
patch 8.0.1406: difficult to track changes to a quickfix list
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
4756 to the list |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
4757 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
|
4758 efm errorformat to use when parsing "lines". If |
| 12968 | 4759 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
|
4760 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
|
4761 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
|
4762 |quickfix-ID|; zero means the id for the |
| 12968 | 4763 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
|
4764 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
|
4765 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
|
4766 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
|
4767 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
|
4768 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
|
4769 quickfix list is not modified. |
|
10237
197795e3530d
commit https://github.com/vim/vim/commit/890680ca6364386fabb271c85e0755bcaa6a33c1
Christian Brabandt <cb@256bit.org>
parents:
10233
diff
changeset
|
4770 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
|
4771 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
|
4772 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
|
4773 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
|
4774 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
|
4775 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
|
4776 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
|
4777 Non-string items in {what} are ignored. To get the value of a |
|
13026
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4778 particular item, set it to zero. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4779 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
|
4780 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
|
4781 specified by "id" is used. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
4782 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
|
4783 "$" 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
|
4784 contains the quickfix stack size. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
4785 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
|
4786 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
|
4787 "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
|
4788 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4789 The returned dictionary contains the following entries: |
|
13062
6479dadcf214
patch 8.0.1406: difficult to track changes to a quickfix list
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
4790 changedtick total number of changes made to the |
|
6479dadcf214
patch 8.0.1406: difficult to track changes to a quickfix list
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
4791 list |quickfix-changedtick| |
|
13026
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4792 context context information stored with |setqflist()|. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4793 If not present, set to "". |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4794 id quickfix list ID |quickfix-ID|. If not |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4795 present, set to 0. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4796 idx index of the current entry in the list. If not |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4797 present, set to 0. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4798 items quickfix list entries. If not present, set to |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4799 an empty list. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4800 nr quickfix list number. If not present, set to 0 |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4801 size number of entries in the quickfix list. If not |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4802 present, set to 0. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4803 title quickfix list title text. If not present, set |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
4804 to "". |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
4805 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
|
4806 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4807 Examples: > |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4808 :echo getqflist({'all': 1}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
4809 :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
|
4810 :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
|
4811 < |
| 230 | 4812 |
| 5796 | 4813 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 4814 The result is a String, which is the contents of register |
| 236 | 4815 {regname}. Example: > |
| 7 | 4816 :let cliptext = getreg('*') |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
4817 < 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
|
4818 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4819 getreg('=') returns the last evaluated value of the expression |
| 236 | 4820 register. (For use in maps.) |
| 282 | 4821 getreg('=', 1) returns the expression itself, so that it can |
| 4822 be restored with |setreg()|. For other registers the extra | |
| 4823 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
|
4824 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4825 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
|
4826 to |List|. Each list item is one text line. Use it if you care |
| 5796 | 4827 about zero bytes possibly present inside register: without |
| 4828 third argument both NLs and zero bytes are represented as NLs | |
| 4829 (see |NL-used-for-Nul|). | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4830 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
|
4831 |
| 7 | 4832 If {regname} is not specified, |v:register| is used. |
| 4833 | |
| 82 | 4834 |
| 7 | 4835 getregtype([{regname}]) *getregtype()* |
| 4836 The result is a String, which is type of register {regname}. | |
| 4837 The value will be one of: | |
| 4838 "v" for |characterwise| text | |
| 4839 "V" for |linewise| text | |
| 4840 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 4841 "" for an empty or unknown register |
| 7 | 4842 <CTRL-V> is one character with value 0x16. |
| 4843 If {regname} is not specified, |v:register| is used. | |
| 4844 | |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4845 gettabinfo([{arg}]) *gettabinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4846 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
|
4847 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
|
4848 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
|
4849 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
|
4850 empty List is returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4851 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4852 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
|
4853 tabnr tab page number. |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4854 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
|
4855 tabpage-local variables |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4856 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
|
4857 |
| 4157 | 4858 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4859 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
|
4860 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4861 Tabs are numbered starting with one. |
| 6197 | 4862 When {varname} is empty a dictionary with all tab-local |
| 4863 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
4864 Note that the name without "t:" must be used. |
| 4157 | 4865 When the tab or variable doesn't exist {def} or an empty |
| 4866 string is returned, there is no error message. | |
| 4867 | |
| 4868 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* | |
| 1156 | 4869 Get the value of window-local variable {varname} in window |
| 4870 {winnr} in tab page {tabnr}. | |
| 4157 | 4871 When {varname} is empty a dictionary with all window-local |
| 4872 variables is returned. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4873 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
|
4874 window-local options in a Dictionary. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4875 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
|
4876 window-local option. |
| 4157 | 4877 Note that {varname} must be the name without "w:". |
| 831 | 4878 Tabs are numbered starting with one. For the current tabpage |
| 4879 use |getwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4880 {winnr} can be the window number or the |window-ID|. |
| 831 | 4881 When {winnr} is zero the current window is used. |
| 4882 This also works for a global option, buffer-local option and | |
| 4883 window-local option, but it doesn't work for a global variable | |
| 4884 or buffer-local variable. | |
| 4157 | 4885 When the tab, window or variable doesn't exist {def} or an |
| 4886 empty string is returned, there is no error message. | |
| 831 | 4887 Examples: > |
| 4888 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 4889 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 4890 < |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4891 getwinpos([{timeout}]) *getwinpos()* |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4892 The result is a list with two numbers, the result of |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4893 getwinposx() and getwinposy() combined: |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4894 [x-pos, y-pos] |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4895 {timeout} can be used to specify how long to wait in msec for |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4896 a response from the terminal. When omitted 100 msec is used. |
| 13437 | 4897 Use a longer time for a remote terminal. |
| 4898 When using a value less than 10 and no response is received | |
| 4899 within that time, a previously reported position is returned, | |
| 4900 if available. This can be used to poll for the position and | |
| 4901 do some work in the mean time: > | |
| 4902 while 1 | |
| 4903 let res = getwinpos(1) | |
| 4904 if res[0] >= 0 | |
| 4905 break | |
| 4906 endif | |
| 4907 " Do some work here | |
| 4908 endwhile | |
| 4909 < | |
| 7 | 4910 *getwinposx()* |
| 4911 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 11347 | 4912 the left hand side of the GUI Vim window. Also works for an |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4913 xterm (uses a timeout of 100 msec). |
| 11347 | 4914 The result will be -1 if the information is not available. |
| 4915 The value can be used with `:winpos`. | |
| 7 | 4916 |
| 4917 *getwinposy()* | |
| 4918 getwinposy() The result is a Number, which is the Y coordinate in pixels of | |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4919 the top of the GUI Vim window. Also works for an xterm (uses |
|
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
4920 a timeout of 100 msec). |
| 11347 | 4921 The result will be -1 if the information is not available. |
| 4922 The value can be used with `:winpos`. | |
| 7 | 4923 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4924 getwininfo([{winid}]) *getwininfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4925 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
|
4926 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4927 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
|
4928 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
|
4929 empty list. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4930 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4931 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
|
4932 tab pages is returned. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4933 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4934 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
|
4935 bufnr number of buffer in the window |
| 12499 | 4936 height window height (excluding winbar) |
| 4937 winbar 1 if the window has a toolbar, 0 | |
| 4938 otherwise | |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4939 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
|
4940 {only with the +quickfix feature} |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4941 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
|
4942 {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
|
4943 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
|
4944 {only with the +terminal feature} |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4945 tabnr tab page number |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4946 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
|
4947 window-local variables |
|
9881
4b53f6be10c0
commit https://github.com/vim/vim/commit/386600f0cbcb8add099c723cf84634f46df2f788
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4948 width window width |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4949 winid |window-ID| |
|
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
4950 winnr window number |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
4951 |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4952 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
|
4953 gettabwinvar({tabnr}, {winnr}, '&') |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
4954 |
| 4157 | 4955 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 4956 Like |gettabwinvar()| for the current tabpage. |
| 7 | 4957 Examples: > |
| 4958 :let list_is_on = getwinvar(2, '&list') | |
| 4959 :echo "myvar = " . getwinvar(1, 'myvar') | |
| 4960 < | |
| 6663 | 4961 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 4962 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 4963 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4964 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4965 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 4966 the 'suffixes' and 'wildignore' options apply: Names matching |
| 4967 one of the patterns in 'wildignore' will be skipped and | |
| 4968 'suffixes' affect the ordering of matches. | |
| 2662 | 4969 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4970 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4971 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
|
4972 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
|
4973 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4974 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
|
4975 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4976 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4977 If the expansion fails, the result is an empty String or List. |
| 6663 | 4978 |
| 3445 | 4979 A name for a non-existing file is not included. A symbolic |
| 4980 link is only included if it points to an existing file. | |
| 6663 | 4981 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
|
4982 |TRUE| then all symbolic links are included. |
| 7 | 4983 |
| 4984 For most systems backticks can be used to get files names from | |
| 4985 any external command. Example: > | |
| 4986 :let tagfiles = glob("`find . -name tags -print`") | |
| 4987 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 4988 < 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
|
4989 item per line. Spaces inside an item are allowed. |
| 7 | 4990 |
| 4991 See |expand()| for expanding special Vim variables. See | |
| 4992 |system()| for getting the raw output of an external command. | |
| 4993 | |
| 6697 | 4994 glob2regpat({expr}) *glob2regpat()* |
| 4995 Convert a file pattern, as used by glob(), into a search | |
| 4996 pattern. The result can be used to match with a string that | |
| 4997 is a file name. E.g. > | |
| 4998 if filename =~ glob2regpat('Make*.mak') | |
| 4999 < This is equivalent to: > | |
| 5000 if filename =~ '^Make.*\.mak$' | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
5001 < 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
|
5002 empty string. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5003 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
|
5004 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
|
5005 |
| 6663 | 5006 *globpath()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5007 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 7 | 5008 Perform glob() on all directories in {path} and concatenate |
| 5009 the results. Example: > | |
| 5010 :echo globpath(&rtp, "syntax/c.vim") | |
| 5873 | 5011 < |
| 5012 {path} is a comma-separated list of directory names. Each | |
| 7 | 5013 directory name is prepended to {expr} and expanded like with |
| 1754 | 5014 |glob()|. A path separator is inserted when needed. |
| 7 | 5015 To add a comma inside a directory name escape it with a |
| 5016 backslash. Note that on MS-Windows a directory may have a | |
| 5017 trailing backslash, remove it if you put a comma after it. | |
| 5018 If the expansion fails for one of the directories, there is no | |
| 5019 error message. | |
| 5873 | 5020 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5021 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 5022 the 'suffixes' and 'wildignore' options apply: Names matching |
| 5023 one of the patterns in 'wildignore' will be skipped and | |
| 5024 'suffixes' affect the ordering of matches. | |
| 7 | 5025 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5026 When {list} is present and it is |TRUE| the result is a List |
| 5873 | 5027 with all matching files. The advantage of using a List is, you |
| 5028 also get filenames containing newlines correctly. Otherwise | |
| 5029 the result is a String and when there are several matches, | |
| 5030 they are separated by <NL> characters. Example: > | |
| 5031 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 5032 < | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5033 {alllinks} is used as with |glob()|. |
| 6663 | 5034 |
| 444 | 5035 The "**" item can be used to search in a directory tree. |
| 5036 For example, to find all "README.txt" files in the directories | |
| 5037 in 'runtimepath' and below: > | |
| 5038 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 5039 < Upwards search and limiting the depth of "**" is not |
| 5040 supported, thus using 'path' will not always work properly. | |
| 5041 | |
| 7 | 5042 *has()* |
| 5043 has({feature}) The result is a Number, which is 1 if the feature {feature} is | |
| 5044 supported, zero otherwise. The {feature} argument is a | |
| 5045 string. See |feature-list| below. | |
| 5046 Also see |exists()|. | |
| 5047 | |
| 102 | 5048 |
| 5049 has_key({dict}, {key}) *has_key()* | |
| 685 | 5050 The result is a Number, which is 1 if |Dictionary| {dict} has |
| 5051 an entry with key {key}. Zero otherwise. | |
| 102 | 5052 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5053 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5054 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
|
5055 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
|
5056 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5057 Without arguments use the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5058 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
|
5059 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
|
5060 page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5061 {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
|
5062 Return 0 if the arguments are invalid. |
| 102 | 5063 |
| 782 | 5064 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 7 | 5065 The result is a Number, which is 1 if there is a mapping that |
| 5066 contains {what} in somewhere in the rhs (what it is mapped to) | |
| 5067 and this mapping exists in one of the modes indicated by | |
| 5068 {mode}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5069 When {abbr} is there and it is |TRUE| use abbreviations |
| 786 | 5070 instead of mappings. Don't forget to specify Insert and/or |
| 5071 Command-line mode. | |
| 7 | 5072 Both the global mappings and the mappings local to the current |
| 5073 buffer are checked for a match. | |
| 5074 If no matching mapping is found 0 is returned. | |
| 5075 The following characters are recognized in {mode}: | |
| 5076 n Normal mode | |
| 5077 v Visual mode | |
| 5078 o Operator-pending mode | |
| 5079 i Insert mode | |
| 5080 l Language-Argument ("r", "f", "t", etc.) | |
| 5081 c Command-line mode | |
| 5082 When {mode} is omitted, "nvo" is used. | |
| 5083 | |
| 5084 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
|
5085 to a function in a Vim script. Example: > |
| 7 | 5086 :if !hasmapto('\ABCdoit') |
| 5087 : map <Leader>d \ABCdoit | |
| 5088 :endif | |
| 5089 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 5090 already a mapping to "\ABCdoit". | |
| 5091 | |
| 5092 histadd({history}, {item}) *histadd()* | |
| 5093 Add the String {item} to the history {history} which can be | |
| 5094 one of: *hist-names* | |
| 5095 "cmd" or ":" command line history | |
| 5096 "search" or "/" search pattern history | |
| 1621 | 5097 "expr" or "=" typed expression history |
| 7 | 5098 "input" or "@" input line history |
| 3682 | 5099 "debug" or ">" debug command history |
|
10228
8a1481e59d64
commit https://github.com/vim/vim/commit/3e496b0ea31996b665824f45664dee1fdd73c4d0
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
5100 empty the current or last used history |
| 3682 | 5101 The {history} string does not need to be the whole name, one |
| 5102 character is sufficient. | |
| 7 | 5103 If {item} does already exist in the history, it will be |
| 5104 shifted to become the newest entry. | |
| 5105 The result is a Number: 1 if the operation was successful, | |
| 5106 otherwise 0 is returned. | |
| 5107 | |
| 5108 Example: > | |
| 5109 :call histadd("input", strftime("%Y %b %d")) | |
| 5110 :let date=input("Enter date: ") | |
| 5111 < This function is not available in the |sandbox|. | |
| 5112 | |
| 5113 histdel({history} [, {item}]) *histdel()* | |
| 236 | 5114 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 5115 for the possible values of {history}. |
| 5116 | |
| 1668 | 5117 If the parameter {item} evaluates to a String, it is used as a |
| 5118 regular expression. All entries matching that expression will | |
| 5119 be removed from the history (if there are any). | |
| 7 | 5120 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 5121 If {item} evaluates to a Number, it will be interpreted as |
| 5122 an index, see |:history-indexing|. The respective entry will | |
| 5123 be removed if it exists. | |
| 7 | 5124 |
| 5125 The result is a Number: 1 for a successful operation, | |
| 5126 otherwise 0 is returned. | |
| 5127 | |
| 5128 Examples: | |
| 5129 Clear expression register history: > | |
| 5130 :call histdel("expr") | |
| 5131 < | |
| 5132 Remove all entries starting with "*" from the search history: > | |
| 5133 :call histdel("/", '^\*') | |
| 5134 < | |
| 5135 The following three are equivalent: > | |
| 5136 :call histdel("search", histnr("search")) | |
| 5137 :call histdel("search", -1) | |
| 5138 :call histdel("search", '^'.histget("search", -1).'$') | |
| 5139 < | |
| 5140 To delete the last search pattern and use the last-but-one for | |
| 5141 the "n" command and 'hlsearch': > | |
| 5142 :call histdel("search", -1) | |
| 5143 :let @/ = histget("search", -1) | |
| 5144 | |
| 5145 histget({history} [, {index}]) *histget()* | |
| 5146 The result is a String, the entry with Number {index} from | |
| 5147 {history}. See |hist-names| for the possible values of | |
| 5148 {history}, and |:history-indexing| for {index}. If there is | |
| 5149 no such entry, an empty String is returned. When {index} is | |
| 5150 omitted, the most recent item from the history is used. | |
| 5151 | |
| 5152 Examples: | |
| 5153 Redo the second last search from history. > | |
| 5154 :execute '/' . histget("search", -2) | |
| 5155 | |
| 5156 < Define an Ex command ":H {num}" that supports re-execution of | |
| 5157 the {num}th entry from the output of |:history|. > | |
| 5158 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 5159 < | |
| 5160 histnr({history}) *histnr()* | |
| 5161 The result is the Number of the current entry in {history}. | |
| 5162 See |hist-names| for the possible values of {history}. | |
| 5163 If an error occurred, -1 is returned. | |
| 5164 | |
| 5165 Example: > | |
| 5166 :let inp_index = histnr("expr") | |
| 5167 < | |
| 5168 hlexists({name}) *hlexists()* | |
| 5169 The result is a Number, which is non-zero if a highlight group | |
| 5170 called {name} exists. This is when the group has been | |
| 5171 defined in some way. Not necessarily when highlighting has | |
| 5172 been defined for it, it may also have been used for a syntax | |
| 5173 item. | |
| 5174 *highlight_exists()* | |
| 5175 Obsolete name: highlight_exists(). | |
| 5176 | |
| 5177 *hlID()* | |
| 5178 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 5179 with name {name}. When the highlight group doesn't exist, | |
| 5180 zero is returned. | |
| 5181 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
|
5182 group. For example, to get the background color of the |
| 7 | 5183 "Comment" group: > |
| 5184 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 5185 < *highlightID()* | |
| 5186 Obsolete name: highlightID(). | |
| 5187 | |
| 5188 hostname() *hostname()* | |
| 5189 The result is a String, which is the name of the machine on | |
| 236 | 5190 which Vim is currently running. Machine names greater than |
| 7 | 5191 256 characters long are truncated. |
| 5192 | |
| 5193 iconv({expr}, {from}, {to}) *iconv()* | |
| 5194 The result is a String, which is the text {expr} converted | |
| 5195 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5196 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5197 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5198 are replaced with "?". |
| 7 | 5199 The encoding names are whatever the iconv() library function |
| 5200 can accept, see ":!man 3 iconv". | |
| 5201 Most conversions require Vim to be compiled with the |+iconv| | |
| 5202 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 5203 can be done. | |
| 5204 This can be used to display messages with special characters, | |
| 5205 no matter what 'encoding' is set to. Write the message in | |
| 5206 UTF-8 and use: > | |
| 5207 echo iconv(utf8_str, "utf-8", &enc) | |
| 5208 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 5209 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 5210 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
|
5211 {only available when compiled with the |+multi_byte| feature} |
| 7 | 5212 |
| 5213 *indent()* | |
| 5214 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 5215 current buffer. The indent is counted in spaces, the value | |
| 5216 of 'tabstop' is relevant. {lnum} is used just like in | |
| 5217 |getline()|. | |
| 5218 When {lnum} is invalid -1 is returned. | |
| 5219 | |
| 79 | 5220 |
| 95 | 5221 index({list}, {expr} [, {start} [, {ic}]]) *index()* |
| 685 | 5222 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
|
5223 value equal to {expr}. There is no automatic conversion, so |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5224 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
|
5225 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
|
5226 is not used here, case always matters. |
| 153 | 5227 If {start} is given then start looking at the item with index |
| 5228 {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
|
5229 When {ic} is given and it is |TRUE|, ignore case. Otherwise |
| 79 | 5230 case must match. |
| 5231 -1 is returned when {expr} is not found in {list}. | |
| 5232 Example: > | |
| 5233 :let idx = index(words, "the") | |
| 87 | 5234 :if index(numbers, 123) >= 0 |
| 79 | 5235 |
| 5236 | |
| 531 | 5237 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 5238 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
|
5239 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5240 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
|
5241 in the prompt to start a new line. |
| 531 | 5242 The highlighting set with |:echohl| is used for the prompt. |
| 5243 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
|
5244 editing commands and mappings. There is a separate history |
| 531 | 5245 for lines typed for input(). |
| 5246 Example: > | |
| 5247 :if input("Coffee or beer? ") == "beer" | |
| 5248 : echo "Cheers!" | |
| 5249 :endif | |
| 5250 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5251 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5252 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
|
5253 Example: > |
| 531 | 5254 :let color = input("Color? ", "white") |
| 5255 | |
| 5256 < The optional {completion} argument specifies the type of | |
| 5257 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
|
5258 not performed. The supported completion types are the same as |
| 531 | 5259 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
|
5260 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 5261 more information. Example: > |
| 5262 let fname = input("File: ", "", "file") | |
| 5263 < | |
| 5264 NOTE: This function must not be used in a startup file, for | |
| 5265 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 5266 Note: When input() is called from within a mapping it will |
| 5267 consume remaining characters from that mapping, because a | |
| 5268 mapping is handled like the characters were typed. | |
| 5269 Use |inputsave()| before input() and |inputrestore()| | |
| 5270 after input() to avoid that. Another solution is to avoid | |
| 5271 that further characters follow in the mapping, e.g., by using | |
| 5272 |:execute| or |:normal|. | |
| 5273 | |
| 531 | 5274 Example with a mapping: > |
| 7 | 5275 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 5276 :function GetFoo() | |
| 5277 : call inputsave() | |
| 5278 : let g:Foo = input("enter search pattern: ") | |
| 5279 : call inputrestore() | |
| 5280 :endfunction | |
| 5281 | |
| 5282 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5283 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5284 are supported, a dialog window pops up to input the text. |
| 7 | 5285 Example: > |
| 3875 | 5286 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 5287 :if n != "" | |
| 5288 : let &sw = n | |
| 5289 :endif | |
| 7 | 5290 < When the dialog is cancelled {cancelreturn} is returned. When |
| 5291 omitted an empty string is returned. | |
| 5292 Hitting <Enter> works like pressing the OK button. Hitting | |
| 5293 <Esc> works like pressing the Cancel button. | |
| 531 | 5294 NOTE: Command-line completion is not supported. |
| 7 | 5295 |
| 519 | 5296 inputlist({textlist}) *inputlist()* |
| 819 | 5297 {textlist} must be a |List| of strings. This |List| is |
| 5298 displayed, one string per line. The user will be prompted to | |
| 5299 enter a number, which is returned. | |
| 519 | 5300 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
|
5301 mouse. For the first string 0 is returned. When clicking |
| 519 | 5302 above the first item a negative number is returned. When |
| 5303 clicking on the prompt one more than the length of {textlist} | |
| 5304 is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5305 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
|
5306 it won't work. It's a good idea to put the entry number at |
| 1156 | 5307 the start of the string. And put a prompt in the first item. |
| 5308 Example: > | |
| 519 | 5309 let color = inputlist(['Select color:', '1. red', |
| 5310 \ '2. green', '3. blue']) | |
| 5311 | |
| 7 | 5312 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5313 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 5314 Should be called the same number of times inputsave() is |
| 5315 called. Calling it more often is harmless though. | |
| 5316 Returns 1 when there is nothing to restore, 0 otherwise. | |
| 5317 | |
| 5318 inputsave() *inputsave()* | |
| 5319 Preserve typeahead (also from mappings) and clear it, so that | |
| 5320 a following prompt gets input from the user. Should be | |
| 5321 followed by a matching inputrestore() after the prompt. Can | |
| 5322 be used several times, in which case there must be just as | |
| 5323 many inputrestore() calls. | |
| 5324 Returns 1 when out of memory, 0 otherwise. | |
| 5325 | |
| 5326 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 5327 This function acts much like the |input()| function with but | |
| 5328 two exceptions: | |
| 5329 a) the user's response will be displayed as a sequence of | |
| 5330 asterisks ("*") thereby keeping the entry secret, and | |
| 5331 b) the user's response will not be recorded on the input | |
| 5332 |history| stack. | |
| 5333 The result is a String, which is whatever the user actually | |
| 5334 typed on the command-line in response to the issued prompt. | |
| 531 | 5335 NOTE: Command-line completion is not supported. |
| 7 | 5336 |
| 55 | 5337 insert({list}, {item} [, {idx}]) *insert()* |
| 685 | 5338 Insert {item} at the start of |List| {list}. |
| 55 | 5339 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
|
5340 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 5341 like omitting {idx}. A negative {idx} is also possible, see |
| 5342 |list-index|. -1 inserts just before the last item. | |
| 685 | 5343 Returns the resulting |List|. Examples: > |
| 55 | 5344 :let mylist = insert([2, 3, 5], 1) |
| 5345 :call insert(mylist, 4, -1) | |
| 5346 :call insert(mylist, 6, len(mylist)) | |
| 82 | 5347 < The last example can be done simpler with |add()|. |
| 685 | 5348 Note that when {item} is a |List| it is inserted as a single |
| 692 | 5349 item. Use |extend()| to concatenate |Lists|. |
| 55 | 5350 |
| 3214 | 5351 invert({expr}) *invert()* |
| 5352 Bitwise invert. The argument is converted to a number. A | |
| 5353 List, Dict or Float argument causes an error. Example: > | |
| 5354 :let bits = invert(bits) | |
| 5355 | |
| 7 | 5356 isdirectory({directory}) *isdirectory()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5357 The result is a Number, which is |TRUE| when a directory |
| 7 | 5358 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
|
5359 exist, or isn't a directory, the result is |FALSE|. {directory} |
| 7 | 5360 is any expression, which is used as a String. |
| 5361 | |
| 819 | 5362 islocked({expr}) *islocked()* *E786* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5363 The result is a Number, which is |TRUE| when {expr} is the |
| 148 | 5364 name of a locked variable. |
| 685 | 5365 {expr} must be the name of a variable, |List| item or |
| 5366 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 5367 :let alist = [0, ['a', 'b'], 2, 3] |
| 5368 :lockvar 1 alist | |
| 5369 :echo islocked('alist') " 1 | |
| 5370 :echo islocked('alist[1]') " 0 | |
| 5371 | |
| 5372 < When {expr} is a variable that does not exist you get an error | |
| 843 | 5373 message. Use |exists()| to check for existence. |
| 148 | 5374 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5375 isnan({expr}) *isnan()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5376 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
|
5377 echo isnan(0.0 / 0.0) |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5378 < 1 ~ |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5379 |
|
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
5380 {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
|
5381 |
| 140 | 5382 items({dict}) *items()* |
| 685 | 5383 Return a |List| with all the key-value pairs of {dict}. Each |
| 5384 |List| item is a list with two items: the key of a {dict} | |
| 5385 entry and the value of this entry. The |List| is in arbitrary | |
| 5386 order. | |
| 140 | 5387 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5388 job_getchannel({job}) *job_getchannel()* |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5389 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
|
5390 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
|
5391 if string(job_getchannel()) == 'channel fail' |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8451
diff
changeset
|
5392 < |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5393 {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
|
5394 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5395 job_info({job}) *job_info()* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5396 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
|
5397 "status" what |job_status()| returns |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5398 "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
|
5399 "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
|
5400 "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
|
5401 "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
|
5402 "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
|
5403 "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
|
5404 "stoponexit" |job-stoponexit| |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
5405 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5406 job_setoptions({job}, {options}) *job_setoptions()* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5407 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
|
5408 "stoponexit" |job-stoponexit| |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5409 "exit_cb" |job-exit_cb| |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5410 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
5411 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
|
5412 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
|
5413 |:!cmd| this does not wait for the job to finish. |
| 12254 | 5414 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
|
5415 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5416 {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
|
5417 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
|
5418 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
|
5419 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5420 {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
|
5421 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
|
5422 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
|
5423 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5424 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
|
5425 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
|
5426 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5427 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
|
5428 '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
|
5429 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
|
5430 < Or: > |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5431 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
|
5432 < 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
|
5433 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
|
5434 shell command. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5435 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5436 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
|
5437 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
|
5438 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5439 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
|
5440 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
|
5441 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
|
5442 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
|
5443 < |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5444 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
|
5445 |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
|
5446 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5447 {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
|
5448 items, see |job-options|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5449 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5450 {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
|
5451 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5452 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
|
5453 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
|
5454 "run" job is running |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5455 "fail" job failed to start |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5456 "dead" job died or was stopped after running |
| 12785 | 5457 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5458 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
|
5459 "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
|
5460 detected. |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
5461 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
5462 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
|
5463 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
|
5464 |
|
8502
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5465 For more information see |job_info()|. |
|
ee5cb2e9ed5a
commit https://github.com/vim/vim/commit/8950a563b306ce76f259573d91c2ddccdf52e32e
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
5466 |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5467 {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
|
5468 |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5469 job_stop({job} [, {how}]) *job_stop()* |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5470 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
|
5471 |
|
8251
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5472 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
|
5473 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
|
5474 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
|
5475 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
|
5476 affected. |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5477 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5478 Effect for Unix: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5479 "term" SIGTERM (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5480 "hup" SIGHUP |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5481 "quit" SIGQUIT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5482 "int" SIGINT |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5483 "kill" SIGKILL (strongest way to stop) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5484 number signal with that number |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5485 |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5486 Effect for MS-Windows: |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5487 "term" terminate process forcedly (default) |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5488 "hup" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5489 "quit" CTRL_BREAK |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5490 "int" CTRL_C |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5491 "kill" terminate process forcedly |
|
989ac3aed1ef
commit https://github.com/vim/vim/commit/923d926d57d985ec8965da9d0cd3634e6b24bfe1
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
5492 Others CTRL_BREAK |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5493 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5494 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
|
5495 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
|
5496 and the command. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5497 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
5498 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
|
5499 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
|
5500 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
|
5501 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
|
5502 |job_status()|. |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5503 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5504 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
|
5505 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
|
5506 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
|
5507 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
5508 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
|
5509 the channel. |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5510 |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
5511 {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
|
5512 |
| 95 | 5513 join({list} [, {sep}]) *join()* |
| 5514 Join the items in {list} together into one String. | |
| 5515 When {sep} is specified it is put in between the items. If | |
| 5516 {sep} is omitted a single space is used. | |
| 5517 Note that {sep} is not added at the end. You might want to | |
| 5518 add it there too: > | |
| 5519 let lines = join(mylist, "\n") . "\n" | |
| 692 | 5520 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 5521 converted into a string like with |string()|. |
| 5522 The opposite function is |split()|. | |
| 5523 | |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5524 js_decode({string}) *js_decode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5525 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
|
5526 - 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
|
5527 - 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
|
5528 - 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
|
5529 result in v:none items. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5530 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5531 js_encode({expr}) *js_encode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5532 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
|
5533 - 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
|
5534 - 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
|
5535 commas. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5536 For example, the Vim object: |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5537 [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
|
5538 Will be encoded as: |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5539 [1,,{one:1},,] ~ |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5540 While json_encode() would produce: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5541 [1,null,{"one":1},null] ~ |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5542 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
|
5543 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
|
5544 |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5545 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5546 json_decode({string}) *json_decode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5547 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
|
5548 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
|
5549 JSON and Vim values. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5550 The decoding is permissive: |
| 11347 | 5551 - A trailing comma in an array and object is ignored, e.g. |
| 5552 "[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
|
5553 - More floating point numbers are recognized, e.g. "1." for |
| 11347 | 5554 "1.0", or "001.2" for "1.2". Special floating point values |
| 5555 "Infinity" and "NaN" (capitalization ignored) are accepted. | |
| 5556 - Leading zeroes in integer numbers are ignored, e.g. "012" | |
| 5557 for "12" or "-012" for "-12". | |
| 5558 - Capitalization is ignored in literal names null, true or | |
| 5559 false, e.g. "NULL" for "null", "True" for "true". | |
| 5560 - Control characters U+0000 through U+001F which are not | |
| 5561 escaped in strings are accepted, e.g. " " (tab | |
| 5562 character in string) for "\t". | |
| 5563 - Backslash in an invalid 2-character sequence escape is | |
| 5564 ignored, e.g. "\a" is decoded as "a". | |
| 5565 - A correct surrogate pair in JSON strings should normally be | |
| 5566 a 12 character sequence such as "\uD834\uDD1E", but | |
| 5567 json_decode() silently accepts truncated surrogate pairs | |
| 5568 such as "\uD834" or "\uD834\u" | |
| 5569 *E938* | |
| 5570 A duplicate key in an object, valid in rfc7159, is not | |
| 5571 accepted by json_decode() as the result must be a valid Vim | |
| 5572 type, e.g. this fails: {"a":"b", "a":"c"} | |
| 5573 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5574 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
5575 json_encode({expr}) *json_encode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
5576 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
|
5577 The encoding is specified in: |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
5578 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
|
5579 Vim values are converted as follows: |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5580 Number decimal number |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5581 Float floating point number |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5582 Float nan "NaN" |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5583 Float inf "Infinity" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5584 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
|
5585 Funcref not possible, error |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5586 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
|
5587 used recursively: [] |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5588 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
|
5589 used recursively: {} |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5590 v:false "false" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5591 v:true "true" |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
5592 v:none "null" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
5593 v:null "null" |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
5594 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
|
5595 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
|
5596 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
|
5597 |
| 99 | 5598 keys({dict}) *keys()* |
| 685 | 5599 Return a |List| with all the keys of {dict}. The |List| is in |
| 99 | 5600 arbitrary order. |
| 5601 | |
| 85 | 5602 *len()* *E701* |
| 55 | 5603 len({expr}) The result is a Number, which is the length of the argument. |
| 5604 When {expr} is a String or a Number the length in bytes is | |
| 5605 used, as with |strlen()|. | |
| 685 | 5606 When {expr} is a |List| the number of items in the |List| is |
| 55 | 5607 returned. |
| 685 | 5608 When {expr} is a |Dictionary| the number of entries in the |
| 5609 |Dictionary| is returned. | |
| 55 | 5610 Otherwise an error is given. |
| 5611 | |
| 7 | 5612 *libcall()* *E364* *E368* |
| 5613 libcall({libname}, {funcname}, {argument}) | |
| 5614 Call function {funcname} in the run-time library {libname} | |
| 5615 with single argument {argument}. | |
| 5616 This is useful to call functions in a library that you | |
| 5617 especially made to be used with Vim. Since only one argument | |
| 5618 is possible, calling standard library functions is rather | |
| 5619 limited. | |
| 5620 The result is the String returned by the function. If the | |
| 5621 function returns NULL, this will appear as an empty string "" | |
| 5622 to Vim. | |
| 5623 If the function returns a number, use libcallnr()! | |
| 5624 If {argument} is a number, it is passed to the function as an | |
| 5625 int; if {argument} is a string, it is passed as a | |
| 5626 null-terminated string. | |
| 5627 This function will fail in |restricted-mode|. | |
| 5628 | |
| 5629 libcall() allows you to write your own 'plug-in' extensions to | |
| 5630 Vim without having to recompile the program. It is NOT a | |
| 5631 means to call system functions! If you try to do so Vim will | |
| 5632 very probably crash. | |
| 5633 | |
| 5634 For Win32, the functions you write must be placed in a DLL | |
| 5635 and use the normal C calling convention (NOT Pascal which is | |
| 5636 used in Windows System DLLs). The function must take exactly | |
| 5637 one parameter, either a character pointer or a long integer, | |
| 5638 and must return a character pointer or NULL. The character | |
| 5639 pointer returned must point to memory that will remain valid | |
| 5640 after the function has returned (e.g. in static data in the | |
| 5641 DLL). If it points to allocated memory, that memory will | |
| 5642 leak away. Using a static buffer in the function should work, | |
| 5643 it's then freed when the DLL is unloaded. | |
| 5644 | |
| 5645 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 5646 crash! This also happens if the function returns a number, |
| 7 | 5647 because Vim thinks it's a pointer. |
| 5648 For Win32 systems, {libname} should be the filename of the DLL | |
| 5649 without the ".DLL" suffix. A full path is only required if | |
| 5650 the DLL is not in the usual places. | |
| 5651 For Unix: When compiling your own plugins, remember that the | |
| 5652 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5653 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 5654 feature is present} |
| 5655 Examples: > | |
| 5656 :echo libcall("libc.so", "getenv", "HOME") | |
| 5657 < | |
| 5658 *libcallnr()* | |
| 5659 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5660 Just like |libcall()|, but used for a function that returns an |
| 7 | 5661 int instead of a string. |
| 5662 {only in Win32 on some Unix versions, when the |+libcall| | |
| 5663 feature is present} | |
| 1621 | 5664 Examples: > |
| 5665 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 5666 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 5667 :call libcallnr("libc.so", "sleep", 10) | |
| 5668 < | |
| 5669 *line()* | |
| 5670 line({expr}) The result is a Number, which is the line number of the file | |
| 5671 position given with {expr}. The accepted positions are: | |
| 5672 . the cursor position | |
| 5673 $ the last line in the current buffer | |
| 5674 'x position of mark x (if the mark is not set, 0 is | |
| 5675 returned) | |
|
11313
327a04a762f6
patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents:
11263
diff
changeset
|
5676 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
|
5677 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
|
5678 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
|
5679 less than "w0" if no lines are visible) |
| 1609 | 5680 v In Visual mode: the start of the Visual area (the |
| 5681 cursor is the end). When not in Visual mode | |
| 5682 returns the cursor position. Differs from |'<| in | |
| 5683 that it's updated right away. | |
| 1156 | 5684 Note that a mark in another file can be used. The line number |
| 5685 then applies to another buffer. | |
| 703 | 5686 To get the column number use |col()|. To get both use |
| 5687 |getpos()|. | |
| 7 | 5688 Examples: > |
| 5689 line(".") line number of the cursor | |
| 5690 line("'t") line number of mark t | |
| 5691 line("'" . marker) line number of mark marker | |
| 5692 < *last-position-jump* | |
| 5693 This autocommand jumps to the last known position in a file | |
| 5694 just after opening it, if the '" mark is set: > | |
| 11518 | 5695 :au BufReadPost * |
| 12785 | 5696 \ 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
|
5697 \ | 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
|
5698 \ | endif |
| 9 | 5699 |
| 7 | 5700 line2byte({lnum}) *line2byte()* |
| 5701 Return the byte count from the start of the buffer for line | |
| 5702 {lnum}. This includes the end-of-line character, depending on | |
| 5703 the 'fileformat' option for the current buffer. The first | |
| 3237 | 5704 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 5705 This can also be used to get the byte count for the line just |
| 5706 below the last line: > | |
| 5707 line2byte(line("$") + 1) | |
| 3237 | 5708 < This is the buffer size plus one. If 'fileencoding' is empty |
| 5709 it is the file size plus one. | |
| 7 | 5710 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 5711 disabled at compile time, -1 is returned. | |
| 5712 Also see |byte2line()|, |go| and |:goto|. | |
| 5713 | |
| 5714 lispindent({lnum}) *lispindent()* | |
| 5715 Get the amount of indent for line {lnum} according the lisp | |
| 5716 indenting rules, as with 'lisp'. | |
| 5717 The indent is counted in spaces, the value of 'tabstop' is | |
| 5718 relevant. {lnum} is used just like in |getline()|. | |
| 5719 When {lnum} is invalid or Vim was not compiled the | |
| 5720 |+lispindent| feature, -1 is returned. | |
| 5721 | |
| 5722 localtime() *localtime()* | |
| 5723 Return the current time, measured as seconds since 1st Jan | |
| 5724 1970. See also |strftime()| and |getftime()|. | |
| 5725 | |
| 95 | 5726 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5727 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
5728 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
|
5729 {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
|
5730 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5731 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5732 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5733 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5734 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5735 < 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
|
5736 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5737 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5738 |
| 1621 | 5739 log10({expr}) *log10()* |
| 5740 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 5741 {expr} must evaluate to a |Float| or a |Number|. | |
| 5742 Examples: > | |
| 5743 :echo log10(1000) | |
| 5744 < 3.0 > | |
| 5745 :echo log10(0.01) | |
| 5746 < -2.0 | |
| 5747 {only available when compiled with the |+float| feature} | |
| 12785 | 5748 |
| 5749 luaeval({expr} [, {expr}]) *luaeval()* | |
| 5750 Evaluate Lua expression {expr} and return its result converted | |
| 5751 to Vim data structures. Second {expr} may hold additional | |
| 3492 | 5752 argument accessible as _A inside first {expr}. |
| 5753 Strings are returned as they are. | |
| 5754 Boolean objects are converted to numbers. | |
| 12785 | 5755 Numbers are converted to |Float| values if vim was compiled |
| 3492 | 5756 with |+float| and to numbers otherwise. |
| 12785 | 5757 Dictionaries and lists obtained by vim.eval() are returned |
| 3492 | 5758 as-is. |
| 5759 Other objects are returned as zero without any errors. | |
| 5760 See |lua-luaeval| for more details. | |
| 5761 {only available when compiled with the |+lua| feature} | |
| 5762 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5763 map({expr1}, {expr2}) *map()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5764 {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
|
5765 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
|
5766 {expr2}. {expr2} must be a |string| or |Funcref|. |
| 12785 | 5767 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5768 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
|
5769 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
|
5770 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
|
5771 the current item. |
| 102 | 5772 Example: > |
| 5773 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 5774 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 5775 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5776 Note that {expr2} is the result of an expression and is then |
| 102 | 5777 used as an expression again. Often it is good to use a |
| 158 | 5778 |literal-string| to avoid having to double backslashes. You |
| 5779 still have to double ' quotes | |
| 102 | 5780 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5781 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
|
5782 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
|
5783 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
|
5784 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
|
5785 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
|
5786 func KeyValue(key, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5787 return a:key . '-' . a:val |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5788 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5789 call map(myDict, function('KeyValue')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
5790 < 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
|
5791 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
|
5792 < 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
|
5793 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
|
5794 < |
| 685 | 5795 The operation is done in-place. If you want a |List| or |
| 5796 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 5797 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 5798 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
5799 < 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
|
5800 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
|
5801 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
|
5802 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
|
5803 defined with the "abort" flag. |
| 95 | 5804 |
| 5805 | |
| 12785 | 5806 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 2610 | 5807 When {dict} is omitted or zero: Return the rhs of mapping |
| 5808 {name} in mode {mode}. The returned String has special | |
| 5809 characters translated like in the output of the ":map" command | |
| 5810 listing. | |
| 12785 | 5811 |
| 2610 | 5812 When there is no mapping for {name}, an empty String is |
| 5813 returned. | |
| 5814 | |
| 5815 The {name} can have special key names, like in the ":map" | |
| 5816 command. | |
| 5817 | |
| 644 | 5818 {mode} can be one of these strings: |
| 7 | 5819 "n" Normal |
| 2610 | 5820 "v" Visual (including Select) |
| 7 | 5821 "o" Operator-pending |
| 5822 "i" Insert | |
| 5823 "c" Cmd-line | |
| 2610 | 5824 "s" Select |
| 5825 "x" Visual | |
| 7 | 5826 "l" langmap |language-mapping| |
| 12499 | 5827 "t" Terminal-Job |
| 7 | 5828 "" Normal, Visual and Operator-pending |
| 644 | 5829 When {mode} is omitted, the modes for "" are used. |
| 2610 | 5830 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5831 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 5832 instead of mappings. |
| 2610 | 5833 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5834 When {dict} is there and it is |TRUE| return a dictionary |
| 2610 | 5835 containing all the information of the mapping with the |
| 5836 following items: | |
| 5837 "lhs" The {lhs} of the mapping. | |
| 5838 "rhs" The {rhs} of the mapping as typed. | |
| 5839 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 5840 "noremap" 1 if the {rhs} of the mapping is not remappable. |
| 2610 | 5841 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 5842 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 5843 "mode" Modes for which the mapping is defined. In | |
| 5844 addition to the modes mentioned above, these | |
| 5845 characters will be used: | |
| 5846 " " Normal, Visual and Operator-pending | |
| 5847 "!" Insert and Commandline mode | |
| 2642 | 5848 (|mapmode-ic|) |
| 2625 | 5849 "sid" The script local ID, used for <sid> mappings |
| 5850 (|<SID>|). | |
| 5555 | 5851 "nowait" Do not wait for other, longer mappings. |
| 5852 (|:map-<nowait>|). | |
| 2610 | 5853 |
| 7 | 5854 The mappings local to the current buffer are checked first, |
| 5855 then the global mappings. | |
| 626 | 5856 This function can be used to map a key even when it's already |
| 5857 mapped, and have it do the original mapping too. Sketch: > | |
| 5858 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 5859 | |
| 7 | 5860 |
| 12785 | 5861 mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 5862 Check if there is a mapping that matches with {name} in mode |
| 5863 {mode}. See |maparg()| for {mode} and special names in | |
| 5864 {name}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5865 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 5866 instead of mappings. |
| 7 | 5867 A match happens with a mapping that starts with {name} and |
| 5868 with a mapping which is equal to the start of {name}. | |
| 5869 | |
| 1621 | 5870 matches mapping "a" "ab" "abc" ~ |
| 7 | 5871 mapcheck("a") yes yes yes |
| 5872 mapcheck("abc") yes yes yes | |
| 5873 mapcheck("ax") yes no no | |
| 5874 mapcheck("b") no no no | |
| 5875 | |
| 5876 The difference with maparg() is that mapcheck() finds a | |
| 5877 mapping that matches with {name}, while maparg() only finds a | |
| 5878 mapping for {name} exactly. | |
| 5879 When there is no mapping that starts with {name}, an empty | |
| 5880 String is returned. If there is one, the rhs of that mapping | |
| 5881 is returned. If there are several mappings that start with | |
| 5882 {name}, the rhs of one of them is returned. | |
| 5883 The mappings local to the current buffer are checked first, | |
| 5884 then the global mappings. | |
| 5885 This function can be used to check if a mapping can be added | |
| 5886 without being ambiguous. Example: > | |
| 5887 :if mapcheck("_vv") == "" | |
| 5888 : map _vv :set guifont=7x13<CR> | |
| 5889 :endif | |
| 5890 < This avoids adding the "_vv" mapping when there already is a | |
| 5891 mapping for "_v" or for "_vvv". | |
| 5892 | |
| 12785 | 5893 match({expr}, {pat} [, {start} [, {count}]]) *match()* |
| 685 | 5894 When {expr} is a |List| then this returns the index of the |
| 5895 first item where {pat} matches. Each item is used as a | |
| 692 | 5896 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
|
5897 Otherwise, {expr} is used as a String. The result is a |
| 95 | 5898 Number, which gives the index (byte offset) in {expr} where |
| 5899 {pat} matches. | |
| 685 | 5900 A match at the first character or |List| item returns zero. |
| 19 | 5901 If there is no match -1 is returned. |
| 2833 | 5902 For getting submatches see |matchlist()|. |
| 19 | 5903 Example: > |
| 95 | 5904 :echo match("testing", "ing") " results in 4 |
| 714 | 5905 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 5906 < See |string-match| for how {pat} is used. |
| 170 | 5907 *strpbrk()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5908 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 5909 :let sepidx = match(line, '[.,;: \t]') |
| 5910 < *strcasestr()* | |
| 5911 Vim doesn't have a strcasestr() function. But you can add | |
| 5912 "\c" to the pattern to ignore case: > | |
| 5913 :let idx = match(haystack, '\cneedle') | |
| 5914 < | |
| 95 | 5915 If {start} is given, the search starts from byte index |
| 685 | 5916 {start} in a String or item {start} in a |List|. |
| 7 | 5917 The result, however, is still the index counted from the |
| 236 | 5918 first character/item. Example: > |
| 7 | 5919 :echo match("testing", "ing", 2) |
| 5920 < result is again "4". > | |
| 5921 :echo match("testing", "ing", 4) | |
| 5922 < result is again "4". > | |
| 5923 :echo match("testing", "t", 2) | |
| 5924 < result is "3". | |
| 694 | 5925 For a String, if {start} > 0 then it is like the string starts |
| 703 | 5926 {start} bytes later, thus "^" will match at {start}. Except |
| 5927 when {count} is given, then it's like matches before the | |
| 5928 {start} byte are ignored (this is a bit complicated to keep it | |
| 5929 backwards compatible). | |
| 95 | 5930 For a String, if {start} < 0, it will be set to 0. For a list |
| 5931 the index is counted from the end. | |
| 697 | 5932 If {start} is out of range ({start} > strlen({expr}) for a |
| 5933 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 5934 |
| 694 | 5935 When {count} is given use the {count}'th match. When a match |
| 697 | 5936 is found in a String the search for the next one starts one |
| 694 | 5937 character further. Thus this example results in 1: > |
| 5938 echo match("testing", "..", 0, 2) | |
| 5939 < In a |List| the search continues in the next item. | |
| 703 | 5940 Note that when {count} is added the way {start} works changes, |
| 5941 see above. | |
| 694 | 5942 |
| 7 | 5943 See |pattern| for the patterns that are accepted. |
| 5944 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
|
5945 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 5946 done like 'magic' is set and 'cpoptions' is empty. |
| 5947 | |
| 1326 | 5948 *matchadd()* *E798* *E799* *E801* |
| 12785 | 5949 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 5950 Defines a pattern to be highlighted in the current window (a |
| 5951 "match"). It will be highlighted with {group}. Returns an | |
| 5952 identification number (ID), which can be used to delete the | |
| 5953 match using |matchdelete()|. | |
| 5466 | 5954 Matching is case sensitive and magic, unless case sensitivity |
| 5955 or magicness are explicitly overridden in {pattern}. The | |
| 5956 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
5957 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
|
5958 concealed. |
| 1326 | 5959 |
| 5960 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
|
5961 match. A match with a high priority will have its |
| 1326 | 5962 highlighting overrule that of a match with a lower priority. |
| 5963 A priority is specified as an integer (negative numbers are no | |
| 5964 exception). If the {priority} argument is not specified, the | |
| 5965 default priority is 10. The priority of 'hlsearch' is zero, | |
| 5966 hence all matches with a priority greater than zero will | |
| 5967 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 5968 mechanism, and regardless of the chosen priority a match will | |
| 5969 always overrule syntax highlighting. | |
| 5970 | |
| 5971 The optional {id} argument allows the request for a specific | |
| 5972 match ID. If a specified ID is already taken, an error | |
| 5973 message will appear and the match will not be added. An ID | |
| 5974 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 5975 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 5976 respectively. If the {id} argument is not specified or -1, |
| 1326 | 5977 |matchadd()| automatically chooses a free ID. |
| 5978 | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
5979 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
|
5980 values. Currently this is used to specify a match specific |
| 6947 | 5981 conceal character that will be shown for |hl-Conceal| |
| 5982 highlighted matches. The dict can have the following members: | |
| 5983 | |
| 5984 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
|
5985 match (only for |hl-Conceal| highlighted |
| 6947 | 5986 matches, see |:syn-cchar|) |
| 5987 | |
| 1326 | 5988 The number of matches is not limited, as it is the case with |
| 5989 the |:match| commands. | |
| 5990 | |
| 5991 Example: > | |
| 5992 :highlight MyGroup ctermbg=green guibg=green | |
| 5993 :let m = matchadd("MyGroup", "TODO") | |
| 5994 < Deletion of the pattern: > | |
| 5995 :call matchdelete(m) | |
| 5996 | |
| 5997 < 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
|
5998 available from |getmatches()|. All matches can be deleted in |
| 1326 | 5999 one operation by |clearmatches()|. |
| 819 | 6000 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6001 *matchaddpos()* |
| 12785 | 6002 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 6003 Same as |matchadd()|, but requires a list of positions {pos} |
| 6004 instead of a pattern. This command is faster than |matchadd()| | |
| 6005 because it does not require to handle regular expressions and | |
| 6006 sets buffer line boundaries to redraw screen. It is supposed | |
| 6007 to be used when fast match additions and deletions are | |
| 6008 required, for example to highlight matching parentheses. | |
| 6009 | |
| 6010 The list {pos} can contain one of these items: | |
| 6007 | 6011 - A number. This whole line will be highlighted. The first |
| 5979 | 6012 line has number 1. |
| 6013 - A list with one number, e.g., [23]. The whole line with this | |
| 6014 number will be highlighted. | |
| 6015 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 6016 the line number, the second one is the column number (first |
| 6017 column is 1, the value must correspond to the byte index as | |
| 6018 |col()| would return). The character at this position will | |
| 6019 be highlighted. | |
| 5979 | 6020 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 6021 the third number gives the length of the highlight in bytes. |
| 12785 | 6022 |
| 5979 | 6023 The maximum number of positions is 8. |
| 6024 | |
| 6025 Example: > | |
| 6026 :highlight MyGroup ctermbg=green guibg=green | |
| 6027 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 6028 < Deletion of the pattern: > | |
| 6029 :call matchdelete(m) | |
| 6030 | |
| 6031 < Matches added by |matchaddpos()| are returned by | |
| 6032 |getmatches()| with an entry "pos1", "pos2", etc., with the | |
| 6033 value a list like the {pos} item. | |
| 6034 | |
| 819 | 6035 matcharg({nr}) *matcharg()* |
| 856 | 6036 Selects the {nr} match item, as set with a |:match|, |
| 819 | 6037 |:2match| or |:3match| command. |
| 6038 Return a |List| with two elements: | |
| 6039 The name of the highlight group used | |
| 6040 The pattern used. | |
| 6041 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 6042 When there is no match item set returns ['', '']. | |
| 1326 | 6043 This is useful to save and restore a |:match|. |
| 6044 Highlighting matches using the |:match| commands are limited | |
| 6045 to three matches. |matchadd()| does not have this limitation. | |
| 6046 | |
| 6047 matchdelete({id}) *matchdelete()* *E802* *E803* | |
| 6048 Deletes a match with ID {id} previously defined by |matchadd()| | |
| 1621 | 6049 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 6050 otherwise -1. See example for |matchadd()|. All matches can |
| 6051 be deleted in one operation by |clearmatches()|. | |
| 819 | 6052 |
| 12785 | 6053 matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6054 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6055 after the match. Example: > |
| 7 | 6056 :echo matchend("testing", "ing") |
| 6057 < results in "7". | |
| 170 | 6058 *strspn()* *strcspn()* |
| 6059 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 6060 do it with matchend(): > | |
| 6061 :let span = matchend(line, '[a-zA-Z]') | |
| 6062 :let span = matchend(line, '[^a-zA-Z]') | |
| 6063 < Except that -1 is returned when there are no matches. | |
| 6064 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6065 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 6066 :echo matchend("testing", "ing", 2) |
| 6067 < results in "7". > | |
| 6068 :echo matchend("testing", "ing", 5) | |
| 6069 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6070 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 6071 |
| 12785 | 6072 matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6073 Same as |match()|, but return a |List|. The first item in the |
| 158 | 6074 list is the matched string, same as what matchstr() would |
| 6075 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 6076 in |:substitute|. When an optional submatch didn't match an |
| 6077 empty string is used. Example: > | |
| 6078 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 6079 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 6080 When there is no match an empty list is returned. |
| 6081 | |
| 12785 | 6082 matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()* |
| 1621 | 6083 Same as |match()|, but return the matched string. Example: > |
| 7 | 6084 :echo matchstr("testing", "ing") |
| 6085 < results in "ing". | |
| 6086 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6087 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 6088 :echo matchstr("testing", "ing", 2) |
| 6089 < results in "ing". > | |
| 6090 :echo matchstr("testing", "ing", 5) | |
| 6091 < result is "". | |
| 685 | 6092 When {expr} is a |List| then the matching item is returned. |
| 95 | 6093 The type isn't changed, it's not necessarily a String. |
| 7 | 6094 |
| 12785 | 6095 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
|
6096 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
|
6097 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
|
6098 :echo matchstrpos("testing", "ing") |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6099 < results in ["ing", 4, 7]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6100 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
|
6101 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
|
6102 :echo matchstrpos("testing", "ing", 2) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6103 < results in ["ing", 4, 7]. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6104 :echo matchstrpos("testing", "ing", 5) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6105 < result is ["", -1, -1]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6106 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
|
6107 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
|
6108 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
|
6109 :echo matchstrpos([1, '__x'], '\a') |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6110 < result is ["x", 1, 2, 3]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
6111 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
|
6112 |
| 87 | 6113 *max()* |
| 10734 | 6114 max({expr}) Return the maximum value of all items in {expr}. |
| 6115 {expr} can be a list or a dictionary. For a dictionary, | |
| 6116 it returns the maximum of all values in the dictionary. | |
| 6117 If {expr} is neither a list nor a dictionary, or one of the | |
| 6118 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
|
6119 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 6120 |
| 6121 *min()* | |
| 10734 | 6122 min({expr}) Return the minimum value of all items in {expr}. |
| 6123 {expr} can be a list or a dictionary. For a dictionary, | |
| 6124 it returns the minimum of all values in the dictionary. | |
| 6125 If {expr} is neither a list nor a dictionary, or one of the | |
| 6126 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
|
6127 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 6128 |
| 843 | 6129 *mkdir()* *E739* |
| 168 | 6130 mkdir({name} [, {path} [, {prot}]]) |
| 6131 Create directory {name}. | |
| 6132 If {path} is "p" then intermediate directories are created as | |
| 6133 necessary. Otherwise it must be "". | |
| 6134 If {prot} is given it is used to set the protection bits of | |
| 6135 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
|
6136 the user readable for others). Use 0700 to make it unreadable |
| 1702 | 6137 for others. This is only used for the last part of {name}. |
| 6138 Thus if you create /tmp/foo/bar then /tmp/foo will be created | |
| 6139 with 0755. | |
| 6140 Example: > | |
| 6141 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700) | |
| 6142 < This function is not available in the |sandbox|. | |
|
13672
4a1efd1a6018
patch 8.0.1708: mkdir with 'p' flag fails on existing directory
Christian Brabandt <cb@256bit.org>
parents:
13626
diff
changeset
|
6143 There is no error if the directory already exists and the "p" |
|
4a1efd1a6018
patch 8.0.1708: mkdir with 'p' flag fails on existing directory
Christian Brabandt <cb@256bit.org>
parents:
13626
diff
changeset
|
6144 flag is passed (since patch 8.0.1708). |
| 168 | 6145 Not available on all systems. To check use: > |
| 6146 :if exists("*mkdir") | |
| 6147 < | |
| 7 | 6148 *mode()* |
| 1621 | 6149 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 6150 If [expr] is supplied and it evaluates to a non-zero Number or |
| 6151 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
|
6152 returned, otherwise only the first letter is returned. |
| 1621 | 6153 |
| 12254 | 6154 n Normal, Terminal-Normal |
| 1621 | 6155 no Operator-pending |
| 7 | 6156 v Visual by character |
| 6157 V Visual by line | |
| 6158 CTRL-V Visual blockwise | |
| 6159 s Select by character | |
| 6160 S Select by line | |
| 6161 CTRL-S Select blockwise | |
| 6162 i Insert | |
|
10787
09926123316b
patch 8.0.0283: mode() does not indicate Insert mode completion
Christian Brabandt <cb@256bit.org>
parents:
10734
diff
changeset
|
6163 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
|
6164 ix Insert mode |i_CTRL-X| completion |
| 1621 | 6165 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
|
6166 Rc Replace mode completion |compl-generic| |
| 1621 | 6167 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
|
6168 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
|
6169 c Command-line editing |
| 1621 | 6170 cv Vim Ex mode |gQ| |
| 6171 ce Normal Ex mode |Q| | |
| 7 | 6172 r Hit-enter prompt |
| 1621 | 6173 rm The -- more -- prompt |
| 6174 r? A |:confirm| query of some sort | |
| 6175 ! Shell or external command is executing | |
| 12254 | 6176 t Terminal-Job mode: keys go to the job |
| 1621 | 6177 This is useful in the 'statusline' option or when used |
| 6178 with |remote_expr()| In most other places it always returns | |
| 6179 "c" or "n". | |
| 6180 Also see |visualmode()|. | |
| 7 | 6181 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6182 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6183 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 6184 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6185 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6186 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
|
6187 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6188 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
|
6189 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6190 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
|
6191 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6192 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6193 :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
|
6194 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6195 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6196 < |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6197 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
6198 |
| 7 | 6199 nextnonblank({lnum}) *nextnonblank()* |
| 6200 Return the line number of the first line at or below {lnum} | |
| 6201 that is not blank. Example: > | |
| 6202 if getline(nextnonblank(1)) =~ "Java" | |
| 6203 < When {lnum} is invalid or there is no non-blank line at or | |
| 6204 below it, zero is returned. | |
| 6205 See also |prevnonblank()|. | |
| 6206 | |
| 12785 | 6207 nr2char({expr} [, {utf8}]) *nr2char()* |
| 7 | 6208 Return a string with a single character, which has the number |
| 6209 value {expr}. Examples: > | |
| 6210 nr2char(64) returns "@" | |
| 6211 nr2char(32) returns " " | |
| 4051 | 6212 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 6213 Example for "utf-8": > | |
| 7 | 6214 nr2char(300) returns I with bow character |
| 4051 | 6215 < With {utf8} set to 1, always return utf-8 characters. |
| 6216 Note that a NUL character in the file is specified with | |
| 7 | 6217 nr2char(10), because NULs are represented with newline |
| 6218 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 6219 string, thus results in an empty string. |
| 7 | 6220 |
| 3214 | 6221 or({expr}, {expr}) *or()* |
| 6222 Bitwise OR on the two arguments. The arguments are converted | |
| 6223 to a number. A List, Dict or Float argument causes an error. | |
| 6224 Example: > | |
| 6225 :let bits = or(bits, 0x80) | |
| 6226 | |
| 6227 | |
| 819 | 6228 pathshorten({expr}) *pathshorten()* |
| 6229 Shorten directory names in the path {expr} and return the | |
| 6230 result. The tail, the file name, is kept as-is. The other | |
| 6231 components in the path are reduced to single letters. Leading | |
| 6232 '~' and '.' characters are kept. Example: > | |
| 6233 :echo pathshorten('~/.vim/autoload/myfile.vim') | |
| 6234 < ~/.v/a/myfile.vim ~ | |
| 6235 It doesn't matter if the path exists or not. | |
| 6236 | |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6237 perleval({expr}) *perleval()* |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6238 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
|
6239 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
|
6240 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
|
6241 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
|
6242 reference to it. |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6243 Example: > |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6244 :echo perleval('[1 .. 4]') |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6245 < [1, 2, 3, 4] |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
6246 {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
|
6247 |
| 1621 | 6248 pow({x}, {y}) *pow()* |
| 6249 Return the power of {x} to the exponent {y} as a |Float|. | |
| 6250 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 6251 Examples: > | |
| 6252 :echo pow(3, 3) | |
| 6253 < 27.0 > | |
| 6254 :echo pow(2, 16) | |
| 6255 < 65536.0 > | |
| 6256 :echo pow(32, 0.20) | |
| 6257 < 2.0 | |
| 6258 {only available when compiled with the |+float| feature} | |
| 12785 | 6259 |
| 667 | 6260 prevnonblank({lnum}) *prevnonblank()* |
| 6261 Return the line number of the first line at or above {lnum} | |
| 6262 that is not blank. Example: > | |
| 6263 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 6264 < When {lnum} is invalid or there is no non-blank line at or | |
| 6265 above it, zero is returned. | |
| 6266 Also see |nextnonblank()|. | |
| 6267 | |
| 6268 | |
| 449 | 6269 printf({fmt}, {expr1} ...) *printf()* |
| 6270 Return a String with {fmt}, where "%" items are replaced by | |
| 6271 the formatted form of their respective arguments. Example: > | |
| 452 | 6272 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 6273 < May result in: |
| 452 | 6274 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 6275 |
| 6276 Often used items are: | |
| 856 | 6277 %s string |
| 3914 | 6278 %6S string right-aligned in 6 display cells |
| 653 | 6279 %6s string right-aligned in 6 bytes |
| 1621 | 6280 %.9s string truncated to 9 bytes |
| 6281 %c single byte | |
| 6282 %d decimal number | |
| 6283 %5d decimal number padded with spaces to 5 characters | |
| 6284 %x hex number | |
| 6285 %04x hex number padded with zeros to at least 4 characters | |
| 6286 %X hex number using upper case letters | |
| 6287 %o octal number | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6288 %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
|
6289 %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
|
6290 %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
|
6291 %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
|
6292 %E floating point number as 1.23E3, INF, -INF or NAN |
| 1621 | 6293 %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
|
6294 %G floating point number, as %F or %E depending on value |
| 1621 | 6295 %% the % character itself |
| 449 | 6296 |
| 6297 Conversion specifications start with '%' and end with the | |
| 6298 conversion type. All other characters are copied unchanged to | |
| 6299 the result. | |
| 6300 | |
| 6301 The "%" starts a conversion specification. The following | |
| 452 | 6302 arguments appear in sequence: |
| 6303 | |
| 6304 % [flags] [field-width] [.precision] type | |
| 6305 | |
| 856 | 6306 flags |
| 452 | 6307 Zero or more of the following flags: |
| 6308 | |
| 449 | 6309 # The value should be converted to an "alternate |
| 6310 form". For c, d, and s conversions, this option | |
| 6311 has no effect. For o conversions, the precision | |
| 6312 of the number is increased to force the first | |
| 6313 character of the output string to a zero (except | |
| 6314 if a zero value is printed with an explicit | |
| 6315 precision of zero). | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6316 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
|
6317 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
|
6318 prepended to it. |
| 449 | 6319 For x and X conversions, a non-zero result has |
| 6320 the string "0x" (or "0X" for X conversions) | |
| 6321 prepended to it. | |
| 452 | 6322 |
| 449 | 6323 0 (zero) Zero padding. For all conversions the converted |
| 6324 value is padded on the left with zeros rather | |
| 6325 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
|
6326 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
|
6327 flag is ignored. |
| 452 | 6328 |
| 449 | 6329 - A negative field width flag; the converted value |
| 6330 is to be left adjusted on the field boundary. | |
| 6331 The converted value is padded on the right with | |
| 6332 blanks, rather than on the left with blanks or | |
| 6333 zeros. A - overrides a 0 if both are given. | |
| 452 | 6334 |
| 449 | 6335 ' ' (space) A blank should be left before a positive |
| 6336 number produced by a signed conversion (d). | |
| 452 | 6337 |
| 449 | 6338 + 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
|
6339 produced by a signed conversion. A + overrides |
| 449 | 6340 a space if both are used. |
| 452 | 6341 |
| 6342 field-width | |
| 6343 An optional decimal digit string specifying a minimum | |
| 653 | 6344 field width. If the converted value has fewer bytes |
| 6345 than the field width, it will be padded with spaces on | |
| 6346 the left (or right, if the left-adjustment flag has | |
| 6347 been given) to fill out the field width. | |
| 452 | 6348 |
| 6349 .precision | |
| 6350 An optional precision, in the form of a period '.' | |
| 6351 followed by an optional digit string. If the digit | |
| 6352 string is omitted, the precision is taken as zero. | |
| 6353 This gives the minimum number of digits to appear for | |
| 6354 d, o, x, and X conversions, or the maximum number of | |
| 653 | 6355 bytes to be printed from a string for s conversions. |
| 1621 | 6356 For floating point it is the number of digits after |
| 6357 the decimal point. | |
| 452 | 6358 |
| 6359 type | |
| 6360 A character that specifies the type of conversion to | |
| 6361 be applied, see below. | |
| 6362 | |
| 449 | 6363 A field width or precision, or both, may be indicated by an |
| 6364 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
|
6365 Number argument supplies the field width or precision. A |
| 449 | 6366 negative field width is treated as a left adjustment flag |
| 6367 followed by a positive field width; a negative precision is | |
| 6368 treated as though it were missing. Example: > | |
| 452 | 6369 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 6370 < This limits the length of the text used from "line" to |
| 452 | 6371 "width" bytes. |
| 449 | 6372 |
| 856 | 6373 The conversion specifiers and their meanings are: |
| 452 | 6374 |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6375 *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
|
6376 *printf-x* *printf-X* |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
6377 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
|
6378 (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
|
6379 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
|
6380 "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
|
6381 "ABCDEF" are used for X conversions. |
| 452 | 6382 The precision, if any, gives the minimum number of |
| 6383 digits that must appear; if the converted value | |
| 6384 requires fewer digits, it is padded on the left with | |
| 6385 zeros. | |
| 6386 In no case does a non-existent or small field width | |
| 6387 cause truncation of a numeric field; if the result of | |
| 6388 a conversion is wider than the field width, the field | |
| 6389 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
|
6390 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
|
6391 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
|
6392 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
|
6393 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
|
6394 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
|
6395 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6396 i alias for d |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6397 D alias for ld |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6398 U alias for lu |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6399 O alias for lo |
| 452 | 6400 |
| 1621 | 6401 *printf-c* |
| 452 | 6402 c The Number argument is converted to a byte, and the |
| 6403 resulting character is written. | |
| 6404 | |
| 1621 | 6405 *printf-s* |
| 452 | 6406 s The text of the String argument is used. If a |
| 6407 precision is specified, no more bytes than the number | |
| 6408 specified are used. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6409 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
|
6410 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
|
6411 as ":echo". |
| 6583 | 6412 *printf-S* |
| 3914 | 6413 S The text of the String argument is used. If a |
| 6414 precision is specified, no more display cells than the | |
| 6415 number specified are used. Without the |+multi_byte| | |
| 6416 feature works just like 's'. | |
| 452 | 6417 |
| 1621 | 6418 *printf-f* *E807* |
| 12785 | 6419 f F The Float argument is converted into a string of the |
| 1621 | 6420 form 123.456. The precision specifies the number of |
| 6421 digits after the decimal point. When the precision is | |
| 6422 zero the decimal point is omitted. When the precision | |
| 6423 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
|
6424 (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
|
6425 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
|
6426 "0.0 / 0.0" results in "nan" with %f (NAN with %F). |
| 1621 | 6427 Example: > |
| 6428 echo printf("%.2f", 12.115) | |
| 6429 < 12.12 | |
| 6430 Note that roundoff depends on the system libraries. | |
| 6431 Use |round()| when in doubt. | |
| 6432 | |
| 6433 *printf-e* *printf-E* | |
| 6434 e E The Float argument is converted into a string of the | |
| 6435 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 6436 precision specifies the number of digits after the | |
| 6437 decimal point, like with 'f'. | |
| 6438 | |
| 6439 *printf-g* *printf-G* | |
| 6440 g G The Float argument is converted like with 'f' if the | |
| 6441 value is between 0.001 (inclusive) and 10000000.0 | |
| 6442 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 6443 for 'G'. When no precision is specified superfluous | |
| 6444 zeroes and '+' signs are removed, except for the zero | |
| 6445 immediately after the decimal point. Thus 10000000.0 | |
| 6446 results in 1.0e7. | |
| 6447 | |
| 6448 *printf-%* | |
| 449 | 6449 % A '%' is written. No argument is converted. The |
| 6450 complete conversion specification is "%%". | |
| 452 | 6451 |
| 1668 | 6452 When a Number argument is expected a String argument is also |
| 6453 accepted and automatically converted. | |
| 6454 When a Float or String argument is expected a Number argument | |
| 6455 is also accepted and automatically converted. | |
| 6456 Any other argument type results in an error message. | |
| 449 | 6457 |
| 459 | 6458 *E766* *E767* |
| 449 | 6459 The number of {exprN} arguments must exactly match the number |
| 6460 of "%" items. If there are not sufficient or too many | |
| 452 | 6461 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 6462 |
| 6463 | |
| 667 | 6464 pumvisible() *pumvisible()* |
| 6465 Returns non-zero when the popup menu is visible, zero | |
| 6466 otherwise. See |ins-completion-menu|. | |
| 712 | 6467 This can be used to avoid some things that would remove the |
| 6468 popup menu. | |
| 7 | 6469 |
| 3682 | 6470 py3eval({expr}) *py3eval()* |
| 6471 Evaluate Python expression {expr} and return its result | |
| 6472 converted to Vim data structures. | |
| 12785 | 6473 Numbers and strings are returned as they are (strings are |
| 6474 copied though, Unicode strings are additionally converted to | |
| 3682 | 6475 'encoding'). |
| 6476 Lists are represented as Vim |List| type. | |
| 12785 | 6477 Dictionaries are represented as Vim |Dictionary| type with |
| 3682 | 6478 keys converted to strings. |
| 6479 {only available when compiled with the |+python3| feature} | |
| 6480 | |
| 6481 *E858* *E859* | |
| 6482 pyeval({expr}) *pyeval()* | |
| 6483 Evaluate Python expression {expr} and return its result | |
| 6484 converted to Vim data structures. | |
| 12785 | 6485 Numbers and strings are returned as they are (strings are |
| 3682 | 6486 copied though). |
| 6487 Lists are represented as Vim |List| type. | |
| 12785 | 6488 Dictionaries are represented as Vim |Dictionary| type, |
| 3830 | 6489 non-string keys result in error. |
| 3682 | 6490 {only available when compiled with the |+python| feature} |
| 6491 | |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6492 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
|
6493 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
|
6494 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
|
6495 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
|
6496 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
|
6497 {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
|
6498 |+python3| feature} |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
6499 |
| 114 | 6500 *E726* *E727* |
| 99 | 6501 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 6502 Returns a |List| with Numbers: |
| 99 | 6503 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 6504 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 6505 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 6506 {max}] (increasing {expr} with {stride} each time, not | |
| 6507 producing a value past {max}). | |
| 336 | 6508 When the maximum is one before the start the result is an |
| 6509 empty list. When the maximum is more than one before the | |
| 6510 start this is an error. | |
| 99 | 6511 Examples: > |
| 856 | 6512 range(4) " [0, 1, 2, 3] |
| 99 | 6513 range(2, 4) " [2, 3, 4] |
| 6514 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 6515 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 6516 range(0) " [] |
| 6517 range(2, 0) " error! | |
| 99 | 6518 < |
| 158 | 6519 *readfile()* |
| 168 | 6520 readfile({fname} [, {binary} [, {max}]]) |
| 685 | 6521 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
|
6522 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
|
6523 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
|
6524 (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
|
6525 All NUL characters are replaced with a NL character. |
| 6918 | 6526 When {binary} contains "b" binary mode is used: |
| 158 | 6527 - When the last line ends in a NL an extra empty list item is |
| 6528 added. | |
| 6529 - No CR characters are removed. | |
| 6530 Otherwise: | |
| 6531 - CR characters that appear before a NL are removed. | |
| 6532 - 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
|
6533 - 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
|
6534 removed from the text. |
| 168 | 6535 When {max} is given this specifies the maximum number of lines |
| 6536 to be read. Useful if you only want to check the first ten | |
| 6537 lines of a file: > | |
| 6538 :for line in readfile(fname, '', 10) | |
| 6539 : if line =~ 'Date' | echo line | endif | |
| 6540 :endfor | |
| 233 | 6541 < When {max} is negative -{max} lines from the end of the file |
| 6542 are returned, or as many as there are. | |
| 6543 When {max} is zero the result is an empty list. | |
| 168 | 6544 Note that without {max} the whole file is read into memory. |
| 6545 Also note that there is no recognition of encoding. Read a | |
| 6546 file into a buffer if you need to. | |
| 158 | 6547 When the file can't be opened an error message is given and |
| 6548 the result is an empty list. | |
| 6549 Also see |writefile()|. | |
| 6550 | |
| 794 | 6551 reltime([{start} [, {end}]]) *reltime()* |
| 6552 Return an item that represents a time value. The format of | |
| 6553 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
|
6554 |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
|
6555 to convert to a Float. |
| 794 | 6556 Without an argument it returns the current time. |
| 6557 With one argument is returns the time passed since the time | |
| 6558 specified in the argument. | |
| 843 | 6559 With two arguments it returns the time passed between {start} |
| 794 | 6560 and {end}. |
| 6561 The {start} and {end} arguments must be values returned by | |
| 6562 reltime(). | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
6563 {only available when compiled with the |+reltime| feature} |
| 794 | 6564 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6565 reltimefloat({time}) *reltimefloat()* |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6566 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
|
6567 Example: > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6568 let start = reltime() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6569 call MyFunction() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6570 let seconds = reltimefloat(reltime(start)) |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6571 < 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
|
6572 Also see |profiling|. |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
6573 {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
|
6574 |
| 794 | 6575 reltimestr({time}) *reltimestr()* |
| 6576 Return a String that represents the time value of {time}. | |
| 6577 This is the number of seconds, a dot and the number of | |
| 6578 microseconds. Example: > | |
| 6579 let start = reltime() | |
| 6580 call MyFunction() | |
| 6581 echo reltimestr(reltime(start)) | |
| 6582 < Note that overhead for the commands will be added to the time. | |
| 6583 The accuracy depends on the system. | |
| 1156 | 6584 Leading spaces are used to make the string align nicely. You |
| 6585 can use split() to remove it. > | |
| 6586 echo split(reltimestr(reltime(start)))[0] | |
| 6587 < 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
|
6588 {only available when compiled with the |+reltime| feature} |
| 794 | 6589 |
| 7 | 6590 *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
|
6591 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
|
6592 Send the {string} to {server}. The string is sent as an |
| 7 | 6593 expression and the result is returned after evaluation. |
| 714 | 6594 The result must be a String or a |List|. A |List| is turned |
| 6595 into a String by joining the items with a line break in | |
| 6596 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
|
6597 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
|
6598 of a variable and a {serverid} for later use with |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
6599 |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
|
6600 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
|
6601 seconds. Otherwise a timeout of 600 seconds is used. |
| 7 | 6602 See also |clientserver| |RemoteReply|. |
| 6603 This function is not available in the |sandbox|. | |
| 6604 {only available when compiled with the |+clientserver| feature} | |
| 6605 Note: Any errors will cause a local error message to be issued | |
| 6606 and the result will be the empty string. | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6607 |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6608 Variables will be evaluated in the global namespace, |
| 12785 | 6609 independent of a function currently being active. Except |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6610 when in debug mode, then local function variables and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6611 arguments can be evaluated. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
6612 |
| 7 | 6613 Examples: > |
| 6614 :echo remote_expr("gvim", "2+2") | |
| 6615 :echo remote_expr("gvim1", "b:current_syntax") | |
| 6616 < | |
| 6617 | |
| 6618 remote_foreground({server}) *remote_foreground()* | |
| 6619 Move the Vim server with the name {server} to the foreground. | |
| 6620 This works like: > | |
| 6621 remote_expr({server}, "foreground()") | |
| 6622 < Except that on Win32 systems the client does the work, to work | |
| 6623 around the problem that the OS doesn't always allow the server | |
| 6624 to bring itself to the foreground. | |
| 574 | 6625 Note: This does not restore the window if it was minimized, |
| 6626 like foreground() does. | |
| 7 | 6627 This function is not available in the |sandbox|. |
| 6628 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 6629 Win32 console version} | |
| 6630 | |
| 6631 | |
| 6632 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 6633 Returns a positive number if there are available strings | |
| 6634 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
|
6635 {retvar} if specified. {retvar} must be a string with the |
| 7 | 6636 name of a variable. |
| 6637 Returns zero if none are available. | |
| 6638 Returns -1 if something is wrong. | |
| 6639 See also |clientserver|. | |
| 6640 This function is not available in the |sandbox|. | |
| 6641 {only available when compiled with the |+clientserver| feature} | |
| 6642 Examples: > | |
| 6643 :let repl = "" | |
| 6644 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 6645 | |
|
11211
71311d899b42
patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents:
11181
diff
changeset
|
6646 remote_read({serverid}, [{timeout}]) *remote_read()* |
| 7 | 6647 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
|
6648 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
|
6649 reply is available. |
| 7 | 6650 See also |clientserver|. |
| 6651 This function is not available in the |sandbox|. | |
| 6652 {only available when compiled with the |+clientserver| feature} | |
| 6653 Example: > | |
| 6654 :echo remote_read(id) | |
| 6655 < | |
| 6656 *remote_send()* *E241* | |
| 6657 remote_send({server}, {string} [, {idvar}]) | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6658 Send the {string} to {server}. The string is sent as input |
| 22 | 6659 keys and the function returns immediately. At the Vim server |
| 6660 the keys are not mapped |:map|. | |
| 667 | 6661 If {idvar} is present, it is taken as the name of a variable |
| 6662 and a {serverid} for later use with remote_read() is stored | |
| 6663 there. | |
| 7 | 6664 See also |clientserver| |RemoteReply|. |
| 6665 This function is not available in the |sandbox|. | |
| 6666 {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
|
6667 |
| 7 | 6668 Note: Any errors will be reported in the server and may mess |
| 6669 up the display. | |
| 6670 Examples: > | |
| 6671 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 6672 \ remote_read(serverid) | |
| 6673 | |
| 6674 :autocmd NONE RemoteReply * | |
| 6675 \ echo remote_read(expand("<amatch>")) | |
| 6676 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 6677 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 6678 < |
|
11177
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
6679 *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
|
6680 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
|
6681 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
|
6682 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
|
6683 {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
|
6684 |
| 79 | 6685 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 6686 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
|
6687 return the item. |
| 79 | 6688 With {end}: Remove items from {idx} to {end} (inclusive) and |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6689 return a List with these items. When {idx} points to the same |
| 79 | 6690 item as {end} a list with one item is returned. When {end} |
| 6691 points to an item before {idx} this is an error. | |
| 6692 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 6693 Example: > |
| 6694 :echo "last item: " . remove(mylist, -1) | |
| 79 | 6695 :call remove(mylist, 0, 9) |
| 99 | 6696 remove({dict}, {key}) |
| 6697 Remove the entry from {dict} with key {key}. Example: > | |
| 6698 :echo "removed " . remove(dict, "one") | |
| 6699 < If there is no {key} in {dict} this is an error. | |
| 6700 | |
| 6701 Use |delete()| to remove a file. | |
| 55 | 6702 |
| 7 | 6703 rename({from}, {to}) *rename()* |
| 6704 Rename the file by the name {from} to the name {to}. This | |
| 6705 should also work to move files across file systems. The | |
| 6706 result is a Number, which is 0 if the file was renamed | |
| 6707 successfully, and non-zero when the renaming failed. | |
| 1851 | 6708 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 6709 This function is not available in the |sandbox|. |
| 6710 | |
| 18 | 6711 repeat({expr}, {count}) *repeat()* |
| 6712 Repeat {expr} {count} times and return the concatenated | |
| 6713 result. Example: > | |
| 843 | 6714 :let separator = repeat('-', 80) |
| 18 | 6715 < When {count} is zero or negative the result is empty. |
| 685 | 6716 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
|
6717 {count} times. Example: > |
| 79 | 6718 :let longlist = repeat(['a', 'b'], 3) |
| 6719 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 6720 |
| 82 | 6721 |
| 7 | 6722 resolve({filename}) *resolve()* *E655* |
| 6723 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 6724 returns the path the shortcut points to in a simplified form. | |
| 6725 On Unix, repeat resolving symbolic links in all path | |
| 6726 components of {filename} and return the simplified result. | |
| 6727 To cope with link cycles, resolving of symbolic links is | |
| 6728 stopped after 100 iterations. | |
| 6729 On other systems, return the simplified {filename}. | |
| 6730 The simplification step is done as by |simplify()|. | |
| 6731 resolve() keeps a leading path component specifying the | |
| 6732 current directory (provided the result is still a relative | |
| 6733 path name) and also keeps a trailing path separator. | |
| 6734 | |
| 82 | 6735 *reverse()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
6736 reverse({list}) Reverse the order of items in {list} in-place. Returns |
| 82 | 6737 {list}. |
| 6738 If you want a list to remain unmodified make a copy first: > | |
| 6739 :let revlist = reverse(copy(mylist)) | |
| 6740 | |
| 1621 | 6741 round({expr}) *round()* |
| 1668 | 6742 Round off {expr} to the nearest integral value and return it |
| 1621 | 6743 as a |Float|. If {expr} lies halfway between two integral |
| 6744 values, then use the larger one (away from zero). | |
| 6745 {expr} must evaluate to a |Float| or a |Number|. | |
| 6746 Examples: > | |
| 6747 echo round(0.456) | |
| 6748 < 0.0 > | |
| 6749 echo round(4.5) | |
| 6750 < 5.0 > | |
| 6751 echo round(-4.5) | |
| 6752 < -5.0 | |
| 6753 {only available when compiled with the |+float| feature} | |
| 3996 | 6754 |
| 12785 | 6755 screenattr({row}, {col}) *screenattr()* |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
6756 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
|
6757 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
|
6758 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6759 |
| 12785 | 6760 screenchar({row}, {col}) *screenchar()* |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6761 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
|
6762 [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
|
6763 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
|
6764 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
|
6765 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6766 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6767 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
6768 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
|
6769 |
| 3996 | 6770 screencol() *screencol()* |
| 6771 The result is a Number, which is the current screen column of | |
| 6772 the cursor. The leftmost column has number 1. | |
| 6773 This function is mainly used for testing. | |
| 6774 | |
| 6775 Note: Always returns the current screen column, thus if used | |
| 6776 in a command (e.g. ":echo screencol()") it will return the | |
| 6777 column inside the command line, which is 1 when the command is | |
| 6778 executed. To get the cursor position in the file use one of | |
| 6779 the following mappings: > | |
| 6780 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 6781 nnoremap <silent> GG :echom screencol()<CR> | |
| 6782 < | |
| 6783 screenrow() *screenrow()* | |
| 6784 The result is a Number, which is the current screen row of the | |
| 6785 cursor. The top line has number one. | |
| 6786 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
|
6787 Alternatively you can use |winline()|. |
| 3996 | 6788 |
| 6789 Note: Same restrictions as with |screencol()|. | |
| 6790 | |
| 1496 | 6791 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()* |
| 7 | 6792 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 6793 cursor position (you can use |cursor()| to set it). |
| 707 | 6794 |
| 3967 | 6795 When a match has been found its line number is returned. |
| 3312 | 6796 If there is no match a 0 is returned and the cursor doesn't |
| 6797 move. No error message is given. | |
| 6798 | |
| 7 | 6799 {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
|
6800 'b' search Backward instead of forward |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
6801 'c' accept a match at the Cursor position |
| 712 | 6802 'e' move to the End of the match |
| 20 | 6803 '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
|
6804 '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
|
6805 '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
|
6806 '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
|
6807 '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
|
6808 'z' start searching at the cursor column instead of zero |
| 7 | 6809 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
| 6810 | |
| 444 | 6811 If the 's' flag is supplied, the ' mark is set, only if the |
| 6812 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 6813 flag. | |
| 6814 | |
| 1156 | 6815 'ignorecase', 'smartcase' and 'magic' are used. |
| 12785 | 6816 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
6817 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
|
6818 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
|
6819 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
|
6820 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
|
6821 one column further. |
| 1156 | 6822 |
| 692 | 6823 When the {stopline} argument is given then the search stops |
| 6824 after searching this line. This is useful to restrict the | |
| 6825 search to a range of lines. Examples: > | |
| 6826 let match = search('(', 'b', line("w0")) | |
| 6827 let end = search('END', '', line("w$")) | |
| 6828 < When {stopline} is used and it is not zero this also implies | |
| 6829 that the search does not wrap around the end of the file. | |
| 1496 | 6830 A zero value is equal to not giving the argument. |
| 6831 | |
| 6832 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
|
6833 more than this many milliseconds have passed. Thus when |
| 1496 | 6834 {timeout} is 500 the search stops after half a second. |
| 6835 The value must not be negative. A zero value is like not | |
| 6836 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
|
6837 {only available when compiled with the |+reltime| feature} |
| 692 | 6838 |
| 714 | 6839 *search()-sub-match* |
| 6840 With the 'p' flag the returned value is one more than the | |
| 6841 first sub-match in \(\). One if none of them matched but the | |
| 6842 whole pattern did match. | |
| 712 | 6843 To get the column number too use |searchpos()|. |
| 6844 | |
| 20 | 6845 The cursor will be positioned at the match, unless the 'n' |
| 707 | 6846 flag is used. |
| 7 | 6847 |
| 6848 Example (goes over all files in the argument list): > | |
| 6849 :let n = 1 | |
| 6850 :while n <= argc() " loop over all files in arglist | |
| 6851 : exe "argument " . n | |
| 6852 : " start at the last char in the file and wrap for the | |
| 6853 : " first search to find match at start of file | |
| 6854 : normal G$ | |
| 6855 : let flags = "w" | |
| 6856 : while search("foo", flags) > 0 | |
| 1621 | 6857 : s/foo/bar/g |
| 7 | 6858 : let flags = "W" |
| 6859 : endwhile | |
| 6860 : update " write the file if modified | |
| 6861 : let n = n + 1 | |
| 6862 :endwhile | |
| 6863 < | |
| 712 | 6864 Example for using some flags: > |
| 6865 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 6866 < This will search for the keywords "if", "else", and "endif" | |
| 6867 under or after the cursor. Because of the 'p' flag, it | |
| 6868 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 6869 if the search fails. With the cursor on the first word of the | |
| 6870 line: | |
| 6871 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 6872 the function returns 1. Without the 'c' flag, the function | |
| 6873 finds the "endif" and returns 3. The same thing happens | |
| 6874 without the 'e' flag if the cursor is on the "f" of "if". | |
| 6875 The 'n' flag tells the function not to move the cursor. | |
| 6876 | |
| 504 | 6877 |
| 523 | 6878 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 6879 Search for the declaration of {name}. | |
| 856 | 6880 |
| 523 | 6881 With a non-zero {global} argument it works like |gD|, find |
| 6882 first match in the file. Otherwise it works like |gd|, find | |
| 6883 first match in the function. | |
| 6884 | |
| 6885 With a non-zero {thisblock} argument matches in a {} block | |
| 6886 that ends before the cursor position are ignored. Avoids | |
| 6887 finding variable declarations only valid in another scope. | |
| 6888 | |
| 504 | 6889 Moves the cursor to the found match. |
| 6890 Returns zero for success, non-zero for failure. | |
| 6891 Example: > | |
| 6892 if searchdecl('myvar') == 0 | |
| 6893 echo getline('.') | |
| 6894 endif | |
| 6895 < | |
| 7 | 6896 *searchpair()* |
| 1496 | 6897 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 6898 [, {stopline} [, {timeout}]]]]) | |
| 7 | 6899 Search for the match of a nested start-end pair. This can be |
| 6900 used to find the "endif" that matches an "if", while other | |
| 6901 if/endif pairs in between are ignored. | |
| 677 | 6902 The search starts at the cursor. The default is to search |
| 6903 forward, include 'b' in {flags} to search backward. | |
| 6904 If a match is found, the cursor is positioned at it and the | |
| 6905 line number is returned. If no match is found 0 or -1 is | |
| 6906 returned and the cursor doesn't move. No error message is | |
| 6907 given. | |
| 7 | 6908 |
| 6909 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 6910 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 6911 {middle} is not empty, it is found when searching from either | |
| 6912 direction, but only when not in a nested start-end pair. A | |
| 6913 typical use is: > | |
| 6914 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 6915 < By leaving {middle} empty the "else" is skipped. | |
| 6916 | |
| 712 | 6917 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 6918 |search()|. Additionally: | |
| 7 | 6919 'r' Repeat until no more matches found; will find the |
| 1621 | 6920 outer pair. Implies the 'W' flag. |
| 6921 'm' Return number of matches instead of line number with | |
| 712 | 6922 the match; will be > 1 when 'r' is used. |
| 1621 | 6923 Note: it's nearly always a good idea to use the 'W' flag, to |
| 6924 avoid wrapping around the end of the file. | |
| 7 | 6925 |
| 6926 When a match for {start}, {middle} or {end} is found, the | |
| 6927 {skip} expression is evaluated with the cursor positioned on | |
| 6928 the start of the match. It should return non-zero if this | |
| 6929 match is to be skipped. E.g., because it is inside a comment | |
| 6930 or a string. | |
| 6931 When {skip} is omitted or empty, every match is accepted. | |
| 6932 When evaluating {skip} causes an error the search is aborted | |
| 6933 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
|
6934 {skip} can be a string, a lambda, a funcref or a partial. |
| 7 | 6935 |
| 1496 | 6936 For {stopline} and {timeout} see |search()|. |
| 692 | 6937 |
| 7 | 6938 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 6939 patterns are used like it's on. | |
| 6940 | |
| 6941 The search starts exactly at the cursor. A match with | |
| 6942 {start}, {middle} or {end} at the next character, in the | |
| 6943 direction of searching, is the first one found. Example: > | |
| 6944 if 1 | |
| 6945 if 2 | |
| 6946 endif 2 | |
| 6947 endif 1 | |
| 6948 < When starting at the "if 2", with the cursor on the "i", and | |
| 6949 searching forwards, the "endif 2" is found. When starting on | |
| 6950 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
|
6951 found. That's because the "if 2" will be found first, and |
| 7 | 6952 then this is considered to be a nested if/endif from "if 2" to |
| 6953 "endif 2". | |
| 6954 When searching backwards and {end} is more than one character, | |
| 6955 it may be useful to put "\zs" at the end of the pattern, so | |
| 6956 that when the cursor is inside a match with the end it finds | |
| 6957 the matching start. | |
| 6958 | |
| 6959 Example, to find the "endif" command in a Vim script: > | |
| 6960 | |
| 6961 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 6962 \ 'getline(".") =~ "^\\s*\""') | |
| 6963 | |
| 6964 < The cursor must be at or after the "if" for which a match is | |
| 6965 to be found. Note that single-quote strings are used to avoid | |
| 6966 having to double the backslashes. The skip expression only | |
| 6967 catches comments at the start of a line, not after a command. | |
| 6968 Also, a word "en" or "if" halfway a line is considered a | |
| 6969 match. | |
| 6970 Another example, to search for the matching "{" of a "}": > | |
| 6971 | |
| 6972 :echo searchpair('{', '', '}', 'bW') | |
| 6973 | |
| 6974 < This works when the cursor is at or before the "}" for which a | |
| 6975 match is to be found. To reject matches that syntax | |
| 6976 highlighting recognized as strings: > | |
| 6977 | |
| 6978 :echo searchpair('{', '', '}', 'bW', | |
| 6979 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 6980 < | |
| 667 | 6981 *searchpairpos()* |
| 1496 | 6982 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 6983 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6984 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 6985 column position of the match. The first element of the |List| |
| 6986 is the line number and the second element is the byte index of | |
| 667 | 6987 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
|
6988 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
6989 |
| 667 | 6990 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 6991 < | |
| 6992 See |match-parens| for a bigger and more useful example. | |
| 6993 | |
| 1496 | 6994 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()* |
| 692 | 6995 Same as |search()|, but returns a |List| with the line and |
| 685 | 6996 column position of the match. The first element of the |List| |
| 6997 is the line number and the second element is the byte index of | |
| 6998 the column position of the match. If no match is found, | |
| 6999 returns [0, 0]. | |
| 714 | 7000 Example: > |
| 7001 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 7002 | |
| 7003 < When the 'p' flag is given then there is an extra item with | |
| 7004 the sub-pattern match number |search()-sub-match|. Example: > | |
| 7005 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 7006 < In this example "submatch" is 2 when a lowercase letter is | |
| 7007 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 7008 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7009 server2client({clientid}, {string}) *server2client()* |
| 7 | 7010 Send a reply string to {clientid}. The most recent {clientid} |
| 7011 that sent a string can be retrieved with expand("<client>"). | |
| 7012 {only available when compiled with the |+clientserver| feature} | |
| 7013 Note: | |
| 7014 This id has to be stored before the next command can be | |
| 236 | 7015 received. I.e. before returning from the received command and |
| 7 | 7016 before calling any commands that waits for input. |
| 7017 See also |clientserver|. | |
| 7018 Example: > | |
| 7019 :echo server2client(expand("<client>"), "HELLO") | |
| 7020 < | |
| 7021 serverlist() *serverlist()* | |
| 7022 Return a list of available server names, one per line. | |
| 7023 When there are no servers or the information is not available | |
| 7024 an empty string is returned. See also |clientserver|. | |
| 7025 {only available when compiled with the |+clientserver| feature} | |
| 7026 Example: > | |
| 7027 :echo serverlist() | |
| 7028 < | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7029 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
|
7030 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
|
7031 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
|
7032 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7033 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
|
7034 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7035 {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
|
7036 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
|
7037 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
|
7038 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7039 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
|
7040 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
|
7041 |
| 7 | 7042 setbufvar({expr}, {varname}, {val}) *setbufvar()* |
| 7043 Set option or local variable {varname} in buffer {expr} to | |
| 7044 {val}. | |
| 7045 This also works for a global or local window option, but it | |
| 7046 doesn't work for a global or local window variable. | |
| 7047 For a local window option the global value is unchanged. | |
| 7048 For the use of {expr}, see |bufname()| above. | |
| 7049 Note that the variable name without "b:" must be used. | |
| 7050 Examples: > | |
| 7051 :call setbufvar(1, "&mod", 1) | |
| 7052 :call setbufvar("todo", "myvar", "foobar") | |
| 7053 < This function is not available in the |sandbox|. | |
| 7054 | |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
7055 setcharsearch({dict}) *setcharsearch()* |
| 6991 | 7056 Set the current character search information to {dict}, |
| 7057 which contains one or more of the following entries: | |
| 7058 | |
| 7059 char character which will be used for a subsequent | |
| 7060 |,| or |;| command; an empty string clears the | |
| 7061 character search | |
| 7062 forward direction of character search; 1 for forward, | |
| 7063 0 for backward | |
| 7064 until type of character search; 1 for a |t| or |T| | |
| 7065 character search, 0 for an |f| or |F| | |
| 7066 character search | |
| 7067 | |
| 7068 This can be useful to save/restore a user's character search | |
| 7069 from a script: > | |
| 7070 :let prevsearch = getcharsearch() | |
| 7071 :" Perform a command which clobbers user's search | |
| 7072 :call setcharsearch(prevsearch) | |
| 7073 < Also see |getcharsearch()|. | |
| 7074 | |
| 7 | 7075 setcmdpos({pos}) *setcmdpos()* |
| 7076 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
|
7077 {pos}. The first position is 1. |
| 7 | 7078 Use |getcmdpos()| to obtain the current position. |
| 7079 Only works while editing the command line, thus you must use | |
| 99 | 7080 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 7081 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 7082 set after the command line is set to the expression. For | |
| 7083 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 7084 before inserting the resulting text. | |
| 7 | 7085 When the number is too big the cursor is put at the end of the |
| 7086 line. A number smaller than one has undefined results. | |
| 7087 Returns 0 when successful, 1 when not editing the command | |
| 7088 line. | |
| 7089 | |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7090 setfperm({fname}, {mode}) *setfperm()* *chmod* |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7091 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
|
7092 {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
|
7093 "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
|
7094 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
|
7095 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
|
7096 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
|
7097 characters are not supported. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7098 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7099 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
|
7100 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
|
7101 would do the same thing. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7102 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7103 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
|
7104 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7105 To read permissions see |getfperm()|. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7106 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
7107 |
| 1621 | 7108 setline({lnum}, {text}) *setline()* |
| 3312 | 7109 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
|
7110 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
|
7111 |setbufline()|. |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7112 |
| 236 | 7113 {lnum} is used like with |getline()|. |
| 1621 | 7114 When {lnum} is just below the last line the {text} will be |
| 282 | 7115 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
|
7116 |
| 236 | 7117 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
|
7118 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
|
7119 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
7120 Example: > |
| 7 | 7121 :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
|
7122 |
| 1621 | 7123 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 7124 will be set to the items in the list. Example: > |
| 7125 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 7126 < This is equivalent to: > | |
| 3465 | 7127 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 7128 : call setline(n, l) |
| 7129 :endfor | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
7130 |
| 7 | 7131 < Note: The '[ and '] marks are not set. |
| 7132 | |
| 12785 | 7133 setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()* |
| 647 | 7134 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
|
7135 {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
|
7136 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
|
7137 |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
7138 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
|
7139 modified. For an invalid window number {nr}, -1 is returned. |
| 1326 | 7140 Otherwise, same as |setqflist()|. |
| 7141 Also see |location-list|. | |
| 7142 | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7143 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
|
7144 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
|
7145 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
|
7146 |
| 1326 | 7147 setmatches({list}) *setmatches()* |
| 7148 Restores a list of matches saved by |getmatches()|. Returns 0 | |
| 1621 | 7149 if successful, otherwise -1. All current matches are cleared |
| 1326 | 7150 before the list is restored. See example for |getmatches()|. |
| 230 | 7151 |
| 707 | 7152 *setpos()* |
| 7153 setpos({expr}, {list}) | |
| 7154 Set the position for {expr}. Possible values: | |
| 7155 . the cursor | |
| 7156 'x mark x | |
| 7157 | |
| 5938 | 7158 {list} must be a |List| with four or five numbers: |
| 707 | 7159 [bufnum, lnum, col, off] |
| 5938 | 7160 [bufnum, lnum, col, off, curswant] |
| 707 | 7161 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7162 "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
|
7163 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
|
7164 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
|
7165 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
|
7166 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
|
7167 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
|
7168 since these are associated with a window, not a buffer. |
| 798 | 7169 Does not change the jumplist. |
| 707 | 7170 |
| 7171 "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
|
7172 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
|
7173 smaller than 1 then 1 is used. |
| 707 | 7174 |
| 7175 The "off" number is only used when 'virtualedit' is set. Then | |
| 7176 it is the offset in screen columns from the start of the | |
| 1266 | 7177 character. E.g., a position within a <Tab> or after the last |
| 707 | 7178 character. |
| 7179 | |
| 5938 | 7180 The "curswant" number is only used when setting the cursor |
| 7181 position. It sets the preferred column for when moving the | |
| 7182 cursor vertically. When the "curswant" number is missing the | |
| 7183 preferred column is not set. When it is present and setting a | |
| 7184 mark position it is not used. | |
| 7185 | |
| 5555 | 7186 Note that for '< and '> changing the line number may result in |
| 7187 the marks to be effectively be swapped, so that '< is always | |
| 7188 before '>. | |
| 7189 | |
| 1533 | 7190 Returns 0 when the position could be set, -1 otherwise. |
| 7191 An error message is given if {expr} is invalid. | |
| 7192 | |
| 5944 | 7193 Also see |getpos()| and |getcurpos()|. |
| 707 | 7194 |
| 1156 | 7195 This does not restore the preferred column for moving |
| 5938 | 7196 vertically; if you set the cursor position with this, |j| and |
| 7197 |k| motions will jump to previous columns! Use |cursor()| to | |
| 7198 also set the preferred column. Also see the "curswant" key in | |
| 7199 |winrestview()|. | |
| 1156 | 7200 |
| 12785 | 7201 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
|
7202 Create or replace or add to the quickfix list. |
| 12785 | 7203 |
|
12048
ebd313aa5a6c
patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents:
12045
diff
changeset
|
7204 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
|
7205 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
|
7206 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
|
7207 entries: |
| 230 | 7208 |
| 1065 | 7209 bufnr buffer number; must be the number of a valid |
| 1621 | 7210 buffer |
| 1065 | 7211 filename name of a file; only used when "bufnr" is not |
| 1621 | 7212 present or it is invalid. |
| 230 | 7213 lnum line number in the file |
| 233 | 7214 pattern search pattern used to locate the error |
| 230 | 7215 col column number |
| 233 | 7216 vcol when non-zero: "col" is visual column |
| 856 | 7217 when zero: "col" is byte index |
| 233 | 7218 nr error number |
| 230 | 7219 text description of the error |
| 233 | 7220 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
|
7221 valid recognized error message |
| 233 | 7222 |
| 7223 The "col", "vcol", "nr", "type" and "text" entries are | |
| 7224 optional. Either "lnum" or "pattern" entry can be used to | |
| 7225 locate a matching error line. | |
| 1065 | 7226 If the "filename" and "bufnr" entries are not present or |
| 7227 neither the "lnum" or "pattern" entries are present, then the | |
| 7228 item will not be handled as an error line. | |
| 230 | 7229 If both "pattern" and "lnum" are present then "pattern" will |
| 7230 be used. | |
|
11390
73cfcf11d983
patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents:
11347
diff
changeset
|
7231 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
|
7232 set when "bufnr" is a valid buffer or "filename" exists. |
| 2152 | 7233 If you supply an empty {list}, the quickfix list will be |
| 7234 cleared. | |
| 1065 | 7235 Note that the list is not exactly the same as what |
| 7236 |getqflist()| returns. | |
| 230 | 7237 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7238 {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
|
7239 '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
|
7240 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
|
7241 new list is created. |
| 12785 | 7242 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7243 '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
|
7244 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
|
7245 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
|
7246 :call setqflist([], 'r') |
| 12785 | 7247 < |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7248 '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
|
7249 freed. |
|
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
7250 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
7251 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
|
7252 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
|
7253 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
|
7254 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
|
7255 set "nr" in {what} to "$". |
| 277 | 7256 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7257 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
|
7258 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
|
7259 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
|
7260 {what}: |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
7261 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
|
7262 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
|
7263 "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
|
7264 '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
|
7265 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
|
7266 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
|
7267 argument. |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
7268 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
|
7269 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
|
7270 {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
|
7271 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
|
7272 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
|
7273 the last quickfix list |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7274 title quickfix list title text |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7275 Unsupported keys in {what} are ignored. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7276 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
|
7277 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
|
7278 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
|
7279 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
|
7280 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
|
7281 specify the list. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7282 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
7283 Examples: > |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
7284 :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
|
7285 :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
|
7286 :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
|
7287 < |
| 230 | 7288 Returns zero for success, -1 for failure. |
| 7289 | |
| 7290 This function can be used to create a quickfix list | |
| 7291 independent of the 'errorformat' setting. Use a command like | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11390
diff
changeset
|
7292 `:cc 1` to jump to the first position. |
| 230 | 7293 |
| 7294 | |
| 7 | 7295 *setreg()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
7296 setreg({regname}, {value} [, {options}]) |
| 7 | 7297 Set the register {regname} to {value}. |
| 12785 | 7298 {value} may be any value returned by |getreg()|, including |
| 5798 | 7299 a |List|. |
| 7 | 7300 If {options} contains "a" or {regname} is upper case, |
| 7301 then the value is appended. | |
| 2423 | 7302 {options} can also contain a register type specification: |
| 7 | 7303 "c" or "v" |characterwise| mode |
| 7304 "l" or "V" |linewise| mode | |
| 7305 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 7306 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 7307 used as the width of the selection - if it is not specified | |
| 7308 then the width of the block is set to the number of characters | |
| 1266 | 7309 in the longest line (counting a <Tab> as 1 character). |
| 7 | 7310 |
| 7311 If {options} contains no register settings, then the default | |
| 12785 | 7312 is to use character mode unless {value} ends in a <NL> for |
| 7313 string {value} and linewise mode for list {value}. Blockwise | |
| 5798 | 7314 mode is never selected automatically. |
| 7315 Returns zero for success, non-zero for failure. | |
| 7316 | |
| 7317 *E883* | |
| 12785 | 7318 Note: you may not use |List| containing more than one item to |
| 7319 set search and expression registers. Lists containing no | |
| 5798 | 7320 items act like empty strings. |
| 7 | 7321 |
| 7322 Examples: > | |
| 7323 :call setreg(v:register, @*) | |
| 7324 :call setreg('*', @%, 'ac') | |
| 7325 :call setreg('a', "1\n2\n3", 'b5') | |
| 7326 | |
| 7327 < 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
|
7328 register: > |
| 5798 | 7329 :let var_a = getreg('a', 1, 1) |
| 7 | 7330 :let var_amode = getregtype('a') |
| 7331 .... | |
| 7332 :call setreg('a', var_a, var_amode) | |
| 12785 | 7333 < Note: you may not reliably restore register value |
| 7334 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
|
7335 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
|
7336 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
|
7337 |
|
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
7338 You can also change the type of a register by appending |
| 7 | 7339 nothing: > |
| 7340 :call setreg('a', '', 'al') | |
| 7341 | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7342 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7343 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
|
7344 |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7345 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
|
7346 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7347 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
7348 |
| 831 | 7349 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 7350 Set option or local variable {varname} in window {winnr} to | |
| 7351 {val}. | |
| 7352 Tabs are numbered starting with one. For the current tabpage | |
| 7353 use |setwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
7354 {winnr} can be the window number or the |window-ID|. |
| 831 | 7355 When {winnr} is zero the current window is used. |
| 7 | 7356 This also works for a global or local buffer option, but it |
| 7357 doesn't work for a global or local buffer variable. | |
| 7358 For a local buffer option the global value is unchanged. | |
| 7359 Note that the variable name without "w:" must be used. | |
| 831 | 7360 Examples: > |
| 7361 :call settabwinvar(1, 1, "&list", 0) | |
| 7362 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 7363 < This function is not available in the |sandbox|. | |
| 7364 | |
| 7365 setwinvar({nr}, {varname}, {val}) *setwinvar()* | |
| 7366 Like |settabwinvar()| for the current tab page. | |
| 7 | 7367 Examples: > |
| 7368 :call setwinvar(1, "&list", 0) | |
| 7369 :call setwinvar(2, "myvar", "foobar") | |
| 7370 | |
| 4126 | 7371 sha256({string}) *sha256()* |
| 6647 | 7372 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 7373 checksum of {string}. |
| 7374 {only available when compiled with the |+cryptv| feature} | |
| 7375 | |
| 1661 | 7376 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7377 Escape {string} for use as a shell command argument. |
| 985 | 7378 On MS-Windows and MS-DOS, when 'shellslash' is not set, it |
| 1661 | 7379 will enclose {string} in double quotes and double all double |
| 985 | 7380 quotes within {string}. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
7381 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
|
7382 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
|
7383 |
| 1661 | 7384 When the {special} argument is present and it's a non-zero |
| 7385 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 7386 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 7387 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 7388 command. |
|
11502
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
7389 |
| 1698 | 7390 The "!" character will be escaped (again with a |non-zero-arg| |
| 7391 {special}) when 'shell' contains "csh" in the tail. That is | |
| 7392 because for csh and tcsh "!" is used for history replacement | |
| 7393 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
|
7394 |
|
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
7395 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
|
7396 escaped. When 'shell' containing "csh" in the tail it's |
| 1698 | 7397 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
|
7398 |
| 1661 | 7399 Example of use with a |:!| command: > |
| 7400 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 7401 < This results in a directory listing for the file under the | |
| 7402 cursor. Example of use with |system()|: > | |
| 7403 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 7404 < See also |::S|. |
| 985 | 7405 |
| 7406 | |
| 3875 | 7407 shiftwidth() *shiftwidth()* |
| 7408 Returns the effective value of 'shiftwidth'. This is the | |
| 7409 '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
|
7410 '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
|
7411 7.3.694 in 2012, everybody should have it by now. |
| 3875 | 7412 |
| 7413 | |
| 7 | 7414 simplify({filename}) *simplify()* |
| 7415 Simplify the file name as much as possible without changing | |
| 7416 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 7417 Unix) are not resolved. If the first path component in | |
| 7418 {filename} designates the current directory, this will be | |
| 7419 valid for the result as well. A trailing path separator is | |
| 7420 not removed either. | |
| 7421 Example: > | |
| 7422 simplify("./dir/.././/file/") == "./file/" | |
| 7423 < Note: The combination "dir/.." is only removed if "dir" is | |
| 7424 a searchable directory or does not exist. On Unix, it is also | |
| 7425 removed when "dir" is a symbolic link within the same | |
| 7426 directory. In order to resolve all the involved symbolic | |
| 7427 links before simplifying the path name, use |resolve()|. | |
| 7428 | |
| 82 | 7429 |
| 1621 | 7430 sin({expr}) *sin()* |
| 7431 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 7432 {expr} must evaluate to a |Float| or a |Number|. | |
| 7433 Examples: > | |
| 7434 :echo sin(100) | |
| 7435 < -0.506366 > | |
| 7436 :echo sin(-4.01) | |
| 7437 < 0.763301 | |
| 7438 {only available when compiled with the |+float| feature} | |
| 12785 | 7439 |
| 1621 | 7440 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7441 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7442 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
|
7443 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7444 {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
|
7445 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7446 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7447 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7448 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7449 < -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
|
7450 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7451 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7452 |
| 2902 | 7453 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 7454 Sort the items in {list} in-place. Returns {list}. |
| 12785 | 7455 |
| 5747 | 7456 If you want a list to remain unmodified make a copy first: > |
| 82 | 7457 :let sortedlist = sort(copy(mylist)) |
| 5968 | 7458 |
| 6009 | 7459 < When {func} is omitted, is empty or zero, then sort() uses the |
| 7460 string representation of each item to sort on. Numbers sort | |
| 7461 after Strings, |Lists| after Numbers. For sorting text in the | |
| 7462 current buffer use |:sort|. | |
| 7463 | |
| 6180 | 7464 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 7465 ignored. |
| 12785 | 7466 |
| 6009 | 7467 When {func} is given and it is 'n' then all items will be |
| 7468 sorted numerical (Implementation detail: This uses the | |
| 7469 strtod() function to parse numbers, Strings, Lists, Dicts and | |
| 7470 Funcrefs will be considered as being 0). | |
| 7471 | |
|
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
7472 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
|
7473 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
|
7474 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
|
7475 |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
7476 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
|
7477 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
|
7478 |
| 685 | 7479 When {func} is a |Funcref| or a function name, this function |
| 7480 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
|
7481 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
|
7482 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
|
7483 smaller if the first one sorts before the second one. |
| 5747 | 7484 |
| 7485 {dict} is for functions with the "dict" attribute. It will be | |
| 7486 used to set the local variable "self". |Dictionary-function| | |
| 7487 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7488 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
|
7489 string) will keep their relative position. E.g., when sorting |
| 6051 | 7490 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
|
7491 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
7492 |
| 5747 | 7493 Also see |uniq()|. |
| 7494 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7495 Example: > |
| 82 | 7496 func MyCompare(i1, i2) |
| 7497 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 7498 endfunc | |
| 7499 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7500 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7501 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7502 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7503 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7504 endfunc |
| 344 | 7505 < |
| 374 | 7506 *soundfold()* |
| 7507 soundfold({word}) | |
| 7508 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 7509 language in 'spelllang' for the current window that supports |
| 375 | 7510 soundfolding. 'spell' must be set. When no sound folding is |
| 7511 possible the {word} is returned unmodified. | |
| 374 | 7512 This can be used for making spelling suggestions. Note that |
| 7513 the method can be quite slow. | |
| 7514 | |
| 344 | 7515 *spellbadword()* |
| 532 | 7516 spellbadword([{sentence}]) |
| 7517 Without argument: The result is the badly spelled word under | |
| 7518 or after the cursor. The cursor is moved to the start of the | |
| 7519 bad word. When no bad word is found in the cursor line the | |
| 7520 result is an empty string and the cursor doesn't move. | |
| 7521 | |
| 7522 With argument: The result is the first word in {sentence} that | |
| 7523 is badly spelled. If there are no spelling mistakes the | |
| 7524 result is an empty string. | |
| 7525 | |
| 7526 The return value is a list with two items: | |
| 7527 - The badly spelled word or an empty string. | |
| 7528 - The type of the spelling error: | |
| 856 | 7529 "bad" spelling mistake |
| 532 | 7530 "rare" rare word |
| 7531 "local" word only valid in another region | |
| 7532 "caps" word should start with Capital | |
| 7533 Example: > | |
| 7534 echo spellbadword("the quik brown fox") | |
| 7535 < ['quik', 'bad'] ~ | |
| 7536 | |
| 7537 The spelling information for the current window is used. The | |
| 7538 'spell' option must be set and the value of 'spelllang' is | |
| 7539 used. | |
| 344 | 7540 |
| 7541 *spellsuggest()* | |
| 537 | 7542 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 7543 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 7544 When {max} is given up to this number of suggestions are |
| 7545 returned. Otherwise up to 25 suggestions are returned. | |
| 7546 | |
| 537 | 7547 When the {capital} argument is given and it's non-zero only |
| 7548 suggestions with a leading capital will be given. Use this | |
| 7549 after a match with 'spellcapcheck'. | |
| 7550 | |
| 344 | 7551 {word} can be a badly spelled word followed by other text. |
| 7552 This allows for joining two words that were split. The | |
| 359 | 7553 suggestions also include the following text, thus you can |
| 7554 replace a line. | |
| 7555 | |
| 7556 {word} may also be a good word. Similar words will then be | |
| 537 | 7557 returned. {word} itself is not included in the suggestions, |
| 7558 although it may appear capitalized. | |
| 344 | 7559 |
| 7560 The spelling information for the current window is used. The | |
| 375 | 7561 'spell' option must be set and the values of 'spelllang' and |
| 7562 'spellsuggest' are used. | |
| 344 | 7563 |
| 82 | 7564 |
| 282 | 7565 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 7566 Make a |List| out of {expr}. When {pattern} is omitted or |
| 7567 empty each white-separated sequence of characters becomes an | |
| 7568 item. | |
| 82 | 7569 Otherwise the string is split where {pattern} matches, |
| 3920 | 7570 removing the matched characters. 'ignorecase' is not used |
| 7571 here, add \c to ignore case. |/\c| | |
| 282 | 7572 When the first or last item is empty it is omitted, unless the |
| 7573 {keepempty} argument is given and it's non-zero. | |
| 293 | 7574 Other empty items are kept when {pattern} matches at least one |
| 7575 character or when {keepempty} is non-zero. | |
| 82 | 7576 Example: > |
| 95 | 7577 :let words = split(getline('.'), '\W\+') |
| 282 | 7578 < To split a string in individual characters: > |
| 236 | 7579 :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
|
7580 < 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
|
7581 the end of the pattern: > |
| 258 | 7582 :echo split('abc:def:ghi', ':\zs') |
| 7583 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 7584 Splitting a table where the first element can be empty: > |
| 7585 :let items = split(line, ':', 1) | |
| 7586 < The opposite function is |join()|. | |
| 82 | 7587 |
| 7588 | |
| 1621 | 7589 sqrt({expr}) *sqrt()* |
| 7590 Return the non-negative square root of Float {expr} as a | |
| 7591 |Float|. | |
| 7592 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 7593 is negative the result is NaN (Not a Number). | |
| 7594 Examples: > | |
| 7595 :echo sqrt(100) | |
| 7596 < 10.0 > | |
| 7597 :echo sqrt(-4.01) | |
| 7598 < nan | |
| 1668 | 7599 "nan" may be different, it depends on system libraries. |
| 1621 | 7600 {only available when compiled with the |+float| feature} |
| 12785 | 7601 |
| 1621 | 7602 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7603 str2float({expr}) *str2float()* |
| 1621 | 7604 Convert String {expr} to a Float. This mostly works the same |
| 7605 as when using a floating point number in an expression, see | |
| 7606 |floating-point-format|. But it's a bit more permissive. | |
| 7607 E.g., "1e40" is accepted, while in an expression you need to | |
| 7608 write "1.0e40". | |
| 7609 Text after the number is silently ignored. | |
| 7610 The decimal point is always '.', no matter what the locale is | |
| 7611 set to. A comma ends the number: "12,345.67" is converted to | |
| 7612 12.0. You can strip out thousands separators with | |
| 7613 |substitute()|: > | |
| 7614 let f = str2float(substitute(text, ',', '', 'g')) | |
| 7615 < {only available when compiled with the |+float| feature} | |
| 7616 | |
| 7617 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
7618 str2nr({expr} [, {base}]) *str2nr()* |
| 782 | 7619 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
|
7620 {base} is the conversion base, it can be 2, 8, 10 or 16. |
| 782 | 7621 When {base} is omitted base 10 is used. This also means that |
| 7622 a leading zero doesn't cause octal conversion to be used, as | |
| 7623 with the default String to Number conversion. | |
| 7624 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
|
7625 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
|
7626 {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
|
7627 leading "0b" or "0B" is ignored. |
| 782 | 7628 Text after the number is silently ignored. |
| 856 | 7629 |
| 782 | 7630 |
| 6884 | 7631 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7632 The result is a Number, which is the number of characters |
| 6884 | 7633 in String {expr}. |
| 7634 When {skipcc} is omitted or zero, composing characters are | |
| 7635 counted separately. | |
| 7636 When {skipcc} set to 1, Composing characters are ignored. | |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7637 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
| 12785 | 7638 |
| 6918 | 7639 {skipcc} is only available after 7.4.755. For backward |
| 7640 compatibility, you can define a wrapper function: > | |
| 7641 if has("patch-7.4.755") | |
| 7642 function s:strchars(str, skipcc) | |
| 7643 return strchars(a:str, a:skipcc) | |
| 7644 endfunction | |
| 7645 else | |
| 7646 function s:strchars(str, skipcc) | |
| 7647 if a:skipcc | |
| 7648 return strlen(substitute(a:str, ".", "x", "g")) | |
| 7649 else | |
| 7650 return strchars(a:str) | |
| 7651 endif | |
| 7652 endfunction | |
| 7653 endif | |
| 7654 < | |
| 12785 | 7655 strcharpart({src}, {start} [, {len}]) *strcharpart()* |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7656 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
|
7657 of byte index and length. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7658 When a character index is used where a character does not |
| 10617 | 7659 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
|
7660 strcharpart('abc', -1, 2) |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7661 < results in 'a'. |
| 6918 | 7662 |
| 12785 | 7663 strdisplaywidth({expr} [, {col}]) *strdisplaywidth()* |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7664 The result is a Number, which is the number of display cells |
| 6884 | 7665 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
|
7666 When {col} is omitted zero is used. Otherwise it is the |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7667 screen column where to start. This matters for Tab |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7668 characters. |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
7669 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
|
7670 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
|
7671 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7672 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7673 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7674 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7675 |
| 7 | 7676 strftime({format} [, {time}]) *strftime()* |
| 7677 The result is a String, which is a formatted date and time, as | |
| 7678 specified by the {format} string. The given {time} is used, | |
| 7679 or the current time if no time is given. The accepted | |
| 7680 {format} depends on your system, thus this is not portable! | |
| 7681 See the manual page of the C function strftime() for the | |
| 7682 format. The maximum length of the result is 80 characters. | |
| 7683 See also |localtime()| and |getftime()|. | |
| 7684 The language can be changed with the |:language| command. | |
| 7685 Examples: > | |
| 7686 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 7687 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 7688 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 7689 :echo strftime("%H:%M") 11:55 | |
| 7690 :echo strftime("%c", getftime("file.c")) | |
| 7691 Show mod time of file.c. | |
| 82 | 7692 < Not available on all systems. To check use: > |
| 7693 :if exists("*strftime") | |
| 7694 | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7695 strgetchar({str}, {index}) *strgetchar()* |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7696 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
|
7697 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
|
7698 separate characters here. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7699 Also see |strcharpart()| and |strchars()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7700 |
| 133 | 7701 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 7702 The result is a Number, which gives the byte index in | |
| 7703 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 7704 If {start} is specified, the search starts at index {start}. |
| 7705 This can be used to find a second match: > | |
| 2662 | 7706 :let colon1 = stridx(line, ":") |
| 7707 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 7708 < The search is done case-sensitive. |
| 205 | 7709 For pattern searches use |match()|. |
| 133 | 7710 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 7711 See also |strridx()|. |
| 7712 Examples: > | |
| 7 | 7713 :echo stridx("An Example", "Example") 3 |
| 7714 :echo stridx("Starting point", "Start") 0 | |
| 7715 :echo stridx("Starting point", "start") -1 | |
| 856 | 7716 < *strstr()* *strchr()* |
| 170 | 7717 stridx() works similar to the C function strstr(). When used |
| 7718 with a single character it works similar to strchr(). | |
| 7719 | |
| 55 | 7720 *string()* |
| 95 | 7721 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
| 1621 | 7722 Float, String or a composition of them, then the result can be |
| 7723 parsed back with |eval()|. | |
| 55 | 7724 {expr} type result ~ |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7725 String 'string' (single quotes are doubled) |
| 95 | 7726 Number 123 |
| 1621 | 7727 Float 123.123456 or 1.123456e8 |
| 99 | 7728 Funcref function('name') |
| 95 | 7729 List [item, item] |
| 323 | 7730 Dictionary {key: value, key: value} |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7731 |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7732 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
|
7733 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
|
7734 will then fail. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
7735 |
| 1156 | 7736 Also see |strtrans()|. |
| 55 | 7737 |
| 7 | 7738 *strlen()* |
| 7739 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 7740 {expr} in bytes. |
| 55 | 7741 If the argument is a Number it is first converted to a String. |
| 7742 For other types an error is given. | |
| 6870 | 7743 If you want to count the number of multi-byte characters use |
| 7744 |strchars()|. | |
| 7745 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 7746 |
| 12785 | 7747 strpart({src}, {start} [, {len}]) *strpart()* |
| 7 | 7748 The result is a String, which is part of {src}, starting from |
| 574 | 7749 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
|
7750 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
|
7751 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7752 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
|
7753 result in an error, the bytes are simply omitted. |
| 7 | 7754 If {len} is missing, the copy continues from {start} till the |
| 7755 end of the {src}. > | |
| 7756 strpart("abcdefg", 3, 2) == "de" | |
| 7757 strpart("abcdefg", -2, 4) == "ab" | |
| 7758 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 7759 strpart("abcdefg", 3) == "defg" |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
7760 |
| 7 | 7761 < Note: To get the first character, {start} must be 0. For |
| 7762 example, to get three bytes under and after the cursor: > | |
| 823 | 7763 strpart(getline("."), col(".") - 1, 3) |
| 7 | 7764 < |
| 140 | 7765 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 7766 The result is a Number, which gives the byte index in | |
| 7767 {haystack} of the last occurrence of the String {needle}. | |
| 7768 When {start} is specified, matches beyond this index are | |
| 7769 ignored. This can be used to find a match before a previous | |
| 7770 match: > | |
| 7771 :let lastcomma = strridx(line, ",") | |
| 7772 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 7773 < The search is done case-sensitive. | |
| 133 | 7774 For pattern searches use |match()|. |
| 7775 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 7776 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 7777 See also |stridx()|. Examples: > |
| 7 | 7778 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 7779 < *strrchr()* |
| 170 | 7780 When used with a single character it works similar to the C |
| 7781 function strrchr(). | |
| 7782 | |
| 7 | 7783 strtrans({expr}) *strtrans()* |
| 7784 The result is a String, which is {expr} with all unprintable | |
| 7785 characters translated into printable characters |'isprint'|. | |
| 7786 Like they are shown in a window. Example: > | |
| 7787 echo strtrans(@a) | |
| 7788 < This displays a newline in register a as "^@" instead of | |
| 7789 starting a new line. | |
| 7790 | |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7791 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7792 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
|
7793 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7794 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7795 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7796 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
7797 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
7798 |
| 12785 | 7799 submatch({nr} [, {list}]) *submatch()* *E935* |
| 2908 | 7800 Only for an expression in a |:substitute| command or |
| 7801 substitute() function. | |
| 7802 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 7803 is 0 the whole matched text is returned. | |
| 5794 | 7804 Note that a NL in the string can stand for a line break of a |
| 7805 multi-line match or a NUL character in the text. | |
| 2908 | 7806 Also see |sub-replace-expression|. |
| 5794 | 7807 |
| 12785 | 7808 If {list} is present and non-zero then submatch() returns |
| 7809 a list of strings, similar to |getline()| with two arguments. | |
| 5794 | 7810 NL characters in the text represent NUL characters in the |
| 7811 text. | |
| 7812 Only returns more than one item for |:substitute|, inside | |
| 7813 |substitute()| this list will always contain one or zero | |
| 7814 items, since there are no real line breaks. | |
| 7815 | |
|
10245
d76ccdacb41e
commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
7816 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
|
7817 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
|
7818 |
| 12968 | 7819 Examples: > |
| 7 | 7820 :s/\d\+/\=submatch(0) + 1/ |
| 12968 | 7821 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '') |
| 7 | 7822 < This finds the first number in the line and adds one to it. |
| 7823 A line break is included as a newline character. | |
| 7824 | |
| 7825 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* | |
| 7826 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 7827 the first match of {pat} is replaced with {sub}. |
| 7828 When {flags} is "g", all matches of {pat} in {expr} are | |
| 7829 replaced. Otherwise {flags} should be "". | |
| 12785 | 7830 |
| 2908 | 7831 This works like the ":substitute" command (without any flags). |
| 7832 But the matching with {pat} is always done like the 'magic' | |
| 7833 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 7834 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 7835 if you want to ignore or match case and ignore 'ignorecase'. | |
| 7836 'smartcase' is not used. See |string-match| for how {pat} is | |
| 7837 used. | |
| 2908 | 7838 |
| 7839 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 7840 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
|
7841 |sub-replace-special|. For example, to replace something with |
| 7 | 7842 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 7843 |
| 7 | 7844 When {pat} does not match in {expr}, {expr} is returned |
| 7845 unmodified. | |
| 2908 | 7846 |
| 7 | 7847 Example: > |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7848 :let &path = substitute(&path, ",\\=[^,]*$", "", "") |
| 7 | 7849 < 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
|
7850 :echo substitute("testing", ".*", "\\U\\0", "") |
| 7 | 7851 < results in "TESTING". |
| 2908 | 7852 |
| 7853 When {sub} starts with "\=", the remainder is interpreted as | |
| 7854 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
|
7855 :echo substitute(s, '%\(\x\x\)', |
| 2833 | 7856 \ '\=nr2char("0x" . submatch(1))', 'g') |
| 7 | 7857 |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7858 < 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
|
7859 optional argument. Example: > |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
7860 :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
|
7861 < 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
|
7862 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
|
7863 |submatch()| returns. Example: > |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7864 :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
|
7865 |
| 32 | 7866 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 7867 The result is a Number, which is the syntax ID at the position |
| 32 | 7868 {lnum} and {col} in the current window. |
| 7 | 7869 The syntax ID can be used with |synIDattr()| and |
| 7870 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 7871 |
| 32 | 7872 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 7873 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
|
7874 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
|
7875 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
|
7876 zero. |
| 419 | 7877 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
7878 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
|
7879 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
|
7880 the effective color. When {trans} is |FALSE|, the transparent |
| 7 | 7881 item is returned. This is useful when wanting to know which |
| 7882 syntax item is effective (e.g. inside parens). | |
| 7883 Warning: This function can be very slow. Best speed is | |
| 7884 obtained by going through the file in forward direction. | |
| 7885 | |
| 7886 Example (echoes the name of the syntax item under the cursor): > | |
| 7887 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 7888 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
7889 |
| 7 | 7890 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 7891 The result is a String, which is the {what} attribute of | |
| 7892 syntax ID {synID}. This can be used to obtain information | |
| 7893 about a syntax item. | |
| 7894 {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
|
7895 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 7896 used, the attributes for the currently active highlighting are |
| 7897 used (GUI, cterm or term). | |
| 7898 Use synIDtrans() to follow linked highlight groups. | |
| 7899 {what} result | |
| 7900 "name" the name of the syntax item | |
| 7901 "fg" foreground color (GUI: color name used to set | |
| 7902 the color, cterm: color number as a string, | |
| 7903 term: empty string) | |
| 1755 | 7904 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7905 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7906 |highlight-font| |
| 1755 | 7907 "sp" special color (as with "fg") |highlight-guisp| |
| 7 | 7908 "fg#" like "fg", but for the GUI and the GUI is |
| 7909 running the name in "#RRGGBB" form | |
| 7910 "bg#" like "fg#" for "bg" | |
| 1755 | 7911 "sp#" like "fg#" for "sp" |
| 7 | 7912 "bold" "1" if bold |
| 7913 "italic" "1" if italic | |
| 7914 "reverse" "1" if reverse | |
| 7915 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
7916 "standout" "1" if standout |
| 7 | 7917 "underline" "1" if underlined |
| 205 | 7918 "undercurl" "1" if undercurled |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12311
diff
changeset
|
7919 "strike" "1" if strikethrough |
| 7 | 7920 |
| 7921 Example (echoes the color of the syntax item under the | |
| 7922 cursor): > | |
| 7923 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 7924 < | |
| 7925 synIDtrans({synID}) *synIDtrans()* | |
| 7926 The result is a Number, which is the translated syntax ID of | |
| 7927 {synID}. This is the syntax group ID of what is being used to | |
| 7928 highlight the character. Highlight links given with | |
| 7929 ":highlight link" are followed. | |
| 7930 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7931 synconcealed({lnum}, {col}) *synconcealed()* |
|
11553
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
7932 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
|
7933 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
|
7934 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
|
7935 region, 1 if it is. |
|
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
7936 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
|
7937 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
|
7938 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
|
7939 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
|
7940 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
|
7941 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
|
7942 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
|
7943 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
|
7944 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
|
7945 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
|
7946 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
|
7947 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
|
7948 call returns ~ |
| 12254 | 7949 synconcealed(lnum, 1) [0, '', 0] |
| 7950 synconcealed(lnum, 2) [1, 'X', 1] | |
| 7951 synconcealed(lnum, 3) [1, 'X', 1] | |
| 7952 synconcealed(lnum, 4) [1, 'X', 2] | |
| 7953 synconcealed(lnum, 5) [1, 'X', 2] | |
| 7954 synconcealed(lnum, 6) [0, '', 0] | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7955 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
7956 |
| 1500 | 7957 synstack({lnum}, {col}) *synstack()* |
| 7958 Return a |List|, which is the stack of syntax items at the | |
| 7959 position {lnum} and {col} in the current window. Each item in | |
| 7960 the List is an ID like what |synID()| returns. | |
| 7961 The first item in the List is the outer region, following are | |
| 7962 items contained in that one. The last one is what |synID()| | |
| 7963 returns, unless not the whole item is highlighted or it is a | |
| 7964 transparent item. | |
| 7965 This function is useful for debugging a syntax file. | |
| 7966 Example that shows the syntax stack under the cursor: > | |
| 7967 for id in synstack(line("."), col(".")) | |
| 7968 echo synIDattr(id, "name") | |
| 7969 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
7970 < 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
|
7971 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
7972 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
|
7973 valid positions. |
| 1500 | 7974 |
| 24 | 7975 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 7976 Get the output of the shell command {expr} as a string. See |
| 7977 |systemlist()| to get the output as a List. | |
| 5806 | 7978 |
| 12785 | 7979 When {input} is given and is a string this string is written |
| 7980 to a file and passed as stdin to the command. The string is | |
| 7981 written as-is, you need to take care of using the correct line | |
| 5806 | 7982 separators yourself. |
| 7983 If {input} is given and is a |List| it is written to the file | |
| 7984 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 7985 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
|
7986 list items converted to NULs). |
|
7232cd9f8a7c
commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
7987 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
|
7988 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
|
7989 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
|
7990 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
|
7991 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
7992 Pipes are not used, the 'shelltemp' option is not used. |
| 5806 | 7993 |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
7994 When prepended by |:silent| the terminal will not be set to |
| 6183 | 7995 cooked mode. This is meant to be used for commands that do |
| 7996 not need the user to type. It avoids stray characters showing | |
| 7997 up on the screen which require |CTRL-L| to remove. > | |
| 7998 :silent let f = system('ls *.vim') | |
| 7999 < | |
| 12785 | 8000 Note: Use |shellescape()| or |::S| with |expand()| or |
| 8001 |fnamemodify()| to escape special characters in a command | |
| 8002 argument. Newlines in {expr} may cause the command to fail. | |
| 8003 The characters in 'shellquote' and 'shellxquote' may also | |
| 5690 | 8004 cause trouble. |
| 7 | 8005 This is not to be used for interactive commands. |
| 1661 | 8006 |
| 7 | 8007 The result is a String. Example: > |
| 1661 | 8008 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 8009 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 8010 |
| 8011 < To make the result more system-independent, the shell output | |
| 8012 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 8013 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 8014 To avoid the string being truncated at a NUL, all NUL |
| 8015 characters are replaced with SOH (0x01). | |
| 8016 | |
| 7 | 8017 The command executed is constructed using several options: |
| 8018 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 8019 ({tmp} is an automatically generated file name). | |
| 8020 For Unix and OS/2 braces are put around {expr} to allow for | |
| 8021 concatenated commands. | |
| 8022 | |
| 794 | 8023 The command will be executed in "cooked" mode, so that a |
| 8024 CTRL-C will interrupt the command (on Unix at least). | |
| 8025 | |
| 7 | 8026 The resulting error code can be found in |v:shell_error|. |
| 8027 This function will fail in |restricted-mode|. | |
| 625 | 8028 |
| 8029 Note that any wrong value in the options mentioned above may | |
| 8030 make the function fail. It has also been reported to fail | |
| 8031 when using a security agent application. | |
| 7 | 8032 Unlike ":!cmd" there is no automatic check for changed files. |
| 8033 Use |:checktime| to force a check. | |
| 8034 | |
| 205 | 8035 |
| 5808 | 8036 systemlist({expr} [, {input}]) *systemlist()* |
| 12785 | 8037 Same as |system()|, but returns a |List| with lines (parts of |
| 8038 output separated by NL) with NULs transformed into NLs. Output | |
| 8039 is the same as |readfile()| will output with {binary} argument | |
|
10548
74effdaa369e
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10522
diff
changeset
|
8040 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
|
8041 characters. |
| 5808 | 8042 |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8043 Returns an empty string on error. |
| 5808 | 8044 |
| 8045 | |
| 677 | 8046 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 8047 The result is a |List|, where each item is the number of the |
| 677 | 8048 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
|
8049 {arg} specifies the number of the tab page to be used. When |
| 677 | 8050 omitted the current tab page is used. |
| 8051 When {arg} is invalid the number zero is returned. | |
| 8052 To get a list of all buffers in all tabs use this: > | |
| 3445 | 8053 let buflist = [] |
| 677 | 8054 for i in range(tabpagenr('$')) |
| 3445 | 8055 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 8056 endfor |
| 8057 < Note that a buffer may appear in more than one window. | |
| 8058 | |
| 8059 | |
| 8060 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 8061 The result is a Number, which is the number of the current |
| 8062 tab page. The first tab page has number 1. | |
| 8063 When the optional argument is "$", the number of the last tab | |
| 8064 page is returned (the tab page count). | |
| 8065 The number can be used with the |:tab| command. | |
| 8066 | |
| 8067 | |
| 5763 | 8068 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8069 Like |winnr()| but for tab page {tabarg}. |
| 677 | 8070 {tabarg} specifies the number of tab page to be used. |
| 8071 {arg} is used like with |winnr()|: | |
| 8072 - When omitted the current window number is returned. This is | |
| 8073 the window which will be used when going to this tab page. | |
| 8074 - When "$" the number of windows is returned. | |
| 8075 - When "#" the previous window nr is returned. | |
| 8076 Useful examples: > | |
| 8077 tabpagewinnr(1) " current window of tab page 1 | |
| 8078 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 8079 < When {tabarg} is invalid zero is returned. | |
| 8080 | |
| 805 | 8081 *tagfiles()* |
| 8082 tagfiles() Returns a |List| with the file names used to search for tags | |
| 8083 for the current buffer. This is the 'tags' option expanded. | |
| 8084 | |
| 8085 | |
| 12785 | 8086 taglist({expr} [, {filename}]) *taglist()* |
| 205 | 8087 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
|
8088 |
|
d3415ec1cdaf
patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents:
11211
diff
changeset
|
8089 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
|
8090 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
|
8091 {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
|
8092 |
| 438 | 8093 Each list item is a dictionary with at least the following |
| 8094 entries: | |
| 648 | 8095 name Name of the tag. |
| 8096 filename Name of the file where the tag is | |
| 1156 | 8097 defined. It is either relative to the |
| 8098 current directory or a full path. | |
| 205 | 8099 cmd Ex command used to locate the tag in |
| 8100 the file. | |
| 648 | 8101 kind Type of the tag. The value for this |
| 205 | 8102 entry depends on the language specific |
| 1156 | 8103 kind values. Only available when |
| 8104 using a tags file generated by | |
| 8105 Exuberant ctags or hdrtag. | |
| 648 | 8106 static A file specific tag. Refer to |
| 205 | 8107 |static-tag| for more information. |
| 1156 | 8108 More entries may be present, depending on the content of the |
| 8109 tags file: access, implementation, inherits and signature. | |
| 8110 Refer to the ctags documentation for information about these | |
| 8111 fields. For C code the fields "struct", "class" and "enum" | |
| 8112 may appear, they give the name of the entity the tag is | |
| 8113 contained in. | |
| 452 | 8114 |
| 11062 | 8115 The ex-command "cmd" can be either an ex search pattern, a |
| 216 | 8116 line number or a line number followed by a byte number. |
| 205 | 8117 |
| 8118 If there are no matching tags, then an empty list is returned. | |
| 8119 | |
| 8120 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 8121 used in {expr}. This also make the function work faster. |
| 8122 Refer to |tag-regexp| for more information about the tag | |
| 8123 search regular expression pattern. | |
| 205 | 8124 |
| 8125 Refer to |'tags'| for information about how the tags file is | |
| 8126 located by Vim. Refer to |tags-file-format| for the format of | |
| 8127 the tags file generated by the different ctags tools. | |
| 8128 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8129 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8130 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
|
8131 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8132 {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
|
8133 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8134 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8135 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8136 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8137 < -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
|
8138 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8139 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8140 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8141 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8142 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
|
8143 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
8144 {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
|
8145 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8146 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8147 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8148 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8149 < -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
|
8150 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8151 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
8152 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8153 tempname() *tempname()* *temp-file-name* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8154 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
|
8155 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
|
8156 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
|
8157 :let tmpfile = tempname() |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8158 :exe "redir > " . tmpfile |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8159 < 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
|
8160 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
|
8161 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
|
8162 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8163 *term_dumpdiff()* |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8164 term_dumpdiff({filename}, {filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8165 Open a new window displaying the difference between the two |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8166 files. The files must have been created with |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8167 |term_dumpwrite()|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8168 Returns the buffer number or zero when the diff fails. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8169 Also see |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8170 NOTE: this does not work with double-width characters yet. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8171 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8172 The top part of the buffer contains the contents of the first |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8173 file, the bottom part of the buffer contains the contents of |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8174 the second file. The middle part shows the differences. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8175 The parts are separated by a line of dashes. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8176 |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8177 If the {options} argument is present, it must be a Dict with |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8178 these possible members: |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8179 "term_name" name to use for the buffer name, instead |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8180 of the first file name. |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8181 "term_rows" vertical size to use for the terminal, |
| 13735 | 8182 instead of using 'termwinsize' |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8183 "term_cols" horizontal size to use for the terminal, |
| 13735 | 8184 instead of using 'termwinsize' |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8185 "vertical" split the window vertically |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8186 "curwin" use the current window, do not split the |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8187 window; fails if the current buffer |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8188 cannot be |abandon|ed |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8189 "norestore" do not add the terminal window to a |
|
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8190 session file |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8191 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8192 Each character in the middle part indicates a difference. If |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8193 there are multiple differences only the first in this list is |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8194 used: |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8195 X different character |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8196 w different width |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8197 f different foreground color |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8198 b different background color |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8199 a different attribute |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8200 + missing position in first file |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8201 - missing position in second file |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8202 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8203 Using the "s" key the top and bottom parts are swapped. This |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8204 makes it easy to spot a difference. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8205 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8206 *term_dumpload()* |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8207 term_dumpload({filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8208 Open a new window displaying the contents of {filename} |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8209 The file must have been created with |term_dumpwrite()|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8210 Returns the buffer number or zero when it fails. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8211 Also see |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8212 |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
8213 For {options} see |term_dumpdiff()|. |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8214 |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8215 *term_dumpwrite()* |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
8216 term_dumpwrite({buf}, {filename} [, {options}]) |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8217 Dump the contents of the terminal screen of {buf} in the file |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8218 {filename}. This uses a format that can be used with |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
8219 |term_dumpload()| and |term_dumpdiff()|. |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8220 If {filename} already exists an error is given. *E953* |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8221 Also see |terminal-diff|. |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
8222 |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
8223 {options} is a dictionary with these optional entries: |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
8224 "rows" maximum number of rows to dump |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
8225 "columns" maximum number of columns to dump |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
8226 |
|
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
|
8227 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
|
8228 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
|
8229 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
|
8230 {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
|
8231 {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
|
8232 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8233 term_getansicolors({buf}) *term_getansicolors()* |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8234 Get the ANSI color palette in use by terminal {buf}. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8235 Returns a List of length 16 where each element is a String |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8236 representing a color in hexadecimal "#rrggbb" format. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8237 Also see |term_setansicolors()| and |g:terminal_ansi_colors|. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8238 If neither was used returns the default colors. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8239 |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8240 {buf} is used as with |term_getsize()|. If the buffer does not |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8241 exist or is not a terminal window, an empty list is returned. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8242 {only available when compiled with the |+terminal| feature and |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8243 with GUI enabled and/or the |+termguicolors| feature} |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8244 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8245 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
|
8246 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
|
8247 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
|
8248 bold |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8249 italic |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8250 underline |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8251 strike |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8252 reverse |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8253 {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
|
8254 |
|
11876
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
8255 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
|
8256 Get the cursor position of terminal {buf}. Returns a list with |
| 12499 | 8257 two numbers and a dictionary: [row, col, dict]. |
| 8258 | |
| 8259 "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
|
8260 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
|
8261 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
|
8262 |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
8263 "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
|
8264 "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
|
8265 is hidden. |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
8266 "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
|
8267 is hidden. |
|
ca4931a20f8c
patch 8.0.0918: cannot get terminal window cursor shape or attributes
Christian Brabandt <cb@256bit.org>
parents:
12072
diff
changeset
|
8268 "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
|
8269 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
|
8270 |
|
3704ca24c9a2
patch 8.0.0818: cannot get the cursor position of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11874
diff
changeset
|
8271 {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
|
8272 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
|
8273 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
|
8274 {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
|
8275 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8276 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
|
8277 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
|
8278 {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
|
8279 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
|
8280 {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
|
8281 |
|
11904
40322e8f07e7
patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents:
11882
diff
changeset
|
8282 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
|
8283 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
|
8284 {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
|
8285 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8286 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
|
8287 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
|
8288 returned. |
|
13438
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8289 |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8290 To get attributes of each character use |term_scrape()|. |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8291 {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
|
8292 |
|
12025
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
8293 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
|
8294 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
|
8295 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
|
8296 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
|
8297 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
|
8298 < 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
|
8299 `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
|
8300 < (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
|
8301 |
|
c0ee48f48a2b
patch 8.0.0893: cannot get the scroll count of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
12007
diff
changeset
|
8302 {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
|
8303 {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
|
8304 |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8305 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
|
8306 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
|
8307 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
|
8308 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
|
8309 |
|
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
|
8310 {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
|
8311 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
|
8312 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
|
8313 {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
|
8314 |
|
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
|
8315 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
|
8316 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
|
8317 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
|
8318 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
|
8319 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
|
8320 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
|
8321 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
|
8322 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
8323 {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
|
8324 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
|
8325 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
|
8326 {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
|
8327 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
8328 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
|
8329 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
|
8330 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
|
8331 |
|
69e7379f46db
patch 8.0.0821: cannot get the title and status of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
11876
diff
changeset
|
8332 {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
|
8333 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
|
8334 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
|
8335 {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
|
8336 |
|
12389
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
8337 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
|
8338 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
|
8339 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
|
8340 |
|
d0cf7f71b95b
patch 8.0.1074: ":term NONE" does not work on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12337
diff
changeset
|
8341 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
|
8342 (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
|
8343 (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
|
8344 {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
|
8345 |
|
11874
d444e087b8fd
patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents:
11846
diff
changeset
|
8346 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
|
8347 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
|
8348 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
|
8349 {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
|
8350 |
|
11904
40322e8f07e7
patch 8.0.0832: terminal function arguments are not consistent
Christian Brabandt <cb@256bit.org>
parents:
11882
diff
changeset
|
8351 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
|
8352 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
|
8353 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
|
8354 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8355 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
|
8356 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
|
8357 returned. |
|
11874
d444e087b8fd
patch 8.0.0817: cannot get the terminal line at the cursor
Christian Brabandt <cb@256bit.org>
parents:
11846
diff
changeset
|
8358 |
| 12785 | 8359 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
|
8360 "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
|
8361 "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
|
8362 "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
|
8363 "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
|
8364 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
|
8365 "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
|
8366 {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
|
8367 |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8368 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
|
8369 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
|
8370 {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
|
8371 |
|
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8372 {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
|
8373 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
|
8374 {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
|
8375 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8376 term_setansicolors({buf}, {colors}) *term_setansicolors()* |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8377 Set the ANSI color palette used by terminal {buf}. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8378 {colors} must be a List of 16 valid color names or hexadecimal |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8379 color codes, like those accepted by |highlight-guifg|. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8380 Also see |term_getansicolors()| and |g:terminal_ansi_colors|. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8381 |
|
13678
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8382 The colors normally are: |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8383 0 black |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8384 1 dark red |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8385 2 dark green |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8386 3 brown |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8387 4 dark blue |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8388 5 dark magenta |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8389 6 dark cyan |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8390 7 light grey |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8391 8 dark grey |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8392 9 red |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8393 10 green |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8394 11 yellow |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8395 12 blue |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8396 13 magenta |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8397 14 cyan |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8398 15 white |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8399 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8400 These colors are used in the GUI and in the terminal when |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8401 'termguicolors' is set. When not using GUI colors (GUI mode |
| 13735 | 8402 or 'termguicolors'), the terminal window always uses the 16 |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8403 ANSI colors of the underlying terminal. |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8404 {only available when compiled with the |+terminal| feature and |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8405 with GUI enabled and/or the |+termguicolors| feature} |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8406 |
|
13438
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8407 term_setkill({buf}, {how}) *term_setkill()* |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8408 When exiting Vim or trying to close the terminal window in |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8409 another way, {how} defines whether the job in the terminal can |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8410 be stopped. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8411 When {how} is empty (the default), the job will not be |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8412 stopped, trying to exit will result in |E947|. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8413 Otherwise, {how} specifies what signal to send to the job. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8414 See |job_stop()| for the values. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8415 |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8416 After sending the signal Vim will wait for up to a second to |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8417 check that the job actually stopped. |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8418 |
| 13437 | 8419 term_setrestore({buf}, {command}) *term_setrestore()* |
| 8420 Set the command to write in a session file to restore the job | |
| 8421 in this terminal. The line written in the session file is: > | |
| 8422 terminal ++curwin ++cols=%d ++rows=%d {command} | |
| 8423 < Make sure to escape the command properly. | |
| 8424 | |
| 8425 Use an empty {command} to run 'shell'. | |
| 8426 Use "NONE" to not restore this window. | |
| 8427 {only available when compiled with the |+terminal| feature} | |
| 8428 | |
| 13735 | 8429 term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955* |
|
13678
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8430 Set the size of terminal {buf}. The size of the window |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8431 containing the terminal will also be adjusted, if possible. |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8432 If {rows} or {cols} is zero or negative, that dimension is not |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8433 changed. |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8434 |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8435 {buf} must be the buffer number of a terminal window. Use an |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8436 empty string for the current buffer. If the buffer does not |
|
39fcaaa973db
patch 8.0.1711: term_setsize() is not implemented yet
Christian Brabandt <cb@256bit.org>
parents:
13672
diff
changeset
|
8437 exist or is not a terminal window, an error is given. |
| 12499 | 8438 {only available when compiled with the |+terminal| feature} |
| 8439 | |
|
11846
1c65cad8b967
patch 8.0.0804: terminal window functions not yet implemented
Christian Brabandt <cb@256bit.org>
parents:
11828
diff
changeset
|
8440 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
|
8441 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
|
8442 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8443 {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
|
8444 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
|
8445 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
|
8446 command like gdb. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8447 |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8448 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
|
8449 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
|
8450 message. |
|
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8451 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
|
8452 |
|
11967
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8453 {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
|
8454 |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
|
8455 are supported: |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8456 all timeout options |
|
12833414cc02
patch 8.0.0864: cannot specify the name of a terminal
Christian Brabandt <cb@256bit.org>
parents:
11933
diff
changeset
|
8457 "stoponexit" |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8458 "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
|
8459 "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
|
8460 "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
|
8461 "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
|
8462 "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
|
8463 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
|
8464 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
|
8465 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
|
8466 |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8467 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
|
8468 "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
|
8469 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
|
8470 "term_rows" vertical size to use for the terminal, |
| 13735 | 8471 instead of using 'termwinsize' |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8472 "term_cols" horizontal size to use for the terminal, |
| 13735 | 8473 instead of using 'termwinsize' |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8474 "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
|
8475 "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
|
8476 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
|
8477 cannot be |abandon|ed |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
8478 "hidden" do not open a window |
| 13437 | 8479 "norestore" do not add the terminal window to a |
| 8480 session file | |
|
13438
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8481 "term_kill" what to do when trying to close the |
|
33eea5ce5415
patch 8.0.1593: :qall never exits with an active terminal window
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
8482 terminal window, see |term_setkill()| |
|
12056
0498547dace0
patch 8.0.0908: cannot set terminal size with options
Christian Brabandt <cb@256bit.org>
parents:
12048
diff
changeset
|
8483 "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
|
8484 "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
|
8485 "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
|
8486 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
|
8487 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
|
8488 "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
|
8489 "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
|
8490 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
|
8491 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
|
8492 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
|
8493 "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
|
8494 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
|
8495 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
|
8496 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
|
8497 "exit". A CR is always added. |
|
13626
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8498 "ansi_colors" A list of 16 color names or hex codes |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8499 defining the ANSI palette used in GUI |
|
ab89131d30e0
patch 8.0.1685: can't set ANSI colors of a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13563
diff
changeset
|
8500 color modes. See |g:terminal_ansi_colors|. |
|
12072
f4e1e1e6886b
patch 8.0.0916: cannot specify properties of window for terminal open
Christian Brabandt <cb@256bit.org>
parents:
12060
diff
changeset
|
8501 |
|
12003
6889f1f25d6b
patch 8.0.0882: term_scrape() and term_getline() require two arguments
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
8502 {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
|
8503 |
|
12007
64b822c4f7ae
patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents:
12003
diff
changeset
|
8504 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
|
8505 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
|
8506 {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
|
8507 {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
|
8508 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
|
8509 {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
|
8510 |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
8511 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
|
8512 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
|
8513 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
|
8514 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
|
8515 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
|
8516 |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
8517 test_autochdir() *test_autochdir()* |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
8518 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
|
8519 startup has finished. |
|
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
8520 |
|
12337
040a892d0eed
patch 8.0.1048: no test for what 8.0.1020 fixes
Christian Brabandt <cb@256bit.org>
parents:
12321
diff
changeset
|
8521 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
|
8522 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
|
8523 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
|
8524 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
|
8525 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8526 test_garbagecollect_now() *test_garbagecollect_now()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8527 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
|
8528 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
|
8529 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
|
8530 any function. |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8531 |
|
11006
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8532 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
|
8533 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
|
8534 instead. |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8535 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
|
8536 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
|
8537 following code). |
|
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
8538 {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
|
8539 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
|
8540 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8541 test_null_channel() *test_null_channel()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8542 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
|
8543 {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
|
8544 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8545 test_null_dict() *test_null_dict()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8546 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
|
8547 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8548 test_null_job() *test_null_job()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8549 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
|
8550 {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
|
8551 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8552 test_null_list() *test_null_list()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8553 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
|
8554 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8555 test_null_partial() *test_null_partial()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8556 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
|
8557 |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8558 test_null_string() *test_null_string()* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8559 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
|
8560 |
| 11160 | 8561 test_override({name}, {val}) *test_override()* |
| 8562 Overrides certain parts of Vims internal processing to be able | |
| 8563 to run tests. Only to be used for testing Vim! | |
| 8564 The override is enabled when {val} is non-zero and removed | |
| 8565 when {val} is zero. | |
| 12785 | 8566 Current supported values for name are: |
| 11160 | 8567 |
| 8568 name effect when {val} is non-zero ~ | |
| 8569 redraw disable the redrawing() function | |
| 8570 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
|
8571 starting reset the "starting" variable, see below |
| 11160 | 8572 ALL clear all overrides ({val} is not used) |
| 8573 | |
|
11587
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
8574 "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
|
8575 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
|
8576 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
|
8577 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
|
8578 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
|
8579 When using: > |
|
439835c4b7aa
patch 8.0.0676: crash when closing quickfix window in autocmd
Christian Brabandt <cb@256bit.org>
parents:
11579
diff
changeset
|
8580 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
|
8581 < 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
|
8582 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
|
8583 |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
8584 test_settime({expr}) *test_settime()* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
8585 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
|
8586 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
|
8587 for undo. |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
8588 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
|
8589 error message. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
8590 {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
|
8591 normal behavior is restored. |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
8592 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8593 *timer_info()* |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8594 timer_info([{id}]) |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8595 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
|
8596 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
|
8597 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
|
8598 returned. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8599 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
|
8600 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8601 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
|
8602 these items: |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8603 "id" the timer ID |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8604 "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
|
8605 "remaining" time until the timer fires |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8606 "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
|
8607 -1 means forever |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
8608 "callback" the callback |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8609 "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
|
8610 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8611 {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
|
8612 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8613 timer_pause({timer}, {paused}) *timer_pause()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8614 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
|
8615 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
|
8616 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
|
8617 has passed. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8618 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8619 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
|
8620 for a short time. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8621 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8622 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
|
8623 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
|
8624 See |non-zero-arg|. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8625 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8626 {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
|
8627 |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
8628 *timer_start()* *timer* *timers* |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8629 timer_start({time}, {callback} [, {options}]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8630 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
|
8631 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8632 {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
|
8633 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
|
8634 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
|
8635 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8636 {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
|
8637 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
|
8638 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
|
8639 waiting for input. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8640 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8641 {options} is a dictionary. Supported entries: |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8642 "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
|
8643 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
|
8644 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
|
8645 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
|
8646 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
|
8647 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
|
8648 messages. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8649 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8650 Example: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8651 func MyHandler(timer) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8652 echo 'Handler called' |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8653 endfunc |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8654 let timer = timer_start(500, 'MyHandler', |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8655 \ {'repeat': 3}) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8656 < 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
|
8657 intervals. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8658 |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
8659 {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
|
8660 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
8661 timer_stop({timer}) *timer_stop()* |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
8662 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
|
8663 {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
|
8664 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
|
8665 |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8666 {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
|
8667 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8668 timer_stopall() *timer_stopall()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8669 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
|
8670 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
|
8671 no timers there is no error. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8672 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
8673 {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
|
8674 |
| 7 | 8675 tolower({expr}) *tolower()* |
| 8676 The result is a copy of the String given, with all uppercase | |
| 8677 characters turned into lowercase (just like applying |gu| to | |
| 8678 the string). | |
| 8679 | |
| 8680 toupper({expr}) *toupper()* | |
| 8681 The result is a copy of the String given, with all lowercase | |
| 8682 characters turned into uppercase (just like applying |gU| to | |
| 8683 the string). | |
| 8684 | |
| 15 | 8685 tr({src}, {fromstr}, {tostr}) *tr()* |
| 8686 The result is a copy of the {src} string with all characters | |
| 8687 which appear in {fromstr} replaced by the character in that | |
| 8688 position in the {tostr} string. Thus the first character in | |
| 8689 {fromstr} is translated into the first character in {tostr} | |
| 8690 and so on. Exactly like the unix "tr" command. | |
| 8691 This code also deals with multibyte characters properly. | |
| 8692 | |
| 8693 Examples: > | |
| 8694 echo tr("hello there", "ht", "HT") | |
| 8695 < returns "Hello THere" > | |
| 8696 echo tr("<blob>", "<>", "{}") | |
| 8697 < returns "{blob}" | |
| 8698 | |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8699 trim({text}[, {mask}]) *trim()* |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8700 Return {text} as a String where any character in {mask} is |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8701 removed from the beginning and end of {text}. |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8702 If {mask} is not given, {mask} is all characters up to 0x20, |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8703 which includes Tab, space, NL and CR, plus the non-breaking |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8704 space character 0xa0. |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8705 This code deals with multibyte characters properly. |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8706 |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8707 Examples: > |
| 13563 | 8708 echo trim(" some text ") |
| 8709 < returns "some text" > | |
| 8710 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") . "_TAIL" | |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8711 < returns "RESERVE_TAIL" > |
| 13563 | 8712 echo trim("rm<Xrm<>X>rrm", "rm<>") |
| 8713 < returns "Xrm<>X" (characters in the middle are not removed) | |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
8714 |
| 1621 | 8715 trunc({expr}) *trunc()* |
| 1668 | 8716 Return the largest integral value with magnitude less than or |
| 1621 | 8717 equal to {expr} as a |Float| (truncate towards zero). |
| 8718 {expr} must evaluate to a |Float| or a |Number|. | |
| 8719 Examples: > | |
| 8720 echo trunc(1.456) | |
| 8721 < 1.0 > | |
| 8722 echo trunc(-5.456) | |
| 8723 < -5.0 > | |
| 8724 echo trunc(4.0) | |
| 8725 < 4.0 | |
| 8726 {only available when compiled with the |+float| feature} | |
| 12785 | 8727 |
| 87 | 8728 *type()* |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8729 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
|
8730 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
|
8731 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
|
8732 Number: 0 |v:t_number| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8733 String: 1 |v:t_string| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8734 Funcref: 2 |v:t_func| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8735 List: 3 |v:t_list| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8736 Dictionary: 4 |v:t_dict| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8737 Float: 5 |v:t_float| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8738 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
|
8739 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
|
8740 Job 8 |v:t_job| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8741 Channel 9 |v:t_channel| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
8742 For backward compatibility, this method can be used: > |
| 87 | 8743 :if type(myvar) == type(0) |
| 8744 :if type(myvar) == type("") | |
| 8745 :if type(myvar) == type(function("tr")) | |
| 8746 :if type(myvar) == type([]) | |
| 153 | 8747 :if type(myvar) == type({}) |
| 1621 | 8748 :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
|
8749 :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
|
8750 :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
|
8751 < 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
|
8752 :if exists('v:t_number') |
| 7 | 8753 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8754 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8755 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
|
8756 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
|
8757 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
|
8758 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
8759 {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
|
8760 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
8761 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
|
8762 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
|
8763 Useful in combination with |:wundo| and |:rundo|. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8764 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
|
8765 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
8766 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8767 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8768 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
|
8769 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8770 "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
|
8771 "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
|
8772 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
|
8773 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
|
8774 "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
|
8775 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
|
8776 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8777 "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
|
8778 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
8779 "save_cur" Number of the current position in the undo |
| 12785 | 8780 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8781 "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
|
8782 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
|
8783 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8784 "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
|
8785 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8786 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8787 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
|
8788 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
|
8789 "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
|
8790 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8791 "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
|
8792 |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
|
8793 "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
|
8794 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
|
8795 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
|
8796 "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
|
8797 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
|
8798 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
|
8799 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
|
8800 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
|
8801 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8802 "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
|
8803 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
|
8804 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
|
8805 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8806 "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
|
8807 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
|
8808 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
8809 |
| 5747 | 8810 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 8811 Remove second and succeeding copies of repeated adjacent | |
| 8812 {list} items in-place. Returns {list}. If you want a list | |
| 8813 to remain unmodified make a copy first: > | |
| 8814 :let newlist = uniq(copy(mylist)) | |
| 8815 < The default compare function uses the string representation of | |
| 8816 each item. For the use of {func} and {dict} see |sort()|. | |
| 8817 | |
| 140 | 8818 values({dict}) *values()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8819 Return a |List| with all the values of {dict}. The |List| is |
| 685 | 8820 in arbitrary order. |
| 140 | 8821 |
| 8822 | |
| 7 | 8823 virtcol({expr}) *virtcol()* |
| 8824 The result is a Number, which is the screen column of the file | |
| 8825 position given with {expr}. That is, the last screen position | |
| 8826 occupied by the character at that position, when the screen | |
| 8827 would be of unlimited width. When there is a <Tab> at the | |
| 8828 position, the returned Number will be the column at the end of | |
| 8829 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 8830 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 8831 For the byte position use |col()|. |
| 8832 For the use of {expr} see |col()|. | |
| 8833 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 8834 "off" is the offset in screen columns from the start of the |
| 1266 | 8835 character. E.g., a position within a <Tab> or after the last |
| 2965 | 8836 character. When "off" is omitted zero is used. |
| 7 | 8837 When Virtual editing is active in the current mode, a position |
| 8838 beyond the end of the line can be returned. |'virtualedit'| | |
| 8839 The accepted positions are: | |
| 8840 . the cursor position | |
| 8841 $ the end of the cursor line (the result is the | |
| 8842 number of displayed characters in the cursor line | |
| 8843 plus one) | |
| 8844 'x position of mark x (if the mark is not set, 0 is | |
| 8845 returned) | |
| 6447 | 8846 v In Visual mode: the start of the Visual area (the |
| 8847 cursor is the end). When not in Visual mode | |
| 8848 returns the cursor position. Differs from |'<| in | |
| 8849 that it's updated right away. | |
| 7 | 8850 Note that only marks in the current file can be used. |
| 8851 Examples: > | |
| 8852 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 8853 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 8854 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
|
8855 < The first column is 1. 0 is returned for an error. |
| 1156 | 8856 A more advanced example that echoes the maximum length of |
| 8857 all lines: > | |
| 8858 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 8859 | |
| 7 | 8860 |
| 8861 visualmode([expr]) *visualmode()* | |
| 8862 The result is a String, which describes the last Visual mode | |
| 856 | 8863 used in the current buffer. Initially it returns an empty |
| 8864 string, but once Visual mode has been used, it returns "v", | |
| 8865 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 8866 character-wise, line-wise, or block-wise Visual mode | |
| 8867 respectively. | |
| 7 | 8868 Example: > |
| 8869 :exe "normal " . visualmode() | |
| 8870 < This enters the same Visual mode as before. It is also useful | |
| 8871 in scripts if you wish to act differently depending on the | |
| 8872 Visual mode that was used. | |
| 1621 | 8873 If Visual mode is active, use |mode()| to get the Visual mode |
| 8874 (e.g., in a |:vmap|). | |
| 1661 | 8875 If [expr] is supplied and it evaluates to a non-zero Number or |
| 8876 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
|
8877 the old value is returned. See |non-zero-arg|. |
| 7 | 8878 |
| 4151 | 8879 wildmenumode() *wildmenumode()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
8880 Returns |TRUE| when the wildmenu is active and |FALSE| |
| 4151 | 8881 otherwise. See 'wildmenu' and 'wildmode'. |
| 8882 This can be used in mappings to handle the 'wildcharm' option | |
| 8883 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 8884 | |
| 8885 For example to make <c-j> work like <down> in wildmode, use: > | |
| 8886 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 8887 < | |
| 8888 (Note, this needs the 'wildcharm' option set appropriately). | |
| 8889 | |
| 8890 | |
|
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
8891 win_findbuf({bufnr}) *win_findbuf()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8892 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
|
8893 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
|
8894 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8895 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
|
8896 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
|
8897 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
|
8898 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
|
8899 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
|
8900 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
|
8901 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
|
8902 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
|
8903 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8904 win_gotoid({expr}) *win_gotoid()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8905 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
|
8906 tabpage. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8907 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
|
8908 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8909 win_id2tabwin({expr}) *win_id2tabwin()* |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8910 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
|
8911 with ID {expr}: [tabnr, winnr]. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8912 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
|
8913 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8914 win_id2win({expr}) *win_id2win()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
8915 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
|
8916 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
|
8917 |
|
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
|
8918 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
|
8919 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
|
8920 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
|
8921 [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
|
8922 {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
|
8923 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
|
8924 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
|
8925 |
| 7 | 8926 *winbufnr()* |
| 8927 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
|
8928 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
|
8929 the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8930 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
|
8931 window is returned. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
8932 When window {nr} doesn't exist, -1 is returned. |
| 7 | 8933 Example: > |
| 8934 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 8935 < | |
| 8936 *wincol()* | |
| 8937 wincol() The result is a Number, which is the virtual column of the | |
| 8938 cursor in the window. This is counting screen cells from the | |
| 8939 left side of the window. The leftmost column is one. | |
| 8940 | |
| 8941 winheight({nr}) *winheight()* | |
| 8942 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
|
8943 {nr} can be the window number or the |window-ID|. |
| 7 | 8944 When {nr} is zero, the height of the current window is |
| 8945 returned. When window {nr} doesn't exist, -1 is returned. | |
| 8946 An existing window always has a height of zero or more. | |
| 12499 | 8947 This excludes any window toolbar line. |
| 7 | 8948 Examples: > |
| 8949 :echo "The current window has " . winheight(0) . " lines." | |
| 8950 < | |
| 8951 *winline()* | |
| 8952 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
|
8953 in the window. This is counting screen lines from the top of |
| 7 | 8954 the window. The first line is one. |
| 531 | 8955 If the cursor was moved the view on the file will be updated |
| 8956 first, this may cause a scroll. | |
| 7 | 8957 |
| 8958 *winnr()* | |
| 20 | 8959 winnr([{arg}]) The result is a Number, which is the number of the current |
| 8960 window. The top window has number 1. | |
| 8961 When the optional argument is "$", the number of the | |
| 3967 | 8962 last window is returned (the window count). > |
| 8963 let window_count = winnr('$') | |
| 8964 < When the optional argument is "#", the number of the last | |
| 20 | 8965 accessed window is returned (where |CTRL-W_p| goes to). |
| 1156 | 8966 If there is no previous window or it is in another tab page 0 |
| 8967 is returned. | |
| 20 | 8968 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 8969 |:wincmd|. | |
| 10734 | 8970 Also see |tabpagewinnr()| and |win_getid()|. |
| 7 | 8971 |
| 8972 *winrestcmd()* | |
| 8973 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 8974 the current window sizes. Only works properly when no windows | |
| 712 | 8975 are opened or closed and the current window and tab page is |
| 8976 unchanged. | |
| 7 | 8977 Example: > |
| 8978 :let cmd = winrestcmd() | |
| 8979 :call MessWithWindowSizes() | |
| 8980 :exe cmd | |
| 712 | 8981 < |
| 8982 *winrestview()* | |
| 8983 winrestview({dict}) | |
| 8984 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 8985 the view of the current window. | |
| 5940 | 8986 Note: The {dict} does not have to contain all values, that are |
| 8987 returned by |winsaveview()|. If values are missing, those | |
| 8988 settings won't be restored. So you can use: > | |
| 8989 :call winrestview({'curswant': 4}) | |
| 8990 < | |
| 8991 This will only set the curswant value (the column the cursor | |
| 8992 wants to move on vertical movements) of the cursor to column 5 | |
| 8993 (yes, that is 5), while all other settings will remain the | |
| 8994 same. This is useful, if you set the cursor position manually. | |
| 8995 | |
| 712 | 8996 If you have changed the values the result is unpredictable. |
| 8997 If the window size changed the result won't be the same. | |
| 8998 | |
| 8999 *winsaveview()* | |
| 9000 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 9001 the view of the current window. Use |winrestview()| to | |
| 9002 restore the view. | |
| 9003 This is useful if you have a mapping that jumps around in the | |
| 9004 buffer and you want to go back to the original view. | |
| 9005 This does not save fold information. Use the 'foldenable' | |
| 798 | 9006 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
|
9007 not opened when moving around. This may have side effects. |
| 712 | 9008 The return value includes: |
| 9009 lnum cursor line number | |
| 5940 | 9010 col cursor column (Note: the first column |
| 9011 zero, as opposed to what getpos() | |
| 9012 returns) | |
| 712 | 9013 coladd cursor column offset for 'virtualedit' |
| 9014 curswant column for vertical movement | |
| 9015 topline first line in the window | |
| 9016 topfill filler lines, only in diff mode | |
| 9017 leftcol first column displayed | |
| 9018 skipcol columns skipped | |
| 9019 Note that no option values are saved. | |
| 9020 | |
| 7 | 9021 |
| 9022 winwidth({nr}) *winwidth()* | |
| 9023 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
|
9024 {nr} can be the window number or the |window-ID|. |
| 7 | 9025 When {nr} is zero, the width of the current window is |
| 9026 returned. When window {nr} doesn't exist, -1 is returned. | |
| 9027 An existing window always has a width of zero or more. | |
| 9028 Examples: > | |
| 9029 :echo "The current window has " . winwidth(0) . " columns." | |
| 9030 :if winwidth(0) <= 50 | |
|
12857
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
9031 : 50 wincmd | |
| 7 | 9032 :endif |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
9033 < 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
|
9034 option. |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
9035 |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
9036 |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9037 wordcount() *wordcount()* |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9038 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
|
9039 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
|
9040 |g_CTRL-G| |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9041 The return value includes: |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9042 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
|
9043 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
|
9044 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
|
9045 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
|
9046 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9047 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
|
9048 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9049 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
|
9050 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9051 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
|
9052 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9053 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
|
9054 (only in Visual mode) |
| 12254 | 9055 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
|
9056 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9057 |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
9058 |
| 158 | 9059 *writefile()* |
| 6341 | 9060 writefile({list}, {fname} [, {flags}]) |
| 685 | 9061 Write |List| {list} to file {fname}. Each list item is |
| 158 | 9062 separated with a NL. Each list item must be a String or |
| 9063 Number. | |
| 6341 | 9064 When {flags} contains "b" then binary mode is used: There will |
| 158 | 9065 not be a NL after the last list item. An empty item at the |
| 9066 end does cause the last line in the file to end in a NL. | |
| 6341 | 9067 |
| 9068 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
|
9069 appended to the file: > |
| 6341 | 9070 :call writefile(["foo"], "event.log", "a") |
| 9071 :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
|
9072 < |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
9073 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
|
9074 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
|
9075 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
|
9076 crashes. |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
9077 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
|
9078 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
|
9079 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
|
9080 when 'fsync' is set. |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
9081 |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
9082 All NL characters are replaced with a NUL character. |
| 158 | 9083 Inserting CR characters needs to be done before passing {list} |
| 9084 to writefile(). | |
| 9085 An existing file is overwritten, if possible. | |
| 9086 When the write fails -1 is returned, otherwise 0. There is an | |
| 9087 error message if the file can't be created or when writing | |
| 9088 fails. | |
| 9089 Also see |readfile()|. | |
| 9090 To copy a file byte for byte: > | |
| 9091 :let fl = readfile("foo", "b") | |
| 9092 :call writefile(fl, "foocopy", "b") | |
| 3214 | 9093 |
| 9094 | |
| 9095 xor({expr}, {expr}) *xor()* | |
| 9096 Bitwise XOR on the two arguments. The arguments are converted | |
| 9097 to a number. A List, Dict or Float argument causes an error. | |
| 9098 Example: > | |
| 9099 :let bits = xor(bits, 0x80) | |
| 3256 | 9100 < |
| 3214 | 9101 |
| 7 | 9102 |
| 9103 *feature-list* | |
| 6009 | 9104 There are four types of features: |
| 7 | 9105 1. Features that are only supported when they have been enabled when Vim |
| 9106 was compiled |+feature-list|. Example: > | |
| 9107 :if has("cindent") | |
| 9108 2. Features that are only supported when certain conditions have been met. | |
| 9109 Example: > | |
| 9110 :if has("gui_running") | |
| 9111 < *has-patch* | |
| 5814 | 9112 3. Included patches. The "patch123" feature means that patch 123 has been |
| 9113 included. Note that this form does not check the version of Vim, you need | |
| 9114 to inspect |v:version| for that. | |
| 9115 Example (checking version 6.2.148 or later): > | |
| 7 | 9116 :if v:version > 602 || v:version == 602 && has("patch148") |
| 5814 | 9117 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 9118 included. | |
| 9119 | |
| 9120 4. Beyond a certain version or at a certain version and including a specific | |
| 5862 | 9121 patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or |
| 9122 later, or it is version 7.4 and patch 237 was included. | |
| 9123 Note that this only works for patch 7.4.237 and later, before that you | |
| 9124 need to use the example above that checks v:version. Example: > | |
| 9125 :if has("patch-7.4.248") | |
| 5814 | 9126 < Note that it's possible for patch 147 to be omitted even though 148 is |
| 1156 | 9127 included. |
| 7 | 9128 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9129 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
|
9130 use: `if exists('+shellslash')` |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9131 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9132 |
| 5340 | 9133 acl Compiled with |ACL| support. |
| 7 | 9134 all_builtin_terms Compiled with all builtin terminals enabled. |
| 9135 amiga Amiga version of Vim. | |
| 9136 arabic Compiled with Arabic support |Arabic|. | |
| 9137 arp Compiled with ARP support (Amiga). | |
| 613 | 9138 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
|
9139 autoservername Automatically enable |clientserver| |
| 7 | 9140 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 9141 balloon_multiline GUI supports multiline balloons. |
| 7 | 9142 beos BeOS version of Vim. |
| 9143 browse Compiled with |:browse| support, and browse() will | |
| 9144 work. | |
| 3682 | 9145 browsefilter Compiled with support for |browsefilter|. |
| 7 | 9146 builtin_terms Compiled with some builtin terminals. |
| 9147 byte_offset Compiled with support for 'o' in 'statusline' | |
| 9148 cindent Compiled with 'cindent' support. | |
| 9149 clientserver Compiled with remote invocation support |clientserver|. | |
| 9150 clipboard Compiled with 'clipboard' support. | |
| 9151 cmdline_compl Compiled with |cmdline-completion| support. | |
| 9152 cmdline_hist Compiled with |cmdline-history| support. | |
| 9153 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 9154 comments Compiled with |'comments'| support. | |
| 2681 | 9155 compatible Compiled to be very Vi compatible. |
| 7 | 9156 cryptv Compiled with encryption support |encryption|. |
| 9157 cscope Compiled with |cscope| support. | |
| 9158 debug Compiled with "DEBUG" defined. | |
| 9159 dialog_con Compiled with console dialog support. | |
| 9160 dialog_gui Compiled with GUI dialog support. | |
| 9161 diff Compiled with |vimdiff| and 'diff' support. | |
| 9162 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
|
9163 directx Compiled with support for DirectX and 'renderoptions'. |
| 7 | 9164 dnd Compiled with support for the "~ register |quote_~|. |
| 9165 ebcdic Compiled on a machine with ebcdic character set. | |
| 9166 emacs_tags Compiled with support for Emacs tags. | |
| 9167 eval Compiled with expression evaluation support. Always | |
| 9168 true, of course! | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7788
diff
changeset
|
9169 ex_extra |+ex_extra|, always true now |
| 7 | 9170 extra_search Compiled with support for |'incsearch'| and |
| 9171 |'hlsearch'| | |
| 9172 farsi Compiled with Farsi support |farsi|. | |
| 9173 file_in_path Compiled with support for |gf| and |<cfile>| | |
| 168 | 9174 filterpipe When 'shelltemp' is off pipes are used for shell |
| 9175 read/write/filter commands | |
| 7 | 9176 find_in_path Compiled with support for include file searches |
| 9177 |+find_in_path|. | |
| 1621 | 9178 float Compiled with support for |Float|. |
| 7 | 9179 fname_case Case in file names matters (for Amiga, MS-DOS, and |
| 9180 Windows this is not present). | |
| 9181 folding Compiled with |folding| support. | |
| 9182 footer Compiled with GUI footer support. |gui-footer| | |
| 9183 fork Compiled to use fork()/exec() instead of system(). | |
| 9184 gettext Compiled with message translation |multi-lang| | |
| 9185 gui Compiled with GUI enabled. | |
| 9186 gui_athena Compiled with Athena GUI. | |
| 2681 | 9187 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 9188 gui_gtk Compiled with GTK+ GUI (any version). |
| 9189 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
|
9190 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
| 7 | 9191 gui_mac Compiled with Macintosh GUI. |
| 9192 gui_motif Compiled with Motif GUI. | |
| 9193 gui_photon Compiled with Photon GUI. | |
| 2681 | 9194 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 9195 gui_win32 Compiled with MS Windows Win32 GUI. |
| 9196 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
| 9197 hangul_input Compiled with Hangul input support. |hangul| | |
| 9198 iconv Can use iconv() for conversion. | |
| 9199 insert_expand Compiled with support for CTRL-X expansion commands in | |
| 9200 Insert mode. | |
| 9201 jumplist Compiled with |jumplist| support. | |
| 9202 keymap Compiled with 'keymap' support. | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
9203 lambda Compiled with |lambda| support. |
| 7 | 9204 langmap Compiled with 'langmap' support. |
| 9205 libcall Compiled with |libcall()| support. | |
| 5995 | 9206 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 9207 'breakindent' support. | |
| 7 | 9208 lispindent Compiled with support for lisp indenting. |
| 9209 listcmds Compiled with commands for the buffer list |:files| | |
| 9210 and the argument list |arglist|. | |
| 9211 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
|
9212 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
|
9213 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
|
9214 macunix Synonym for osxdarwin |
| 7 | 9215 menu Compiled with support for |:menu|. |
| 9216 mksession Compiled with support for |:mksession|. | |
| 9217 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
| 9218 mouse Compiled with support mouse. | |
| 9219 mouse_dec Compiled with support for Dec terminal mouse. | |
| 9220 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
| 9221 mouse_netterm Compiled with support for netterm mouse. | |
| 9222 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 9223 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 9224 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 9225 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 9226 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 9227 mouseshape Compiled with support for 'mouseshape'. |
| 1768 | 9228 multi_byte Compiled with support for 'encoding' |
| 9229 multi_byte_encoding 'encoding' is set to a multi-byte encoding. | |
| 7 | 9230 multi_byte_ime Compiled with support for IME input method. |
| 9231 multi_lang Compiled with support for multiple languages. | |
| 14 | 9232 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 9233 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 9234 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
|
9235 num64 Compiled with 64-bit |Number| support. |
| 7 | 9236 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
|
9237 osx Compiled for macOS cf. mac |
|
351cf7c67bbe
patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents:
12632
diff
changeset
|
9238 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
|
9239 packages Compiled with |packages| support. |
| 7 | 9240 path_extra Compiled with up/downwards search in 'path' and 'tags' |
| 9241 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
|
9242 persistent_undo Compiled with support for persistent undo history. |
| 7 | 9243 postscript Compiled with PostScript file printing. |
| 9244 printer Compiled with |:hardcopy| support. | |
| 170 | 9245 profile Compiled with |:profile| support. |
|
13123
aaead5b4d77d
patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents:
13070
diff
changeset
|
9246 python Python 2.x interface available. |has-python| |
|
aaead5b4d77d
patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents:
13070
diff
changeset
|
9247 python_compiled Compiled with Python 2.x interface. |has-python| |
|
aaead5b4d77d
patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents:
13070
diff
changeset
|
9248 python_dynamic Python 2.x interface is dynamically loaded. |has-python| |
|
aaead5b4d77d
patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents:
13070
diff
changeset
|
9249 python3 Python 3.x interface available. |has-python| |
|
aaead5b4d77d
patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents:
13070
diff
changeset
|
9250 python3_compiled Compiled with Python 3.x interface. |has-python| |
|
aaead5b4d77d
patch 8.0.1436: not enough information about what Python version may work
Christian Brabandt <cb@256bit.org>
parents:
13070
diff
changeset
|
9251 python3_dynamic Python 3.x interface is dynamically loaded. |has-python| |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
9252 pythonx Compiled with |python_x| interface. |has-pythonx| |
| 7 | 9253 qnx QNX version of Vim. |
| 9254 quickfix Compiled with |quickfix| support. | |
| 857 | 9255 reltime Compiled with |reltime()| support. |
| 7 | 9256 rightleft Compiled with 'rightleft' support. |
| 9257 ruby Compiled with Ruby interface |ruby|. | |
| 9258 scrollbind Compiled with 'scrollbind' support. | |
| 9259 showcmd Compiled with 'showcmd' support. | |
| 9260 signs Compiled with |:sign| support. | |
| 9261 smartindent Compiled with 'smartindent' support. | |
| 2681 | 9262 spell Compiled with spell checking support |spell|. |
| 1989 | 9263 startuptime Compiled with |--startuptime| support. |
| 7 | 9264 statusline Compiled with support for 'statusline', 'rulerformat' |
| 9265 and special formats of 'titlestring' and 'iconstring'. | |
| 9266 sun_workshop Compiled with support for Sun |workshop|. | |
| 314 | 9267 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 9268 syntax_items There are active syntax highlighting items for the |
| 9269 current buffer. | |
| 9270 system Compiled to use system() instead of fork()/exec(). | |
| 9271 tag_binary Compiled with binary searching in tags files | |
| 9272 |tag-binary-search|. | |
| 9273 tag_old_static Compiled with support for old static tags | |
| 9274 |tag-old-static|. | |
| 9275 tag_any_white Compiled with support for any white characters in tags | |
| 9276 files |tag-any-white|. | |
| 9277 tcl Compiled with Tcl interface. | |
|
9076
9305a1251e51
commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
9278 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
|
9279 terminal Compiled with |terminal| support. |
| 7 | 9280 terminfo Compiled with terminfo instead of termcap. |
| 9281 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 9282 textobjects Compiled with support for |text-objects|. | |
| 9283 tgetent Compiled with tgetent support, able to use a termcap | |
| 9284 or terminfo file. | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
9285 timers Compiled with |timer_start()| support. |
| 7 | 9286 title Compiled with window title support |'title'|. |
| 9287 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
|
9288 ttyin input is a terminal (tty) |
|
65e0537a4560
commit https://github.com/vim/vim/commit/2cab0e191055a8145ccd46cd52869fbb9798b971
Christian Brabandt <cb@256bit.org>
parents:
10348
diff
changeset
|
9289 ttyout output is a terminal (tty) |
| 12499 | 9290 unix Unix version of Vim. *+unix* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9291 unnamedplus Compiled with support for "unnamedplus" in 'clipboard' |
| 7 | 9292 user_commands User-defined commands. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
9293 vcon Win32: Virtual console support is working, can use |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
9294 'termguicolors'. Also see |+vtp|. |
| 2681 | 9295 vertsplit Compiled with vertically split windows |:vsplit|. |
| 2581 | 9296 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
|
9297 *vim_starting* |
| 2681 | 9298 viminfo Compiled with viminfo support. |
| 7 | 9299 virtualedit Compiled with 'virtualedit' option. |
| 9300 visual Compiled with Visual mode. | |
| 9301 visualextra Compiled with extra Visual mode commands. | |
| 9302 |blockwise-operators|. | |
| 9303 vms VMS version of Vim. | |
| 9304 vreplace Compiled with |gR| and |gr| commands. | |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
9305 vtp Compiled for vcon support |+vtp| (check vcon to find |
|
13501
a4a559e08798
patch 8.0.1624: options for term_dumpdiff() and term_dumpload() not implemented
Christian Brabandt <cb@256bit.org>
parents:
13482
diff
changeset
|
9306 out if it works in the current console). |
| 7 | 9307 wildignore Compiled with 'wildignore' option. |
| 9308 wildmenu Compiled with 'wildmenu' option. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
9309 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
|
9310 64 bits) |
| 2681 | 9311 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 9312 win64 Win64 version of Vim (MS-Windows 64 bit). |
| 9313 win95 Win32 version for MS-Windows 95/98/ME. | |
| 2681 | 9314 winaltkeys Compiled with 'winaltkeys' option. |
| 9315 windows Compiled with support for more than one window. | |
| 7 | 9316 writebackup Compiled with 'writebackup' default on. |
| 9317 xfontset Compiled with X fontset support |xfontset|. | |
| 9318 xim Compiled with X input method support |xim|. | |
| 5340 | 9319 xpm Compiled with pixmap support. |
| 9320 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 9321 backward compatibility. Use "xpm" instead.) | |
| 7 | 9322 xsmp Compiled with X session management support. |
| 9323 xsmp_interact Compiled with interactive X session management support. | |
| 9324 xterm_clipboard Compiled with support for xterm clipboard. | |
| 9325 xterm_save Compiled with support for saving and restoring the | |
| 9326 xterm screen. | |
| 9327 x11 Compiled with X11 support. | |
| 9328 | |
| 9329 *string-match* | |
| 9330 Matching a pattern in a String | |
| 9331 | |
| 9332 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 9333 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 9334 everything works in the same way. The difference is that a String is handled | |
| 9335 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 9336 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 9337 with ".". Example: > | |
| 9338 :let a = "aaaa\nxxxx" | |
| 9339 :echo matchstr(a, "..\n..") | |
| 9340 aa | |
| 9341 xx | |
| 9342 :echo matchstr(a, "a.x") | |
| 9343 a | |
| 9344 x | |
| 9345 | |
| 9346 Don't forget that "^" will only match at the first character of the String and | |
| 9347 "$" at the last character of the string. They don't match after or before a | |
| 9348 "\n". | |
| 9349 | |
| 9350 ============================================================================== | |
| 9351 5. Defining functions *user-functions* | |
| 9352 | |
| 9353 New functions can be defined. These can be called just like builtin | |
| 9354 functions. The function executes a sequence of Ex commands. Normal mode | |
| 9355 commands can be executed with the |:normal| command. | |
| 9356 | |
| 9357 The function name must start with an uppercase letter, to avoid confusion with | |
| 9358 builtin functions. To prevent from using the same name in different scripts | |
| 9359 avoid obvious, short names. A good habit is to start the function name with | |
| 9360 the name of the script, e.g., "HTMLcolor()". | |
| 9361 | |
| 504 | 9362 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 9363 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 9364 |
| 9365 *local-function* | |
| 9366 A function local to a script must start with "s:". A local script function | |
| 9367 can only be called from within the script and from functions, user commands | |
| 9368 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 9369 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 9370 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 9371 There are only script-local functions, no buffer-local or window-local |
| 9372 functions. | |
| 7 | 9373 |
| 9374 *:fu* *:function* *E128* *E129* *E123* | |
| 9375 :fu[nction] List all functions and their arguments. | |
| 9376 | |
| 9377 :fu[nction] {name} List function {name}. | |
| 685 | 9378 {name} can also be a |Dictionary| entry that is a |
| 9379 |Funcref|: > | |
| 114 | 9380 :function dict.init |
| 504 | 9381 |
| 9382 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 9383 Example that lists all functions ending with "File": > | |
| 9384 :function /File$ | |
| 482 | 9385 < |
| 9386 *:function-verbose* | |
| 9387 When 'verbose' is non-zero, listing a function will also display where it was | |
| 9388 last defined. Example: > | |
| 9389 | |
| 9390 :verbose function SetFileTypeSH | |
| 9391 function SetFileTypeSH(name) | |
| 9392 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 9393 < | |
| 484 | 9394 See |:verbose-cmd| for more information. |
| 482 | 9395 |
| 5862 | 9396 *E124* *E125* *E853* *E884* |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9397 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9398 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
|
9399 the function follows in the next lines, until the |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9400 matching |:endfunction|. |
| 12785 | 9401 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9402 The name must be made of alphanumeric characters and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9403 '_', and must start with a capital or "s:" (see |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9404 above). Note that using "b:" or "g:" is not allowed. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9405 (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
|
9406 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
|
9407 Before that patch no error was given). |
| 114 | 9408 |
| 685 | 9409 {name} can also be a |Dictionary| entry that is a |
| 9410 |Funcref|: > | |
| 114 | 9411 :function dict.init(arg) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9412 < "dict" must be an existing dictionary. The entry |
| 114 | 9413 "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
|
9414 is required to overwrite an existing function. The |
| 114 | 9415 result is a |Funcref| to a numbered function. The |
| 9416 function can only be used with a |Funcref| and will be | |
| 9417 deleted if there are no more references to it. | |
| 7 | 9418 *E127* *E122* |
| 9419 When a function by this name already exists and [!] is | |
| 9420 not used an error message is given. When [!] is used, | |
| 9421 an existing function is silently replaced. Unless it | |
| 9422 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
|
9423 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
|
9424 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
|
9425 which is hard to debug. |
| 133 | 9426 |
| 9427 For the {arguments} see |function-argument|. | |
| 9428 | |
| 5618 | 9429 *:func-range* *a:firstline* *a:lastline* |
| 7 | 9430 When the [range] argument is added, the function is |
| 9431 expected to take care of a range itself. The range is | |
| 9432 passed as "a:firstline" and "a:lastline". If [range] | |
| 9433 is excluded, ":{range}call" will call the function for | |
| 9434 each line in the range, with the cursor on the start | |
| 9435 of each line. See |function-range-example|. | |
| 3967 | 9436 The cursor is still moved to the first line of the |
| 9437 range, as is the case with all Ex commands. | |
| 5618 | 9438 *:func-abort* |
| 7 | 9439 When the [abort] argument is added, the function will |
| 9440 abort as soon as an error is detected. | |
| 5618 | 9441 *:func-dict* |
| 102 | 9442 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
|
9443 be invoked through an entry in a |Dictionary|. The |
| 102 | 9444 local variable "self" will then be set to the |
| 9445 dictionary. See |Dictionary-function|. | |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9446 *:func-closure* *E932* |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9447 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
|
9448 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
|
9449 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
|
9450 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
|
9451 remains referenced even after Foo() returns: > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9452 :function! Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9453 : let x = 0 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9454 : function! Bar() closure |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9455 : let x += 1 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9456 : return x |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9457 : endfunction |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
9458 : return funcref('Bar') |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9459 :endfunction |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9460 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9461 :let F = Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9462 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9463 < 1 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9464 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9465 < 2 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9466 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
9467 < 3 |
| 7 | 9468 |
| 1621 | 9469 *function-search-undo* |
| 653 | 9470 The last used search pattern and the redo command "." |
| 1621 | 9471 will not be changed by the function. This also |
| 9472 implies that the effect of |:nohlsearch| is undone | |
| 9473 when the function returns. | |
| 653 | 9474 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
9475 *: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
|
9476 :endf[unction] [argument] |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9477 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
|
9478 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
|
9479 |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9480 [argument] can be: |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9481 | 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
|
9482 \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
|
9483 " 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
|
9484 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
|
9485 '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
|
9486 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
|
9487 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
|
9488 ignored. |
| 7 | 9489 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
9490 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
|
9491 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
|
9492 :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
|
9493 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
9494 *: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
|
9495 :delf[unction][!] {name} |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9496 Delete function {name}. |
| 685 | 9497 {name} can also be a |Dictionary| entry that is a |
| 9498 |Funcref|: > | |
| 114 | 9499 :delfunc dict.init |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9500 < This will remove the "init" entry from "dict". The |
| 114 | 9501 function is deleted if there are no more references to |
| 9502 it. | |
|
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
9503 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
|
9504 exist. |
| 7 | 9505 *:retu* *:return* *E133* |
| 9506 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 9507 evaluated and returned as the result of the function. | |
| 9508 If "[expr]" is not given, the number 0 is returned. | |
| 9509 When a function ends without an explicit ":return", | |
| 9510 the number 0 is returned. | |
| 9511 Note that there is no check for unreachable lines, | |
| 9512 thus there is no warning if commands follow ":return". | |
| 9513 | |
| 9514 If the ":return" is used after a |:try| but before the | |
| 9515 matching |:finally| (if present), the commands | |
| 9516 following the ":finally" up to the matching |:endtry| | |
| 9517 are executed first. This process applies to all | |
| 9518 nested ":try"s inside the function. The function | |
| 9519 returns at the outermost ":endtry". | |
| 9520 | |
| 133 | 9521 *function-argument* *a:var* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9522 An argument can be defined by giving its name. In the function this can then |
| 133 | 9523 be used as "a:name" ("a:" for argument). |
| 1156 | 9524 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 9525 Up to 20 arguments can be given, separated by commas. After the named |
| 9526 arguments an argument "..." can be specified, which means that more arguments | |
| 9527 may optionally be following. In the function the extra arguments can be used | |
| 9528 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 9529 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 9530 that "a:1" is the same as "a:000[0]". | |
| 148 | 9531 *E742* |
| 9532 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
|
9533 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
|
9534 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
|
9535 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
|
9536 change a |List| or |Dictionary| use |:lockvar|. |
| 133 | 9537 |
| 9538 When not using "...", the number of arguments in a function call must be equal | |
| 9539 to the number of named arguments. When using "...", the number of arguments | |
| 9540 may be larger. | |
| 9541 | |
| 9542 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
|
9543 still supply the () then. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
9544 |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
9545 It is allowed to define another function inside a function body. |
| 133 | 9546 |
| 9547 *local-variables* | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
9548 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
|
9549 function returns. Global variables need to be accessed with "g:". |
| 7 | 9550 |
| 9551 Example: > | |
| 9552 :function Table(title, ...) | |
| 9553 : echohl Title | |
| 9554 : echo a:title | |
| 9555 : echohl None | |
| 140 | 9556 : echo a:0 . " items:" |
| 9557 : for s in a:000 | |
| 9558 : echon ' ' . s | |
| 9559 : endfor | |
| 7 | 9560 :endfunction |
| 9561 | |
| 9562 This function can then be called with: > | |
| 140 | 9563 call Table("Table", "line1", "line2") |
| 9564 call Table("Empty Table") | |
| 7 | 9565 |
| 1156 | 9566 To return more than one value, return a |List|: > |
| 9567 :function Compute(n1, n2) | |
| 7 | 9568 : if a:n2 == 0 |
| 1156 | 9569 : return ["fail", 0] |
| 7 | 9570 : endif |
| 1156 | 9571 : return ["ok", a:n1 / a:n2] |
| 7 | 9572 :endfunction |
| 9573 | |
| 9574 This function can then be called with: > | |
| 1156 | 9575 :let [success, div] = Compute(102, 6) |
| 7 | 9576 :if success == "ok" |
| 9577 : echo div | |
| 9578 :endif | |
| 1156 | 9579 < |
| 786 | 9580 *:cal* *:call* *E107* *E117* |
| 7 | 9581 :[range]cal[l] {name}([arguments]) |
| 9582 Call a function. The name of the function and its arguments | |
| 9583 are as specified with |:function|. Up to 20 arguments can be | |
| 1156 | 9584 used. The returned value is discarded. |
| 7 | 9585 Without a range and for functions that accept a range, the |
| 9586 function is called once. When a range is given the cursor is | |
| 9587 positioned at the start of the first line before executing the | |
| 9588 function. | |
| 9589 When a range is given and the function doesn't handle it | |
| 9590 itself, the function is executed for each line in the range, | |
| 9591 with the cursor in the first column of that line. The cursor | |
| 9592 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
|
9593 call). The arguments are re-evaluated for each line. Thus |
| 7 | 9594 this works: |
| 9595 *function-range-example* > | |
| 9596 :function Mynumber(arg) | |
| 9597 : echo line(".") . " " . a:arg | |
| 9598 :endfunction | |
| 9599 :1,5call Mynumber(getline(".")) | |
| 9600 < | |
| 9601 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 9602 can be used to do something different at the start or end of | |
| 9603 the range. | |
| 9604 | |
| 9605 Example of a function that handles the range itself: > | |
| 9606 | |
| 9607 :function Cont() range | |
| 9608 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 9609 :endfunction | |
| 9610 :4,8call Cont() | |
| 9611 < | |
| 9612 This function inserts the continuation character "\" in front | |
| 9613 of all the lines in the range, except the first one. | |
| 9614 | |
| 1156 | 9615 When the function returns a composite value it can be further |
| 9616 dereferenced, but the range will not be used then. Example: > | |
| 9617 :4,8call GetDict().method() | |
| 9618 < Here GetDict() gets the range but method() does not. | |
| 9619 | |
| 7 | 9620 *E132* |
| 9621 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 9622 option. | |
| 9623 | |
| 161 | 9624 |
| 9625 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 9626 *autoload-functions* |
| 9627 When using many or large functions, it's possible to automatically define them | |
| 161 | 9628 only when they are used. There are two methods: with an autocommand and with |
| 9629 the "autoload" directory in 'runtimepath'. | |
| 9630 | |
| 9631 | |
| 9632 Using an autocommand ~ | |
| 9633 | |
| 170 | 9634 This is introduced in the user manual, section |41.14|. |
| 9635 | |
| 161 | 9636 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 9637 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
|
9638 That makes Vim startup faster. The autocommand should then load the same file |
| 161 | 9639 again, setting a variable to skip the |:finish| command. |
| 9640 | |
| 9641 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 9642 function(s) to be defined. Example: > | |
| 7 | 9643 |
| 9644 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 9645 | |
| 9646 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 9647 "BufNet". Also see |FuncUndefined|. | |
| 9648 | |
| 161 | 9649 |
| 9650 Using an autoload script ~ | |
| 168 | 9651 *autoload* *E746* |
| 170 | 9652 This is introduced in the user manual, section |41.15|. |
| 9653 | |
| 161 | 9654 Using a script in the "autoload" directory is simpler, but requires using |
| 9655 exactly the right file name. A function that can be autoloaded has a name | |
| 9656 like this: > | |
| 9657 | |
| 270 | 9658 :call filename#funcname() |
| 161 | 9659 |
| 9660 When such a function is called, and it is not defined yet, Vim will search the | |
| 9661 "autoload" directories in 'runtimepath' for a script file called | |
| 9662 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 9663 then define the function like this: > | |
| 9664 | |
| 270 | 9665 function filename#funcname() |
| 161 | 9666 echo "Done!" |
| 9667 endfunction | |
| 9668 | |
| 530 | 9669 The file name and the name used before the # in the function must match |
| 161 | 9670 exactly, and the defined function must have the name exactly as it will be |
| 9671 called. | |
| 9672 | |
| 270 | 9673 It is possible to use subdirectories. Every # in the function name works like |
| 9674 a path separator. Thus when calling a function: > | |
| 9675 | |
| 9676 :call foo#bar#func() | |
| 161 | 9677 |
| 9678 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 9679 | |
| 168 | 9680 This also works when reading a variable that has not been set yet: > |
| 9681 | |
| 270 | 9682 :let l = foo#bar#lvar |
| 168 | 9683 |
| 557 | 9684 However, when the autoload script was already loaded it won't be loaded again |
| 9685 for an unknown variable. | |
| 9686 | |
| 168 | 9687 When assigning a value to such a variable nothing special happens. This can |
| 9688 be used to pass settings to the autoload script before it's loaded: > | |
| 9689 | |
| 270 | 9690 :let foo#bar#toggle = 1 |
| 9691 :call foo#bar#func() | |
| 168 | 9692 |
| 164 | 9693 Note that when you make a mistake and call a function that is supposed to be |
| 9694 defined in an autoload script, but the script doesn't actually define the | |
| 9695 function, the script will be sourced every time you try to call the function. | |
| 168 | 9696 And you will get an error message every time. |
| 9697 | |
| 9698 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 9699 other and vice versa, before the used function is defined, it won't work. |
| 168 | 9700 Avoid using the autoload functionality at the toplevel. |
| 161 | 9701 |
| 794 | 9702 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 9703 |vimball| utility. Also read the user manual |distribute-script|. | |
| 9704 | |
| 7 | 9705 ============================================================================== |
| 9706 6. Curly braces names *curly-braces-names* | |
| 9707 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9708 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
|
9709 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
|
9710 wrapped in braces {} like this: > |
| 7 | 9711 my_{adjective}_variable |
| 9712 | |
| 9713 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 9714 that in place of the expression, and re-interprets the whole as a variable | |
| 9715 name. So in the above example, if the variable "adjective" was set to | |
| 9716 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 9717 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 9718 | |
| 9719 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
|
9720 value. For example, the statement > |
| 7 | 9721 echo my_{&background}_message |
| 9722 | |
| 9723 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 9724 on the current value of 'background'. | |
| 9725 | |
| 9726 You can use multiple brace pairs: > | |
| 9727 echo my_{adverb}_{adjective}_message | |
| 9728 ..or even nest them: > | |
| 9729 echo my_{ad{end_of_word}}_message | |
| 9730 where "end_of_word" is either "verb" or "jective". | |
| 9731 | |
| 9732 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 9733 variable name, e.g. this is invalid: > |
| 7 | 9734 :let foo='a + b' |
| 9735 :echo c{foo}d | |
| 9736 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 9737 | |
| 9738 *curly-braces-function-names* | |
| 9739 You can call and define functions by an evaluated name in a similar way. | |
| 9740 Example: > | |
| 9741 :let func_end='whizz' | |
| 9742 :call my_func_{func_end}(parameter) | |
| 9743 | |
| 9744 This would call the function "my_func_whizz(parameter)". | |
| 9745 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9746 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9747 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9748 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9749 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
9750 |
| 7 | 9751 ============================================================================== |
| 9752 7. Commands *expression-commands* | |
| 9753 | |
| 9754 :let {var-name} = {expr1} *:let* *E18* | |
| 9755 Set internal variable {var-name} to the result of the | |
| 9756 expression {expr1}. The variable will get the type | |
| 9757 from the {expr}. If {var-name} didn't exist yet, it | |
| 9758 is created. | |
| 9759 | |
| 85 | 9760 :let {var-name}[{idx}] = {expr1} *E689* |
| 9761 Set a list item to the result of the expression | |
| 9762 {expr1}. {var-name} must refer to a list and {idx} | |
| 9763 must be a valid index in that list. For nested list | |
| 9764 the index can be repeated. | |
| 1621 | 9765 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
|
9766 This cannot be used to set a byte in a String. You |
| 1621 | 9767 can do that like this: > |
| 9768 :let var = var[0:2] . 'X' . var[4:] | |
| 9769 < | |
| 114 | 9770 *E711* *E719* |
| 9771 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 9772 Set a sequence of items in a |List| to the result of |
| 9773 the expression {expr1}, which must be a list with the | |
| 87 | 9774 correct number of items. |
| 9775 {idx1} can be omitted, zero is used instead. | |
| 9776 {idx2} can be omitted, meaning the end of the list. | |
| 9777 When the selected range of items is partly past the | |
| 9778 end of the list, items will be added. | |
| 9779 | |
| 153 | 9780 *:let+=* *:let-=* *:let.=* *E734* |
| 114 | 9781 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 9782 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
| 9783 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". | |
| 9784 These fail if {var} was not set yet and when the type | |
| 9785 of {var} and {expr1} don't fit the operator. | |
| 9786 | |
| 9787 | |
| 7 | 9788 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 9789 Set environment variable {env-name} to the result of | |
| 9790 the expression {expr1}. The type is always String. | |
| 114 | 9791 :let ${env-name} .= {expr1} |
| 9792 Append {expr1} to the environment variable {env-name}. | |
| 9793 If the environment variable didn't exist yet this | |
| 9794 works like "=". | |
| 7 | 9795 |
| 9796 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 9797 Write the result of the expression {expr1} in register | |
| 9798 {reg-name}. {reg-name} must be a single letter, and | |
| 9799 must be the name of a writable register (see | |
| 9800 |registers|). "@@" can be used for the unnamed | |
| 9801 register, "@/" for the search pattern. | |
| 9802 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 9803 register will be linewise, otherwise it will be set to | |
| 9804 characterwise. | |
| 9805 This can be used to clear the last search pattern: > | |
| 9806 :let @/ = "" | |
| 9807 < This is different from searching for an empty string, | |
| 9808 that would match everywhere. | |
| 9809 | |
| 114 | 9810 :let @{reg-name} .= {expr1} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9811 Append {expr1} to register {reg-name}. If the |
| 114 | 9812 register was empty it's like setting it to {expr1}. |
| 9813 | |
| 1156 | 9814 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 9815 Set option {option-name} to the result of the |
| 68 | 9816 expression {expr1}. A String or Number value is |
| 9817 always converted to the type of the option. | |
| 7 | 9818 For an option local to a window or buffer the effect |
| 9819 is just like using the |:set| command: both the local | |
| 555 | 9820 value and the global value are changed. |
| 68 | 9821 Example: > |
| 9822 :let &path = &path . ',/usr/local/include' | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9823 < This also works for terminal codes in the form t_xx. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9824 But only for alphanumerical names. Example: > |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9825 :let &t_k1 = "\<Esc>[234;" |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
9826 < 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
|
9827 a terminal key code, there is no error. |
| 7 | 9828 |
| 114 | 9829 :let &{option-name} .= {expr1} |
| 9830 For a string option: Append {expr1} to the value. | |
| 9831 Does not insert a comma like |:set+=|. | |
| 9832 | |
| 9833 :let &{option-name} += {expr1} | |
| 9834 :let &{option-name} -= {expr1} | |
| 9835 For a number or boolean option: Add or subtract | |
| 9836 {expr1}. | |
| 9837 | |
| 7 | 9838 :let &l:{option-name} = {expr1} |
| 114 | 9839 :let &l:{option-name} .= {expr1} |
| 9840 :let &l:{option-name} += {expr1} | |
| 9841 :let &l:{option-name} -= {expr1} | |
| 7 | 9842 Like above, but only set the local value of an option |
| 9843 (if there is one). Works like |:setlocal|. | |
| 9844 | |
| 9845 :let &g:{option-name} = {expr1} | |
| 114 | 9846 :let &g:{option-name} .= {expr1} |
| 9847 :let &g:{option-name} += {expr1} | |
| 9848 :let &g:{option-name} -= {expr1} | |
| 7 | 9849 Like above, but only set the global value of an option |
| 9850 (if there is one). Works like |:setglobal|. | |
| 9851 | |
| 85 | 9852 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 9853 {expr1} must evaluate to a |List|. The first item in |
| 68 | 9854 the list is assigned to {name1}, the second item to |
| 9855 {name2}, etc. | |
| 9856 The number of names must match the number of items in | |
| 685 | 9857 the |List|. |
| 68 | 9858 Each name can be one of the items of the ":let" |
| 9859 command as mentioned above. | |
| 9860 Example: > | |
| 9861 :let [s, item] = GetItem(s) | |
| 114 | 9862 < Detail: {expr1} is evaluated first, then the |
| 9863 assignments are done in sequence. This matters if | |
| 9864 {name2} depends on {name1}. Example: > | |
| 9865 :let x = [0, 1] | |
| 9866 :let i = 0 | |
| 9867 :let [i, x[i]] = [1, 2] | |
| 9868 :echo x | |
| 9869 < The result is [0, 2]. | |
| 9870 | |
| 9871 :let [{name1}, {name2}, ...] .= {expr1} | |
| 9872 :let [{name1}, {name2}, ...] += {expr1} | |
| 9873 :let [{name1}, {name2}, ...] -= {expr1} | |
| 9874 Like above, but append/add/subtract the value for each | |
| 685 | 9875 |List| item. |
| 68 | 9876 |
| 9877 :let [{name}, ..., ; {lastname}] = {expr1} | |
| 685 | 9878 Like |:let-unpack| above, but the |List| may have more |
| 114 | 9879 items than there are names. A list of the remaining |
| 9880 items is assigned to {lastname}. If there are no | |
| 9881 remaining items {lastname} is set to an empty list. | |
| 68 | 9882 Example: > |
| 9883 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 9884 < | |
| 114 | 9885 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 9886 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 9887 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 9888 Like above, but append/add/subtract the value for each | |
| 685 | 9889 |List| item. |
| 2596 | 9890 |
| 9891 *E121* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9892 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 9893 variable names may be given. Special names recognized |
| 9894 here: *E738* | |
| 777 | 9895 g: global variables |
| 9896 b: local buffer variables | |
| 9897 w: local window variables | |
| 819 | 9898 t: local tab page variables |
| 777 | 9899 s: script-local variables |
| 9900 l: local function variables | |
| 123 | 9901 v: Vim variables. |
| 7 | 9902 |
| 55 | 9903 :let List the values of all variables. The type of the |
| 9904 variable is indicated before the value: | |
| 9905 <nothing> String | |
| 9906 # Number | |
| 856 | 9907 * Funcref |
| 7 | 9908 |
| 148 | 9909 |
| 1156 | 9910 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 9911 Remove the internal variable {name}. Several variable |
| 9912 names can be given, they are all removed. The name | |
| 685 | 9913 may also be a |List| or |Dictionary| item. |
| 7 | 9914 With [!] no error message is given for non-existing |
| 9915 variables. | |
| 685 | 9916 One or more items from a |List| can be removed: > |
| 108 | 9917 :unlet list[3] " remove fourth item |
| 9918 :unlet list[3:] " remove fourth item to last | |
| 685 | 9919 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 9920 :unlet dict['two'] |
| 9921 :unlet dict.two | |
| 1668 | 9922 < This is especially useful to clean up used global |
| 9923 variables and script-local variables (these are not | |
| 9924 deleted when the script ends). Function-local | |
| 9925 variables are automatically deleted when the function | |
| 9926 ends. | |
| 7 | 9927 |
| 148 | 9928 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 9929 Lock the internal variable {name}. Locking means that | |
| 9930 it can no longer be changed (until it is unlocked). | |
| 9931 A locked variable can be deleted: > | |
| 9932 :lockvar v | |
| 9933 :let v = 'asdf' " fails! | |
| 9934 :unlet v | |
|
10908
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
9935 < *E741* *E940* |
| 148 | 9936 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
|
9937 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
|
9938 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
|
9939 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
|
9940 variable {name}". |
| 148 | 9941 |
| 685 | 9942 [depth] is relevant when locking a |List| or |
| 9943 |Dictionary|. It specifies how deep the locking goes: | |
| 9944 1 Lock the |List| or |Dictionary| itself, | |
| 148 | 9945 cannot add or remove items, but can |
| 9946 still change their values. | |
| 9947 2 Also lock the values, cannot change | |
| 685 | 9948 the items. If an item is a |List| or |
| 9949 |Dictionary|, cannot add or remove | |
| 148 | 9950 items, but can still change the |
| 9951 values. | |
| 685 | 9952 3 Like 2 but for the |List| / |
| 9953 |Dictionary| in the |List| / | |
| 9954 |Dictionary|, one level deeper. | |
| 9955 The default [depth] is 2, thus when {name} is a |List| | |
| 9956 or |Dictionary| the values cannot be changed. | |
| 148 | 9957 *E743* |
| 9958 For unlimited depth use [!] and omit [depth]. | |
| 9959 However, there is a maximum depth of 100 to catch | |
| 9960 loops. | |
| 9961 | |
| 685 | 9962 Note that when two variables refer to the same |List| |
| 9963 and you lock one of them, the |List| will also be | |
| 819 | 9964 locked when used through the other variable. |
| 9965 Example: > | |
| 148 | 9966 :let l = [0, 1, 2, 3] |
| 9967 :let cl = l | |
| 9968 :lockvar l | |
| 9969 :let cl[1] = 99 " won't work! | |
| 9970 < You may want to make a copy of a list to avoid this. | |
| 9971 See |deepcopy()|. | |
| 9972 | |
| 9973 | |
| 9974 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 9975 Unlock the internal variable {name}. Does the | |
| 9976 opposite of |:lockvar|. | |
| 9977 | |
| 9978 | |
| 7 | 9979 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580* |
| 9980 :en[dif] Execute the commands until the next matching ":else" | |
| 9981 or ":endif" if {expr1} evaluates to non-zero. | |
| 9982 | |
| 9983 From Vim version 4.5 until 5.0, every Ex command in | |
| 9984 between the ":if" and ":endif" is ignored. These two | |
| 9985 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
|
9986 backward compatible way. Nesting was allowed. Note |
| 7 | 9987 that any ":else" or ":elseif" was ignored, the "else" |
| 9988 part was not executed either. | |
| 9989 | |
| 9990 You can use this to remain compatible with older | |
| 9991 versions: > | |
| 9992 :if version >= 500 | |
| 9993 : version-5-specific-commands | |
| 9994 :endif | |
| 9995 < The commands still need to be parsed to find the | |
| 9996 "endif". Sometimes an older Vim has a problem with a | |
| 9997 new command. For example, ":silent" is recognized as | |
| 9998 a ":substitute" command. In that case ":execute" can | |
| 9999 avoid problems: > | |
| 10000 :if version >= 600 | |
| 10001 : execute "silent 1,$delete" | |
| 10002 :endif | |
| 10003 < | |
| 10004 NOTE: The ":append" and ":insert" commands don't work | |
| 10005 properly in between ":if" and ":endif". | |
| 10006 | |
| 10007 *:else* *:el* *E581* *E583* | |
| 10008 :el[se] Execute the commands until the next matching ":else" | |
| 10009 or ":endif" if they previously were not being | |
| 10010 executed. | |
| 10011 | |
| 10012 *:elseif* *:elsei* *E582* *E584* | |
| 10013 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 10014 is no extra ":endif". | |
| 10015 | |
| 10016 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 10017 *E170* *E585* *E588* *E733* |
| 7 | 10018 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 10019 as long as {expr1} evaluates to non-zero. | |
| 10020 When an error is detected from a command inside the | |
| 10021 loop, execution continues after the "endwhile". | |
| 75 | 10022 Example: > |
| 10023 :let lnum = 1 | |
| 10024 :while lnum <= line("$") | |
| 10025 :call FixLine(lnum) | |
| 10026 :let lnum = lnum + 1 | |
| 10027 :endwhile | |
| 10028 < | |
| 7 | 10029 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 10030 properly inside a ":while" and ":for" loop. |
| 75 | 10031 |
| 114 | 10032 :for {var} in {list} *:for* *E690* *E732* |
| 75 | 10033 :endfo[r] *:endfo* *:endfor* |
| 10034 Repeat the commands between ":for" and ":endfor" for | |
| 158 | 10035 each item in {list}. Variable {var} is set to the |
| 79 | 10036 value of each item. |
| 10037 When an error is detected for a command inside the | |
| 75 | 10038 loop, execution continues after the "endfor". |
| 464 | 10039 Changing {list} inside the loop affects what items are |
| 10040 used. Make a copy if this is unwanted: > | |
| 79 | 10041 :for item in copy(mylist) |
| 10042 < When not making a copy, Vim stores a reference to the | |
| 10043 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
|
10044 with the current item. Thus the current item can be |
| 79 | 10045 removed without effect. Removing any later item means |
| 10046 it will not be found. Thus the following example | |
| 10047 works (an inefficient way to make a list empty): > | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10048 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10049 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10050 endfor |
| 87 | 10051 < Note that reordering the list (e.g., with sort() or |
| 10052 reverse()) may have unexpected effects. | |
| 75 | 10053 |
| 10054 :for [{var1}, {var2}, ...] in {listlist} | |
| 10055 :endfo[r] | |
| 10056 Like ":for" above, but each item in {listlist} must be | |
| 10057 a list, of which each item is assigned to {var1}, | |
| 10058 {var2}, etc. Example: > | |
| 10059 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 10060 :echo getline(lnum)[col] | |
| 10061 :endfor | |
| 10062 < | |
| 7 | 10063 *:continue* *:con* *E586* |
| 75 | 10064 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 10065 to the start of the loop. | |
| 10066 If it is used after a |:try| inside the loop but | |
| 10067 before the matching |:finally| (if present), the | |
| 10068 commands following the ":finally" up to the matching | |
| 10069 |:endtry| are executed first. This process applies to | |
| 10070 all nested ":try"s inside the loop. The outermost | |
| 10071 ":endtry" then jumps back to the start of the loop. | |
| 7 | 10072 |
| 10073 *:break* *:brea* *E587* | |
| 75 | 10074 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 10075 the command after the matching ":endwhile" or | |
| 10076 ":endfor". | |
| 10077 If it is used after a |:try| inside the loop but | |
| 10078 before the matching |:finally| (if present), the | |
| 10079 commands following the ":finally" up to the matching | |
| 10080 |:endtry| are executed first. This process applies to | |
| 10081 all nested ":try"s inside the loop. The outermost | |
| 10082 ":endtry" then jumps to the command after the loop. | |
| 7 | 10083 |
| 10084 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 10085 :endt[ry] Change the error handling for the commands between | |
| 10086 ":try" and ":endtry" including everything being | |
| 10087 executed across ":source" commands, function calls, | |
| 10088 or autocommand invocations. | |
| 10089 | |
| 10090 When an error or interrupt is detected and there is | |
| 10091 a |:finally| command following, execution continues | |
| 10092 after the ":finally". Otherwise, or when the | |
| 10093 ":endtry" is reached thereafter, the next | |
| 10094 (dynamically) surrounding ":try" is checked for | |
| 10095 a corresponding ":finally" etc. Then the script | |
| 10096 processing is terminated. (Whether a function | |
| 10097 definition has an "abort" argument does not matter.) | |
| 10098 Example: > | |
| 10099 :try | edit too much | finally | echo "cleanup" | endtry | |
| 10100 :echo "impossible" " not reached, script terminated above | |
| 10101 < | |
| 10102 Moreover, an error or interrupt (dynamically) inside | |
| 10103 ":try" and ":endtry" is converted to an exception. It | |
| 10104 can be caught as if it were thrown by a |:throw| | |
| 10105 command (see |:catch|). In this case, the script | |
| 10106 processing is not terminated. | |
| 10107 | |
| 10108 The value "Vim:Interrupt" is used for an interrupt | |
| 10109 exception. An error in a Vim command is converted | |
| 10110 to a value of the form "Vim({command}):{errmsg}", | |
| 10111 other errors are converted to a value of the form | |
| 10112 "Vim:{errmsg}". {command} is the full command name, | |
| 10113 and {errmsg} is the message that is displayed if the | |
| 10114 error exception is not caught, always beginning with | |
| 10115 the error number. | |
| 10116 Examples: > | |
| 10117 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry | |
| 10118 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 10119 < | |
| 10120 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10121 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 10122 |:finally|, or |:endtry| that belongs to the same |
| 10123 |:try| as the ":catch" are executed when an exception | |
| 10124 matching {pattern} is being thrown and has not yet | |
| 10125 been caught by a previous ":catch". Otherwise, these | |
| 10126 commands are skipped. | |
| 10127 When {pattern} is omitted all errors are caught. | |
| 10128 Examples: > | |
| 10129 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) | |
| 10130 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors | |
| 10131 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts | |
| 10132 :catch /^Vim(write):/ " catch all errors in :write | |
| 10133 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123 | |
| 10134 :catch /my-exception/ " catch user exception | |
| 10135 :catch /.*/ " catch everything | |
| 10136 :catch " same as /.*/ | |
| 10137 < | |
| 10138 Another character can be used instead of / around the | |
| 10139 {pattern}, so long as it does not have a special | |
| 10140 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 10141 {pattern}. | |
| 5814 | 10142 Information about the exception is available in |
| 10143 |v:exception|. Also see |throw-variables|. | |
| 7 | 10144 NOTE: It is not reliable to ":catch" the TEXT of |
| 10145 an error message because it may vary in different | |
| 10146 locales. | |
| 10147 | |
| 10148 *:fina* *:finally* *E606* *E607* | |
| 10149 :fina[lly] The following commands until the matching |:endtry| | |
| 10150 are executed whenever the part between the matching | |
| 10151 |:try| and the ":finally" is left: either by falling | |
| 10152 through to the ":finally" or by a |:continue|, | |
| 10153 |:break|, |:finish|, or |:return|, or by an error or | |
| 10154 interrupt or exception (see |:throw|). | |
| 10155 | |
| 10156 *:th* *:throw* *E608* | |
| 10157 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 10158 If the ":throw" is used after a |:try| but before the | |
| 10159 first corresponding |:catch|, commands are skipped | |
| 10160 until the first ":catch" matching {expr1} is reached. | |
| 10161 If there is no such ":catch" or if the ":throw" is | |
| 10162 used after a ":catch" but before the |:finally|, the | |
| 10163 commands following the ":finally" (if present) up to | |
| 10164 the matching |:endtry| are executed. If the ":throw" | |
| 10165 is after the ":finally", commands up to the ":endtry" | |
| 10166 are skipped. At the ":endtry", this process applies | |
| 10167 again for the next dynamically surrounding ":try" | |
| 10168 (which may be found in a calling function or sourcing | |
| 10169 script), until a matching ":catch" has been found. | |
| 10170 If the exception is not caught, the command processing | |
| 10171 is terminated. | |
| 10172 Example: > | |
| 10173 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 10174 < Note that "catch" may need to be on a separate line |
| 10175 for when an error causes the parsing to skip the whole | |
| 10176 line and not see the "|" that separates the commands. | |
| 7 | 10177 |
| 10178 *:ec* *:echo* | |
| 10179 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 10180 first {expr1} starts on a new line. | |
| 10181 Also see |:comment|. | |
| 10182 Use "\n" to start a new line. Use "\r" to move the | |
| 10183 cursor to the first column. | |
| 10184 Uses the highlighting set by the |:echohl| command. | |
| 10185 Cannot be followed by a comment. | |
| 10186 Example: > | |
| 10187 :echo "the value of 'shell' is" &shell | |
| 1156 | 10188 < *:echo-redraw* |
| 10189 A later redraw may make the message disappear again. | |
| 10190 And since Vim mostly postpones redrawing until it's | |
| 10191 finished with a sequence of commands this happens | |
| 10192 quite often. To avoid that a command from before the | |
| 10193 ":echo" causes a redraw afterwards (redraws are often | |
| 10194 postponed until you type something), force a redraw | |
| 10195 with the |:redraw| command. Example: > | |
| 7 | 10196 :new | redraw | echo "there is a new window" |
| 10197 < | |
| 10198 *:echon* | |
| 10199 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 10200 |:comment|. | |
| 10201 Uses the highlighting set by the |:echohl| command. | |
| 10202 Cannot be followed by a comment. | |
| 10203 Example: > | |
| 10204 :echon "the value of 'shell' is " &shell | |
| 10205 < | |
| 10206 Note the difference between using ":echo", which is a | |
| 10207 Vim command, and ":!echo", which is an external shell | |
| 10208 command: > | |
| 10209 :!echo % --> filename | |
| 10210 < The arguments of ":!" are expanded, see |:_%|. > | |
| 10211 :!echo "%" --> filename or "filename" | |
| 10212 < Like the previous example. Whether you see the double | |
| 10213 quotes or not depends on your 'shell'. > | |
| 10214 :echo % --> nothing | |
| 10215 < The '%' is an illegal character in an expression. > | |
| 10216 :echo "%" --> % | |
| 10217 < This just echoes the '%' character. > | |
| 10218 :echo expand("%") --> filename | |
| 10219 < This calls the expand() function to expand the '%'. | |
| 10220 | |
| 10221 *:echoh* *:echohl* | |
| 10222 :echoh[l] {name} Use the highlight group {name} for the following | |
| 10223 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 10224 for the |input()| prompt. Example: > | |
| 10225 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 10226 < Don't forget to set the group back to "None", | |
| 10227 otherwise all following echo's will be highlighted. | |
| 10228 | |
| 10229 *:echom* *:echomsg* | |
| 10230 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 10231 message in the |message-history|. | |
| 10232 Spaces are placed between the arguments as with the | |
| 10233 |:echo| command. But unprintable characters are | |
| 10234 displayed, not interpreted. | |
| 1156 | 10235 The parsing works slightly different from |:echo|, |
| 10236 more like |:execute|. All the expressions are first | |
| 10237 evaluated and concatenated before echoing anything. | |
| 10238 The expressions must evaluate to a Number or String, a | |
| 10239 Dictionary or List causes an error. | |
| 7 | 10240 Uses the highlighting set by the |:echohl| command. |
| 10241 Example: > | |
| 10242 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 10243 < See |:echo-redraw| to avoid the message disappearing |
| 10244 when the screen is redrawn. | |
| 7 | 10245 *:echoe* *:echoerr* |
| 10246 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 10247 message in the |message-history|. When used in a | |
| 10248 script or function the line number will be added. | |
| 10249 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
|
10250 :echo command. When used inside a try conditional, |
| 7 | 10251 the message is raised as an error exception instead |
| 10252 (see |try-echoerr|). | |
| 10253 Example: > | |
| 10254 :echoerr "This script just failed!" | |
| 10255 < If you just want a highlighted message use |:echohl|. | |
| 10256 And to get a beep: > | |
| 10257 :exe "normal \<Esc>" | |
| 10258 < | |
| 10259 *:exe* *:execute* | |
| 10260 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 10261 of {expr1} as an Ex command. |
| 10262 Multiple arguments are concatenated, with a space in | |
| 10263 between. To avoid the extra space use the "." | |
| 10264 operator to concatenate strings into one argument. | |
| 10265 {expr1} is used as the processed command, command line | |
| 10266 editing keys are not recognized. | |
| 7 | 10267 Cannot be followed by a comment. |
| 10268 Examples: > | |
| 2152 | 10269 :execute "buffer" nextbuf |
| 10270 :execute "normal" count . "w" | |
| 7 | 10271 < |
| 10272 ":execute" can be used to append a command to commands | |
| 10273 that don't accept a '|'. Example: > | |
| 10274 :execute '!ls' | echo "theend" | |
| 10275 | |
| 10276 < ":execute" is also a nice way to avoid having to type | |
| 10277 control characters in a Vim script for a ":normal" | |
| 10278 command: > | |
| 10279 :execute "normal ixxx\<Esc>" | |
| 10280 < This has an <Esc> character, see |expr-string|. | |
| 10281 | |
| 1621 | 10282 Be careful to correctly escape special characters in |
| 10283 file names. The |fnameescape()| function can be used | |
| 1661 | 10284 for Vim commands, |shellescape()| for |:!| commands. |
| 10285 Examples: > | |
| 1621 | 10286 :execute "e " . fnameescape(filename) |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5690
diff
changeset
|
10287 :execute "!ls " . shellescape(filename, 1) |
| 1621 | 10288 < |
| 7 | 10289 Note: The executed string may be any command-line, but |
| 5763 | 10290 starting or ending "if", "while" and "for" does not |
| 10291 always work, because when commands are skipped the | |
| 10292 ":execute" is not evaluated and Vim loses track of | |
| 10293 where blocks start and end. Also "break" and | |
| 10294 "continue" should not be inside ":execute". | |
| 10295 This example does not work, because the ":execute" is | |
| 10296 not evaluated and Vim does not see the "while", and | |
| 10297 gives an error for finding an ":endwhile": > | |
| 10298 :if 0 | |
| 10299 : execute 'while i > 5' | |
| 10300 : echo "test" | |
| 10301 : endwhile | |
| 10302 :endif | |
| 7 | 10303 < |
| 10304 It is allowed to have a "while" or "if" command | |
| 10305 completely in the executed string: > | |
| 10306 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 10307 < | |
| 10308 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10309 *:exe-comment* |
| 7 | 10310 ":execute", ":echo" and ":echon" cannot be followed by |
| 10311 a comment directly, because they see the '"' as the | |
| 10312 start of a string. But, you can use '|' followed by a | |
| 10313 comment. Example: > | |
| 10314 :echo "foo" | "this is a comment | |
| 10315 | |
| 10316 ============================================================================== | |
| 10317 8. Exception handling *exception-handling* | |
| 10318 | |
| 10319 The Vim script language comprises an exception handling feature. This section | |
| 10320 explains how it can be used in a Vim script. | |
| 10321 | |
| 10322 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 10323 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 10324 exception by using the ":throw" command, see |throw-catch|. | |
| 10325 | |
| 10326 | |
| 10327 TRY CONDITIONALS *try-conditionals* | |
| 10328 | |
| 10329 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 10330 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 10331 a finally clause (to be executed for cleanup). | |
| 10332 A try conditional begins with a |:try| command and ends at the matching | |
| 10333 |:endtry| command. In between, you can use a |:catch| command to start | |
| 10334 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 10335 be none or multiple catch clauses, but there is at most one finally clause, | |
| 10336 which must not be followed by any catch clauses. The lines before the catch | |
| 10337 clauses and the finally clause is called a try block. > | |
| 10338 | |
| 10339 :try | |
| 1621 | 10340 : ... |
| 10341 : ... TRY BLOCK | |
| 10342 : ... | |
| 7 | 10343 :catch /{pattern}/ |
| 1621 | 10344 : ... |
| 10345 : ... CATCH CLAUSE | |
| 10346 : ... | |
| 7 | 10347 :catch /{pattern}/ |
| 1621 | 10348 : ... |
| 10349 : ... CATCH CLAUSE | |
| 10350 : ... | |
| 7 | 10351 :finally |
| 1621 | 10352 : ... |
| 10353 : ... FINALLY CLAUSE | |
| 10354 : ... | |
| 7 | 10355 :endtry |
| 10356 | |
| 10357 The try conditional allows to watch code for exceptions and to take the | |
| 10358 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 10359 from the try block and also the catch clauses may cause cleanup actions. | |
| 10360 When no exception is thrown during execution of the try block, the control | |
| 10361 is transferred to the finally clause, if present. After its execution, the | |
| 10362 script continues with the line following the ":endtry". | |
| 10363 When an exception occurs during execution of the try block, the remaining | |
| 10364 lines in the try block are skipped. The exception is matched against the | |
| 10365 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 10366 after the first matching ":catch" is taken, other catch clauses are not | |
| 10367 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 10368 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 10369 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 10370 continues in the following line as usual. | |
| 10371 When an exception that does not match any of the patterns specified by the | |
| 10372 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 10373 that try conditional and none of the catch clauses is executed. Only the | |
| 10374 finally clause, if present, is taken. The exception pends during execution of | |
| 10375 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 10376 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 10377 see |try-nesting|. | |
| 10378 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
|
10379 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 10380 not matched against the patterns in any of the ":catch" commands of the same |
| 10381 try conditional and none of its catch clauses is taken. If there is, however, | |
| 10382 a finally clause, it is executed, and the exception pends during its | |
| 10383 execution. The commands following the ":endtry" are not executed. The new | |
| 10384 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 10385 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
|
10386 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 10387 clause has been taken because of an exception from the try block or one of the |
| 10388 catch clauses, the original (pending) exception is discarded. The commands | |
| 10389 following the ":endtry" are not executed, and the exception from the finally | |
| 10390 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 10391 | |
| 10392 The finally clause is also executed, when a ":break" or ":continue" for | |
| 10393 a ":while" loop enclosing the complete try conditional is executed from the | |
| 10394 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 10395 from the try block or a catch clause of a try conditional in a function or | |
| 10396 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 10397 ":finish" pends during execution of the finally clause and is resumed when the | |
| 10398 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 10399 from the finally clause. | |
| 10400 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 10401 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 10402 clause, the rest of the finally clause is skipped, and the ":break", | |
| 10403 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 10404 clause has been taken because of an exception or an earlier ":break", | |
| 10405 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 10406 this pending exception or command is discarded. | |
| 10407 | |
| 10408 For examples see |throw-catch| and |try-finally|. | |
| 10409 | |
| 10410 | |
| 10411 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 10412 | |
| 10413 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 10414 conditional can be put into the try block, a catch clause, or the finally | |
| 10415 clause of another try conditional. If the inner try conditional does not | |
| 10416 catch an exception thrown in its try block or throws a new exception from one | |
| 10417 of its catch clauses or its finally clause, the outer try conditional is | |
| 10418 checked according to the rules above. If the inner try conditional is in the | |
| 10419 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
|
10420 otherwise only the finally clause is executed. It does not matter for |
| 7 | 10421 nesting, whether the inner try conditional is directly contained in the outer |
| 10422 one, or whether the outer one sources a script or calls a function containing | |
| 10423 the inner try conditional. | |
| 10424 | |
| 10425 When none of the active try conditionals catches an exception, just their | |
| 10426 finally clauses are executed. Thereafter, the script processing terminates. | |
| 10427 An error message is displayed in case of an uncaught exception explicitly | |
| 10428 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 10429 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 10430 as usual. | |
| 10431 | |
| 10432 For examples see |throw-catch|. | |
| 10433 | |
| 10434 | |
| 10435 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 10436 | |
| 10437 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 10438 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 10439 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 10440 finished. When using a verbosity level of at least 14, things pending in | |
| 10441 a finally clause are also shown. This information is also given in debug mode | |
| 10442 (see |debug-scripts|). | |
| 10443 | |
| 10444 | |
| 10445 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 10446 | |
| 10447 You can throw any number or string as an exception. Use the |:throw| command | |
| 10448 and pass the value to be thrown as argument: > | |
| 10449 :throw 4711 | |
| 10450 :throw "string" | |
| 10451 < *throw-expression* | |
| 10452 You can also specify an expression argument. The expression is then evaluated | |
| 10453 first, and the result is thrown: > | |
| 10454 :throw 4705 + strlen("string") | |
| 10455 :throw strpart("strings", 0, 6) | |
| 10456 | |
| 10457 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 10458 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 10459 The ":throw" command then does not throw a new exception. | |
| 10460 Example: > | |
| 10461 | |
| 10462 :function! Foo(arg) | |
| 10463 : try | |
| 10464 : throw a:arg | |
| 10465 : catch /foo/ | |
| 10466 : endtry | |
| 10467 : return 1 | |
| 10468 :endfunction | |
| 10469 : | |
| 10470 :function! Bar() | |
| 10471 : echo "in Bar" | |
| 10472 : return 4710 | |
| 10473 :endfunction | |
| 10474 : | |
| 10475 :throw Foo("arrgh") + Bar() | |
| 10476 | |
| 10477 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 10478 executed. > | |
| 10479 :throw Foo("foo") + Bar() | |
| 10480 however displays "in Bar" and throws 4711. | |
| 10481 | |
| 10482 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
|
10483 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 10484 exception is then propagated to the caller of the command. |
| 10485 Example: > | |
| 10486 | |
| 10487 :if Foo("arrgh") | |
| 10488 : echo "then" | |
| 10489 :else | |
| 10490 : echo "else" | |
| 10491 :endif | |
| 10492 | |
| 10493 Here neither of "then" or "else" is displayed. | |
| 10494 | |
| 10495 *catch-order* | |
| 10496 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 10497 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 10498 command can be specified as a pattern argument. The subsequent catch clause | |
| 10499 gets executed when a matching exception is caught. | |
| 10500 Example: > | |
| 10501 | |
| 10502 :function! Foo(value) | |
| 10503 : try | |
| 10504 : throw a:value | |
| 10505 : catch /^\d\+$/ | |
| 10506 : echo "Number thrown" | |
| 10507 : catch /.*/ | |
| 10508 : echo "String thrown" | |
| 10509 : endtry | |
| 10510 :endfunction | |
| 10511 : | |
| 10512 :call Foo(0x1267) | |
| 10513 :call Foo('string') | |
| 10514 | |
| 10515 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 10516 An exception is matched against the ":catch" commands in the order they are | |
| 10517 specified. Only the first match counts. So you should place the more | |
| 10518 specific ":catch" first. The following order does not make sense: > | |
| 10519 | |
| 10520 : catch /.*/ | |
| 10521 : echo "String thrown" | |
| 10522 : catch /^\d\+$/ | |
| 10523 : echo "Number thrown" | |
| 10524 | |
| 10525 The first ":catch" here matches always, so that the second catch clause is | |
| 10526 never taken. | |
| 10527 | |
| 10528 *throw-variables* | |
| 10529 If you catch an exception by a general pattern, you may access the exact value | |
| 10530 in the variable |v:exception|: > | |
| 10531 | |
| 10532 : catch /^\d\+$/ | |
| 10533 : echo "Number thrown. Value is" v:exception | |
| 10534 | |
| 10535 You may also be interested where an exception was thrown. This is stored in | |
| 10536 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 10537 exception most recently caught as long it is not finished. | |
| 10538 Example: > | |
| 10539 | |
| 10540 :function! Caught() | |
| 10541 : if v:exception != "" | |
| 10542 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 10543 : else | |
| 10544 : echo 'Nothing caught' | |
| 10545 : endif | |
| 10546 :endfunction | |
| 10547 : | |
| 10548 :function! Foo() | |
| 10549 : try | |
| 10550 : try | |
| 10551 : try | |
| 10552 : throw 4711 | |
| 10553 : finally | |
| 10554 : call Caught() | |
| 10555 : endtry | |
| 10556 : catch /.*/ | |
| 10557 : call Caught() | |
| 10558 : throw "oops" | |
| 10559 : endtry | |
| 10560 : catch /.*/ | |
| 10561 : call Caught() | |
| 10562 : finally | |
| 10563 : call Caught() | |
| 10564 : endtry | |
| 10565 :endfunction | |
| 10566 : | |
| 10567 :call Foo() | |
| 10568 | |
| 10569 This displays > | |
| 10570 | |
| 10571 Nothing caught | |
| 10572 Caught "4711" in function Foo, line 4 | |
| 10573 Caught "oops" in function Foo, line 10 | |
| 10574 Nothing caught | |
| 10575 | |
| 10576 A practical example: The following command ":LineNumber" displays the line | |
| 10577 number in the script or function where it has been used: > | |
| 10578 | |
| 10579 :function! LineNumber() | |
| 10580 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 10581 :endfunction | |
| 10582 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 10583 < | |
| 10584 *try-nested* | |
| 10585 An exception that is not caught by a try conditional can be caught by | |
| 10586 a surrounding try conditional: > | |
| 10587 | |
| 10588 :try | |
| 10589 : try | |
| 10590 : throw "foo" | |
| 10591 : catch /foobar/ | |
| 10592 : echo "foobar" | |
| 10593 : finally | |
| 10594 : echo "inner finally" | |
| 10595 : endtry | |
| 10596 :catch /foo/ | |
| 10597 : echo "foo" | |
| 10598 :endtry | |
| 10599 | |
| 10600 The inner try conditional does not catch the exception, just its finally | |
| 10601 clause is executed. The exception is then caught by the outer try | |
| 10602 conditional. The example displays "inner finally" and then "foo". | |
| 10603 | |
| 10604 *throw-from-catch* | |
| 10605 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 10606 catch clause: > | |
| 10607 | |
| 10608 :function! Foo() | |
| 10609 : throw "foo" | |
| 10610 :endfunction | |
| 10611 : | |
| 10612 :function! Bar() | |
| 10613 : try | |
| 10614 : call Foo() | |
| 10615 : catch /foo/ | |
| 10616 : echo "Caught foo, throw bar" | |
| 10617 : throw "bar" | |
| 10618 : endtry | |
| 10619 :endfunction | |
| 10620 : | |
| 10621 :try | |
| 10622 : call Bar() | |
| 10623 :catch /.*/ | |
| 10624 : echo "Caught" v:exception | |
| 10625 :endtry | |
| 10626 | |
| 10627 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 10628 | |
| 10629 *rethrow* | |
| 10630 There is no real rethrow in the Vim script language, but you may throw | |
| 10631 "v:exception" instead: > | |
| 10632 | |
| 10633 :function! Bar() | |
| 10634 : try | |
| 10635 : call Foo() | |
| 10636 : catch /.*/ | |
| 10637 : echo "Rethrow" v:exception | |
| 10638 : throw v:exception | |
| 10639 : endtry | |
| 10640 :endfunction | |
| 10641 < *try-echoerr* | |
| 10642 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 10643 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 10644 Trying so causes an error exception. You should throw your own exception | |
| 10645 denoting the situation. If you want to cause a Vim error exception containing | |
| 10646 the original error exception value, you can use the |:echoerr| command: > | |
| 10647 | |
| 10648 :try | |
| 10649 : try | |
| 10650 : asdf | |
| 10651 : catch /.*/ | |
| 10652 : echoerr v:exception | |
| 10653 : endtry | |
| 10654 :catch /.*/ | |
| 10655 : echo v:exception | |
| 10656 :endtry | |
| 10657 | |
| 10658 This code displays | |
| 10659 | |
| 1621 | 10660 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 10661 |
| 10662 | |
| 10663 CLEANUP CODE *try-finally* | |
| 10664 | |
| 10665 Scripts often change global settings and restore them at their end. If the | |
| 10666 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
|
10667 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 10668 a script when an error occurs or you explicitly throw an exception without |
| 10669 catching it. You can solve these problems by using a try conditional with | |
| 10670 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 10671 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 10672 (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
|
10673 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 10674 clause has been executed.) |
| 10675 Example: > | |
| 10676 | |
| 10677 :try | |
| 10678 : let s:saved_ts = &ts | |
| 10679 : set ts=17 | |
| 10680 : | |
| 10681 : " Do the hard work here. | |
| 10682 : | |
| 10683 :finally | |
| 10684 : let &ts = s:saved_ts | |
| 10685 : unlet s:saved_ts | |
| 10686 :endtry | |
| 10687 | |
| 10688 This method should be used locally whenever a function or part of a script | |
| 10689 changes global settings which need to be restored on failure or normal exit of | |
| 10690 that function or script part. | |
| 10691 | |
| 10692 *break-finally* | |
| 10693 Cleanup code works also when the try block or a catch clause is left by | |
| 10694 a ":continue", ":break", ":return", or ":finish". | |
| 10695 Example: > | |
| 10696 | |
| 10697 :let first = 1 | |
| 10698 :while 1 | |
| 10699 : try | |
| 10700 : if first | |
| 10701 : echo "first" | |
| 10702 : let first = 0 | |
| 10703 : continue | |
| 10704 : else | |
| 10705 : throw "second" | |
| 10706 : endif | |
| 10707 : catch /.*/ | |
| 10708 : echo v:exception | |
| 10709 : break | |
| 10710 : finally | |
| 10711 : echo "cleanup" | |
| 10712 : endtry | |
| 10713 : echo "still in while" | |
| 10714 :endwhile | |
| 10715 :echo "end" | |
| 10716 | |
| 10717 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 10718 | |
| 10719 :function! Foo() | |
| 10720 : try | |
| 10721 : return 4711 | |
| 10722 : finally | |
| 10723 : echo "cleanup\n" | |
| 10724 : endtry | |
| 10725 : echo "Foo still active" | |
| 10726 :endfunction | |
| 10727 : | |
| 10728 :echo Foo() "returned by Foo" | |
| 10729 | |
| 10730 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
|
10731 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 10732 return value.) |
| 10733 | |
| 10734 *except-from-finally* | |
| 10735 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 10736 a finally clause is possible, but not recommended since it abandons the | |
| 10737 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 10738 exceptions might get raised from a finally clause. | |
| 10739 Example where an error in the finally clause stops an interrupt from | |
| 10740 working correctly: > | |
| 10741 | |
| 10742 :try | |
| 10743 : try | |
| 10744 : echo "Press CTRL-C for interrupt" | |
| 10745 : while 1 | |
| 10746 : endwhile | |
| 10747 : finally | |
| 10748 : unlet novar | |
| 10749 : endtry | |
| 10750 :catch /novar/ | |
| 10751 :endtry | |
| 10752 :echo "Script still running" | |
| 10753 :sleep 1 | |
| 10754 | |
| 10755 If you need to put commands that could fail into a finally clause, you should | |
| 10756 think about catching or ignoring the errors in these commands, see | |
| 10757 |catch-errors| and |ignore-errors|. | |
| 10758 | |
| 10759 | |
| 10760 CATCHING ERRORS *catch-errors* | |
| 10761 | |
| 10762 If you want to catch specific errors, you just have to put the code to be | |
| 10763 watched in a try block and add a catch clause for the error message. The | |
| 10764 presence of the try conditional causes all errors to be converted to an | |
| 10765 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 10766 the right pattern for the ":catch" command, you have to know how the format of | |
| 10767 the error exception is. | |
| 10768 Error exceptions have the following format: > | |
| 10769 | |
| 10770 Vim({cmdname}):{errmsg} | |
| 10771 or > | |
| 10772 Vim:{errmsg} | |
| 10773 | |
| 10774 {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
|
10775 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 10776 when the error occurs outside try conditionals. It always begins with |
| 10777 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 10778 a space. | |
| 10779 | |
| 10780 Examples: | |
| 10781 | |
| 10782 The command > | |
| 10783 :unlet novar | |
| 10784 normally produces the error message > | |
| 10785 E108: No such variable: "novar" | |
| 10786 which is converted inside try conditionals to an exception > | |
| 10787 Vim(unlet):E108: No such variable: "novar" | |
| 10788 | |
| 10789 The command > | |
| 10790 :dwim | |
| 10791 normally produces the error message > | |
| 10792 E492: Not an editor command: dwim | |
| 10793 which is converted inside try conditionals to an exception > | |
| 10794 Vim:E492: Not an editor command: dwim | |
| 10795 | |
| 10796 You can catch all ":unlet" errors by a > | |
| 10797 :catch /^Vim(unlet):/ | |
| 10798 or all errors for misspelled command names by a > | |
| 10799 :catch /^Vim:E492:/ | |
| 10800 | |
| 10801 Some error messages may be produced by different commands: > | |
| 10802 :function nofunc | |
| 10803 and > | |
| 10804 :delfunction nofunc | |
| 10805 both produce the error message > | |
| 10806 E128: Function name must start with a capital: nofunc | |
| 10807 which is converted inside try conditionals to an exception > | |
| 10808 Vim(function):E128: Function name must start with a capital: nofunc | |
| 10809 or > | |
| 10810 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 10811 respectively. You can catch the error by its number independently on the | |
| 10812 command that caused it if you use the following pattern: > | |
| 10813 :catch /^Vim(\a\+):E128:/ | |
| 10814 | |
| 10815 Some commands like > | |
| 10816 :let x = novar | |
| 10817 produce multiple error messages, here: > | |
| 10818 E121: Undefined variable: novar | |
| 10819 E15: Invalid expression: novar | |
| 10820 Only the first is used for the exception value, since it is the most specific | |
| 10821 one (see |except-several-errors|). So you can catch it by > | |
| 10822 :catch /^Vim(\a\+):E121:/ | |
| 10823 | |
| 10824 You can catch all errors related to the name "nofunc" by > | |
| 10825 :catch /\<nofunc\>/ | |
| 10826 | |
| 10827 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 10828 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 10829 | |
| 10830 You can catch all Vim errors by the pattern > | |
| 10831 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 10832 < | |
| 10833 *catch-text* | |
| 10834 NOTE: You should never catch the error message text itself: > | |
| 10835 :catch /No such variable/ | |
| 6647 | 10836 only works in the English locale, but not when the user has selected |
| 7 | 10837 a different language by the |:language| command. It is however helpful to |
| 10838 cite the message text in a comment: > | |
| 10839 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 10840 | |
| 10841 | |
| 10842 IGNORING ERRORS *ignore-errors* | |
| 10843 | |
| 10844 You can ignore errors in a specific Vim command by catching them locally: > | |
| 10845 | |
| 10846 :try | |
| 10847 : write | |
| 10848 :catch | |
| 10849 :endtry | |
| 10850 | |
| 10851 But you are strongly recommended NOT to use this simple form, since it could | |
| 10852 catch more than you want. With the ":write" command, some autocommands could | |
| 10853 be executed and cause errors not related to writing, for instance: > | |
| 10854 | |
| 10855 :au BufWritePre * unlet novar | |
| 10856 | |
| 10857 There could even be such errors you are not responsible for as a script | |
| 10858 writer: a user of your script might have defined such autocommands. You would | |
| 10859 then hide the error from the user. | |
| 10860 It is much better to use > | |
| 10861 | |
| 10862 :try | |
| 10863 : write | |
| 10864 :catch /^Vim(write):/ | |
| 10865 :endtry | |
| 10866 | |
| 10867 which only catches real write errors. So catch only what you'd like to ignore | |
| 10868 intentionally. | |
| 10869 | |
| 10870 For a single command that does not cause execution of autocommands, you could | |
| 10871 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 10872 command: > | |
| 10873 :silent! nunmap k | |
| 10874 This works also when a try conditional is active. | |
| 10875 | |
| 10876 | |
| 10877 CATCHING INTERRUPTS *catch-interrupt* | |
| 10878 | |
| 10879 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
|
10880 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 10881 script is not terminated, then. |
| 10882 Example: > | |
| 10883 | |
| 10884 :function! TASK1() | |
| 10885 : sleep 10 | |
| 10886 :endfunction | |
| 10887 | |
| 10888 :function! TASK2() | |
| 10889 : sleep 20 | |
| 10890 :endfunction | |
| 10891 | |
| 10892 :while 1 | |
| 10893 : let command = input("Type a command: ") | |
| 10894 : try | |
| 10895 : if command == "" | |
| 10896 : continue | |
| 10897 : elseif command == "END" | |
| 10898 : break | |
| 10899 : elseif command == "TASK1" | |
| 10900 : call TASK1() | |
| 10901 : elseif command == "TASK2" | |
| 10902 : call TASK2() | |
| 10903 : else | |
| 10904 : echo "\nIllegal command:" command | |
| 10905 : continue | |
| 10906 : endif | |
| 10907 : catch /^Vim:Interrupt$/ | |
| 10908 : echo "\nCommand interrupted" | |
| 10909 : " Caught the interrupt. Continue with next prompt. | |
| 10910 : endtry | |
| 10911 :endwhile | |
| 10912 | |
| 10913 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
|
10914 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 10915 |
| 10916 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 10917 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 10918 command on that line. See |debug-scripts|. | |
| 10919 | |
| 10920 | |
| 10921 CATCHING ALL *catch-all* | |
| 10922 | |
| 10923 The commands > | |
| 10924 | |
| 10925 :catch /.*/ | |
| 10926 :catch // | |
| 10927 :catch | |
| 10928 | |
| 10929 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 10930 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 10931 a script in order to catch unexpected things. | |
| 10932 Example: > | |
| 10933 | |
| 10934 :try | |
| 10935 : | |
| 10936 : " do the hard work here | |
| 10937 : | |
| 10938 :catch /MyException/ | |
| 10939 : | |
| 10940 : " handle known problem | |
| 10941 : | |
| 10942 :catch /^Vim:Interrupt$/ | |
| 10943 : echo "Script interrupted" | |
| 10944 :catch /.*/ | |
| 10945 : echo "Internal error (" . v:exception . ")" | |
| 10946 : echo " - occurred at " . v:throwpoint | |
| 10947 :endtry | |
| 10948 :" end of script | |
| 10949 | |
| 10950 Note: Catching all might catch more things than you want. Thus, you are | |
| 10951 strongly encouraged to catch only for problems that you can really handle by | |
| 10952 specifying a pattern argument to the ":catch". | |
| 10953 Example: Catching all could make it nearly impossible to interrupt a script | |
| 10954 by pressing CTRL-C: > | |
| 10955 | |
| 10956 :while 1 | |
| 10957 : try | |
| 10958 : sleep 1 | |
| 10959 : catch | |
| 10960 : endtry | |
| 10961 :endwhile | |
| 10962 | |
| 10963 | |
| 10964 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 10965 | |
| 10966 Exceptions may be used during execution of autocommands. Example: > | |
| 10967 | |
| 10968 :autocmd User x try | |
| 10969 :autocmd User x throw "Oops!" | |
| 10970 :autocmd User x catch | |
| 10971 :autocmd User x echo v:exception | |
| 10972 :autocmd User x endtry | |
| 10973 :autocmd User x throw "Arrgh!" | |
| 10974 :autocmd User x echo "Should not be displayed" | |
| 10975 : | |
| 10976 :try | |
| 10977 : doautocmd User x | |
| 10978 :catch | |
| 10979 : echo v:exception | |
| 10980 :endtry | |
| 10981 | |
| 10982 This displays "Oops!" and "Arrgh!". | |
| 10983 | |
| 10984 *except-autocmd-Pre* | |
| 10985 For some commands, autocommands get executed before the main action of the | |
| 10986 command takes place. If an exception is thrown and not caught in the sequence | |
| 10987 of autocommands, the sequence and the command that caused its execution are | |
| 10988 abandoned and the exception is propagated to the caller of the command. | |
| 10989 Example: > | |
| 10990 | |
| 10991 :autocmd BufWritePre * throw "FAIL" | |
| 10992 :autocmd BufWritePre * echo "Should not be displayed" | |
| 10993 : | |
| 10994 :try | |
| 10995 : write | |
| 10996 :catch | |
| 10997 : echo "Caught:" v:exception "from" v:throwpoint | |
| 10998 :endtry | |
| 10999 | |
| 11000 Here, the ":write" command does not write the file currently being edited (as | |
| 11001 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 11002 autocommand abandons the ":write". The exception is then caught and the | |
| 11003 script displays: > | |
| 11004 | |
| 11005 Caught: FAIL from BufWrite Auto commands for "*" | |
| 11006 < | |
| 11007 *except-autocmd-Post* | |
| 11008 For some commands, autocommands get executed after the main action of the | |
| 11009 command has taken place. If this main action fails and the command is inside | |
| 11010 an active try conditional, the autocommands are skipped and an error exception | |
| 11011 is thrown that can be caught by the caller of the command. | |
| 11012 Example: > | |
| 11013 | |
| 11014 :autocmd BufWritePost * echo "File successfully written!" | |
| 11015 : | |
| 11016 :try | |
| 11017 : write /i/m/p/o/s/s/i/b/l/e | |
| 11018 :catch | |
| 11019 : echo v:exception | |
| 11020 :endtry | |
| 11021 | |
| 11022 This just displays: > | |
| 11023 | |
| 11024 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 11025 | |
| 11026 If you really need to execute the autocommands even when the main action | |
| 11027 fails, trigger the event from the catch clause. | |
| 11028 Example: > | |
| 11029 | |
| 11030 :autocmd BufWritePre * set noreadonly | |
| 11031 :autocmd BufWritePost * set readonly | |
| 11032 : | |
| 11033 :try | |
| 11034 : write /i/m/p/o/s/s/i/b/l/e | |
| 11035 :catch | |
| 11036 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 11037 :endtry | |
| 11038 < | |
| 11039 You can also use ":silent!": > | |
| 11040 | |
| 11041 :let x = "ok" | |
| 11042 :let v:errmsg = "" | |
| 11043 :autocmd BufWritePost * if v:errmsg != "" | |
| 11044 :autocmd BufWritePost * let x = "after fail" | |
| 11045 :autocmd BufWritePost * endif | |
| 11046 :try | |
| 11047 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 11048 :catch | |
| 11049 :endtry | |
| 11050 :echo x | |
| 11051 | |
| 11052 This displays "after fail". | |
| 11053 | |
| 11054 If the main action of the command does not fail, exceptions from the | |
| 11055 autocommands will be catchable by the caller of the command: > | |
| 11056 | |
| 11057 :autocmd BufWritePost * throw ":-(" | |
| 11058 :autocmd BufWritePost * echo "Should not be displayed" | |
| 11059 : | |
| 11060 :try | |
| 11061 : write | |
| 11062 :catch | |
| 11063 : echo v:exception | |
| 11064 :endtry | |
| 11065 < | |
| 11066 *except-autocmd-Cmd* | |
| 11067 For some commands, the normal action can be replaced by a sequence of | |
| 11068 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 11069 of the command. | |
| 11070 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
|
11071 had actually been written when the exception occurred. You need to tell it in |
| 7 | 11072 some way. > |
| 11073 | |
| 11074 :if !exists("cnt") | |
| 11075 : let cnt = 0 | |
| 11076 : | |
| 11077 : autocmd BufWriteCmd * if &modified | |
| 11078 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 11079 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 11080 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 11081 : autocmd BufWriteCmd * endif | |
| 11082 : autocmd BufWriteCmd * write | set nomodified | |
| 11083 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 11084 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 11085 : autocmd BufWriteCmd * endif | |
| 11086 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 11087 : autocmd BufWriteCmd * endif | |
| 11088 :endif | |
| 11089 : | |
| 11090 :try | |
| 11091 : write | |
| 11092 :catch /^BufWriteCmdError$/ | |
| 11093 : if &modified | |
| 11094 : echo "Error on writing (file contents not changed)" | |
| 11095 : else | |
| 11096 : echo "Error after writing" | |
| 11097 : endif | |
| 11098 :catch /^Vim(write):/ | |
| 11099 : echo "Error on writing" | |
| 11100 :endtry | |
| 11101 | |
| 11102 When this script is sourced several times after making changes, it displays | |
| 11103 first > | |
| 11104 File successfully written! | |
| 11105 then > | |
| 11106 Error on writing (file contents not changed) | |
| 11107 then > | |
| 11108 Error after writing | |
| 11109 etc. | |
| 11110 | |
| 11111 *except-autocmd-ill* | |
| 11112 You cannot spread a try conditional over autocommands for different events. | |
| 11113 The following code is ill-formed: > | |
| 11114 | |
| 11115 :autocmd BufWritePre * try | |
| 11116 : | |
| 11117 :autocmd BufWritePost * catch | |
| 11118 :autocmd BufWritePost * echo v:exception | |
| 11119 :autocmd BufWritePost * endtry | |
| 11120 : | |
| 11121 :write | |
| 11122 | |
| 11123 | |
| 11124 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 11125 | |
| 11126 Some programming languages allow to use hierarchies of exception classes or to | |
| 11127 pass additional information with the object of an exception class. You can do | |
| 11128 similar things in Vim. | |
| 11129 In order to throw an exception from a hierarchy, just throw the complete | |
| 11130 class name with the components separated by a colon, for instance throw the | |
| 11131 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 11132 When you want to pass additional information with your exception class, add | |
| 11133 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 11134 for an error when writing "myfile". | |
| 11135 With the appropriate patterns in the ":catch" command, you can catch for | |
| 11136 base classes or derived classes of your hierarchy. Additional information in | |
| 11137 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 11138 Example: > | |
| 11139 | |
| 11140 :function! CheckRange(a, func) | |
| 11141 : if a:a < 0 | |
| 11142 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 11143 : endif | |
| 11144 :endfunction | |
| 11145 : | |
| 11146 :function! Add(a, b) | |
| 11147 : call CheckRange(a:a, "Add") | |
| 11148 : call CheckRange(a:b, "Add") | |
| 11149 : let c = a:a + a:b | |
| 11150 : if c < 0 | |
| 11151 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 11152 : endif | |
| 11153 : return c | |
| 11154 :endfunction | |
| 11155 : | |
| 11156 :function! Div(a, b) | |
| 11157 : call CheckRange(a:a, "Div") | |
| 11158 : call CheckRange(a:b, "Div") | |
| 11159 : if (a:b == 0) | |
| 11160 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 11161 : endif | |
| 11162 : return a:a / a:b | |
| 11163 :endfunction | |
| 11164 : | |
| 11165 :function! Write(file) | |
| 11166 : try | |
| 1621 | 11167 : execute "write" fnameescape(a:file) |
| 7 | 11168 : catch /^Vim(write):/ |
| 11169 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 11170 : endtry | |
| 11171 :endfunction | |
| 11172 : | |
| 11173 :try | |
| 11174 : | |
| 11175 : " something with arithmetics and I/O | |
| 11176 : | |
| 11177 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 11178 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 11179 : echo "Range error in" function | |
| 11180 : | |
| 11181 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 11182 : echo "Math error" | |
| 11183 : | |
| 11184 :catch /^EXCEPT:IO/ | |
| 11185 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 11186 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 11187 : if file !~ '^/' | |
| 11188 : let file = dir . "/" . file | |
| 11189 : endif | |
| 11190 : echo 'I/O error for "' . file . '"' | |
| 11191 : | |
| 11192 :catch /^EXCEPT/ | |
| 11193 : echo "Unspecified error" | |
| 11194 : | |
| 11195 :endtry | |
| 11196 | |
| 11197 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 11198 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 11199 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 11200 Vim error exceptions are parameterized with the name of the command that | |
| 11201 failed, if known. See |catch-errors|. | |
| 11202 | |
| 11203 | |
| 11204 PECULIARITIES | |
| 11205 *except-compat* | |
| 11206 The exception handling concept requires that the command sequence causing the | |
| 11207 exception is aborted immediately and control is transferred to finally clauses | |
| 11208 and/or a catch clause. | |
| 11209 | |
| 11210 In the Vim script language there are cases where scripts and functions | |
| 11211 continue after an error: in functions without the "abort" flag or in a command | |
| 11212 after ":silent!", control flow goes to the following line, and outside | |
| 11213 functions, control flow goes to the line following the outermost ":endwhile" | |
| 11214 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 11215 (thus, requiring the immediate abortion). | |
| 11216 | |
| 11217 This problem has been solved by converting errors to exceptions and using | |
| 11218 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
|
11219 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
|
11220 be caught only from an active try conditional. If you want an immediate |
| 7 | 11221 termination without catching the error, just use a try conditional without |
| 11222 catch clause. (You can cause cleanup code being executed before termination | |
| 11223 by specifying a finally clause.) | |
| 11224 | |
| 11225 When no try conditional is active, the usual abortion and continuation | |
| 11226 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 11227 scripts written for Vim 6.1 and earlier. | |
| 11228 | |
| 11229 However, when sourcing an existing script that does not use exception handling | |
| 11230 commands (or when calling one of its functions) from inside an active try | |
| 11231 conditional of a new script, you might change the control flow of the existing | |
| 11232 script on error. You get the immediate abortion on error and can catch the | |
| 11233 error in the new script. If however the sourced script suppresses error | |
| 11234 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
|
11235 |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
|
11236 not converted to an exception. (See |:silent|.) So the only remaining cause |
| 7 | 11237 where this happens is for scripts that don't care about errors and produce |
| 11238 error messages. You probably won't want to use such code from your new | |
| 11239 scripts. | |
| 11240 | |
| 11241 *except-syntax-err* | |
| 11242 Syntax errors in the exception handling commands are never caught by any of | |
| 11243 the ":catch" commands of the try conditional they belong to. Its finally | |
| 11244 clauses, however, is executed. | |
| 11245 Example: > | |
| 11246 | |
| 11247 :try | |
| 11248 : try | |
| 11249 : throw 4711 | |
| 11250 : catch /\(/ | |
| 11251 : echo "in catch with syntax error" | |
| 11252 : catch | |
| 11253 : echo "inner catch-all" | |
| 11254 : finally | |
| 11255 : echo "inner finally" | |
| 11256 : endtry | |
| 11257 :catch | |
| 11258 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 11259 : finally | |
| 11260 : echo "outer finally" | |
| 11261 :endtry | |
| 11262 | |
| 11263 This displays: > | |
| 11264 inner finally | |
| 11265 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 11266 outer finally | |
| 11267 The original exception is discarded and an error exception is raised, instead. | |
| 11268 | |
| 11269 *except-single-line* | |
| 11270 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 11271 a single line, but then syntax errors may make it difficult to recognize the | |
| 11272 "catch" line, thus you better avoid this. | |
| 11273 Example: > | |
| 11274 :try | unlet! foo # | catch | endtry | |
| 11275 raises an error exception for the trailing characters after the ":unlet!" | |
| 11276 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 11277 error exception is discarded and the "E488: Trailing characters" message gets | |
| 11278 displayed. | |
| 11279 | |
| 11280 *except-several-errors* | |
| 11281 When several errors appear in a single command, the first error message is | |
| 11282 usually the most specific one and therefor converted to the error exception. | |
| 11283 Example: > | |
| 11284 echo novar | |
| 11285 causes > | |
| 11286 E121: Undefined variable: novar | |
| 11287 E15: Invalid expression: novar | |
| 11288 The value of the error exception inside try conditionals is: > | |
| 11289 Vim(echo):E121: Undefined variable: novar | |
| 11290 < *except-syntax-error* | |
| 11291 But when a syntax error is detected after a normal error in the same command, | |
| 11292 the syntax error is used for the exception being thrown. | |
| 11293 Example: > | |
| 11294 unlet novar # | |
| 11295 causes > | |
| 11296 E108: No such variable: "novar" | |
| 11297 E488: Trailing characters | |
| 11298 The value of the error exception inside try conditionals is: > | |
| 11299 Vim(unlet):E488: Trailing characters | |
| 11300 This is done because the syntax error might change the execution path in a way | |
| 11301 not intended by the user. Example: > | |
| 11302 try | |
| 11303 try | unlet novar # | catch | echo v:exception | endtry | |
| 11304 catch /.*/ | |
| 11305 echo "outer catch:" v:exception | |
| 11306 endtry | |
| 11307 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 11308 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 11309 | |
| 11310 ============================================================================== | |
| 11311 9. Examples *eval-examples* | |
| 11312 | |
| 1156 | 11313 Printing in Binary ~ |
| 7 | 11314 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
11315 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 11316 :func Nr2Bin(nr) |
| 7 | 11317 : let n = a:nr |
| 11318 : let r = "" | |
| 11319 : while n | |
| 1156 | 11320 : let r = '01'[n % 2] . r |
| 11321 : let n = n / 2 | |
| 7 | 11322 : endwhile |
| 11323 : return r | |
| 11324 :endfunc | |
| 11325 | |
| 1156 | 11326 :" The function String2Bin() converts each character in a string to a |
| 11327 :" binary string, separated with dashes. | |
| 11328 :func String2Bin(str) | |
| 7 | 11329 : let out = '' |
| 1156 | 11330 : for ix in range(strlen(a:str)) |
| 11331 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 11332 : endfor | |
| 11333 : return out[1:] | |
| 7 | 11334 :endfunc |
| 11335 | |
| 11336 Example of its use: > | |
| 1156 | 11337 :echo Nr2Bin(32) |
| 11338 result: "100000" > | |
| 11339 :echo String2Bin("32") | |
| 11340 result: "110011-110010" | |
| 11341 | |
| 11342 | |
| 11343 Sorting lines ~ | |
| 11344 | |
| 11345 This example sorts lines with a specific compare function. > | |
| 11346 | |
| 11347 :func SortBuffer() | |
| 11348 : let lines = getline(1, '$') | |
| 11349 : call sort(lines, function("Strcmp")) | |
| 11350 : call setline(1, lines) | |
| 7 | 11351 :endfunction |
| 11352 | |
| 1156 | 11353 As a one-liner: > |
| 11354 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 11355 | |
| 11356 | |
| 11357 scanf() replacement ~ | |
| 7 | 11358 *sscanf* |
| 11359 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 11360 line, you can use matchstr() and substitute() to do it. This example shows | |
| 11361 how to get the file name, line number and column number out of a line like | |
| 11362 "foobar.txt, 123, 45". > | |
| 11363 :" Set up the match bit | |
| 11364 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 11365 :"get the part matching the whole expression | |
| 11366 :let l = matchstr(line, mx) | |
| 11367 :"get each item out of the match | |
| 11368 :let file = substitute(l, mx, '\1', '') | |
| 11369 :let lnum = substitute(l, mx, '\2', '') | |
| 11370 :let col = substitute(l, mx, '\3', '') | |
| 11371 | |
| 11372 The input is in the variable "line", the results in the variables "file", | |
| 11373 "lnum" and "col". (idea from Michael Geddes) | |
| 11374 | |
| 1156 | 11375 |
| 11376 getting the scriptnames in a Dictionary ~ | |
| 11377 *scriptnames-dictionary* | |
| 11378 The |:scriptnames| command can be used to get a list of all script files that | |
| 11379 have been sourced. There is no equivalent function or variable for this | |
| 11380 (because it's rarely needed). In case you need to manipulate the list this | |
| 11381 code can be used: > | |
| 11382 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 11383 let scriptnames_output = '' | |
| 11384 redir => scriptnames_output | |
| 11385 silent scriptnames | |
| 11386 redir END | |
| 12785 | 11387 |
| 1621 | 11388 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 11389 " "scripts" dictionary. |
| 11390 let scripts = {} | |
| 11391 for line in split(scriptnames_output, "\n") | |
| 11392 " Only do non-blank lines. | |
| 11393 if line =~ '\S' | |
| 11394 " Get the first number in the line. | |
| 1621 | 11395 let nr = matchstr(line, '\d\+') |
| 1156 | 11396 " Get the file name, remove the script number " 123: ". |
| 1621 | 11397 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 11398 " Add an item to the Dictionary |
| 1621 | 11399 let scripts[nr] = name |
| 1156 | 11400 endif |
| 11401 endfor | |
| 11402 unlet scriptnames_output | |
| 11403 | |
| 7 | 11404 ============================================================================== |
| 11405 10. No +eval feature *no-eval-feature* | |
| 11406 | |
| 11407 When the |+eval| feature was disabled at compile time, none of the expression | |
| 11408 evaluation commands are available. To prevent this from causing Vim scripts | |
| 11409 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 11410 recognized, though the argument of the ":if" and everything between the ":if" | |
| 11411 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 11412 only if the commands are at the start of the line. The ":else" command is not | |
| 11413 recognized. | |
| 11414 | |
| 11415 Example of how to avoid executing commands when the |+eval| feature is | |
| 11416 missing: > | |
| 11417 | |
| 11418 :if 1 | |
| 11419 : echo "Expression evaluation is compiled in" | |
| 11420 :else | |
| 11421 : echo "You will _never_ see this message" | |
| 11422 :endif | |
| 11423 | |
| 11347 | 11424 To execute a command only when the |+eval| feature is disabled requires a trick, |
| 11425 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
|
11426 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11427 silent! while 0 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11428 set history=111 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11429 silent! endwhile |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11430 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
11431 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
|
11432 "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
|
11433 silently ignored, and the command is executed. |
| 11347 | 11434 |
| 7 | 11435 ============================================================================== |
| 11436 11. The sandbox *eval-sandbox* *sandbox* *E48* | |
| 11437 | |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
11438 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
|
11439 '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
|
11440 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
|
11441 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
|
11442 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 11443 The sandbox is also used for the |:sandbox| command. |
| 7 | 11444 |
| 11445 These items are not allowed in the sandbox: | |
| 11446 - changing the buffer text | |
| 11447 - defining or changing mapping, autocommands, functions, user commands | |
| 11448 - setting certain options (see |option-summary|) | |
| 1156 | 11449 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 11450 - executing a shell command |
| 11451 - reading or writing a file | |
| 11452 - jumping to another buffer or editing a file | |
| 625 | 11453 - executing Python, Perl, etc. commands |
| 29 | 11454 This is not guaranteed 100% secure, but it should block most attacks. |
| 11455 | |
| 11456 *:san* *:sandbox* | |
| 401 | 11457 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 11458 option that may have been set from a modeline, e.g. |
| 11459 'foldexpr'. | |
| 11460 | |
| 634 | 11461 *sandbox-option* |
| 11462 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 11463 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 11464 restrictive, thus this only happens when the option was set from an insecure |
| 11465 location. Insecure in this context are: | |
| 843 | 11466 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 11467 - while executing in the sandbox |
| 11468 - value coming from a modeline | |
| 11469 | |
| 11470 Note that when in the sandbox and saving an option value and restoring it, the | |
| 11471 option will still be marked as it was set in the sandbox. | |
| 11472 | |
| 11473 ============================================================================== | |
| 11474 12. Textlock *textlock* | |
| 11475 | |
| 11476 In a few situations it is not allowed to change the text in the buffer, jump | |
| 11477 to another window and some other things that might confuse or break what Vim | |
| 11478 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
|
11479 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 11480 happen any moment the mouse cursor is resting at some position. |
| 11481 | |
| 11482 This is not allowed when the textlock is active: | |
| 11483 - changing the buffer text | |
| 11484 - jumping to another buffer or window | |
| 11485 - editing another file | |
| 11486 - closing a window or quitting Vim | |
| 11487 - etc. | |
| 11488 | |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11489 ============================================================================== |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11490 13. Testing *testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11491 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11492 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
|
11493 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
|
11494 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11495 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
|
11496 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
|
11497 test_something.in old style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11498 test_something.vim new style tests |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11499 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11500 *new-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11501 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
|
11502 |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
|
11503 place. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11504 *old-style-testing* |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11505 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
|
11506 without the |+eval| feature. |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11507 |
|
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11508 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
|
11509 |
| 7 | 11510 |
| 11511 vim:tw=78:ts=8:ft=help:norl: |