Mercurial > vim
annotate runtime/doc/eval.txt @ 24307:55f458d35292 v8.2.2694
patch 8.2.2694: when 'matchpairs' is empty every character beeps
Commit: https://github.com/vim/vim/commit/5b8cabfef7c3707f3e53e13844d90e5a217e1e84
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri Apr 2 18:55:57 2021 +0200
patch 8.2.2694: when 'matchpairs' is empty every character beeps
Problem: When 'matchpairs' is empty every character beeps. (Marco Hinz)
Solution: Bail out when no character in 'matchpairs' was found.
(closes #8053) Add assert_nobeep().
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Fri, 02 Apr 2021 19:00:06 +0200 |
| parents | 4ab4ef0c48b1 |
| children | 5c98ea5f5d6e |
| rev | line source |
|---|---|
| 24278 | 1 *eval.txt* For Vim version 8.2. Last change: 2021 Mar 28 |
| 1621 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 7 | 5 |
| 6 | |
| 7 Expression evaluation *expression* *expr* *E15* *eval* | |
| 8 | |
| 9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|. | |
| 10 | |
| 11 Note: Expression evaluation can be disabled at compile time. If this has been | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12 done, the features in this document are not available. See |+eval| and |
| 99 | 13 |no-eval-feature|. |
| 7 | 14 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
15 This file is about the backwards compatible Vim script. For Vim9 script, |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
16 which executes much faster, supports type checking and much more, see |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
17 |vim9.txt|. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
18 |
| 85 | 19 1. Variables |variables| |
| 20 1.1 Variable types | |
| 87 | 21 1.2 Function references |Funcref| |
| 161 | 22 1.3 Lists |Lists| |
| 99 | 23 1.4 Dictionaries |Dictionaries| |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
24 1.5 Blobs |Blobs| |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
25 1.6 More about variables |more-variables| |
| 85 | 26 2. Expression syntax |expression-syntax| |
| 27 3. Internal variable |internal-variables| | |
| 28 4. Builtin Functions |functions| | |
| 29 5. Defining functions |user-functions| | |
| 30 6. Curly braces names |curly-braces-names| | |
| 31 7. Commands |expression-commands| | |
| 32 8. Exception handling |exception-handling| | |
| 33 9. Examples |eval-examples| | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
34 10. Vim script version |vimscript-version| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
35 11. No +eval feature |no-eval-feature| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
36 12. The sandbox |eval-sandbox| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
37 13. Textlock |textlock| |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
38 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
39 Testing support is documented in |testing.txt|. |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
40 Profiling is documented at |profiling|. |
| 7 | 41 |
| 42 ============================================================================== | |
| 43 1. Variables *variables* | |
| 44 | |
| 85 | 45 1.1 Variable types ~ |
|
15579
391ac26c9412
patch 8.1.0797: error E898 is used twice
Bram Moolenaar <Bram@vim.org>
parents:
15571
diff
changeset
|
46 *E712* *E896* *E897* *E899* |
| 17909 | 47 There are ten types of variables: |
| 1621 | 48 |
| 18831 | 49 *Number* *Integer* |
| 50 Number A 32 or 64 bit signed number. |expr-number| | |
|
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
51 The number of bits is available in |v:numbersize|. |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
52 Examples: -123 0x10 0177 0o177 0b1011 |
| 99 | 53 |
| 1621 | 54 Float A floating point number. |floating-point-format| *Float* |
| 55 {only when compiled with the |+float| feature} | |
| 56 Examples: 123.456 1.15e-6 -1.1e3 | |
| 57 | |
|
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
58 *E928* |
| 99 | 59 String A NUL terminated string of 8-bit unsigned characters (bytes). |
| 1621 | 60 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
| 99 | 61 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
62 List An ordered sequence of items, see |List| for details. |
| 99 | 63 Example: [1, 2, ['a', 'b']] |
| 55 | 64 |
| 370 | 65 Dictionary An associative, unordered array: Each entry has a key and a |
| 66 value. |Dictionary| | |
|
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
67 Examples: |
|
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
68 {'blue': "#0000ff", 'red': "#ff0000"} |
|
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
69 #{blue: "#0000ff", red: "#ff0000"} |
| 370 | 70 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
71 Funcref A reference to a function |Funcref|. |
|
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
72 Example: function("strlen") |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
73 It can be bound to a dictionary and arguments, it then works |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
74 like a Partial. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
75 Example: function("Callback", [arg], myDict) |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
76 |
|
8178
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
77 Special |v:false|, |v:true|, |v:none| and |v:null|. *Special* |
|
e77efd7a7dad
commit https://github.com/vim/vim/commit/02e83b438ea7071fdb176dabbaefea319ab2d686
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
78 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
79 Job Used for a job, see |job_start()|. *Job* *Jobs* |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
80 |
|
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
81 Channel Used for a channel, see |ch_open()|. *Channel* *Channels* |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
82 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
83 Blob Binary Large Object. Stores any sequence of bytes. See |Blob| |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
84 for details |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
85 Example: 0zFF00ED015DAF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
86 0z is an empty Blob. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
87 |
| 55 | 88 The Number and String types are converted automatically, depending on how they |
| 89 are used. | |
| 7 | 90 |
| 91 Conversion from a Number to a String is by making the ASCII representation of | |
| 2581 | 92 the Number. Examples: |
| 93 Number 123 --> String "123" ~ | |
| 94 Number 0 --> String "0" ~ | |
| 95 Number -1 --> String "-1" ~ | |
| 2152 | 96 *octal* |
|
21409
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
97 Conversion from a String to a Number only happens in legacy Vim script, not in |
|
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
98 Vim9 script. It is done by converting the first digits to a number. |
|
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
99 Hexadecimal "0xf9", Octal "017" or "0o17", and Binary "0b10" |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
100 numbers are recognized |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
101 NOTE: when using |scriptversion-4| octal with a leading "0" is not recognized. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
102 The 0o notation requires patch 8.2.0886. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
103 If the String doesn't start with digits, the result is zero. |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
104 Examples: |
| 2581 | 105 String "456" --> Number 456 ~ |
| 106 String "6bar" --> Number 6 ~ | |
| 107 String "foo" --> Number 0 ~ | |
| 108 String "0xf1" --> Number 241 ~ | |
| 109 String "0100" --> Number 64 ~ | |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
110 String "0o100" --> Number 64 ~ |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
111 String "0b101" --> Number 5 ~ |
| 2581 | 112 String "-8" --> Number -8 ~ |
| 113 String "+8" --> Number 0 ~ | |
| 7 | 114 |
| 115 To force conversion from String to Number, add zero to it: > | |
| 116 :echo "0100" + 0 | |
| 782 | 117 < 64 ~ |
| 118 | |
| 119 To avoid a leading zero to cause octal conversion, or for using a different | |
| 120 base, use |str2nr()|. | |
| 7 | 121 |
| 15512 | 122 *TRUE* *FALSE* *Boolean* |
| 7 | 123 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. |
| 22723 | 124 You can also use |v:false| and |v:true|. In Vim9 script |false| and |true|. |
| 22171 | 125 When TRUE is returned from a function it is the Number one, FALSE is the |
| 126 number zero. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
127 |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
128 Note that in the command: > |
| 7 | 129 :if "foo" |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
130 :" NOT executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
131 "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
|
132 non-zero number it means TRUE: > |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
133 :if "8foo" |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
134 :" executed |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
135 To test for a non-empty string, use empty(): > |
| 3893 | 136 :if !empty("foo") |
|
22492
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
137 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
138 < *falsy* *truthy* |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
139 An expression can be used as a condition, ignoring the type and only using |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
140 whether the value is "sort of true" or "sort of false". Falsy is: |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
141 the number zero |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
142 empty string, blob, list or dictionary |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
143 Other values are truthy. Examples: |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
144 0 falsy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
145 1 truthy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
146 -1 truthy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
147 0.0 falsy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
148 0.1 truthy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
149 '' falsy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
150 'x' truthy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
151 [] falsy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
152 [0] truthy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
153 {} falsy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
154 #{x: 1} truthy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
155 0z falsy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
156 0z00 truthy |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
157 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
158 *non-zero-arg* |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
159 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
|
160 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
|
161 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
|
162 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
|
163 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
|
164 |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
165 *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* *E913* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
166 *E974* *E975* *E976* |
| 15512 | 167 |List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not |
| 168 automatically converted. | |
| 85 | 169 |
| 1621 | 170 *E805* *E806* *E808* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
171 When mixing Number and Float the Number is converted to Float. Otherwise |
| 1621 | 172 there is no automatic conversion of Float. You can use str2float() for String |
| 173 to Float, printf() for Float to String and float2nr() for Float to Number. | |
| 174 | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
8031
diff
changeset
|
175 *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
|
176 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
|
177 |
|
8512
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
178 *no-type-checking* |
|
5104f96b6ecf
commit https://github.com/vim/vim/commit/f6f32c38bf3319144a84a01a154c8c91939e7acf
Christian Brabandt <cb@256bit.org>
parents:
8502
diff
changeset
|
179 You will not get an error if you try to change the type of a variable. |
| 85 | 180 |
| 181 | |
| 87 | 182 1.2 Function references ~ |
| 21093 | 183 *Funcref* *E695* *E718* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
184 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
|
185 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
|
186 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
|
187 around the arguments, to invoke the function it refers to. Example: > |
| 55 | 188 |
| 189 :let Fn = function("MyFunc") | |
| 190 :echo Fn() | |
| 114 | 191 < *E704* *E705* *E707* |
| 819 | 192 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
| 5340 | 193 can use "g:" but the following name must still start with a capital. You |
| 819 | 194 cannot have both a Funcref variable and a function with the same name. |
| 85 | 195 |
| 114 | 196 A special case is defining a function and directly assigning its Funcref to a |
| 197 Dictionary entry. Example: > | |
| 198 :function dict.init() dict | |
| 199 : let self.val = 0 | |
| 200 :endfunction | |
| 201 | |
| 202 The key of the Dictionary can start with a lower case letter. The actual | |
| 203 function name is not used here. Also see |numbered-function|. | |
| 204 | |
| 205 A Funcref can also be used with the |:call| command: > | |
| 206 :call Fn() | |
| 207 :call dict.init() | |
| 85 | 208 |
| 209 The name of the referenced function can be obtained with |string()|. > | |
| 119 | 210 :let func = string(Fn) |
| 85 | 211 |
| 212 You can use |call()| to invoke a Funcref and use a list variable for the | |
| 213 arguments: > | |
| 119 | 214 :let r = call(Fn, mylist) |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
215 < |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
216 *Partial* |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
217 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
|
218 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
|
219 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
|
220 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
|
221 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
222 let Cb = function('Callback', ['foo'], myDict) |
| 14999 | 223 call Cb('bar') |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
224 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
225 This will invoke the function as if using: > |
| 14999 | 226 call myDict.Callback('foo', 'bar') |
|
9104
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
227 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
228 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
|
229 |ch_open()|. |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
230 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
231 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
|
232 a member of the Dictionary: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
233 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
234 let myDict.myFunction = MyFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
235 call myDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
236 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
237 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
|
238 "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
|
239 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
|
240 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
241 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
242 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
243 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
244 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
|
245 this won't happen: > |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
246 |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
247 let myDict.myFunction = function(MyFunction, myDict) |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
248 let otherDict.myFunction = myDict.myFunction |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
249 call otherDict.myFunction() |
|
2242a5766417
commit https://github.com/vim/vim/commit/1d429610bf9e99a6252be8abbc910d6667e4d1da
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
250 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
251 Here "self" will be "myDict", because it was bound explicitly. |
| 85 | 252 |
| 253 | |
| 87 | 254 1.3 Lists ~ |
| 5814 | 255 *list* *List* *Lists* *E686* |
| 55 | 256 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
|
257 can be accessed by their index number. Items can be added and removed at any |
| 55 | 258 position in the sequence. |
| 259 | |
| 85 | 260 |
| 261 List creation ~ | |
| 262 *E696* *E697* | |
| 55 | 263 A List is created with a comma separated list of items in square brackets. |
| 85 | 264 Examples: > |
| 265 :let mylist = [1, two, 3, "four"] | |
| 266 :let emptylist = [] | |
| 55 | 267 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
268 An item can be any expression. Using a List for an item creates a |
| 842 | 269 List of Lists: > |
| 85 | 270 :let nestlist = [[11, 12], [21, 22], [31, 32]] |
| 55 | 271 |
| 272 An extra comma after the last item is ignored. | |
| 273 | |
| 85 | 274 |
| 275 List index ~ | |
| 276 *list-index* *E684* | |
| 55 | 277 An item in the List can be accessed by putting the index in square brackets |
| 85 | 278 after the List. Indexes are zero-based, thus the first item has index zero. > |
| 279 :let item = mylist[0] " get the first item: 1 | |
| 55 | 280 :let item = mylist[2] " get the third item: 3 |
| 85 | 281 |
| 87 | 282 When the resulting item is a list this can be repeated: > |
| 85 | 283 :let item = nestlist[0][1] " get the first list, second item: 12 |
| 55 | 284 < |
| 85 | 285 A negative index is counted from the end. Index -1 refers to the last item in |
| 286 the List, -2 to the last but one item, etc. > | |
| 55 | 287 :let last = mylist[-1] " get the last item: "four" |
| 288 | |
| 85 | 289 To avoid an error for an invalid index use the |get()| function. When an item |
| 87 | 290 is not available it returns zero or the default value you specify: > |
| 85 | 291 :echo get(mylist, idx) |
| 292 :echo get(mylist, idx, "NONE") | |
| 293 | |
| 294 | |
| 295 List concatenation ~ | |
|
23788
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
296 *list-concatenation* |
| 85 | 297 Two lists can be concatenated with the "+" operator: > |
| 298 :let longlist = mylist + [5, 6] | |
| 119 | 299 :let mylist += [7, 8] |
| 85 | 300 |
|
23788
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
301 To prepend or append an item, turn the item into a list by putting [] around |
|
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
302 it. To change a list in-place, refer to |list-modification| below. |
| 85 | 303 |
| 304 | |
| 305 Sublist ~ | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
306 *sublist* |
| 55 | 307 A part of the List can be obtained by specifying the first and last index, |
| 308 separated by a colon in square brackets: > | |
| 85 | 309 :let shortlist = mylist[2:-1] " get List [3, "four"] |
| 55 | 310 |
| 311 Omitting the first index is similar to zero. Omitting the last index is | |
| 1156 | 312 similar to -1. > |
| 90 | 313 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 314 :let shortlist = mylist[2:2] " List with one item: [3] | |
| 315 :let otherlist = mylist[:] " make a copy of the List | |
| 85 | 316 |
|
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
317 Notice that the last index is inclusive. If you prefer using an exclusive |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
318 index use the |slice()| method. |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
319 |
| 842 | 320 If the first index is beyond the last item of the List or the second item is |
| 321 before the first item, the result is an empty list. There is no error | |
| 322 message. | |
| 323 | |
| 324 If the second index is equal to or greater than the length of the list the | |
| 325 length minus one is used: > | |
| 829 | 326 :let mylist = [0, 1, 2, 3] |
| 327 :echo mylist[2:8] " result: [2, 3] | |
| 328 | |
| 270 | 329 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
|
330 using a single letter variable before the ":". Insert a space when needed: |
| 270 | 331 mylist[s : e]. |
| 332 | |
| 85 | 333 |
| 334 List identity ~ | |
| 99 | 335 *list-identity* |
| 85 | 336 When variable "aa" is a list and you assign it to another variable "bb", both |
| 337 variables refer to the same list. Thus changing the list "aa" will also | |
| 338 change "bb": > | |
| 339 :let aa = [1, 2, 3] | |
| 340 :let bb = aa | |
| 341 :call add(aa, 4) | |
| 342 :echo bb | |
| 114 | 343 < [1, 2, 3, 4] |
| 85 | 344 |
| 345 Making a copy of a list is done with the |copy()| function. Using [:] also | |
| 346 works, as explained above. This creates a shallow copy of the list: Changing | |
| 87 | 347 a list item in the list will also change the item in the copied list: > |
| 85 | 348 :let aa = [[1, 'a'], 2, 3] |
| 349 :let bb = copy(aa) | |
| 114 | 350 :call add(aa, 4) |
| 85 | 351 :let aa[0][1] = 'aaa' |
| 352 :echo aa | |
| 114 | 353 < [[1, aaa], 2, 3, 4] > |
| 85 | 354 :echo bb |
| 114 | 355 < [[1, aaa], 2, 3] |
| 85 | 356 |
| 87 | 357 To make a completely independent list use |deepcopy()|. This also makes a |
| 114 | 358 copy of the values in the list, recursively. Up to a hundred levels deep. |
| 85 | 359 |
| 360 The operator "is" can be used to check if two variables refer to the same | |
| 114 | 361 List. "isnot" does the opposite. In contrast "==" compares if two lists have |
| 87 | 362 the same value. > |
| 363 :let alist = [1, 2, 3] | |
| 364 :let blist = [1, 2, 3] | |
| 365 :echo alist is blist | |
| 114 | 366 < 0 > |
| 87 | 367 :echo alist == blist |
| 114 | 368 < 1 |
| 85 | 369 |
| 323 | 370 Note about comparing lists: Two lists are considered equal if they have the |
| 371 same length and all items compare equal, as with using "==". There is one | |
| 388 | 372 exception: When comparing a number with a string they are considered |
| 373 different. There is no automatic type conversion, as with using "==" on | |
| 374 variables. Example: > | |
| 375 echo 4 == "4" | |
| 323 | 376 < 1 > |
| 388 | 377 echo [4] == ["4"] |
| 323 | 378 < 0 |
| 379 | |
| 388 | 380 Thus comparing Lists is more strict than comparing numbers and strings. You |
| 1621 | 381 can compare simple values this way too by putting them in a list: > |
| 388 | 382 |
| 383 :let a = 5 | |
| 384 :let b = "5" | |
| 1621 | 385 :echo a == b |
| 388 | 386 < 1 > |
| 1621 | 387 :echo [a] == [b] |
| 388 | 388 < 0 |
| 323 | 389 |
| 85 | 390 |
| 391 List unpack ~ | |
| 392 | |
| 393 To unpack the items in a list to individual variables, put the variables in | |
| 394 square brackets, like list items: > | |
| 395 :let [var1, var2] = mylist | |
| 396 | |
| 397 When the number of variables does not match the number of items in the list | |
| 398 this produces an error. To handle any extra items from the list append ";" | |
| 399 and a variable name: > | |
| 400 :let [var1, var2; rest] = mylist | |
| 401 | |
| 402 This works like: > | |
| 403 :let var1 = mylist[0] | |
| 404 :let var2 = mylist[1] | |
| 95 | 405 :let rest = mylist[2:] |
| 85 | 406 |
| 407 Except that there is no error if there are only two items. "rest" will be an | |
| 408 empty list then. | |
| 409 | |
| 410 | |
| 411 List modification ~ | |
| 412 *list-modification* | |
| 87 | 413 To change a specific item of a list use |:let| this way: > |
| 85 | 414 :let list[4] = "four" |
| 415 :let listlist[0][3] = item | |
| 416 | |
| 87 | 417 To change part of a list you can specify the first and last item to be |
| 114 | 418 modified. The value must at least have the number of items in the range: > |
| 87 | 419 :let list[3:5] = [3, 4, 5] |
| 420 | |
| 85 | 421 Adding and removing items from a list is done with functions. Here are a few |
| 422 examples: > | |
| 423 :call insert(list, 'a') " prepend item 'a' | |
| 424 :call insert(list, 'a', 3) " insert item 'a' before list[3] | |
| 425 :call add(list, "new") " append String item | |
| 114 | 426 :call add(list, [1, 2]) " append a List as one new item |
| 85 | 427 :call extend(list, [1, 2]) " extend the list with two more items |
| 428 :let i = remove(list, 3) " remove item 3 | |
| 108 | 429 :unlet list[3] " idem |
| 85 | 430 :let l = remove(list, 3, -1) " remove items 3 to last item |
| 108 | 431 :unlet list[3 : ] " idem |
| 114 | 432 :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
| 433 | |
| 434 Changing the order of items in a list: > | |
| 87 | 435 :call sort(list) " sort a list alphabetically |
| 436 :call reverse(list) " reverse the order of items | |
| 5747 | 437 :call uniq(sort(list)) " sort and remove duplicates |
| 87 | 438 |
| 85 | 439 |
| 440 For loop ~ | |
| 441 | |
|
24234
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
442 The |:for| loop executes commands for each item in a List, String or Blob. |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
443 A variable is set to each item in sequence. Example with a List: > |
| 114 | 444 :for item in mylist |
| 445 : call Doit(item) | |
| 85 | 446 :endfor |
| 447 | |
| 448 This works like: > | |
| 449 :let index = 0 | |
| 450 :while index < len(mylist) | |
| 114 | 451 : let item = mylist[index] |
| 452 : :call Doit(item) | |
| 85 | 453 : let index = index + 1 |
| 454 :endwhile | |
| 455 | |
| 95 | 456 If all you want to do is modify each item in the list then the |map()| |
| 114 | 457 function will be a simpler method than a for loop. |
| 95 | 458 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
459 Just like the |:let| command, |:for| also accepts a list of variables. This |
|
24234
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
460 requires the argument to be a List of Lists. > |
| 85 | 461 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] |
| 462 : call Doit(lnum, col) | |
| 463 :endfor | |
| 464 | |
| 465 This works like a |:let| command is done for each list item. Again, the types | |
| 466 must remain the same to avoid an error. | |
| 467 | |
| 114 | 468 It is also possible to put remaining items in a List variable: > |
| 85 | 469 :for [i, j; rest] in listlist |
| 470 : call Doit(i, j) | |
| 471 : if !empty(rest) | |
| 472 : echo "remainder: " . string(rest) | |
| 473 : endif | |
| 474 :endfor | |
| 475 | |
|
24234
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
476 For a Blob one byte at a time is used. |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
477 |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
478 For a String one character, including any composing characters, is used as a |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
479 String. Example: > |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
480 for c in text |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
481 echo 'This character is ' .. c |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
482 endfor |
|
7ffc795288dd
patch 8.2.2658: :for cannot loop over a string
Bram Moolenaar <Bram@vim.org>
parents:
24194
diff
changeset
|
483 |
| 85 | 484 |
| 485 List functions ~ | |
| 114 | 486 *E714* |
| 85 | 487 Functions that are useful with a List: > |
| 87 | 488 :let r = call(funcname, list) " call a function with an argument list |
| 85 | 489 :if empty(list) " check if list is empty |
| 102 | 490 :let l = len(list) " number of items in list |
| 491 :let big = max(list) " maximum value in list | |
| 492 :let small = min(list) " minimum value in list | |
| 87 | 493 :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 494 :let i = index(list, 'x') " index of first 'x' in list | |
| 85 | 495 :let lines = getline(1, 10) " get ten text lines from buffer |
| 496 :call append('$', lines) " append text lines in buffer | |
| 95 | 497 :let list = split("a b c") " create list from items in a string |
| 498 :let string = join(list, ', ') " create string from list items | |
| 102 | 499 :let s = string(list) " String representation of list |
| 500 :call map(list, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 501 |
| 258 | 502 Don't forget that a combination of features can make things simple. For |
| 503 example, to add up all the numbers in a list: > | |
| 504 :exe 'let sum = ' . join(nrlist, '+') | |
| 505 | |
| 99 | 506 |
| 507 1.4 Dictionaries ~ | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
508 *dict* *Dict* *Dictionaries* *Dictionary* |
| 99 | 509 A Dictionary is an associative array: Each entry has a key and a value. The |
| 114 | 510 entry can be located with the key. The entries are stored without a specific |
| 511 ordering. | |
| 99 | 512 |
| 513 | |
| 514 Dictionary creation ~ | |
| 114 | 515 *E720* *E721* *E722* *E723* |
| 99 | 516 A Dictionary is created with a comma separated list of entries in curly |
| 114 | 517 braces. Each entry has a key and a value, separated by a colon. Each key can |
| 518 only appear once. Examples: > | |
| 99 | 519 :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 520 :let emptydict = {} | |
| 114 | 521 < *E713* *E716* *E717* |
| 99 | 522 A key is always a String. You can use a Number, it will be converted to a |
| 523 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
|
524 entry. Note that the String '04' and the Number 04 are different, since the |
|
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
525 Number will be converted to the String '4'. The empty string can also be used |
|
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
526 as a key. |
| 17758 | 527 *literal-Dict* *#{}* |
|
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
528 To avoid having to put quotes around every key the #{} form can be used. This |
|
17368
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
529 does require the key to consist only of ASCII letters, digits, '-' and '_'. |
|
6604ecb7a615
patch 8.1.1683: dictionary with string keys is longer than needed
Bram Moolenaar <Bram@vim.org>
parents:
17366
diff
changeset
|
530 Example: > |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
531 :let mydict = #{zero: 0, one_key: 1, two-key: 2, 333: 3} |
|
17413
40417757dffd
patch 8.1.1705: using ~{} for a literal dict is not nice
Bram Moolenaar <Bram@vim.org>
parents:
17387
diff
changeset
|
532 Note that 333 here is the string "333". Empty keys are not possible with #{}. |
| 114 | 533 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
534 A value can be any expression. Using a Dictionary for a value creates a |
| 99 | 535 nested Dictionary: > |
| 536 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} | |
| 537 | |
| 538 An extra comma after the last entry is ignored. | |
| 539 | |
| 540 | |
| 541 Accessing entries ~ | |
| 542 | |
| 543 The normal way to access an entry is by putting the key in square brackets: > | |
| 544 :let val = mydict["one"] | |
| 545 :let mydict["four"] = 4 | |
| 546 | |
| 114 | 547 You can add new entries to an existing Dictionary this way, unlike Lists. |
| 99 | 548 |
| 549 For keys that consist entirely of letters, digits and underscore the following | |
| 550 form can be used |expr-entry|: > | |
| 551 :let val = mydict.one | |
| 552 :let mydict.four = 4 | |
| 553 | |
| 554 Since an entry can be any type, also a List and a Dictionary, the indexing and | |
| 555 key lookup can be repeated: > | |
| 114 | 556 :echo dict.key[idx].key |
| 99 | 557 |
| 558 | |
| 559 Dictionary to List conversion ~ | |
| 560 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
561 You may want to loop over the entries in a dictionary. For this you need to |
| 99 | 562 turn the Dictionary into a List and pass it to |:for|. |
| 563 | |
| 564 Most often you want to loop over the keys, using the |keys()| function: > | |
| 565 :for key in keys(mydict) | |
| 566 : echo key . ': ' . mydict[key] | |
| 567 :endfor | |
| 568 | |
| 569 The List of keys is unsorted. You may want to sort them first: > | |
| 570 :for key in sort(keys(mydict)) | |
| 571 | |
| 572 To loop over the values use the |values()| function: > | |
| 573 :for v in values(mydict) | |
| 574 : echo "value: " . v | |
| 575 :endfor | |
| 576 | |
| 577 If you want both the key and the value use the |items()| function. It returns | |
| 15131 | 578 a List in which each item is a List with two items, the key and the value: > |
| 1156 | 579 :for [key, value] in items(mydict) |
| 580 : echo key . ': ' . value | |
| 99 | 581 :endfor |
| 582 | |
| 583 | |
| 584 Dictionary identity ~ | |
| 161 | 585 *dict-identity* |
| 99 | 586 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 587 Dictionary. Otherwise, assignment results in referring to the same | |
| 588 Dictionary: > | |
| 589 :let onedict = {'a': 1, 'b': 2} | |
| 590 :let adict = onedict | |
| 591 :let adict['a'] = 11 | |
| 592 :echo onedict['a'] | |
| 593 11 | |
| 594 | |
| 327 | 595 Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 596 more info see |list-identity|. | |
| 99 | 597 |
| 598 | |
| 599 Dictionary modification ~ | |
| 600 *dict-modification* | |
| 601 To change an already existing entry of a Dictionary, or to add a new entry, | |
| 602 use |:let| this way: > | |
| 603 :let dict[4] = "four" | |
| 604 :let dict['one'] = item | |
| 605 | |
| 108 | 606 Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 607 Three ways to remove the entry with key "aaa" from dict: > | |
| 608 :let i = remove(dict, 'aaa') | |
| 609 :unlet dict.aaa | |
| 610 :unlet dict['aaa'] | |
| 99 | 611 |
| 612 Merging a Dictionary with another is done with |extend()|: > | |
| 114 | 613 :call extend(adict, bdict) |
| 614 This extends adict with all entries from bdict. Duplicate keys cause entries | |
| 615 in adict to be overwritten. An optional third argument can change this. | |
| 119 | 616 Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 617 expect ":echo adict" to show the items from bdict after the older entries in | |
| 618 adict. | |
| 99 | 619 |
| 620 Weeding out entries from a Dictionary can be done with |filter()|: > | |
| 1156 | 621 :call filter(dict, 'v:val =~ "x"') |
| 114 | 622 This removes all entries from "dict" with a value not matching 'x'. |
| 20552 | 623 This can also be used to remove all entries: > |
| 624 call filter(dict, 0) | |
| 102 | 625 |
| 626 | |
| 627 Dictionary function ~ | |
| 4159 | 628 *Dictionary-function* *self* *E725* *E862* |
| 102 | 629 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
|
630 special way with a dictionary. Example: > |
| 102 | 631 :function Mylen() dict |
| 114 | 632 : return len(self.data) |
| 102 | 633 :endfunction |
| 114 | 634 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 635 :echo mydict.len() | |
| 102 | 636 |
| 637 This is like a method in object oriented programming. The entry in the | |
| 638 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary | |
| 639 the function was invoked from. | |
| 640 | |
| 114 | 641 It is also possible to add a function without the "dict" attribute as a |
| 642 Funcref to a Dictionary, but the "self" variable is not available then. | |
| 643 | |
| 819 | 644 *numbered-function* *anonymous-function* |
| 102 | 645 To avoid the extra name for the function it can be defined and directly |
| 646 assigned to a Dictionary in this way: > | |
| 114 | 647 :let mydict = {'data': [0, 1, 2, 3]} |
| 6741 | 648 :function mydict.len() |
| 114 | 649 : return len(self.data) |
| 102 | 650 :endfunction |
| 114 | 651 :echo mydict.len() |
| 652 | |
| 653 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
|
654 that references this function. The function can only be used through a |
| 114 | 655 |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 656 remaining that refers to it. | |
| 657 | |
| 658 It is not necessary to use the "dict" attribute for a numbered function. | |
| 102 | 659 |
|
2488
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
660 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
|
661 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
|
662 :function {42} |
|
def0e3934129
Preparations for 7.3d release.
Bram Moolenaar <bram@vim.org>
parents:
2465
diff
changeset
|
663 |
| 102 | 664 |
| 665 Functions for Dictionaries ~ | |
| 114 | 666 *E715* |
| 667 Functions that can be used with a Dictionary: > | |
| 102 | 668 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 669 :if empty(dict) " TRUE if dict is empty | |
| 670 :let l = len(dict) " number of items in dict | |
| 671 :let big = max(dict) " maximum value in dict | |
| 672 :let small = min(dict) " minimum value in dict | |
| 673 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict | |
| 674 :let s = string(dict) " String representation of dict | |
| 675 :call map(dict, '">> " . v:val') " prepend ">> " to each item | |
| 99 | 676 |
| 677 | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
678 1.5 Blobs ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
679 *blob* *Blob* *Blobs* *E978* |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
680 A Blob is a binary object. It can be used to read an image from a file and |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
681 send it over a channel, for example. |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
682 |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
683 A Blob mostly behaves like a |List| of numbers, where each number has the |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
684 value of an 8-bit byte, from 0 to 255. |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
685 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
686 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
687 Blob creation ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
688 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
689 A Blob can be created with a |blob-literal|: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
690 :let b = 0zFF00ED015DAF |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
691 Dots can be inserted between bytes (pair of hex characters) for readability, |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
692 they don't change the value: > |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
693 :let b = 0zFF00.ED01.5DAF |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
694 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
695 A blob can be read from a file with |readfile()| passing the {type} argument |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
696 set to "B", for example: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
697 :let b = readfile('image.png', 'B') |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
698 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
699 A blob can be read from a channel with the |ch_readblob()| function. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
700 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
701 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
702 Blob index ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
703 *blob-index* *E979* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
704 A byte in the Blob can be accessed by putting the index in square brackets |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
705 after the Blob. Indexes are zero-based, thus the first byte has index zero. > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
706 :let myblob = 0z00112233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
707 :let byte = myblob[0] " get the first byte: 0x00 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
708 :let byte = myblob[2] " get the third byte: 0x22 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
709 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
710 A negative index is counted from the end. Index -1 refers to the last byte in |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
711 the Blob, -2 to the last but one byte, etc. > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
712 :let last = myblob[-1] " get the last byte: 0x33 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
713 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
714 To avoid an error for an invalid index use the |get()| function. When an item |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
715 is not available it returns -1 or the default value you specify: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
716 :echo get(myblob, idx) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
717 :echo get(myblob, idx, 999) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
718 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
719 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
720 Blob iteration ~ |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
721 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
722 The |:for| loop executes commands for each byte of a Blob. The loop variable is |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
723 set to each byte in the Blob. Example: > |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
724 :for byte in 0z112233 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
725 : call Doit(byte) |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
726 :endfor |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
727 This calls Doit() with 0x11, 0x22 and 0x33. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
728 |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
729 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
730 Blob concatenation ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
731 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
732 Two blobs can be concatenated with the "+" operator: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
733 :let longblob = myblob + 0z4455 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
734 :let myblob += 0z6677 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
735 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
736 To change a blob in-place see |blob-modification| below. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
737 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
738 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
739 Part of a blob ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
740 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
741 A part of the Blob can be obtained by specifying the first and last index, |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
742 separated by a colon in square brackets: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
743 :let myblob = 0z00112233 |
| 15512 | 744 :let shortblob = myblob[1:2] " get 0z1122 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
745 :let shortblob = myblob[2:-1] " get 0z2233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
746 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
747 Omitting the first index is similar to zero. Omitting the last index is |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
748 similar to -1. > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
749 :let endblob = myblob[2:] " from item 2 to the end: 0z2233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
750 :let shortblob = myblob[2:2] " Blob with one byte: 0z22 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
751 :let otherblob = myblob[:] " make a copy of the Blob |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
752 |
| 15512 | 753 If the first index is beyond the last byte of the Blob or the second index is |
|
15725
a3e2e7948ee4
patch 8.1.0870: Vim doesn't use the new ConPTY support in Windows 10
Bram Moolenaar <Bram@vim.org>
parents:
15711
diff
changeset
|
754 before the first index, the result is an empty Blob. There is no error |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
755 message. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
756 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
757 If the second index is equal to or greater than the length of the list the |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
758 length minus one is used: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
759 :echo myblob[2:8] " result: 0z2233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
760 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
761 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
762 Blob modification ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
763 *blob-modification* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
764 To change a specific byte of a blob use |:let| this way: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
765 :let blob[4] = 0x44 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
766 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
767 When the index is just one beyond the end of the Blob, it is appended. Any |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
768 higher index is an error. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
769 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
770 To change a sequence of bytes the [:] notation can be used: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
771 let blob[1:3] = 0z445566 |
| 15512 | 772 The length of the replaced bytes must be exactly the same as the value |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
773 provided. *E972* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
774 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
775 To change part of a blob you can specify the first and last byte to be |
| 15512 | 776 modified. The value must have the same number of bytes in the range: > |
| 777 :let blob[3:5] = 0z334455 | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
778 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
779 You can also use the functions |add()|, |remove()| and |insert()|. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
780 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
781 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
782 Blob identity ~ |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
783 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
784 Blobs can be compared for equality: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
785 if blob == 0z001122 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
786 And for equal identity: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
787 if blob is otherblob |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
788 < *blob-identity* *E977* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
789 When variable "aa" is a Blob and you assign it to another variable "bb", both |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
790 variables refer to the same Blob. Then the "is" operator returns true. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
791 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
792 When making a copy using [:] or |copy()| the values are the same, but the |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
793 identity is different: > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
794 :let blob = 0z112233 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
795 :let blob2 = blob |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
796 :echo blob == blob2 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
797 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
798 :echo blob is blob2 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
799 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
800 :let blob3 = blob[:] |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
801 :echo blob == blob3 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
802 < 1 > |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
803 :echo blob is blob3 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
804 < 0 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
805 |
| 15512 | 806 Making a copy of a Blob is done with the |copy()| function. Using [:] also |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
807 works, as explained above. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
808 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
809 |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
810 1.6 More about variables ~ |
| 85 | 811 *more-variables* |
| 7 | 812 If you need to know the type of a variable or expression, use the |type()| |
| 813 function. | |
| 814 | |
| 815 When the '!' flag is included in the 'viminfo' option, global variables that | |
| 816 start with an uppercase letter, and don't contain a lowercase letter, are | |
| 817 stored in the viminfo file |viminfo-file|. | |
| 818 | |
| 819 When the 'sessionoptions' option contains "global", global variables that | |
| 820 start with an uppercase letter and contain at least one lowercase letter are | |
| 821 stored in the session file |session-file|. | |
| 822 | |
| 823 variable name can be stored where ~ | |
| 824 my_var_6 not | |
| 825 My_Var_6 session file | |
| 826 MY_VAR_6 viminfo file | |
| 827 | |
| 828 | |
| 829 It's possible to form a variable name with curly braces, see | |
| 830 |curly-braces-names|. | |
| 831 | |
| 832 ============================================================================== | |
| 833 2. Expression syntax *expression-syntax* | |
| 834 | |
| 835 Expression syntax summary, from least to most significant: | |
| 836 | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
837 |expr1| expr2 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
838 expr2 ? expr1 : expr1 if-then-else |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
839 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
840 |expr2| expr3 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
841 expr3 || expr3 ... logical OR |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
842 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
843 |expr3| expr4 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
844 expr4 && expr4 ... logical AND |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
845 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
846 |expr4| expr5 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
847 expr5 == expr5 equal |
| 7 | 848 expr5 != expr5 not equal |
| 849 expr5 > expr5 greater than | |
| 850 expr5 >= expr5 greater than or equal | |
| 851 expr5 < expr5 smaller than | |
| 852 expr5 <= expr5 smaller than or equal | |
| 853 expr5 =~ expr5 regexp matches | |
| 854 expr5 !~ expr5 regexp doesn't match | |
| 855 | |
| 856 expr5 ==? expr5 equal, ignoring case | |
| 857 expr5 ==# expr5 equal, match case | |
| 858 etc. As above, append ? for ignoring case, # for | |
| 859 matching case | |
| 860 | |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
861 expr5 is expr5 same |List|, |Dictionary| or |Blob| instance |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
862 expr5 isnot expr5 different |List|, |Dictionary| or |Blob| |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
863 instance |
| 79 | 864 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
865 |expr5| expr6 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
866 expr6 + expr6 ... number addition, list or blob concatenation |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
867 expr6 - expr6 ... number subtraction |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
868 expr6 . expr6 ... string concatenation |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
869 expr6 .. expr6 ... string concatenation |
| 7 | 870 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
871 |expr6| expr7 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
872 expr7 * expr7 ... number multiplication |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
873 expr7 / expr7 ... number division |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
874 expr7 % expr7 ... number modulo |
| 7 | 875 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
876 |expr7| expr8 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
877 ! expr7 logical NOT |
| 7 | 878 - expr7 unary minus |
| 879 + expr7 unary plus | |
| 102 | 880 |
|
10048
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
881 |expr8| expr9 |
|
43efa4f5a8ea
commit https://github.com/vim/vim/commit/89bcfda6834aba724d12554a34b9ed49f5789fd5
Christian Brabandt <cb@256bit.org>
parents:
10038
diff
changeset
|
882 expr8[expr1] byte of a String or item of a |List| |
| 685 | 883 expr8[expr1 : expr1] substring of a String or sublist of a |List| |
| 884 expr8.name entry in a |Dictionary| | |
| 885 expr8(expr1, ...) function call with |Funcref| variable | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
886 expr8->name(expr1, ...) |method| call |
| 102 | 887 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
888 |expr9| number number constant |
| 26 | 889 "string" string constant, backslash is special |
| 99 | 890 'string' string constant, ' is doubled |
| 685 | 891 [expr1, ...] |List| |
| 892 {expr1: expr1, ...} |Dictionary| | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
893 #{key: expr1, ...} |Dictionary| |
| 7 | 894 &option option value |
| 895 (expr1) nested expression | |
| 896 variable internal variable | |
| 897 va{ria}ble internal variable with curly braces | |
| 898 $VAR environment variable | |
| 899 @r contents of register 'r' | |
| 900 function(expr1, ...) function call | |
| 901 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
|
902 {args -> expr1} lambda expression |
| 7 | 903 |
| 904 | |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
905 "..." indicates that the operations in this level can be concatenated. |
| 7 | 906 Example: > |
| 907 &nu || &list && &shell == "csh" | |
| 908 | |
| 909 All expressions within one level are parsed from left to right. | |
| 910 | |
| 911 | |
| 22565 | 912 expr1 *expr1* *trinary* *falsy-operator* *??* *E109* |
| 7 | 913 ----- |
| 914 | |
|
22492
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
915 The trinary operator: expr2 ? expr1 : expr1 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
916 The falsy operator: expr2 ?? expr1 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
917 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
918 Trinary operator ~ |
| 7 | 919 |
| 920 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
|
921 |TRUE|, the result is the value of the expression between the '?' and ':', |
| 7 | 922 otherwise the result is the value of the expression after the ':'. |
| 923 Example: > | |
| 924 :echo lnum == 1 ? "top" : lnum | |
| 925 | |
| 926 Since the first expression is an "expr2", it cannot contain another ?:. The | |
| 927 other two expressions can, thus allow for recursive use of ?:. | |
| 928 Example: > | |
| 929 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum | |
| 930 | |
| 931 To keep this readable, using |line-continuation| is suggested: > | |
| 932 :echo lnum == 1 | |
| 933 :\ ? "top" | |
| 934 :\ : lnum == 1000 | |
| 935 :\ ? "last" | |
| 936 :\ : lnum | |
| 937 | |
| 1156 | 938 You should always put a space before the ':', otherwise it can be mistaken for |
| 939 use in a variable such as "a:1". | |
| 940 | |
|
22492
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
941 Falsy operator ~ |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
942 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
943 This is also known as the "null coalescing operator", but that's too |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
944 complicated, thus we just call it the falsy operator. |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
945 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
946 The expression before the '??' is evaluated. If it evaluates to |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
947 |truthy|, this is used as the result. Otherwise the expression after the '??' |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
948 is evaluated and used as the result. This is most useful to have a default |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
949 value for an expression that may result in zero or empty: > |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
950 echo theList ?? 'list is empty' |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
951 echo GetName() ?? 'unknown' |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
952 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
953 These are similar, but not equal: > |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
954 expr2 ?? expr1 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
955 expr2 ? expr2 : expr1 |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
956 In the second line "expr2" is evaluated twice. |
|
0e03ef68e738
patch 8.2.1794: no falsy Coalescing operator
Bram Moolenaar <Bram@vim.org>
parents:
22446
diff
changeset
|
957 |
| 7 | 958 |
| 959 expr2 and expr3 *expr2* *expr3* | |
| 960 --------------- | |
| 961 | |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
962 expr3 || expr3 .. logical OR *expr-barbar* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
963 expr4 && expr4 .. logical AND *expr-&&* |
|
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
964 |
| 7 | 965 The "||" and "&&" operators take one argument on each side. The arguments |
| 966 are (converted to) Numbers. The result is: | |
| 967 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
968 input output ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
969 n1 n2 n1 || n2 n1 && n2 ~ |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
970 |FALSE| |FALSE| |FALSE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
971 |FALSE| |TRUE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
972 |TRUE| |FALSE| |TRUE| |FALSE| |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
973 |TRUE| |TRUE| |TRUE| |TRUE| |
| 7 | 974 |
| 975 The operators can be concatenated, for example: > | |
| 976 | |
| 977 &nu || &list && &shell == "csh" | |
| 978 | |
| 979 Note that "&&" takes precedence over "||", so this has the meaning of: > | |
| 980 | |
| 981 &nu || (&list && &shell == "csh") | |
| 982 | |
| 983 Once the result is known, the expression "short-circuits", that is, further | |
| 984 arguments are not evaluated. This is like what happens in C. For example: > | |
| 985 | |
| 986 let a = 1 | |
| 987 echo a || b | |
| 988 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
989 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
|
990 so the result must be |TRUE|. Similarly below: > |
| 7 | 991 |
| 992 echo exists("b") && b == "yes" | |
| 993 | |
| 994 This is valid whether "b" has been defined or not. The second clause will | |
| 995 only be evaluated if "b" has been defined. | |
| 996 | |
| 997 | |
| 998 expr4 *expr4* | |
| 999 ----- | |
| 1000 | |
| 1001 expr5 {cmp} expr5 | |
| 1002 | |
| 1003 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 | |
| 1004 if it evaluates to true. | |
| 1005 | |
| 1621 | 1006 *expr-==* *expr-!=* *expr->* *expr->=* |
| 7 | 1007 *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 1008 *expr-==#* *expr-!=#* *expr->#* *expr->=#* | |
| 1009 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* | |
| 1010 *expr-==?* *expr-!=?* *expr->?* *expr->=?* | |
| 1011 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* | |
| 2908 | 1012 *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
| 1013 *expr-is?* *expr-isnot?* | |
| 7 | 1014 use 'ignorecase' match case ignore case ~ |
| 1015 equal == ==# ==? | |
| 1016 not equal != !=# !=? | |
| 1017 greater than > ># >? | |
| 1018 greater than or equal >= >=# >=? | |
| 1019 smaller than < <# <? | |
| 1020 smaller than or equal <= <=# <=? | |
| 1021 regexp matches =~ =~# =~? | |
| 1022 regexp doesn't match !~ !~# !~? | |
| 2908 | 1023 same instance is is# is? |
| 1024 different instance isnot isnot# isnot? | |
| 7 | 1025 |
| 1026 Examples: | |
| 1027 "abc" ==# "Abc" evaluates to 0 | |
| 1028 "abc" ==? "Abc" evaluates to 1 | |
| 1029 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise | |
| 1030 | |
| 85 | 1031 *E691* *E692* |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1032 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
|
1033 "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
|
1034 recursively. Ignoring case means case is ignored when comparing item values. |
| 79 | 1035 |
| 114 | 1036 *E735* *E736* |
| 685 | 1037 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
|
1038 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
|
1039 |Dictionary| recursively. Ignoring case means case is ignored when comparing |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
1040 item values. |
| 114 | 1041 |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
1042 *E694* |
|
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
1043 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
|
1044 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
|
1045 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
|
1046 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
|
1047 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
|
1048 |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9389
diff
changeset
|
1049 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
|
1050 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
|
1051 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
|
1052 " Part1 and Part2 refer to the same function |
| 685 | 1053 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1054 Using "is" or "isnot" with a |List|, |Dictionary| or |Blob| checks whether |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1055 the expressions are referring to the same |List|, |Dictionary| or |Blob| |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1056 instance. A copy of a |List| is different from the original |List|. When |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1057 using "is" without a |List|, |Dictionary| or |Blob|, it is equivalent to |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1058 using "equal", using "isnot" equivalent to using "not equal". Except that |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1059 a different type means the values are different: > |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1060 echo 4 == '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1061 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1062 echo 4 is '4' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1063 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1064 echo 0 is [] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1065 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1066 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
| 79 | 1067 |
| 7 | 1068 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
|
1069 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
|
1070 echo 0 == 'x' |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1071 1 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1072 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
|
1073 echo [0] == ['x'] |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1074 0 |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
1075 Inside a List or Dictionary this conversion is not used. |
| 7 | 1076 |
| 1077 When comparing two Strings, this is done with strcmp() or stricmp(). This | |
| 1078 results in the mathematical difference (comparing byte values), not | |
| 1079 necessarily the alphabetical difference in the local language. | |
| 1080 | |
| 1621 | 1081 When using the operators with a trailing '#', or the short version and |
| 1156 | 1082 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
| 7 | 1083 |
| 1084 When using the operators with a trailing '?', or the short version and | |
| 1156 | 1085 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 1086 | |
| 1087 'smartcase' is not used. | |
| 7 | 1088 |
| 1089 The "=~" and "!~" operators match the lefthand argument with the righthand | |
| 1090 argument, which is used as a pattern. See |pattern| for what a pattern is. | |
| 1091 This matching is always done like 'magic' was set and 'cpoptions' is empty, no | |
| 1092 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts | |
| 1093 portable. To avoid backslashes in the regexp pattern to be doubled, use a | |
| 1094 single-quote string, see |literal-string|. | |
| 1095 Since a string is considered to be a single line, a multi-line pattern | |
| 1096 (containing \n, backslash-n) will not match. However, a literal NL character | |
| 1097 can be matched like an ordinary character. Examples: | |
| 1098 "foo\nbar" =~ "\n" evaluates to 1 | |
| 1099 "foo\nbar" =~ "\\n" evaluates to 0 | |
| 1100 | |
| 1101 | |
| 1102 expr5 and expr6 *expr5* *expr6* | |
| 1103 --------------- | |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1104 expr6 + expr6 Number addition, |List| or |Blob| concatenation *expr-+* |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1105 expr6 - expr6 Number subtraction *expr--* |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1106 expr6 . expr6 String concatenation *expr-.* |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1107 expr6 .. expr6 String concatenation *expr-..* |
| 79 | 1108 |
| 692 | 1109 For |Lists| only "+" is possible and then both expr6 must be a list. The |
| 685 | 1110 result is a new list with the two lists Concatenated. |
| 79 | 1111 |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1112 For String concatenation ".." is preferred, since "." is ambiguous, it is also |
|
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1113 used for |Dict| member access and floating point numbers. |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
1114 When |vimscript-version| is 2 or higher, using "." is not allowed. |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
1115 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1116 expr7 * expr7 Number multiplication *expr-star* |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1117 expr7 / expr7 Number division *expr-/* |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
1118 expr7 % expr7 Number modulo *expr-%* |
| 7 | 1119 |
| 16267 | 1120 For all, except "." and "..", Strings are converted to Numbers. |
| 3214 | 1121 For bitwise operators see |and()|, |or()| and |xor()|. |
| 7 | 1122 |
| 1123 Note the difference between "+" and ".": | |
| 1124 "123" + "456" = 579 | |
| 1125 "123" . "456" = "123456" | |
| 1126 | |
| 1621 | 1127 Since '.' has the same precedence as '+' and '-', you need to read: > |
| 1128 1 . 90 + 90.0 | |
| 1129 As: > | |
| 1130 (1 . 90) + 90.0 | |
| 1131 That works, since the String "190" is automatically converted to the Number | |
| 1132 190, which can be added to the Float 90.0. However: > | |
| 1133 1 . 90 * 90.0 | |
| 1134 Should be read as: > | |
| 1135 1 . (90 * 90.0) | |
| 1136 Since '.' has lower precedence than '*'. This does NOT work, since this | |
| 1137 attempts to concatenate a Float and a String. | |
| 1138 | |
| 1139 When dividing a Number by zero the result depends on the value: | |
| 1140 0 / 0 = -0x80000000 (like NaN for Float) | |
| 1141 >0 / 0 = 0x7fffffff (like positive infinity) | |
| 1142 <0 / 0 = -0x7fffffff (like negative infinity) | |
| 1143 (before Vim 7.2 it was always 0x7fffffff) | |
| 1144 | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1145 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
|
1146 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
|
1147 >0 / 0 = 0x7fffffffffffffff (like positive infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1148 <0 / 0 = -0x7fffffffffffffff (like negative infinity) |
|
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1149 |
| 7 | 1150 When the righthand side of '%' is zero, the result is 0. |
| 1151 | |
| 685 | 1152 None of these work for |Funcref|s. |
| 79 | 1153 |
| 1621 | 1154 . and % do not work for Float. *E804* |
| 1155 | |
| 7 | 1156 |
| 1157 expr7 *expr7* | |
| 1158 ----- | |
| 1159 ! expr7 logical NOT *expr-!* | |
| 1160 - expr7 unary minus *expr-unary--* | |
| 1161 + expr7 unary plus *expr-unary-+* | |
| 1162 | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
1163 For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one). |
| 7 | 1164 For '-' the sign of the number is changed. |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1165 For '+' the number is unchanged. Note: "++" has no effect. |
| 7 | 1166 |
| 1167 A String will be converted to a Number first. | |
| 1168 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1169 These three can be repeated and mixed. Examples: |
| 7 | 1170 !-1 == 0 |
| 1171 !!8 == 1 | |
| 1172 --9 == 9 | |
| 1173 | |
| 1174 | |
| 1175 expr8 *expr8* | |
| 1176 ----- | |
| 14637 | 1177 This expression is either |expr9| or a sequence of the alternatives below, |
| 1178 in any order. E.g., these are all possible: | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1179 expr8[expr1].name |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1180 expr8.name[expr1] |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1181 expr8(expr1, ...)[expr1].name |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1182 expr8->(expr1, ...)[expr1] |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1183 Evaluation is always from left to right. |
| 14637 | 1184 |
| 685 | 1185 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
|
1186 *E909* *subscript* |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1187 In legacy Vim script: |
| 102 | 1188 If expr8 is a Number or String this results in a String that contains the |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1189 expr1'th single byte from expr8. expr8 is used as a String (a number is |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1190 automatically converted to a String), expr1 as a Number. This doesn't |
| 21991 | 1191 recognize multibyte encodings, see `byteidx()` for an alternative, or use |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1192 `split()` to turn the string into a list of characters. Example, to get the |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1193 byte under the cursor: > |
| 823 | 1194 :let c = getline(".")[col(".") - 1] |
| 7 | 1195 |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1196 In Vim9 script: |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1197 If expr8 is a String this results in a String that contains the expr1'th |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1198 single character (including any composing characters) from expr8. To use byte |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1199 indexes use |strpart()|. |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1200 |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1201 Index zero gives the first byte or character. Careful: text column numbers |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1202 start with one! |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1203 |
| 7 | 1204 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
|
1205 String. A negative index always results in an empty string (reason: backward |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1206 compatibility). Use [-1:] to get the last byte or character. |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1207 In Vim9 script a negative index is used like with a list: count from the end. |
| 55 | 1208 |
| 685 | 1209 If expr8 is a |List| then it results the item at index expr1. See |list-index| |
| 55 | 1210 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
|
1211 error. Example: > |
| 55 | 1212 :let item = mylist[-1] " get last item |
| 1213 | |
| 685 | 1214 Generally, if a |List| index is equal to or higher than the length of the |
| 1215 |List|, or more negative than the length of the |List|, this results in an | |
| 1216 error. | |
| 55 | 1217 |
| 99 | 1218 |
| 102 | 1219 expr8[expr1a : expr1b] substring or sublist *expr-[:]* |
| 1220 | |
| 21991 | 1221 If expr8 is a String this results in the substring with the bytes or |
| 1222 characters from expr1a to and including expr1b. expr8 is used as a String, | |
| 1223 expr1a and expr1b are used as a Number. | |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1224 |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1225 In legacy Vim script the indexes are byte indexes. This doesn't recognize |
| 21991 | 1226 multibyte encodings, see |byteidx()| for computing the indexes. If expr8 is |
|
21823
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1227 a Number it is first converted to a String. |
|
b1f3d8a44ab6
patch 8.2.1461: Vim9: string indexes are counted in bytes
Bram Moolenaar <Bram@vim.org>
parents:
21703
diff
changeset
|
1228 |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1229 In Vim9 script the indexes are character indexes and include composing |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1230 characters. To use byte indexes use |strpart()|. To use character indexes |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
1231 without including composing characters use |strcharpart()|. |
| 55 | 1232 |
|
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
1233 The item at index expr1b is included, it is inclusive. For an exclusive index |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
1234 use the |slice()| function. |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
1235 |
| 55 | 1236 If expr1a is omitted zero is used. If expr1b is omitted the length of the |
| 1237 string minus one is used. | |
| 1238 | |
| 1239 A negative number can be used to measure from the end of the string. -1 is | |
| 1240 the last character, -2 the last but one, etc. | |
| 1241 | |
| 1242 If an index goes out of range for the string characters are omitted. If | |
| 1243 expr1b is smaller than expr1a the result is an empty string. | |
| 1244 | |
| 1245 Examples: > | |
| 1246 :let c = name[-1:] " last byte of a string | |
| 21991 | 1247 :let c = name[0:-1] " the whole string |
| 55 | 1248 :let c = name[-2:-2] " last but one byte of a string |
| 1249 :let s = line(".")[4:] " from the fifth byte to the end | |
| 1250 :let s = s[:-3] " remove last two bytes | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1251 < |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
1252 *slice* |
| 685 | 1253 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
|
1254 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
|
1255 just above. Also see |sublist| below. Examples: > |
| 55 | 1256 :let l = mylist[:3] " first four items |
| 1257 :let l = mylist[4:4] " List with one item | |
| 1258 :let l = mylist[:] " shallow copy of a List | |
| 1259 | |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1260 If expr8 is a |Blob| this results in a new |Blob| with the bytes in the |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1261 indexes expr1a and expr1b, inclusive. Examples: > |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1262 :let b = 0zDEADBEEF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1263 :let bs = b[1:2] " 0zADBE |
| 15512 | 1264 :let bs = b[:] " copy of 0zDEADBEEF |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1265 |
| 685 | 1266 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an |
| 1267 error. | |
| 1268 | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1269 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
|
1270 for a sublist: > |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1271 mylist[n:] " uses variable n |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1272 mylist[s:] " uses namespace s:, error! |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1273 |
| 685 | 1274 |
| 1275 expr8.name entry in a |Dictionary| *expr-entry* | |
| 1276 | |
| 1277 If expr8 is a |Dictionary| and it is followed by a dot, then the following | |
| 1278 name will be used as a key in the |Dictionary|. This is just like: | |
| 1279 expr8[name]. | |
| 99 | 1280 |
| 1281 The name must consist of alphanumeric characters, just like a variable name, | |
| 1282 but it may start with a number. Curly braces cannot be used. | |
| 1283 | |
| 1284 There must not be white space before or after the dot. | |
| 1285 | |
| 1286 Examples: > | |
| 1287 :let dict = {"one": 1, 2: "two"} | |
| 16808 | 1288 :echo dict.one " shows "1" |
| 1289 :echo dict.2 " shows "two" | |
| 1290 :echo dict .2 " error because of space before the dot | |
| 99 | 1291 |
| 1292 Note that the dot is also used for String concatenation. To avoid confusion | |
| 1293 always put spaces around the dot for String concatenation. | |
| 1294 | |
| 1295 | |
| 685 | 1296 expr8(expr1, ...) |Funcref| function call |
| 102 | 1297 |
| 1298 When expr8 is a |Funcref| type variable, invoke the function it refers to. | |
| 1299 | |
| 1300 | |
|
17674
06c3e15ad84d
patch 8.1.1834: cannot use a lambda as a method
Bram Moolenaar <Bram@vim.org>
parents:
17667
diff
changeset
|
1301 expr8->name([args]) method call *method* *->* |
|
06c3e15ad84d
patch 8.1.1834: cannot use a lambda as a method
Bram Moolenaar <Bram@vim.org>
parents:
17667
diff
changeset
|
1302 expr8->{lambda}([args]) |
| 17758 | 1303 *E276* |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1304 For methods that are also available as global functions this is the same as: > |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1305 name(expr8 [, args]) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
1306 There can also be methods specifically for the type of "expr8". |
| 102 | 1307 |
|
17661
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1308 This allows for chaining, passing the value that one method returns to the |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1309 next method: > |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1310 mylist->filter(filterexpr)->map(mapexpr)->sort()->join() |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1311 < |
|
17674
06c3e15ad84d
patch 8.1.1834: cannot use a lambda as a method
Bram Moolenaar <Bram@vim.org>
parents:
17667
diff
changeset
|
1312 Example of using a lambda: > |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
1313 GetPercentage()->{x -> x * 100}()->printf('%d%%') |
| 17758 | 1314 < |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1315 When using -> the |expr7| operators will be applied first, thus: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1316 -1.234->string() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1317 Is equivalent to: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1318 (-1.234)->string() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1319 And NOT: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1320 -(1.234->string()) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
1321 < |
|
17661
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1322 *E274* |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1323 "->name(" must not contain white space. There can be white space before the |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1324 "->" and after the "(", thus you can split the lines like this: > |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1325 mylist |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1326 \ ->filter(filterexpr) |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1327 \ ->map(mapexpr) |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1328 \ ->sort() |
|
da7890e3359b
patch 8.1.1828: not strict enough checking syntax of method invocation
Bram Moolenaar <Bram@vim.org>
parents:
17624
diff
changeset
|
1329 \ ->join() |
| 17758 | 1330 |
| 1331 When using the lambda form there must be no white space between the } and the | |
| 1332 (. | |
| 1333 | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
1334 |
| 102 | 1335 *expr9* |
| 7 | 1336 number |
| 1337 ------ | |
| 12785 | 1338 number number constant *expr-number* |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1339 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1340 *0x* *hex-number* *0o* *octal-number* *binary-number* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
1341 Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B) |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
1342 and Octal (starting with 0, 0o or 0O). |
| 7 | 1343 |
| 1621 | 1344 *floating-point-format* |
| 1345 Floating point numbers can be written in two forms: | |
| 1346 | |
| 1347 [-+]{N}.{M} | |
| 6530 | 1348 [-+]{N}.{M}[eE][-+]{exp} |
| 1621 | 1349 |
| 1350 {N} and {M} are numbers. Both {N} and {M} must be present and can only | |
| 1351 contain digits. | |
| 1352 [-+] means there is an optional plus or minus sign. | |
| 1353 {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
|
1354 Only a decimal point is accepted, not a comma. No matter what the current |
| 1621 | 1355 locale is. |
| 1356 {only when compiled with the |+float| feature} | |
| 1357 | |
| 1358 Examples: | |
| 1359 123.456 | |
| 1360 +0.0001 | |
| 1361 55.0 | |
| 1362 -0.123 | |
| 1363 1.234e03 | |
| 1364 1.0E-6 | |
| 1365 -3.1416e+88 | |
| 1366 | |
| 1367 These are INVALID: | |
| 1368 3. empty {M} | |
| 1369 1e40 missing .{M} | |
| 1370 | |
| 1371 Rationale: | |
| 1372 Before floating point was introduced, the text "123.456" was interpreted as | |
| 1373 the two numbers "123" and "456", both converted to a string and concatenated, | |
| 1374 resulting in the string "123456". Since this was considered pointless, and we | |
| 1698 | 1375 could not find it intentionally being used in Vim scripts, this backwards |
| 1621 | 1376 incompatibility was accepted in favor of being able to use the normal notation |
| 1377 for floating point numbers. | |
| 1378 | |
| 15131 | 1379 *float-pi* *float-e* |
| 1380 A few useful values to copy&paste: > | |
| 1381 :let pi = 3.14159265359 | |
| 1382 :let e = 2.71828182846 | |
| 1383 Or, if you don't want to write them in as floating-point literals, you can | |
| 1384 also use functions, like the following: > | |
| 1385 :let pi = acos(-1.0) | |
| 1386 :let e = exp(1.0) | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
1387 < |
| 1621 | 1388 *floating-point-precision* |
| 1389 The precision and range of floating points numbers depends on what "double" | |
| 1390 means in the library Vim was compiled with. There is no way to change this at | |
| 1391 runtime. | |
| 1392 | |
| 1393 The default for displaying a |Float| is to use 6 decimal places, like using | |
| 1394 printf("%g", f). You can select something else when using the |printf()| | |
| 1395 function. Example: > | |
| 1396 :echo printf('%.15e', atan(1)) | |
| 1397 < 7.853981633974483e-01 | |
| 1398 | |
| 1399 | |
| 7 | 1400 |
| 6884 | 1401 string *string* *String* *expr-string* *E114* |
| 7 | 1402 ------ |
| 1403 "string" string constant *expr-quote* | |
| 1404 | |
| 1405 Note that double quotes are used. | |
| 1406 | |
| 1407 A string constant accepts these special characters: | |
| 1408 \... three-digit octal number (e.g., "\316") | |
| 1409 \.. two-digit octal number (must be followed by non-digit) | |
| 1410 \. one-digit octal number (must be followed by non-digit) | |
| 1411 \x.. byte specified with two hex numbers (e.g., "\x1f") | |
| 1412 \x. byte specified with one hex number (must be followed by non-hex char) | |
| 1413 \X.. same as \x.. | |
| 1414 \X. same as \x. | |
| 1621 | 1415 \u.... character specified with up to 4 hex numbers, stored according to the |
| 7 | 1416 current value of 'encoding' (e.g., "\u02a4") |
| 6840 | 1417 \U.... same as \u but allows up to 8 hex numbers. |
| 7 | 1418 \b backspace <BS> |
| 1419 \e escape <Esc> | |
| 1420 \f formfeed <FF> | |
| 1421 \n newline <NL> | |
| 1422 \r return <CR> | |
| 1423 \t tab <Tab> | |
| 1424 \\ backslash | |
| 1425 \" double quote | |
| 2152 | 1426 \<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
|
1427 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
|
1428 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
|
1429 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
|
1430 mentioned above. |
|
20627
8bce783af0cb
patch 8.2.0867: using {xxx} for encoding a modifier is not nice
Bram Moolenaar <Bram@vim.org>
parents:
20615
diff
changeset
|
1431 \<*xxx> Like \<xxx> but prepends a modifier instead of including it in the |
|
8bce783af0cb
patch 8.2.0867: using {xxx} for encoding a modifier is not nice
Bram Moolenaar <Bram@vim.org>
parents:
20615
diff
changeset
|
1432 character. E.g. "\<C-w>" is one character 0x17 while "\<*C-w>" is four |
|
20603
c2570baa2e4c
patch 8.2.0855: GUI tests fail because the test doesn't use a modifier
Bram Moolenaar <Bram@vim.org>
parents:
20593
diff
changeset
|
1433 bytes: 3 for the CTRL modifier and then character "W". |
| 7 | 1434 |
| 1156 | 1435 Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1436 encodings. Use "\u00ff" to store character 255 according to the current value | |
| 1437 of 'encoding'. | |
| 1438 | |
| 7 | 1439 Note that "\000" and "\x00" force the end of the string. |
| 1440 | |
| 1441 | |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
1442 blob-literal *blob-literal* *E973* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1443 ------------ |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1444 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1445 Hexadecimal starting with 0z or 0Z, with an arbitrary number of bytes. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1446 The sequence must be an even number of hex characters. Example: > |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1447 :let b = 0zFF00ED015DAF |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1448 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
1449 |
| 7 | 1450 literal-string *literal-string* *E115* |
| 1451 --------------- | |
| 26 | 1452 'string' string constant *expr-'* |
| 7 | 1453 |
| 1454 Note that single quotes are used. | |
| 1455 | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1456 This string is taken as it is. No backslashes are removed or have a special |
| 99 | 1457 meaning. The only exception is that two quotes stand for one quote. |
| 26 | 1458 |
| 1459 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
|
1460 to be doubled. These two commands are equivalent: > |
| 26 | 1461 if a =~ "\\s*" |
| 1462 if a =~ '\s*' | |
| 7 | 1463 |
| 1464 | |
| 1465 option *expr-option* *E112* *E113* | |
| 1466 ------ | |
| 1467 &option option value, local value if possible | |
| 1468 &g:option global option value | |
| 1469 &l:option local option value | |
| 1470 | |
| 1471 Examples: > | |
| 1472 echo "tabstop is " . &tabstop | |
| 1473 if &insertmode | |
| 1474 | |
| 1475 Any option name can be used here. See |options|. When using the local value | |
| 1476 and there is no buffer-local or window-local value, the global value is used | |
| 1477 anyway. | |
| 1478 | |
| 1479 | |
| 1156 | 1480 register *expr-register* *@r* |
| 7 | 1481 -------- |
| 1482 @r contents of register 'r' | |
| 1483 | |
| 1484 The result is the contents of the named register, as a single string. | |
| 1485 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
|
1486 register use @" or @@. See |registers| for an explanation of the available |
| 336 | 1487 registers. |
| 1488 | |
| 1489 When using the '=' register you get the expression itself, not what it | |
| 1490 evaluates to. Use |eval()| to evaluate it. | |
| 7 | 1491 |
| 1492 | |
| 1493 nesting *expr-nesting* *E110* | |
| 1494 ------- | |
| 1495 (expr1) nested expression | |
| 1496 | |
| 1497 | |
| 1498 environment variable *expr-env* | |
| 1499 -------------------- | |
| 1500 $VAR environment variable | |
| 1501 | |
| 1502 The String value of any environment variable. When it is not defined, the | |
| 1503 result is an empty string. | |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1504 |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1505 The functions `getenv()` and `setenv()` can also be used and work for |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1506 environment variables with non-alphanumeric names. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1507 The function `environ()` can be used to get a Dict with all environment |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1508 variables. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1509 |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
1510 |
| 7 | 1511 *expr-env-expand* |
| 1512 Note that there is a difference between using $VAR directly and using | |
| 1513 expand("$VAR"). Using it directly will only expand environment variables that | |
| 1514 are known inside the current Vim session. Using expand() will first try using | |
| 1515 the environment variables known inside the current Vim session. If that | |
| 1516 fails, a shell will be used to expand the variable. This can be slow, but it | |
| 1517 does expand all variables that the shell knows about. Example: > | |
| 6180 | 1518 :echo $shell |
| 1519 :echo expand("$shell") | |
| 1520 The first one probably doesn't echo anything, the second echoes the $shell | |
| 7 | 1521 variable (if your shell supports it). |
| 1522 | |
| 1523 | |
| 1524 internal variable *expr-variable* | |
| 1525 ----------------- | |
| 1526 variable internal variable | |
| 1527 See below |internal-variables|. | |
| 1528 | |
| 1529 | |
| 170 | 1530 function call *expr-function* *E116* *E118* *E119* *E120* |
| 7 | 1531 ------------- |
| 1532 function(expr1, ...) function call | |
| 1533 See below |functions|. | |
| 1534 | |
| 1535 | |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1536 lambda expression *expr-lambda* *lambda* |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1537 ----------------- |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1538 {args -> expr1} lambda expression |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1539 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1540 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
|
1541 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
|
1542 the following ways: |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1543 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1544 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
|
1545 commands. |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1546 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
|
1547 :let F = {arg1, arg2 -> arg1 - arg2} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1548 :echo F(5, 2) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1549 < 3 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1550 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1551 The arguments are optional. Example: > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1552 :let F = {-> 'error function'} |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1553 :echo F() |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1554 < error function |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1555 *closure* |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1556 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
|
1557 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
|
1558 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
|
1559 the function returns: > |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1560 :function Foo(arg) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1561 : let i = 3 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1562 : return {x -> x + i - a:arg} |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1563 :endfunction |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1564 :let Bar = Foo(4) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1565 :echo Bar(6) |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1566 < 5 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
1567 |
| 20552 | 1568 Note that the variables must exist in the outer scope before the lambda is |
|
13329
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1569 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
|
1570 |
|
424321d6eea7
patch 8.0.1539: no test for the popup menu positioning
Christian Brabandt <cb@256bit.org>
parents:
13298
diff
changeset
|
1571 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
|
1572 if has('lambda') |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1573 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1574 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
|
1575 :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
|
1576 < [2, 3, 4] > |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1577 :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
|
1578 < [1, 2, 3, 4, 7] |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1579 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1580 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
|
1581 :let timer = timer_start(500, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1582 \ {-> execute("echo 'Handler called'", "")}, |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1583 \ {'repeat': 3}) |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1584 < Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1585 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1586 Handler called |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1587 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1588 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
|
1589 |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1590 |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1591 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
|
1592 for a lambda expression, you can find what it is with the following command: > |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
1593 :function <lambda>42 |
|
9686
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1594 See also: |numbered-function| |
|
8c2553beff0f
commit https://github.com/vim/vim/commit/1e96d9bf98f9ab84d5af7f98d6a961d91b17364f
Christian Brabandt <cb@256bit.org>
parents:
9644
diff
changeset
|
1595 |
| 7 | 1596 ============================================================================== |
| 2596 | 1597 3. Internal variable *internal-variables* *E461* |
| 1598 | |
| 7 | 1599 An internal variable name can be made up of letters, digits and '_'. But it |
| 1600 cannot start with a digit. It's also possible to use curly braces, see | |
| 1601 |curly-braces-names|. | |
| 1602 | |
| 1603 An internal variable is created with the ":let" command |:let|. | |
| 87 | 1604 An internal variable is explicitly destroyed with the ":unlet" command |
| 1605 |:unlet|. | |
| 1606 Using a name that is not an internal variable or refers to a variable that has | |
| 1607 been destroyed results in an error. | |
| 7 | 1608 |
| 20856 | 1609 *variable-scope* |
| 7 | 1610 There are several name spaces for variables. Which one is to be used is |
| 1611 specified by what is prepended: | |
| 1612 | |
| 1613 (nothing) In a function: local to a function; otherwise: global | |
| 1614 |buffer-variable| b: Local to the current buffer. | |
| 1615 |window-variable| w: Local to the current window. | |
| 819 | 1616 |tabpage-variable| t: Local to the current tab page. |
| 7 | 1617 |global-variable| g: Global. |
| 1618 |local-variable| l: Local to a function. | |
| 1619 |script-variable| s: Local to a |:source|'ed Vim script. | |
| 1620 |function-argument| a: Function argument (only inside a function). | |
| 5815 | 1621 |vim-variable| v: Global, predefined by Vim. |
| 7 | 1622 |
| 685 | 1623 The scope name by itself can be used as a |Dictionary|. For example, to |
| 1624 delete all script-local variables: > | |
| 133 | 1625 :for k in keys(s:) |
| 1626 : unlet s:[k] | |
| 1627 :endfor | |
| 20856 | 1628 |
| 1629 Note: in Vim9 script this is different, see |vim9-scopes|. | |
| 1630 | |
| 4358 | 1631 *buffer-variable* *b:var* *b:* |
| 7 | 1632 A variable name that is preceded with "b:" is local to the current buffer. |
| 1633 Thus you can have several "b:foo" variables, one for each buffer. | |
| 1634 This kind of variable is deleted when the buffer is wiped out or deleted with | |
| 1635 |:bdelete|. | |
| 1636 | |
| 1637 One local buffer variable is predefined: | |
| 4264 | 1638 *b:changedtick* *changetick* |
| 7 | 1639 b:changedtick The total number of changes to the current buffer. It is |
| 1640 incremented for each change. An undo command is also a change | |
|
16996
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1641 in this case. Resetting 'modified' when writing the buffer is |
|
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1642 also counted. |
|
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1643 This can be used to perform an action only when the buffer has |
|
d5e1e09a829f
patch 8.1.1498: ":write" increments b:changedtick even though nothing changed
Bram Moolenaar <Bram@vim.org>
parents:
16971
diff
changeset
|
1644 changed. Example: > |
| 7 | 1645 :if my_changedtick != b:changedtick |
| 1621 | 1646 : let my_changedtick = b:changedtick |
| 1647 : call My_Update() | |
| 7 | 1648 :endif |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1649 < You cannot change or delete the b:changedtick variable. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
1650 |
| 4358 | 1651 *window-variable* *w:var* *w:* |
| 7 | 1652 A variable name that is preceded with "w:" is local to the current window. It |
| 1653 is deleted when the window is closed. | |
| 1654 | |
| 4437 | 1655 *tabpage-variable* *t:var* *t:* |
| 819 | 1656 A variable name that is preceded with "t:" is local to the current tab page, |
| 1657 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
|
1658 without the |+windows| feature} |
| 819 | 1659 |
| 4358 | 1660 *global-variable* *g:var* *g:* |
| 7 | 1661 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
|
1662 access a variable local to a function. But "g:" can also be used in any other |
| 7 | 1663 place if you like. |
| 1664 | |
| 4358 | 1665 *local-variable* *l:var* *l:* |
| 7 | 1666 Inside functions local variables are accessed without prepending anything. |
| 1156 | 1667 But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1668 you may run into reserved variable names. For example "count". By itself it | |
| 1669 refers to "v:count". Using "l:count" you can have a local variable with the | |
| 1670 same name. | |
| 7 | 1671 |
| 1672 *script-variable* *s:var* | |
| 1673 In a Vim script variables starting with "s:" can be used. They cannot be | |
| 1674 accessed from outside of the scripts, thus are local to the script. | |
| 1675 | |
| 1676 They can be used in: | |
| 1677 - commands executed while the script is sourced | |
| 1678 - functions defined in the script | |
| 1679 - autocommands defined in the script | |
| 1680 - functions and autocommands defined in functions and autocommands which were | |
| 1681 defined in the script (recursively) | |
| 1682 - user defined commands defined in the script | |
| 1683 Thus not in: | |
| 1684 - other scripts sourced from this one | |
| 1685 - mappings | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1686 - menus |
| 7 | 1687 - etc. |
| 1688 | |
| 1156 | 1689 Script variables can be used to avoid conflicts with global variable names. |
| 1690 Take this example: > | |
| 7 | 1691 |
| 1692 let s:counter = 0 | |
| 1693 function MyCounter() | |
| 1694 let s:counter = s:counter + 1 | |
| 1695 echo s:counter | |
| 1696 endfunction | |
| 1697 command Tick call MyCounter() | |
| 1698 | |
| 1699 You can now invoke "Tick" from any script, and the "s:counter" variable in | |
| 1700 that script will not be changed, only the "s:counter" in the script where | |
| 1701 "Tick" was defined is used. | |
| 1702 | |
| 1703 Another example that does the same: > | |
| 1704 | |
| 1705 let s:counter = 0 | |
| 1706 command Tick let s:counter = s:counter + 1 | echo s:counter | |
| 1707 | |
| 1708 When calling a function and invoking a user-defined command, the context for | |
| 9 | 1709 script variables is set to the script where the function or command was |
| 7 | 1710 defined. |
| 1711 | |
| 1712 The script variables are also available when a function is defined inside a | |
| 1713 function that is defined in a script. Example: > | |
| 1714 | |
| 1715 let s:counter = 0 | |
| 1716 function StartCounting(incr) | |
| 1717 if a:incr | |
| 1718 function MyCounter() | |
| 1719 let s:counter = s:counter + 1 | |
| 1720 endfunction | |
| 1721 else | |
| 1722 function MyCounter() | |
| 1723 let s:counter = s:counter - 1 | |
| 1724 endfunction | |
| 1725 endif | |
| 1726 endfunction | |
| 1727 | |
| 1728 This defines the MyCounter() function either for counting up or counting down | |
| 1729 when calling StartCounting(). It doesn't matter from where StartCounting() is | |
| 1730 called, the s:counter variable will be accessible in MyCounter(). | |
| 1731 | |
| 1732 When the same script is sourced again it will use the same script variables. | |
| 1733 They will remain valid as long as Vim is running. This can be used to | |
| 1734 maintain a counter: > | |
| 1735 | |
| 1736 if !exists("s:counter") | |
| 1737 let s:counter = 1 | |
| 1738 echo "script executed for the first time" | |
| 1739 else | |
| 1740 let s:counter = s:counter + 1 | |
| 1741 echo "script executed " . s:counter . " times now" | |
| 1742 endif | |
| 1743 | |
| 1744 Note that this means that filetype plugins don't get a different set of script | |
| 1745 variables for each buffer. Use local buffer variables instead |b:var|. | |
| 1746 | |
| 1747 | |
| 15131 | 1748 PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:* |
| 1749 *E963* | |
| 1750 Some variables can be set by the user, but the type cannot be changed. | |
| 7 | 1751 |
|
18477
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1752 *v:argv* *argv-variable* |
|
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1753 v:argv The command line arguments Vim was invoked with. This is a |
|
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1754 list of strings. The first item is the Vim command. |
|
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
1755 |
| 189 | 1756 *v:beval_col* *beval_col-variable* |
| 1757 v:beval_col The number of the column, over which the mouse pointer is. | |
| 1758 This is the byte index in the |v:beval_lnum| line. | |
| 1759 Only valid while evaluating the 'balloonexpr' option. | |
| 1760 | |
| 1761 *v:beval_bufnr* *beval_bufnr-variable* | |
| 1762 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only | |
| 1763 valid while evaluating the 'balloonexpr' option. | |
| 1764 | |
| 1765 *v:beval_lnum* *beval_lnum-variable* | |
| 1766 v:beval_lnum The number of the line, over which the mouse pointer is. Only | |
| 1767 valid while evaluating the 'balloonexpr' option. | |
| 1768 | |
| 1769 *v:beval_text* *beval_text-variable* | |
| 374 | 1770 v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1771 it is useful for debugging a C program. 'iskeyword' applies, | |
| 1772 but a dot and "->" before the position is included. When on a | |
| 1773 ']' the text before it is used, including the matching '[' and | |
| 189 | 1774 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
|
1775 highlighted text is used. Also see |<cexpr>|. |
| 189 | 1776 Only valid while evaluating the 'balloonexpr' option. |
| 1777 | |
| 1778 *v:beval_winnr* *beval_winnr-variable* | |
| 1779 v:beval_winnr The number of the window, over which the mouse pointer is. Only | |
| 2709 | 1780 valid while evaluating the 'balloonexpr' option. The first |
| 1781 window has number zero (unlike most other places where a | |
| 1782 window gets a number). | |
| 189 | 1783 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
1784 *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
|
1785 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
|
1786 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
|
1787 |
| 844 | 1788 *v:char* *char-variable* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1789 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
|
1790 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
|
1791 It is also used by the |InsertCharPre| and |InsertEnter| events. |
| 844 | 1792 |
| 7 | 1793 *v:charconvert_from* *charconvert_from-variable* |
| 1794 v:charconvert_from | |
| 1795 The name of the character encoding of a file to be converted. | |
| 1796 Only valid while evaluating the 'charconvert' option. | |
| 1797 | |
| 1798 *v:charconvert_to* *charconvert_to-variable* | |
| 1799 v:charconvert_to | |
| 1800 The name of the character encoding of a file after conversion. | |
| 1801 Only valid while evaluating the 'charconvert' option. | |
| 1802 | |
| 1803 *v:cmdarg* *cmdarg-variable* | |
| 1804 v:cmdarg This variable is used for two purposes: | |
| 1805 1. The extra arguments given to a file read/write command. | |
| 1806 Currently these are "++enc=" and "++ff=". This variable is | |
| 1807 set before an autocommand event for a file read/write | |
| 1808 command is triggered. There is a leading space to make it | |
| 1809 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
|
1810 read/write command. Note: The "+cmd" argument isn't |
| 7 | 1811 included here, because it will be executed anyway. |
| 1812 2. When printing a PostScript file with ":hardcopy" this is | |
| 1813 the argument for the ":hardcopy" command. This can be used | |
| 1814 in 'printexpr'. | |
| 1815 | |
| 1816 *v:cmdbang* *cmdbang-variable* | |
| 1817 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" | |
| 1818 was used the value is 1, otherwise it is 0. Note that this | |
| 1819 can only be used in autocommands. For user commands |<bang>| | |
| 1820 can be used. | |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1821 *v:collate* *collate-variable* |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1822 v:collate The current locale setting for collation order of the runtime |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1823 environment. This allows Vim scripts to be aware of the |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1824 current locale encoding. Technical: it's the value of |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1825 LC_COLLATE. When not using a locale the value is "C". |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1826 This variable can not be set directly, use the |:language| |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1827 command. |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
1828 See |multi-lang|. |
| 7 | 1829 |
| 6909 | 1830 *v:completed_item* *completed_item-variable* |
| 1831 v:completed_item | |
| 1832 |Dictionary| containing the |complete-items| for the most | |
| 1833 recently completed word after |CompleteDone|. The | |
| 1834 |Dictionary| is empty if the completion failed. | |
| 1835 | |
| 7 | 1836 *v:count* *count-variable* |
| 1837 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
|
1838 to get the count before a mapping. Read-only. Example: > |
| 7 | 1839 :map _x :<C-U>echo "the count is " . v:count<CR> |
| 1840 < Note: The <C-U> is required to remove the line range that you | |
| 1841 get when typing ':' after a count. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1842 When there are two counts, as in "3d2w", they are multiplied, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
1843 just like what happens in the command, "d6w" for the example. |
| 667 | 1844 Also used for evaluating the 'formatexpr' option. |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1845 "count" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1846 |scriptversion| is 3 or higher. |
| 7 | 1847 |
| 1848 *v:count1* *count1-variable* | |
| 1849 v:count1 Just like "v:count", but defaults to one when no count is | |
| 1850 used. | |
| 1851 | |
| 1852 *v:ctype* *ctype-variable* | |
| 1853 v:ctype The current locale setting for characters of the runtime | |
| 1854 environment. This allows Vim scripts to be aware of the | |
| 1855 current locale encoding. Technical: it's the value of | |
| 1856 LC_CTYPE. When not using a locale the value is "C". | |
| 1857 This variable can not be set directly, use the |:language| | |
| 1858 command. | |
| 1859 See |multi-lang|. | |
| 1860 | |
| 1861 *v:dying* *dying-variable* | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
1862 v:dying Normally zero. When a deadly signal is caught it's set to |
| 7 | 1863 one. When multiple signals are caught the number increases. |
| 1864 Can be used in an autocommand to check if Vim didn't | |
| 1865 terminate normally. {only works on Unix} | |
| 1866 Example: > | |
| 1867 :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
|
1868 < 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
|
1869 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
|
1870 |
|
23048
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1871 *v:exiting* *exiting-variable* |
|
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1872 v:exiting Vim exit code. Normally zero, non-zero when something went |
|
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1873 wrong. The value is v:null before invoking the |VimLeavePre| |
|
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1874 and |VimLeave| autocmds. See |:q|, |:x| and |:cquit|. |
|
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1875 Example: > |
|
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1876 :au VimLeave * echo "Exit value is " .. v:exiting |
|
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1877 < |
|
17833
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1878 *v:echospace* *echospace-variable* |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1879 v:echospace Number of screen cells that can be used for an `:echo` message |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1880 in the last screen line before causing the |hit-enter-prompt|. |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1881 Depends on 'showcmd', 'ruler' and 'columns'. You need to |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1882 check 'cmdheight' for whether there are full-width lines |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1883 available above the last line. |
|
8377ec7c5824
patch 8.1.1913: not easy to compute the space on the command line
Bram Moolenaar <Bram@vim.org>
parents:
17829
diff
changeset
|
1884 |
| 7 | 1885 *v:errmsg* *errmsg-variable* |
| 1886 v:errmsg Last given error message. It's allowed to set this variable. | |
| 1887 Example: > | |
| 1888 :let v:errmsg = "" | |
| 1889 :silent! next | |
| 1890 :if v:errmsg != "" | |
| 1891 : ... handle error | |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1892 < "errmsg" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
1893 |scriptversion| is 3 or higher. |
| 7 | 1894 |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
1895 *v:errors* *errors-variable* *assert-return* |
|
7279
b5e9810b389d
commit https://github.com/vim/vim/commit/683fa185a4b4ed7595e5942901548b8239ed5cdb
Christian Brabandt <cb@256bit.org>
parents:
7277
diff
changeset
|
1896 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
|
1897 This is a list of strings. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1898 The assert functions append an item when an assert fails. |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
1899 The return value indicates this: a one is returned if an item |
|
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
1900 was added to v:errors, otherwise zero is returned. |
|
7277
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1901 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
|
1902 :let v:errors = [] |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1903 < 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
|
1904 list by the assert function. |
|
6600871bb38c
commit https://github.com/vim/vim/commit/43345546ae63710441f066648b8485fb545b3801
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
1905 |
|
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1906 *v:event* *event-variable* |
|
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
13026
diff
changeset
|
1907 v:event Dictionary containing information about the current |
| 19303 | 1908 |autocommand|. See the specific event for what it puts in |
| 1909 this dictionary. | |
| 20115 | 1910 The dictionary is emptied when the |autocommand| finishes, |
| 1911 please refer to |dict-identity| for how to get an independent | |
| 1912 copy of it. Use |deepcopy()| if you want to keep the | |
| 1913 information after the event triggers. Example: > | |
| 1914 au TextYankPost * let g:foo = deepcopy(v:event) | |
| 1915 < | |
| 7 | 1916 *v:exception* *exception-variable* |
| 1917 v:exception The value of the exception most recently caught and not | |
| 1918 finished. See also |v:throwpoint| and |throw-variables|. | |
| 1919 Example: > | |
| 1920 :try | |
| 1921 : throw "oops" | |
| 1922 :catch /.*/ | |
| 17571 | 1923 : echo "caught " .. v:exception |
| 7 | 1924 :endtry |
| 1925 < Output: "caught oops". | |
| 1926 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1927 *v:false* *false-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1928 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
|
1929 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1930 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
|
1931 echo v:false |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1932 < v:false ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
1933 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
|
1934 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
1935 |
| 179 | 1936 *v:fcs_reason* *fcs_reason-variable* |
| 1937 v:fcs_reason The reason why the |FileChangedShell| event was triggered. | |
| 1938 Can be used in an autocommand to decide what to do and/or what | |
| 1939 to set v:fcs_choice to. Possible values: | |
| 1940 deleted file no longer exists | |
| 1941 conflict file contents, mode or timestamp was | |
| 1942 changed and buffer is modified | |
| 1943 changed file contents has changed | |
| 1944 mode mode of file changed | |
| 1945 time only file timestamp changed | |
| 1946 | |
| 1947 *v:fcs_choice* *fcs_choice-variable* | |
| 1948 v:fcs_choice What should happen after a |FileChangedShell| event was | |
| 1949 triggered. Can be used in an autocommand to tell Vim what to | |
| 1950 do with the affected buffer: | |
| 1951 reload Reload the buffer (does not work if | |
| 1952 the file was deleted). | |
| 1953 ask Ask the user what to do, as if there | |
| 1954 was no autocommand. Except that when | |
| 1955 only the timestamp changed nothing | |
| 1956 will happen. | |
| 1957 <empty> Nothing, the autocommand should do | |
| 1958 everything that needs to be done. | |
| 1959 The default is empty. If another (invalid) value is used then | |
| 1960 Vim behaves like it is empty, there is no warning message. | |
| 1961 | |
| 7 | 1962 *v:fname_in* *fname_in-variable* |
| 579 | 1963 v:fname_in The name of the input file. Valid while evaluating: |
| 7 | 1964 option used for ~ |
| 1965 'charconvert' file to be converted | |
| 1966 'diffexpr' original file | |
| 1967 'patchexpr' original file | |
| 1968 'printexpr' file to be printed | |
| 593 | 1969 And set to the swap file name for |SwapExists|. |
| 7 | 1970 |
| 1971 *v:fname_out* *fname_out-variable* | |
| 1972 v:fname_out The name of the output file. Only valid while | |
| 1973 evaluating: | |
| 1974 option used for ~ | |
| 1975 'charconvert' resulting converted file (*) | |
| 1976 'diffexpr' output of diff | |
| 1977 'patchexpr' resulting patched file | |
| 1978 (*) 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
|
1979 file") it will be equal to v:fname_in. When doing conversion |
| 7 | 1980 for a read command (e.g., ":e file") it will be a temporary |
| 1981 file and different from v:fname_in. | |
| 1982 | |
| 1983 *v:fname_new* *fname_new-variable* | |
| 1984 v:fname_new The name of the new version of the file. Only valid while | |
| 1985 evaluating 'diffexpr'. | |
| 1986 | |
| 1987 *v:fname_diff* *fname_diff-variable* | |
| 1988 v:fname_diff The name of the diff (patch) file. Only valid while | |
| 1989 evaluating 'patchexpr'. | |
| 1990 | |
| 1991 *v:folddashes* *folddashes-variable* | |
| 1992 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed | |
| 1993 fold. | |
| 29 | 1994 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1995 |
| 1996 *v:foldlevel* *foldlevel-variable* | |
| 1997 v:foldlevel Used for 'foldtext': foldlevel of closed fold. | |
| 29 | 1998 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 1999 |
| 2000 *v:foldend* *foldend-variable* | |
| 2001 v:foldend Used for 'foldtext': last line of closed fold. | |
| 29 | 2002 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 2003 |
| 2004 *v:foldstart* *foldstart-variable* | |
| 2005 v:foldstart Used for 'foldtext': first line of closed fold. | |
| 29 | 2006 Read-only in the |sandbox|. |fold-foldtext| |
| 7 | 2007 |
| 5460 | 2008 *v:hlsearch* *hlsearch-variable* |
| 12785 | 2009 v:hlsearch Variable that indicates whether search highlighting is on. |
| 6413 | 2010 Setting it makes sense only if 'hlsearch' is enabled which |
| 2011 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
|
2012 like the |:nohlsearch| command, setting it to one acts like > |
| 5460 | 2013 let &hlsearch = &hlsearch |
| 6918 | 2014 < Note that the value is restored when returning from a |
| 2015 function. |function-search-undo|. | |
| 2016 | |
| 11 | 2017 *v:insertmode* *insertmode-variable* |
| 2018 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand | |
| 2019 events. Values: | |
| 2020 i Insert mode | |
| 2021 r Replace mode | |
| 2022 v Virtual Replace mode | |
| 2023 | |
| 102 | 2024 *v:key* *key-variable* |
| 685 | 2025 v:key Key of the current item of a |Dictionary|. Only valid while |
| 102 | 2026 evaluating the expression used with |map()| and |filter()|. |
| 2027 Read-only. | |
| 2028 | |
| 7 | 2029 *v:lang* *lang-variable* |
| 2030 v:lang The current locale setting for messages of the runtime | |
| 2031 environment. This allows Vim scripts to be aware of the | |
| 2032 current language. Technical: it's the value of LC_MESSAGES. | |
| 2033 The value is system dependent. | |
| 2034 This variable can not be set directly, use the |:language| | |
| 2035 command. | |
| 2036 It can be different from |v:ctype| when messages are desired | |
| 2037 in a different language than what is used for character | |
| 2038 encoding. See |multi-lang|. | |
| 2039 | |
| 2040 *v:lc_time* *lc_time-variable* | |
| 2041 v:lc_time The current locale setting for time messages of the runtime | |
| 2042 environment. This allows Vim scripts to be aware of the | |
| 2043 current language. Technical: it's the value of LC_TIME. | |
| 2044 This variable can not be set directly, use the |:language| | |
| 2045 command. See |multi-lang|. | |
| 2046 | |
| 2047 *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
|
2048 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
|
2049 '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
|
2050 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
|
2051 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
|
2052 |sandbox|. |
| 7 | 2053 |
| 1029 | 2054 *v:mouse_win* *mouse_win-variable* |
| 2055 v:mouse_win Window number for a mouse click obtained with |getchar()|. | |
| 2056 First window has number 1, like with |winnr()|. The value is | |
| 2057 zero when there was no mouse button click. | |
| 2058 | |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
2059 *v:mouse_winid* *mouse_winid-variable* |
|
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
2060 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
|
2061 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
|
2062 |
| 1029 | 2063 *v:mouse_lnum* *mouse_lnum-variable* |
| 2064 v:mouse_lnum Line number for a mouse click obtained with |getchar()|. | |
| 2065 This is the text line number, not the screen line number. The | |
| 2066 value is zero when there was no mouse button click. | |
| 2067 | |
| 2068 *v:mouse_col* *mouse_col-variable* | |
| 2069 v:mouse_col Column number for a mouse click obtained with |getchar()|. | |
| 2070 This is the screen column number, like with |virtcol()|. The | |
| 2071 value is zero when there was no mouse button click. | |
| 2072 | |
| 15512 | 2073 *v:none* *none-variable* *None* |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2074 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
|
2075 |json_encode()|. |
| 21499 | 2076 This can also be used as a function argument to use the |
| 2077 default value, see |none-function_argument|. | |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
2078 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
|
2079 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
|
2080 echo v:none |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2081 < v:none ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2082 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
|
2083 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2084 |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2085 *v:null* *null-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2086 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
|
2087 |json_encode()|. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
2088 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
|
2089 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
|
2090 echo v:null |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2091 < v:null ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2092 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
|
2093 value. Read-only. |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2094 |
|
23693
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2095 *v:numbermax* *numbermax-variable* |
|
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2096 v:numbermax Maximum value of a number. |
|
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2097 |
| 23737 | 2098 *v:numbermin* *numbermin-variable* |
|
23693
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2099 v:numbermin Minimum value of a number (negative) |
|
cd06cc37f53f
patch 8.2.2388: no easy way to get the maximum or mininum number value
Bram Moolenaar <Bram@vim.org>
parents:
23666
diff
changeset
|
2100 |
|
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2101 *v:numbersize* *numbersize-variable* |
|
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2102 v:numbersize Number of bits in a Number. This is normally 64, but on some |
| 19523 | 2103 systems it may be 32. |
|
19477
2bb0e80fcd32
patch 8.2.0296: mixing up "long long" and __int64 may cause problems
Bram Moolenaar <Bram@vim.org>
parents:
19400
diff
changeset
|
2104 |
| 1733 | 2105 *v:oldfiles* *oldfiles-variable* |
| 2106 v:oldfiles List of file names that is loaded from the |viminfo| file on | |
| 2107 startup. These are the files that Vim remembers marks for. | |
| 2108 The length of the List is limited by the ' argument of the | |
| 2109 'viminfo' option (default is 100). | |
| 5618 | 2110 When the |viminfo| file is not used the List is empty. |
| 1733 | 2111 Also see |:oldfiles| and |c_#<|. |
| 2112 The List can be modified, but this has no effect on what is | |
| 2113 stored in the |viminfo| file later. If you use values other | |
| 2114 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
|
2115 {only when compiled with the |+viminfo| feature} |
| 1733 | 2116 |
| 6935 | 2117 *v:option_new* |
| 2118 v:option_new New value of the option. Valid while executing an |OptionSet| | |
| 2119 autocommand. | |
| 2120 *v:option_old* | |
| 2121 v:option_old Old value of the option. Valid while executing an |OptionSet| | |
|
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2122 autocommand. Depending on the command used for setting and the |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2123 kind of option this is either the local old value or the |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2124 global old value. |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2125 *v:option_oldlocal* |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2126 v:option_oldlocal |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2127 Old local value of the option. Valid while executing an |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2128 |OptionSet| autocommand. |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2129 *v:option_oldglobal* |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2130 v:option_oldglobal |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2131 Old global value of the option. Valid while executing an |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2132 |OptionSet| autocommand. |
| 6935 | 2133 *v:option_type* |
| 2134 v:option_type Scope of the set command. Valid while executing an | |
| 2135 |OptionSet| autocommand. Can be either "global" or "local" | |
|
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2136 *v:option_command* |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2137 v:option_command |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2138 Command used to set the option. Valid while executing an |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2139 |OptionSet| autocommand. |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2140 value option was set via ~ |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2141 "setlocal" |:setlocal| or ":let l:xxx" |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2142 "setglobal" |:setglobal| or ":let g:xxx" |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2143 "set" |:set| or |:let| |
|
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
17079
diff
changeset
|
2144 "modeline" |modeline| |
| 1490 | 2145 *v:operator* *operator-variable* |
| 2146 v:operator The last operator given in Normal mode. This is a single | |
| 2147 character except for commands starting with <g> or <z>, | |
| 2148 in which case it is two characters. Best used alongside | |
| 2149 |v:prevcount| and |v:register|. Useful if you want to cancel | |
| 2150 Operator-pending mode and then use the operator, e.g.: > | |
| 2151 :omap O <Esc>:call MyMotion(v:operator)<CR> | |
| 2152 < The value remains set until another operator is entered, thus | |
| 2153 don't expect it to be empty. | |
| 2154 v:operator is not set for |:delete|, |:yank| or other Ex | |
| 2155 commands. | |
| 2156 Read-only. | |
| 2157 | |
| 7 | 2158 *v:prevcount* *prevcount-variable* |
| 2159 v:prevcount The count given for the last but one Normal mode command. | |
| 2160 This is the v:count value of the previous command. Useful if | |
| 1490 | 2161 you want to cancel Visual or Operator-pending mode and then |
| 2162 use the count, e.g.: > | |
| 7 | 2163 :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 2164 < Read-only. | |
| 2165 | |
| 170 | 2166 *v:profiling* *profiling-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2167 v:profiling Normally zero. Set to one after using ":profile start". |
| 170 | 2168 See |profiling|. |
| 2169 | |
| 7 | 2170 *v:progname* *progname-variable* |
| 2171 v:progname Contains the name (with path removed) with which Vim was | |
| 3492 | 2172 invoked. Allows you to do special initialisations for |view|, |
| 2173 |evim| etc., or any other name you might symlink to Vim. | |
| 7 | 2174 Read-only. |
| 2175 | |
| 5780 | 2176 *v:progpath* *progpath-variable* |
| 17758 | 2177 v:progpath Contains the command with which Vim was invoked, in a form |
| 2178 that when passed to the shell will run the same Vim executable | |
| 2179 as the current one (if $PATH remains unchanged). | |
| 2180 Useful if you want to message a Vim server using a | |
| 5780 | 2181 |--remote-expr|. |
| 5782 | 2182 To get the full path use: > |
| 2183 echo exepath(v:progpath) | |
| 17758 | 2184 < If the command has a relative path it will be expanded to the |
| 2185 full path, so that it still works after `:cd`. Thus starting | |
| 2186 "./vim" results in "/home/user/path/to/vim/src/vim". | |
| 2187 On Linux and other systems it will always be the full path. | |
| 2188 On Mac it may just be "vim" and using exepath() as mentioned | |
| 2189 above should be used to get the full path. | |
|
11032
516391d8865f
patch 8.0.0405: v:progpath may become invalid after :cd
Christian Brabandt <cb@256bit.org>
parents:
11014
diff
changeset
|
2190 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
|
2191 ".exe" is not added to v:progpath. |
| 5780 | 2192 Read-only. |
| 2193 | |
| 7 | 2194 *v:register* *register-variable* |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2195 v:register The name of the register in effect for the current normal mode |
| 3492 | 2196 command (regardless of whether that command actually used a |
| 2197 register). Or for the currently executing normal mode mapping | |
| 2198 (use this in custom commands that take a register). | |
| 2199 If none is supplied it is the default register '"', unless | |
| 2200 'clipboard' contains "unnamed" or "unnamedplus", then it is | |
| 2201 '*' or '+'. | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
2202 Also see |getreg()| and |setreg()| |
| 7 | 2203 |
| 540 | 2204 *v:scrollstart* *scrollstart-variable* |
| 2205 v:scrollstart String describing the script or function that caused the | |
| 2206 screen to scroll up. It's only set when it is empty, thus the | |
| 2207 first reason is remembered. It is set to "Unknown" for a | |
| 2208 typed command. | |
| 2209 This can be used to find out why your script causes the | |
| 2210 hit-enter prompt. | |
| 2211 | |
| 7 | 2212 *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
|
2213 v:servername The resulting registered |client-server-name| if any. |
| 7 | 2214 Read-only. |
| 2215 | |
| 12785 | 2216 |
| 1621 | 2217 v:searchforward *v:searchforward* *searchforward-variable* |
| 2218 Search direction: 1 after a forward search, 0 after a | |
| 2219 backward search. It is reset to forward when directly setting | |
| 2220 the last search pattern, see |quote/|. | |
| 2221 Note that the value is restored when returning from a | |
| 2222 function. |function-search-undo|. | |
| 2223 Read-write. | |
| 2224 | |
| 7 | 2225 *v:shell_error* *shell_error-variable* |
| 2226 v:shell_error Result of the last shell command. When non-zero, the last | |
| 2227 shell command had an error. When zero, there was no problem. | |
| 2228 This only works when the shell returns the error code to Vim. | |
| 2229 The value -1 is often used when the command could not be | |
| 2230 executed. Read-only. | |
| 2231 Example: > | |
| 2232 :!mv foo bar | |
| 2233 :if v:shell_error | |
| 2234 : echo 'could not rename "foo" to "bar"!' | |
| 2235 :endif | |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2236 < "shell_error" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2237 |scriptversion| is 3 or higher. |
| 7 | 2238 |
| 2239 *v:statusmsg* *statusmsg-variable* | |
| 2240 v:statusmsg Last given status message. It's allowed to set this variable. | |
| 2241 | |
| 579 | 2242 *v:swapname* *swapname-variable* |
| 2243 v:swapname Only valid when executing |SwapExists| autocommands: Name of | |
| 2244 the swap file found. Read-only. | |
| 2245 | |
| 2246 *v:swapchoice* *swapchoice-variable* | |
| 2247 v:swapchoice |SwapExists| autocommands can set this to the selected choice | |
| 2248 for handling an existing swap file: | |
| 2249 'o' Open read-only | |
| 2250 'e' Edit anyway | |
| 2251 'r' Recover | |
| 2252 'd' Delete swapfile | |
| 2253 'q' Quit | |
| 2254 'a' Abort | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2255 The value should be a single-character string. An empty value |
| 579 | 2256 results in the user being asked, as would happen when there is |
| 2257 no SwapExists autocommand. The default is empty. | |
| 2258 | |
| 590 | 2259 *v:swapcommand* *swapcommand-variable* |
| 625 | 2260 v:swapcommand Normal mode command to be executed after a file has been |
| 590 | 2261 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
|
2262 another Vim open the file and jump to the right place. For |
| 590 | 2263 example, when jumping to a tag the value is ":tag tagname\r". |
| 716 | 2264 For ":edit +cmd file" the value is ":cmd\r". |
| 590 | 2265 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
2266 *v:t_TYPE* *v:t_bool* *t_bool-variable* |
| 15512 | 2267 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
|
2268 *v:t_channel* *t_channel-variable* |
| 15512 | 2269 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
|
2270 *v:t_dict* *t_dict-variable* |
| 15512 | 2271 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
|
2272 *v:t_float* *t_float-variable* |
| 15512 | 2273 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
|
2274 *v:t_func* *t_func-variable* |
| 15512 | 2275 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
|
2276 *v:t_job* *t_job-variable* |
| 15512 | 2277 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
|
2278 *v:t_list* *t_list-variable* |
| 15512 | 2279 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
|
2280 *v:t_none* *t_none-variable* |
| 15512 | 2281 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
|
2282 *v:t_number* *t_number-variable* |
| 15512 | 2283 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
|
2284 *v:t_string* *t_string-variable* |
| 15512 | 2285 v:t_string Value of |String| type. Read-only. See: |type()| |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2286 *v:t_blob* *t_blob-variable* |
| 15512 | 2287 v:t_blob Value of |Blob| type. Read-only. See: |type()| |
|
9587
05a56bbe34a1
commit https://github.com/vim/vim/commit/f562e72df726c6191fa305e1c0a113f1cfb87f76
Christian Brabandt <cb@256bit.org>
parents:
9555
diff
changeset
|
2288 |
| 7 | 2289 *v:termresponse* *termresponse-variable* |
| 2290 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
|
2291 termcap entry. It is set when Vim receives an escape sequence |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2292 that starts with ESC [ or CSI, then '>' or '?' and ends in a |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2293 'c', with only digits and ';' in between. |
| 7 | 2294 When this option is set, the TermResponse autocommand event is |
| 2295 fired, so that you can react to the response from the | |
|
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
2296 terminal. You can use |terminalprops()| to see what Vim |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
2297 figured out about the terminal. |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
2298 The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp |
| 7 | 2299 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the |
| 2300 patch level (since this was introduced in patch 95, it's | |
| 2301 always 95 or bigger). Pc is always zero. | |
| 2302 {only when compiled with |+termresponse| feature} | |
| 2303 | |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2304 *v:termblinkresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2305 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
|
2306 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
|
2307 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
|
2308 |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2309 *v:termstyleresp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2310 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
|
2311 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
|
2312 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
|
2313 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2314 *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
|
2315 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
|
2316 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
|
2317 background color is, see 'background'. |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2318 |
|
12632
b1a7e3968a31
patch 8.0.1194: actual fg and bg colors of terminal are unknown
Christian Brabandt <cb@256bit.org>
parents:
12499
diff
changeset
|
2319 *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
|
2320 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
|
2321 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
|
2322 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
|
2323 |
|
12273
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2324 *v:termu7resp* |
|
c952a6af25e0
patch 8.0.1016: gnome terminal echoes t_RC
Christian Brabandt <cb@256bit.org>
parents:
12254
diff
changeset
|
2325 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
|
2326 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
|
2327 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
|
2328 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
2329 *v:testing* *testing-variable* |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
2330 v:testing Must be set before using `test_garbagecollect_now()`. |
| 11160 | 2331 Also, when set certain error messages won't be shown for 2 |
| 12785 | 2332 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
|
2333 |
| 7 | 2334 *v:this_session* *this_session-variable* |
| 2335 v:this_session Full filename of the last loaded or saved session file. See | |
| 2336 |:mksession|. It is allowed to set this variable. When no | |
| 2337 session file has been saved, this variable is empty. | |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2338 "this_session" also works, for backwards compatibility, unless |
|
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2339 |scriptversion| is 3 or higher |
| 7 | 2340 |
| 2341 *v:throwpoint* *throwpoint-variable* | |
| 2342 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
|
2343 finished was thrown. Not set when commands are typed. See |
| 7 | 2344 also |v:exception| and |throw-variables|. |
| 2345 Example: > | |
| 2346 :try | |
| 2347 : throw "oops" | |
| 2348 :catch /.*/ | |
| 2349 : echo "Exception from" v:throwpoint | |
| 2350 :endtry | |
| 2351 < Output: "Exception from test.vim, line 2" | |
| 2352 | |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2353 *v:true* *true-variable* |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
2354 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
|
2355 |json_encode()|. |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2356 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
|
2357 echo v:true |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2358 < v:true ~ |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9223
diff
changeset
|
2359 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
|
2360 value. Read-only. |
| 102 | 2361 *v:val* *val-variable* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
2362 v:val Value of the current item of a |List| or |Dictionary|. Only |
| 685 | 2363 valid while evaluating the expression used with |map()| and |
| 102 | 2364 |filter()|. Read-only. |
| 2365 | |
| 7 | 2366 *v:version* *version-variable* |
| 2367 v:version Version number of Vim: Major version number times 100 plus | |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2368 minor version number. Version 5.0 is 500. Version 5.1 |
| 7 | 2369 is 501. Read-only. "version" also works, for backwards |
|
16366
6ee80f3b5ea9
patch 8.1.1188: not all Vim variables require the v: prefix
Bram Moolenaar <Bram@vim.org>
parents:
16271
diff
changeset
|
2370 compatibility, unless |scriptversion| is 3 or higher. |
| 7 | 2371 Use |has()| to check if a certain patch was included, e.g.: > |
| 5786 | 2372 if has("patch-7.4.123") |
| 7 | 2373 < Note that patch numbers are specific to the version, thus both |
| 2374 version 5.0 and 5.1 may have a patch 123, but these are | |
| 2375 completely different. | |
| 2376 | |
|
17053
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2377 *v:versionlong* *versionlong-variable* |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2378 v:versionlong Like v:version, but also including the patchlevel in the last |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2379 four digits. Version 8.1 with patch 123 has value 8010123. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2380 This can be used like this: > |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
2381 if v:versionlong >= 8010123 |
|
17053
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2382 < However, if there are gaps in the list of patches included |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2383 this will not work well. This can happen if a recent patch |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2384 was included into an older version, e.g. for a security fix. |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2385 Use the has() function to make sure the patch is actually |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2386 included. |
|
d5fa04016df0
patch 8.1.1526: no numerical value for the patchlevel
Bram Moolenaar <Bram@vim.org>
parents:
17036
diff
changeset
|
2387 |
|
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2388 *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
|
2389 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
|
2390 before |VimEnter| autocommands are triggered. |
|
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
8669
diff
changeset
|
2391 |
| 7 | 2392 *v:warningmsg* *warningmsg-variable* |
| 2393 v:warningmsg Last given warning message. It's allowed to set this variable. | |
| 2394 | |
| 2609 | 2395 *v:windowid* *windowid-variable* |
| 2396 v:windowid When any X11 based GUI is running or when running in a | |
| 2397 terminal and Vim connects to the X server (|-X|) this will be | |
| 2616 | 2398 set to the window ID. |
| 2399 When an MS-Windows GUI is running this will be set to the | |
| 2400 window handle. | |
| 2401 Otherwise the value is zero. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
2402 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
|
2403 see |window-ID|. |
| 2609 | 2404 |
| 7 | 2405 ============================================================================== |
| 2406 4. Builtin Functions *functions* | |
| 2407 | |
| 2408 See |function-list| for a list grouped by what the function is used for. | |
| 2409 | |
| 236 | 2410 (Use CTRL-] on the function name to jump to the full explanation.) |
| 7 | 2411 |
| 2412 USAGE RESULT DESCRIPTION ~ | |
| 2413 | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2414 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
|
2415 acos({expr}) Float arc cosine of {expr} |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
2416 add({object}, {item}) List/Blob append {item} to {object} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2417 and({expr}, {expr}) Number bitwise AND |
| 14864 | 2418 append({lnum}, {text}) Number append {text} below line {lnum} |
| 2419 appendbufline({expr}, {lnum}, {text}) | |
| 2420 Number append {text} below line {lnum} | |
| 2421 in buffer {expr} | |
| 15033 | 2422 argc([{winid}]) Number number of files in the argument list |
| 55 | 2423 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
|
2424 arglistid([{winnr} [, {tabnr}]]) Number argument list id |
|
14964
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
2425 argv({nr} [, {winid}]) String {nr} entry of the argument list |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
2426 argv([-1, {winid}]) List the argument list |
|
20679
1af1d8ff2aa8
patch 8.2.0893: assert_equalfile() does not take a third argument
Bram Moolenaar <Bram@vim.org>
parents:
20665
diff
changeset
|
2427 asin({expr}) Float arc sine of {expr} |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2428 assert_beeps({cmd}) Number assert {cmd} causes a beep |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2429 assert_equal({exp}, {act} [, {msg}]) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2430 Number assert {exp} is equal to {act} |
|
20679
1af1d8ff2aa8
patch 8.2.0893: assert_equalfile() does not take a third argument
Bram Moolenaar <Bram@vim.org>
parents:
20665
diff
changeset
|
2431 assert_equalfile({fname-one}, {fname-two} [, {msg}]) |
|
1af1d8ff2aa8
patch 8.2.0893: assert_equalfile() does not take a third argument
Bram Moolenaar <Bram@vim.org>
parents:
20665
diff
changeset
|
2432 Number assert file contents are equal |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2433 assert_exception({error} [, {msg}]) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2434 Number assert {error} is in v:exception |
| 22171 | 2435 assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]]) |
| 14945 | 2436 Number assert {cmd} fails |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2437 assert_false({actual} [, {msg}]) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2438 Number assert {actual} is false |
|
9636
ccbb8e393d80
commit https://github.com/vim/vim/commit/61c04493b00f85d0b97436260a9ef9ab82143b78
Christian Brabandt <cb@256bit.org>
parents:
9626
diff
changeset
|
2439 assert_inrange({lower}, {upper}, {actual} [, {msg}]) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2440 Number assert {actual} is inside the range |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2441 assert_match({pat}, {text} [, {msg}]) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2442 Number assert {pat} matches {text} |
|
24307
55f458d35292
patch 8.2.2694: when 'matchpairs' is empty every character beeps
Bram Moolenaar <Bram@vim.org>
parents:
24278
diff
changeset
|
2443 assert_nobeep({cmd}) Number assert {cmd} does not cause 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
|
2444 assert_notequal({exp}, {act} [, {msg}]) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2445 Number assert {exp} is not equal {act} |
|
11181
13544aa85dc0
patch 8.0.0477: the client-server test may hang when failing
Christian Brabandt <cb@256bit.org>
parents:
11177
diff
changeset
|
2446 assert_notmatch({pat}, {text} [, {msg}]) |
|
13796
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2447 Number assert {pat} not matches {text} |
|
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2448 assert_report({msg}) Number report a test failure |
|
87012d2b17b5
patch 8.0.1770: assert functions don't return anything
Christian Brabandt <cb@256bit.org>
parents:
13740
diff
changeset
|
2449 assert_true({actual} [, {msg}]) Number assert {actual} is true |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2450 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
|
2451 atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2} |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
2452 balloon_gettext() String current text in the balloon |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
2453 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
|
2454 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
|
2455 browse({save}, {title}, {initdir}, {default}) |
| 7 | 2456 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
|
2457 browsedir({title}, {initdir}) String put up a directory requester |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
2458 bufadd({name}) Number add a buffer to the buffer list |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2459 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
|
2460 buflisted({expr}) Number |TRUE| if buffer {expr} is listed |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
2461 bufload({expr}) Number load buffer {expr} if not loaded yet |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2462 bufloaded({expr}) Number |TRUE| if buffer {expr} is loaded |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
2463 bufname([{expr}]) String Name of the buffer {expr} |
|
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
2464 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
|
2465 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
|
2466 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
|
2467 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
|
2468 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
|
2469 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
|
2470 call({func}, {arglist} [, {dict}]) |
| 102 | 2471 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
|
2472 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
|
2473 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
|
2474 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
|
2475 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
|
2476 ch_evalexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2477 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
|
2478 ch_evalraw({handle}, {string} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2479 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
|
2480 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
|
2481 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
|
2482 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
|
2483 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
|
2484 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
|
2485 ch_open({address} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2486 Channel open a channel to {address} |
|
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2487 ch_read({handle} [, {options}]) String read from {handle} |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2488 ch_readblob({handle} [, {options}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2489 Blob read Blob from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2490 ch_readraw({handle} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2491 String read raw from {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2492 ch_sendexpr({handle}, {expr} [, {options}]) |
|
8440
4c6ad81d41fe
commit https://github.com/vim/vim/commit/5f148ec0b5a6cedd9129b3abac351034b83cc4f7
Christian Brabandt <cb@256bit.org>
parents:
8392
diff
changeset
|
2493 any send {expr} over JSON {handle} |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2494 ch_sendraw({handle}, {expr} [, {options}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2495 any send {expr} over raw {handle} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2496 ch_setoptions({handle}, {options}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2497 none set options for {handle} |
|
10233
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2498 ch_status({handle} [, {options}]) |
|
d709622a18c9
commit https://github.com/vim/vim/commit/7ef3810d28b7ab2edbfcafab3fe8ad8bc2c2f138
Christian Brabandt <cb@256bit.org>
parents:
10228
diff
changeset
|
2499 String status of channel {handle} |
| 1621 | 2500 changenr() Number current change number |
| 12785 | 2501 char2nr({expr} [, {utf8}]) Number ASCII/UTF8 value of first char in {expr} |
|
21973
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
2502 charclass({string}) Number character class of {string} |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
2503 charcol({expr}) Number column number of cursor or mark |
|
23380
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
2504 charidx({string}, {idx} [, {countcc}]) |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
2505 Number char index of byte {idx} in {string} |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
2506 chdir({dir}) String change current working directory |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2507 cindent({lnum}) Number C indent for line {lnum} |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2508 clearmatches([{win}]) none clear all matches |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
2509 col({expr}) Number column byte index of cursor or mark |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2510 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
|
2511 complete_add({expr}) Number add completion match |
| 1621 | 2512 complete_check() Number check for key typed during completion |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
2513 complete_info([{what}]) Dict get current completion information |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2514 confirm({msg} [, {choices} [, {default} [, {type}]]]) |
| 7 | 2515 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
|
2516 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
|
2517 cos({expr}) Float cosine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2518 cosh({expr}) Float hyperbolic cosine of {expr} |
| 14864 | 2519 count({comp}, {expr} [, {ic} [, {start}]]) |
| 2520 Number count how many {expr} are in {comp} | |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
2521 cscope_connection([{num}, {dbpath} [, {prepend}]]) |
| 7 | 2522 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
|
2523 cursor({lnum}, {col} [, {off}]) |
| 6385 | 2524 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
|
2525 cursor({list}) Number move cursor to position in {list} |
|
14147
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
2526 debugbreak({pid}) Number interrupt process being debugged |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2527 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
|
2528 delete({fname} [, {flags}]) Number delete the file or directory {fname} |
| 14519 | 2529 deletebufline({expr}, {first} [, {last}]) |
|
14043
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
2530 Number delete lines from buffer {expr} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2531 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
|
2532 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
|
2533 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col} |
|
19400
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
2534 echoraw({expr}) none output {expr} as-is |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2535 empty({expr}) Number |TRUE| if {expr} is empty |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
2536 environ() Dict return environment variables |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2537 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
|
2538 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
|
2539 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
|
2540 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
|
2541 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
|
2542 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
|
2543 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
|
2544 exp({expr}) Float exponential of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2545 expand({expr} [, {nosuf} [, {list}]]) |
| 3398 | 2546 any expand special keywords in {expr} |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
2547 expandcmd({expr}) String expand {expr} like with `:edit` |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2548 extend({expr1}, {expr2} [, {expr3}]) |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2549 List/Dict insert items of {expr2} into {expr1} |
|
23588
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
2550 extendnew({expr1}, {expr2} [, {expr3}]) |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
2551 List/Dict like |extend()| but creates a new |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
2552 List or Dictionary |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2553 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
|
2554 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
|
2555 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
|
2556 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
|
2557 {expr2} is 0 |
| 12785 | 2558 finddir({name} [, {path} [, {count}]]) |
| 824 | 2559 String find directory {name} in {path} |
| 12785 | 2560 findfile({name} [, {path} [, {count}]]) |
| 824 | 2561 String find file {name} in {path} |
|
20766
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
2562 flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels |
|
23816
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
2563 flattennew({list} [, {maxdepth}]) |
|
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
2564 List flatten a copy of {list} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2565 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
|
2566 floor({expr}) Float round {expr} down |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2567 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
|
2568 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
|
2569 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
|
2570 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
|
2571 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
|
2572 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
|
2573 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
|
2574 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
|
2575 foreground() Number bring the Vim window to the foreground |
|
23853
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
2576 fullcommand({name}) String get full command from {name} |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2577 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2578 Funcref reference to function {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2579 function({name} [, {arglist}] [, {dict}]) |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
2580 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
|
2581 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
|
2582 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
|
2583 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
|
2584 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
|
2585 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
|
2586 getbufline({expr}, {lnum} [, {end}]) |
| 435 | 2587 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
|
2588 getbufvar({expr}, {varname} [, {def}]) |
| 4157 | 2589 any variable {varname} in buffer {expr} |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
2590 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
|
2591 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
|
2592 getcharmod() Number modifiers for the last typed character |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
2593 getcharpos({expr}) List position of cursor, mark, etc. |
| 7013 | 2594 getcharsearch() Dict last character search |
| 7 | 2595 getcmdline() String return the current command-line |
| 2596 getcmdpos() Number return cursor position in command-line | |
| 6153 | 2597 getcmdtype() String return current command-line type |
| 2598 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
|
2599 getcompletion({pat}, {type} [, {filtered}]) |
|
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
2600 List list of cmdline completion matches |
|
22357
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
2601 getcurpos([{winnr}]) List position of the cursor |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
2602 getcursorcharpos([{winnr}]) List character position of the cursor |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2603 getcwd([{winnr} [, {tabnr}]]) String get the current working directory |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
2604 getenv({name}) String return environment variable |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2605 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
|
2606 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
|
2607 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
|
2608 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
|
2609 getftype({fname}) String description of type of file {fname} |
|
18008
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
2610 getimstatus() Number |TRUE| if the IME status is active |
|
13246
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
2611 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
|
2612 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
|
2613 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
|
2614 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer |
| 21093 | 2615 getloclist({nr}) List list of location list items |
| 2616 getloclist({nr}, {what}) Dict get specific location list properties | |
|
20615
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
2617 getmarklist([{expr}]) List list of global/local marks |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2618 getmatches([{win}]) List list of current matches |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
2619 getmousepos() Dict last known mouse position |
| 1548 | 2620 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
|
2621 getpos({expr}) List position of cursor, mark, etc. |
| 21093 | 2622 getqflist() List list of quickfix items |
| 2623 getqflist({what}) Dict get specific quickfix list properties | |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2624 getreg([{regname} [, 1 [, {list}]]]) |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
2625 String or List contents of a register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
2626 getreginfo([{regname}]) Dict information about a register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
2627 getregtype([{regname}]) String type of a register |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2628 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
|
2629 gettabvar({nr}, {varname} [, {def}]) |
| 4157 | 2630 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
|
2631 gettabwinvar({tabnr}, {winnr}, {name} [, {def}]) |
| 831 | 2632 any {name} in {winnr} in tab page {tabnr} |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
2633 gettagstack([{nr}]) Dict get the tag stack of window {nr} |
|
21989
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
2634 gettext({text}) String lookup translation of {text} |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
2635 getwininfo([{winid}]) List list of info about each window |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
2636 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
|
2637 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
|
2638 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
|
2639 getwinvar({nr}, {varname} [, {def}]) |
| 4157 | 2640 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
|
2641 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 3398 | 2642 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
|
2643 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
|
2644 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
| 1754 | 2645 String do glob({expr}) for all dirs in {path} |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
2646 has({feature} [, {check}]) Number |TRUE| if feature {feature} supported |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2647 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
|
2648 haslocaldir([{winnr} [, {tabnr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2649 Number |TRUE| if the window executed |:lcd| |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
2650 or |:tcd| |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2651 hasmapto({what} [, {mode} [, {abbr}]]) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2652 Number |TRUE| if mapping to {what} exists |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
2653 histadd({history}, {item}) Number add an item to a history |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
2654 histdel({history} [, {item}]) Number remove an item from a history |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2655 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
|
2656 histnr({history}) Number highest index of a history |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2657 hlID({name}) Number syntax ID of highlight group {name} |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2658 hlexists({name}) Number |TRUE| if highlight group {name} exists |
| 7 | 2659 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
|
2660 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
|
2661 indent({lnum}) Number indent of line {lnum} |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2662 index({object}, {expr} [, {start} [, {ic}]]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2663 Number index in {object} where {expr} appears |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2664 input({prompt} [, {text} [, {completion}]]) |
| 531 | 2665 String get input from the user |
|
11763
21f3930dfe6e
Documentation updates.
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
2666 inputdialog({prompt} [, {text} [, {completion}]]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2667 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
|
2668 inputlist({textlist}) Number let the user pick from a choice list |
| 55 | 2669 inputrestore() Number restore typeahead |
| 2670 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
|
2671 inputsecret({prompt} [, {text}]) String like input() but hiding the text |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2672 insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}] |
|
18699
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
2673 interrupt() none interrupt script execution |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2674 invert({expr}) Number bitwise invert |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2675 isdirectory({directory}) Number |TRUE| if {directory} is a directory |
|
16213
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
2676 isinf({expr}) Number determine if {expr} is infinity value |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
2677 (positive or negative) |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
2678 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
|
2679 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
|
2680 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
|
2681 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
|
2682 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
|
2683 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
|
2684 job_start({command} [, {options}]) |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2685 Job start a job |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2686 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
|
2687 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
|
2688 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
|
2689 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
|
2690 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
|
2691 json_decode({string}) any decode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2692 json_encode({expr}) String encode JSON |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2693 keys({dict}) List keys in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2694 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
|
2695 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
|
2696 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
2697 line({expr} [, {winid}]) Number line nr of cursor, last line or mark |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2698 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
|
2699 lispindent({lnum}) Number Lisp indent for line {lnum} |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
2700 list2str({list} [, {utf8}]) String turn numbers in {list} into a String |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
2701 listener_add({callback} [, {buf}]) |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
2702 Number add a callback to listen to changes |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
2703 listener_flush([{buf}]) none invoke listener callbacks |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
2704 listener_remove({id}) none remove a listener callback |
| 7 | 2705 localtime() Number current time |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2706 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
|
2707 log10({expr}) Float logarithm of Float {expr} to base 10 |
| 12785 | 2708 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
|
2709 map({expr1}, {expr2}) List/Dict change each item in {expr1} to {expr} |
| 12785 | 2710 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) |
| 3224 | 2711 String or Dict |
| 2712 rhs of mapping {name} in mode {mode} | |
| 12785 | 2713 mapcheck({name} [, {mode} [, {abbr}]]) |
| 782 | 2714 String check for mappings matching {name} |
|
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
2715 mapnew({expr1}, {expr2}) List/Dict like |map()| but creates a new List |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
2716 or Dictionary |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
2717 mapset({mode}, {abbr}, {dict}) none restore mapping from |maparg()| result |
| 12785 | 2718 match({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2719 Number position where {pat} matches in {expr} |
| 12785 | 2720 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 2721 Number highlight {pattern} with {group} |
| 12785 | 2722 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 2723 Number highlight positions with {group} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2724 matcharg({nr}) List arguments of |:match| |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2725 matchdelete({id} [, {win}]) Number delete match identified by {id} |
| 12785 | 2726 matchend({expr}, {pat} [, {start} [, {count}]]) |
| 7 | 2727 Number position where {pat} ends in {expr} |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2728 matchfuzzy({list}, {str} [, {dict}]) |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2729 List fuzzy match {str} in {list} |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2730 matchfuzzypos({list}, {str} [, {dict}]) |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2731 List fuzzy match {str} in {list} |
| 12785 | 2732 matchlist({expr}, {pat} [, {start} [, {count}]]) |
| 158 | 2733 List match and submatches of {pat} in {expr} |
| 12785 | 2734 matchstr({expr}, {pat} [, {start} [, {count}]]) |
| 19 | 2735 String {count}'th match of {pat} in {expr} |
| 12785 | 2736 matchstrpos({expr}, {pat} [, {start} [, {count}]]) |
|
8793
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
2737 List {count}'th match of {pat} in {expr} |
| 10734 | 2738 max({expr}) Number maximum value of items in {expr} |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
2739 menu_info({name} [, {mode}]) Dict get menu item information |
| 10734 | 2740 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
|
2741 mkdir({name} [, {path} [, {prot}]]) |
| 168 | 2742 Number create directory {name} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2743 mode([expr]) String current editing mode |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2744 mzeval({expr}) any evaluate |MzScheme| expression |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2745 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} |
| 12785 | 2746 nr2char({expr} [, {utf8}]) String single char with ASCII/UTF8 value {expr} |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
2747 or({expr}, {expr}) Number bitwise OR |
|
22385
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
2748 pathshorten({expr} [, {len}]) String shorten directory names in a path |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2749 perleval({expr}) any evaluate |Perl| expression |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2750 popup_atcursor({what}, {options}) Number create popup window near the cursor |
| 18130 | 2751 popup_beval({what}, {options}) Number create popup window for 'ballooneval' |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2752 popup_clear() none close all popup windows |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2753 popup_close({id} [, {result}]) none close popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2754 popup_create({what}, {options}) Number create a popup window |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2755 popup_dialog({what}, {options}) Number create a popup window used as a dialog |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2756 popup_filter_menu({id}, {key}) Number filter for a menu popup window |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2757 popup_filter_yesno({id}, {key}) Number filter for a dialog popup window |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
2758 popup_findinfo() Number get window ID of info popup window |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
2759 popup_findpreview() Number get window ID of preview popup window |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2760 popup_getoptions({id}) Dict get options of popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2761 popup_getpos({id}) Dict get position of popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2762 popup_hide({id}) none hide popup menu {id} |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2763 popup_list() List get a list of window IDs of all popups |
|
20386
3b3589275ab9
patch 8.2.0748: cannot get a list of all popups
Bram Moolenaar <Bram@vim.org>
parents:
20241
diff
changeset
|
2764 popup_locate({row}, {col}) Number get window ID of popup at position |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2765 popup_menu({what}, {options}) Number create a popup window used as a menu |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2766 popup_move({id}, {options}) none set position of popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2767 popup_notification({what}, {options}) |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2768 Number create a notification popup window |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2769 popup_setoptions({id}, {options}) |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2770 none set options for popup window {id} |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
2771 popup_settext({id}, {text}) none set the text of popup window {id} |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2772 popup_show({id}) none unhide popup window {id} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2773 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
|
2774 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
|
2775 printf({fmt}, {expr1}...) String format text |
|
22077
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
2776 prompt_getprompt({buf}) String get prompt text |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
2777 prompt_setcallback({buf}, {expr}) none set prompt callback function |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
2778 prompt_setinterrupt({buf}, {text}) none set prompt interrupt function |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
2779 prompt_setprompt({buf}, {text}) none set prompt text |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2780 prop_add({lnum}, {col}, {props}) none add a text property |
|
15251
17525ca95e1e
patch 8.1.0634: text properties cannot cross line boundaries
Bram Moolenaar <Bram@vim.org>
parents:
15219
diff
changeset
|
2781 prop_clear({lnum} [, {lnum-end} [, {props}]]) |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2782 none remove all text properties |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2783 prop_find({props} [, {direction}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2784 Dict search for a text property |
| 20241 | 2785 prop_list({lnum} [, {props}]) List text properties in {lnum} |
| 15281 | 2786 prop_remove({props} [, {lnum} [, {lnum-end}]]) |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2787 Number remove a text property |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2788 prop_type_add({name}, {props}) none define a new property type |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2789 prop_type_change({name}, {props}) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2790 none change an existing property type |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2791 prop_type_delete({name} [, {props}]) |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2792 none delete a property type |
| 22723 | 2793 prop_type_get({name} [, {props}]) |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2794 Dict get property type values |
|
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
2795 prop_type_list([{props}]) List get list of property types |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
2796 pum_getpos() Dict position and size of pum if visible |
| 1621 | 2797 pumvisible() Number whether popup menu is visible |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2798 py3eval({expr}) any evaluate |python3| expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2799 pyeval({expr}) any evaluate |Python| expression |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
2800 pyxeval({expr}) any evaluate |python_x| expression |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
2801 rand([{expr}]) Number get pseudo-random number |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2802 range({expr} [, {max} [, {stride}]]) |
| 99 | 2803 List items from {expr} to {max} |
|
23602
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
2804 readblob({fname}) Blob read a |Blob| from {fname} |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
2805 readdir({dir} [, {expr} [, {dict}]]) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
2806 List file names in {dir} selected by {expr} |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
2807 readdirex({dir} [, {expr} [, {dict}]]) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
2808 List file info in {dir} selected by {expr} |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
2809 readfile({fname} [, {type} [, {max}]]) |
| 168 | 2810 List get list of lines from file {fname} |
|
20649
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
2811 reduce({object}, {func} [, {initial}]) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
2812 any reduce {object} using {func} |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
2813 reg_executing() String get the executing register name |
|
14004
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
2814 reg_recording() String get the recording register name |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2815 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
|
2816 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
|
2817 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
|
2818 remote_expr({server}, {string} [, {idvar} [, {timeout}]]) |
| 7 | 2819 String send expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2820 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
|
2821 remote_peek({serverid} [, {retvar}]) |
| 7 | 2822 Number check for reply string |
|
11229
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2823 remote_read({serverid} [, {timeout}]) |
|
146a1e213b60
Update runtime files. Add Rust support.
Christian Brabandt <cb@256bit.org>
parents:
11225
diff
changeset
|
2824 String read reply string |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2825 remote_send({server}, {string} [, {idvar}]) |
| 7 | 2826 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
|
2827 remote_startserver({name}) none become server {name} |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2828 remove({list}, {idx} [, {end}]) any/List |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
2829 remove items {idx}-{end} from {list} |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
2830 remove({blob}, {idx} [, {end}]) Number/Blob |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
2831 remove bytes {idx}-{end} from {blob} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2832 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
|
2833 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
|
2834 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
|
2835 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
|
2836 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
|
2837 round({expr}) Float round off {expr} |
|
16103
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
2838 rubyeval({expr}) any evaluate |Ruby| expression |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2839 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
|
2840 screenchar({row}, {col}) Number character at screen position |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
2841 screenchars({row}, {col}) List List of characters at screen position |
| 3986 | 2842 screencol() Number current cursor column |
|
17292
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
2843 screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character |
| 3986 | 2844 screenrow() Number current cursor row |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
2845 screenstring({row}, {col}) String characters at screen position |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
2846 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 1496 | 2847 Number search for {pattern} |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
2848 searchcount([{options}]) Dict get or update search stats |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2849 searchdecl({name} [, {global} [, {thisblock}]]) |
| 1621 | 2850 Number search for variable declaration |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2851 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 55 | 2852 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
|
2853 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]]) |
| 667 | 2854 List search for other end of start/end pair |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
2855 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 667 | 2856 List search for {pattern} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2857 server2client({clientid}, {string}) |
| 7 | 2858 Number send reply string |
| 2859 serverlist() String get a list of available servers | |
| 14864 | 2860 setbufline({expr}, {lnum}, {text}) |
| 2861 Number set line {lnum} to {text} in buffer | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
2862 {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2863 setbufvar({expr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2864 none set {varname} in buffer {expr} to {val} |
|
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
2865 setcellwidths({list}) none set character cell width overrides |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
2866 setcharpos({expr}, {list}) Number set the {expr} position to {list} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2867 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
|
2868 setcmdpos({pos}) Number set cursor position in command-line |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
2869 setcursorcharpos({list}) Number move cursor to position in {list} |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
2870 setenv({name}, {val}) none set environment variable |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2871 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
|
2872 setline({lnum}, {line}) Number set line {lnum} to {line} |
| 21093 | 2873 setloclist({nr}, {list} [, {action}]) |
| 2874 Number modify location list using {list} | |
| 2875 setloclist({nr}, {list}, {action}, {what}) | |
| 2876 Number modify specific location list props | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
2877 setmatches({list} [, {win}]) Number restore a list of matches |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2878 setpos({expr}, {list}) Number set the {expr} position to {list} |
| 21093 | 2879 setqflist({list} [, {action}]) Number modify quickfix list using {list} |
| 2880 setqflist({list}, {action}, {what}) | |
| 2881 Number modify specific quickfix list props | |
| 12785 | 2882 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
|
2883 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
|
2884 settabwinvar({tabnr}, {winnr}, {varname}, {val}) |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2885 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
|
2886 page {tabnr} to {val} |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
2887 settagstack({nr}, {dict} [, {action}]) |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
2888 Number modify tag stack using {dict} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2889 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
|
2890 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
|
2891 shellescape({string} [, {special}]) |
| 1661 | 2892 String escape {string} for use as shell |
| 985 | 2893 command argument |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
2894 shiftwidth([{col}]) Number effective value of 'shiftwidth' |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2895 sign_define({name} [, {dict}]) Number define or update a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2896 sign_define({list}) List define or update a list of signs |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2897 sign_getdefined([{name}]) List get a list of defined signs |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2898 sign_getplaced([{expr} [, {dict}]]) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2899 List get a list of placed signs |
|
15418
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
2900 sign_jump({id}, {group}, {expr}) |
|
51b3c36b0523
patch 8.1.0717: there is no function for the ":sign jump" command
Bram Moolenaar <Bram@vim.org>
parents:
15388
diff
changeset
|
2901 Number jump to a sign |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2902 sign_place({id}, {group}, {name}, {expr} [, {dict}]) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2903 Number place a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2904 sign_placelist({list}) List place a list of signs |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2905 sign_undefine([{name}]) Number undefine a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2906 sign_undefine({list}) List undefine a list of signs |
|
15209
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2907 sign_unplace({group} [, {dict}]) |
|
3a99b2e6d136
patch 8.1.0614: placing signs can be complicated
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
2908 Number unplace a sign |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
2909 sign_unplacelist({list}) List unplace a list of signs |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2910 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
|
2911 sin({expr}) Float sine of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2912 sinh({expr}) Float hyperbolic sine of {expr} |
|
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
2913 slice({expr}, {start} [, {end}]) String, List or Blob |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
2914 slice of a String, List or Blob |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2915 sort({list} [, {func} [, {dict}]]) |
| 2902 | 2916 List sort {list}, using {func} to compare |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
2917 sound_clear() none stop playing all sounds |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
2918 sound_playevent({name} [, {callback}]) |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
2919 Number play an event sound |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
2920 sound_playfile({path} [, {callback}]) |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
2921 Number play sound file {path} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
2922 sound_stop({id}) none stop playing sound {id} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2923 soundfold({word}) String sound-fold {word} |
| 344 | 2924 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
|
2925 spellsuggest({word} [, {max} [, {capital}]]) |
| 537 | 2926 List spelling suggestions |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2927 split({expr} [, {pat} [, {keepempty}]]) |
| 685 | 2928 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
|
2929 sqrt({expr}) Float square root of {expr} |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
2930 srand([{expr}]) List get seed for |rand()| |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
2931 state([{what}]) String current state of Vim |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2932 str2float({expr}) Float convert String to Float |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
2933 str2list({expr} [, {utf8}]) List convert each character of {expr} to |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
2934 ASCII/UTF8 value |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2935 str2nr({expr} [, {base} [, {quoted}]]) |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
2936 Number convert String to Number |
|
24130
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
2937 strcharlen({expr}) Number character length of the String {expr} |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
2938 strcharpart({str}, {start} [, {len} [, {skipcc}]]) |
|
21935
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
2939 String {len} characters of {str} at |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
2940 character {start} |
|
24130
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
2941 strchars({expr} [, {skipcc}]) Number character count of the String {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2942 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2943 strftime({format} [, {time}]) String format time with a specified format |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
2944 strgetchar({str}, {index}) Number get char {index} from {str} |
| 12785 | 2945 stridx({haystack}, {needle} [, {start}]) |
| 133 | 2946 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
|
2947 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
|
2948 strlen({expr}) Number length of the String {expr} |
|
21935
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
2949 strpart({str}, {start} [, {len} [, {chars}]]) |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
2950 String {len} bytes/chars of {str} at |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
2951 byte {start} |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2952 strptime({format}, {timestring}) |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
2953 Number Convert {timestring} to unix timestamp |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2954 strridx({haystack}, {needle} [, {start}]) |
| 140 | 2955 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
|
2956 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
|
2957 strwidth({expr}) Number display cell length of the String {expr} |
| 12785 | 2958 submatch({nr} [, {list}]) String or List |
| 5794 | 2959 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
|
2960 substitute({expr}, {pat}, {sub}, {flags}) |
| 7 | 2961 String all {pat} in {expr} replaced with {sub} |
|
14599
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
2962 swapinfo({fname}) Dict information about swap file {fname} |
|
14778
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
2963 swapname({expr}) String swap file of buffer {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2964 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
|
2965 synIDattr({synID}, {what} [, {mode}]) |
| 7 | 2966 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
|
2967 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
|
2968 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
|
2969 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
|
2970 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
|
2971 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
|
2972 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
|
2973 tabpagenr([{arg}]) Number number of current or last tab page |
| 12785 | 2974 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
2975 tagfiles() List tags files used |
| 12785 | 2976 taglist({expr} [, {filename}]) List list of tags matching {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2977 tan({expr}) Float tangent of {expr} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
2978 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
|
2979 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
|
2980 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
|
2981 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
|
2982 term_dumpload({filename} [, {options}]) |
|
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
2983 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
|
2984 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
|
2985 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
|
2986 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
|
2987 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
|
2988 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
|
2989 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
|
2990 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
|
2991 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
|
2992 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
|
2993 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
|
2994 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
|
2995 term_gettitle({buf}) String get the title of a terminal |
| 12785 | 2996 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
|
2997 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
|
2998 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
|
2999 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
|
3000 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
|
3001 none set ANSI palette in GUI color mode |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
3002 term_setapi({buf}, {expr}) none set |terminal-api| function name prefix |
| 13735 | 3003 term_setkill({buf}, {how}) none set signal to stop job in terminal |
| 13437 | 3004 term_setrestore({buf}, {command}) none set command to restore terminal |
| 13735 | 3005 term_setsize({buf}, {rows}, {cols}) |
| 3006 none set the size of a terminal | |
| 16380 | 3007 term_start({cmd} [, {options}]) Number open a terminal window and run a job |
|
12007
64b822c4f7ae
patch 8.0.0884: can't specify the wait time for term_wait()
Christian Brabandt <cb@256bit.org>
parents:
12003
diff
changeset
|
3008 term_wait({buf} [, {time}]) Number wait for screen to be updated |
|
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
3009 terminalprops() Dict properties of the terminal |
|
9121
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
3010 test_alloc_fail({id}, {countdown}, {repeat}) |
|
7350959e53c3
commit https://github.com/vim/vim/commit/8e8df251bf2505e5decf258397c6069fbe5e2e01
Christian Brabandt <cb@256bit.org>
parents:
9117
diff
changeset
|
3011 none make memory allocation fail |
|
9644
9f7bcc2c3b97
commit https://github.com/vim/vim/commit/6f1d9a096bf22d50c727dca73abbfb8e3ff55176
Christian Brabandt <cb@256bit.org>
parents:
9636
diff
changeset
|
3012 test_autochdir() none enable 'autochdir' during startup |
| 14864 | 3013 test_feedinput({string}) none add key sequence to input buffer |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
3014 test_garbagecollect_now() none free memory right now for testing |
|
17159
3fd0765f454f
patch 8.1.1579: dict and list could be GC'ed while displaying error
Bram Moolenaar <Bram@vim.org>
parents:
17131
diff
changeset
|
3015 test_garbagecollect_soon() none free memory soon for testing |
|
16664
ca1814eeecf5
patch 8.1.1334: when buffer is hidden "F" in 'shortmess' is not used
Bram Moolenaar <Bram@vim.org>
parents:
16660
diff
changeset
|
3016 test_getvalue({string}) any get value of an internal variable |
|
11006
b3601a8eb679
patch 8.0.0392: GUI test fails with Athena and Motif
Christian Brabandt <cb@256bit.org>
parents:
10908
diff
changeset
|
3017 test_ignore_error({expr}) none ignore a specific error |
|
15456
f01eb1aed348
patch 8.1.0736: code for Blob not sufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
15454
diff
changeset
|
3018 test_null_blob() Blob null value for testing |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
3019 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
|
3020 test_null_dict() Dict null value for testing |
|
19874
f92435f0f449
patch 8.2.0493: Vim9: some error messages not tested
Bram Moolenaar <Bram@vim.org>
parents:
19870
diff
changeset
|
3021 test_null_function() Funcref null value for testing |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
3022 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
|
3023 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
|
3024 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
|
3025 test_null_string() String null value for testing |
| 14945 | 3026 test_option_not_set({name}) none reset flag indicating option was set |
| 3027 test_override({expr}, {val}) none test with Vim internal overrides | |
|
16078
d13aa9c5a1d1
patch 8.1.1044: no way to check the reference count of objects
Bram Moolenaar <Bram@vim.org>
parents:
16019
diff
changeset
|
3028 test_refcount({expr}) Number get the reference count of {expr} |
|
14756
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
3029 test_scrollbar({which}, {value}, {dragging}) |
|
a179e5cfcab7
patch 8.1.0390: scrollbars are not tested
Christian Brabandt <cb@256bit.org>
parents:
14748
diff
changeset
|
3030 none scroll in the GUI for testing |
|
16517
9484fc00ac6b
patch 8.1.1262: cannot simulate a mouse click in a test
Bram Moolenaar <Bram@vim.org>
parents:
16489
diff
changeset
|
3031 test_setmouse({row}, {col}) none set the mouse position for testing |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
3032 test_settime({expr}) none set current time for testing |
|
19350
76cb39bf1871
patch 8.2.0233: crash when using garbagecollect() in between rand()
Bram Moolenaar <Bram@vim.org>
parents:
19308
diff
changeset
|
3033 test_srand_seed([seed]) none set seed for testing srand() |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
3034 test_unknown() any unknown value for testing |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
3035 test_void() any void value for testing |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
3036 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
|
3037 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
|
3038 timer_start({time}, {callback} [, {options}]) |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
3039 Number create a timer |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3040 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
|
3041 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
|
3042 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
|
3043 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
|
3044 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr} |
| 15 | 3045 to chars in {tostr} |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
3046 trim({text} [, {mask} [, {dir}]]) |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
3047 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
|
3048 trunc({expr}) Float truncate Float {expr} |
|
23594
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
3049 type({expr}) Number type of value {expr} |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
3050 typename({expr}) String representation of the type of {expr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3051 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
|
3052 undotree() List undo file tree |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3053 uniq({list} [, {func} [, {dict}]]) |
| 5747 | 3054 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
|
3055 values({dict}) List values in {dict} |
|
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3056 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
|
3057 visualmode([expr]) String last visual mode used |
| 4151 | 3058 wildmenumode() Number whether 'wildmenu' mode is active |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
3059 win_execute({id}, {command} [, {silent}]) |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
3060 String execute {command} in window {id} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3061 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
|
3062 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab} |
| 20115 | 3063 win_gettype([{nr}]) String type of window {nr} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3064 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
|
3065 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
|
3066 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
|
3067 win_screenpos({nr}) List get screen position of window {nr} |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
3068 win_splitmove({nr}, {target} [, {options}]) |
| 18343 | 3069 Number move window {nr} to split of {target} |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3070 winbufnr({nr}) Number buffer number of window {nr} |
| 7 | 3071 wincol() Number window column of the cursor |
| 20552 | 3072 windowsversion() String MS-Windows OS version |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
3073 winheight({nr}) Number height of window {nr} |
|
14587
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
3074 winlayout([{tabnr}]) List layout of windows in tab {tabnr} |
| 7 | 3075 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
|
3076 winnr([{expr}]) Number number of current window |
| 55 | 3077 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
|
3078 winrestview({dict}) none restore view of current window |
| 712 | 3079 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
|
3080 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
|
3081 wordcount() Dict get byte/char/word statistics |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3082 writefile({object}, {fname} [, {flags}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
3083 Number write |Blob| or |List| of lines to file |
|
9536
b2aada04d84e
commit https://github.com/vim/vim/commit/a06ecab7a5159e744448ace731036f0dc5f87dd4
Christian Brabandt <cb@256bit.org>
parents:
9527
diff
changeset
|
3084 xor({expr}, {expr}) Number bitwise XOR |
| 7 | 3085 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
3086 |
| 1621 | 3087 abs({expr}) *abs()* |
| 3088 Return the absolute value of {expr}. When {expr} evaluates to | |
| 3089 a |Float| abs() returns a |Float|. When {expr} can be | |
| 3090 converted to a |Number| abs() returns a |Number|. Otherwise | |
| 3091 abs() gives an error message and returns -1. | |
| 3092 Examples: > | |
| 3093 echo abs(1.456) | |
| 3094 < 1.456 > | |
| 3095 echo abs(-5.456) | |
| 3096 < 5.456 > | |
| 3097 echo abs(-4) | |
| 3098 < 4 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3099 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3100 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3101 Compute()->abs() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3102 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3103 < {only available when compiled with the |+float| feature} |
| 1621 | 3104 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3105 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3106 acos({expr}) *acos()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3107 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
|
3108 |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
|
3109 {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
|
3110 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3111 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3112 :echo acos(0) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3113 < 1.570796 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3114 :echo acos(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3115 < 2.094395 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3116 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3117 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3118 Compute()->acos() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3119 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3120 < {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3121 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3122 |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
3123 add({object}, {expr}) *add()* |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
3124 Append the item {expr} to |List| or |Blob| {object}. Returns |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
3125 the resulting |List| or |Blob|. Examples: > |
| 82 | 3126 :let alist = add([1, 2, 3], item) |
| 3127 :call add(mylist, "woodstock") | |
| 685 | 3128 < Note that when {expr} is a |List| it is appended as a single |
| 692 | 3129 item. Use |extend()| to concatenate |Lists|. |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
3130 When {object} is a |Blob| then {expr} must be a number. |
| 85 | 3131 Use |insert()| to add an item at another position. |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3132 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3133 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3134 mylist->add(val1)->add(val2) |
| 55 | 3135 |
| 82 | 3136 |
| 3214 | 3137 and({expr}, {expr}) *and()* |
| 3138 Bitwise AND on the two arguments. The arguments are converted | |
| 3139 to a number. A List, Dict or Float argument causes an error. | |
| 3140 Example: > | |
| 3141 :let flag = and(bits, 0x80) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3142 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3143 :let flag = bits->and(0x80) |
| 3214 | 3144 |
| 3145 | |
| 14864 | 3146 append({lnum}, {text}) *append()* |
| 3147 When {text} is a |List|: Append each item of the |List| as a | |
| 685 | 3148 text line below line {lnum} in the current buffer. |
| 14864 | 3149 Otherwise append {text} as one text line below line {lnum} in |
| 153 | 3150 the current buffer. |
|
23788
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
3151 Any type of item is accepted and converted to a String. |
| 153 | 3152 {lnum} can be zero to insert a line before the first one. |
| 82 | 3153 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
|
3154 0 for success. Example: > |
| 55 | 3155 :let failed = append(line('$'), "# THE END") |
| 82 | 3156 :let failed = append(0, ["Chapter 1", "the beginning"]) |
|
14039
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3157 |
| 21250 | 3158 < Can also be used as a |method| after a List, the base is |
| 3159 passed as the second argument: > | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3160 mylist->append(lnum) |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3161 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3162 |
|
14039
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3163 appendbufline({expr}, {lnum}, {text}) *appendbufline()* |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3164 Like |append()| but append the text in buffer {expr}. |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3165 |
| 18343 | 3166 This function works only for loaded buffers. First call |
| 3167 |bufload()| if needed. | |
| 3168 | |
|
14039
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3169 For the use of {expr}, see |bufname()|. |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3170 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3171 {lnum} is used like with |append()|. Note that using |line()| |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3172 would use the current buffer, not the one appending to. |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3173 Use "$" to append at the end of the buffer. |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3174 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3175 On success 0 is returned, on failure 1 is returned. |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3176 |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3177 If {expr} is not a valid buffer or {lnum} is not valid, an |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3178 error message is given. Example: > |
|
acb2dc112b06
patch 8.1.0037: cannot easily append lines to another buffer
Christian Brabandt <cb@256bit.org>
parents:
14019
diff
changeset
|
3179 :let failed = appendbufline(13, 0, "# THE START") |
| 55 | 3180 < |
| 22723 | 3181 Can also be used as a |method| after a List, the base is |
| 21250 | 3182 passed as the second argument: > |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3183 mylist->appendbufline(buf, lnum) |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3184 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3185 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
3186 argc([{winid}]) *argc()* |
|
14964
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3187 The result is the number of files in the argument list. See |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3188 |arglist|. |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3189 If {winid} is not supplied, the argument list of the current |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3190 window is used. |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3191 If {winid} is -1, the global argument list is used. |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3192 Otherwise {winid} specifies the window of which the argument |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3193 list is used: either the window number or the window ID. |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3194 Returns -1 if the {winid} argument is invalid. |
| 7 | 3195 |
| 3196 *argidx()* | |
| 3197 argidx() The result is the current index in the argument list. 0 is | |
| 3198 the first file. argc() - 1 is the last one. See |arglist|. | |
| 3199 | |
| 5942 | 3200 *arglistid()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
3201 arglistid([{winnr} [, {tabnr}]]) |
| 5942 | 3202 Return the argument list ID. This is a number which |
| 3203 identifies the argument list being used. Zero is used for the | |
| 6153 | 3204 global argument list. See |arglist|. |
|
14964
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3205 Returns -1 if the arguments are invalid. |
| 5942 | 3206 |
| 3207 Without arguments use the current window. | |
| 3208 With {winnr} only use this window in the current tab page. | |
| 3209 With {winnr} and {tabnr} use the window in the specified tab | |
| 3210 page. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3211 {winnr} can be the window number or the |window-ID|. |
| 5942 | 3212 |
| 7 | 3213 *argv()* |
| 20241 | 3214 argv([{nr} [, {winid}]]) |
|
14964
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3215 The result is the {nr}th file in the argument list. See |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3216 |arglist|. "argv(0)" is the first one. Example: > |
| 7 | 3217 :let i = 0 |
| 3218 :while i < argc() | |
| 1621 | 3219 : let f = escape(fnameescape(argv(i)), '.') |
| 7 | 3220 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>' |
| 3221 : let i = i + 1 | |
| 3222 :endwhile | |
|
14964
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3223 < Without the {nr} argument, or when {nr} is -1, a |List| with |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3224 the whole |arglist| is returned. |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3225 |
|
2c0bfa167468
patch 8.1.0493: argv() and argc() only work on the current argument list
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
3226 The {winid} argument specifies the window ID, see |argc()|. |
|
18477
e93cab5d0f0f
patch 8.1.2233: cannot get the Vim command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
18463
diff
changeset
|
3227 For the Vim command line arguments see |v:argv|. |
| 818 | 3228 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3229 asin({expr}) *asin()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3230 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
|
3231 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
|
3232 {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
|
3233 [-1, 1]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3234 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3235 :echo asin(0.8) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3236 < 0.927295 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3237 :echo asin(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3238 < -0.523599 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3239 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3240 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3241 Compute()->asin() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3242 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3243 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3244 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3245 |
| 19099 | 3246 assert_ functions are documented here: |assert-functions-details| |
| 3247 | |
| 3248 | |
| 3249 | |
| 1621 | 3250 atan({expr}) *atan()* |
| 3251 Return the principal value of the arc tangent of {expr}, in | |
| 3252 the range [-pi/2, +pi/2] radians, as a |Float|. | |
| 3253 {expr} must evaluate to a |Float| or a |Number|. | |
| 3254 Examples: > | |
| 3255 :echo atan(100) | |
| 3256 < 1.560797 > | |
| 3257 :echo atan(-4.01) | |
| 3258 < -1.326405 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3259 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3260 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3261 Compute()->atan() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3262 < |
| 1621 | 3263 {only available when compiled with the |+float| feature} |
| 3264 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3265 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3266 atan2({expr1}, {expr2}) *atan2()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3267 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
|
3268 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
|
3269 {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
|
3270 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3271 :echo atan2(-1, 1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3272 < -0.785398 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3273 :echo atan2(1, -1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3274 < 2.356194 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3275 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3276 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3277 Compute()->atan(1) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3278 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3279 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3280 |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3281 balloon_gettext() *balloon_gettext()* |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3282 Return the current text in the balloon. Only for the string, |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3283 not used for the List. |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3284 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3285 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
|
3286 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
|
3287 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
|
3288 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
|
3289 split with |balloon_split()|. |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3290 If {expr} is an empty string any existing balloon is removed. |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3291 |
| 11062 | 3292 Example: > |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3293 func GetBalloonContent() |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
3294 " ... initiate getting the content |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3295 return '' |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3296 endfunc |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3297 set balloonexpr=GetBalloonContent() |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3298 |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3299 func BalloonCallback(result) |
| 11062 | 3300 call balloon_show(a:result) |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3301 endfunc |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3302 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3303 GetText()->balloon_show() |
|
11014
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3304 < |
|
fb2bcfa6a8de
patch 8.0.0396: 'balloonexpr' only works synchronously
Christian Brabandt <cb@256bit.org>
parents:
11006
diff
changeset
|
3305 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
|
3306 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
|
3307 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
|
3308 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
|
3309 empty string or a placeholder. |
| 11062 | 3310 |
| 3311 When showing a balloon is not possible nothing happens, no | |
| 3312 error message. | |
| 14864 | 3313 {only available when compiled with the |+balloon_eval| or |
| 3314 |+balloon_eval_term| feature} | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3315 |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3316 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
|
3317 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
|
3318 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
|
3319 show debugger output. |
|
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3320 Returns a |List| with the split lines. |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3321 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3322 GetText()->balloon_split()->balloon_show() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3323 |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3324 < {only available when compiled with the |+balloon_eval_term| |
|
12885
10cb5c3df3f5
patch 8.0.1319: can't build GUI on MS-Windows
Christian Brabandt <cb@256bit.org>
parents:
12883
diff
changeset
|
3325 feature} |
|
12883
058e93aee621
patch 8.0.1318: terminal balloon only shows one line
Christian Brabandt <cb@256bit.org>
parents:
12857
diff
changeset
|
3326 |
| 7 | 3327 *browse()* |
| 3328 browse({save}, {title}, {initdir}, {default}) | |
| 3329 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
|
3330 returns |TRUE| (only in some GUI versions). |
| 7 | 3331 The input fields are: |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3332 {save} when |TRUE|, select file to write |
| 7 | 3333 {title} title for the requester |
| 3334 {initdir} directory to start browsing in | |
| 3335 {default} default file name | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3336 An empty string is returned when the "Cancel" button is hit, |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3337 something went wrong, or browsing is not possible. |
| 7 | 3338 |
| 29 | 3339 *browsedir()* |
| 3340 browsedir({title}, {initdir}) | |
| 3341 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
|
3342 "has("browse")" returns |TRUE| (only in some GUI versions). |
| 29 | 3343 On systems where a directory browser is not supported a file |
| 3344 browser is used. In that case: select a file in the directory | |
| 3345 to be used. | |
| 3346 The input fields are: | |
| 3347 {title} title for the requester | |
| 3348 {initdir} directory to start browsing in | |
| 3349 When the "Cancel" button is hit, something went wrong, or | |
| 3350 browsing is not possible, an empty string is returned. | |
| 3351 | |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3352 bufadd({name}) *bufadd()* |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3353 Add a buffer to the buffer list with {name}. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3354 If a buffer for file {name} already exists, return that buffer |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3355 number. Otherwise return the buffer number of the newly |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3356 created buffer. When {name} is an empty string then a new |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3357 buffer is always created. |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
3358 The buffer will not have 'buflisted' set and not be loaded |
|
17253
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3359 yet. To add some text to the buffer use this: > |
|
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3360 let bufnr = bufadd('someName') |
|
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3361 call bufload(bufnr) |
|
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
3362 call setbufline(bufnr, 1, ['some', 'text']) |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3363 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3364 let bufnr = 'somename'->bufadd() |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3365 |
| 7 | 3366 bufexists({expr}) *bufexists()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3367 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3368 {expr} exists. |
| 9 | 3369 If the {expr} argument is a number, buffer numbers are used. |
| 12909 | 3370 Number zero is the alternate buffer for the current window. |
| 3371 | |
| 7 | 3372 If the {expr} argument is a string it must match a buffer name |
| 9 | 3373 exactly. The name can be: |
| 3374 - Relative to the current directory. | |
| 3375 - A full path. | |
| 1621 | 3376 - The name of a buffer with 'buftype' set to "nofile". |
| 9 | 3377 - A URL name. |
| 7 | 3378 Unlisted buffers will be found. |
| 3379 Note that help files are listed by their short name in the | |
| 3380 output of |:buffers|, but bufexists() requires using their | |
| 3381 long name to be able to find them. | |
| 1621 | 3382 bufexists() may report a buffer exists, but to use the name |
| 3383 with a |:buffer| command you may need to use |expand()|. Esp | |
| 3384 for MS-Windows 8.3 names in the form "c:\DOCUME~1" | |
| 7 | 3385 Use "bufexists(0)" to test for the existence of an alternate |
| 3386 file name. | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3387 |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3388 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3389 let exists = 'somename'->bufexists() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3390 < |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3391 Obsolete name: buffer_exists(). *buffer_exists()* |
| 7 | 3392 |
| 3393 buflisted({expr}) *buflisted()* | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3394 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3395 {expr} exists and is listed (has the 'buflisted' option set). |
| 9 | 3396 The {expr} argument is used like with |bufexists()|. |
| 7 | 3397 |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3398 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3399 let listed = 'somename'->buflisted() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3400 |
|
17221
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3401 bufload({expr}) *bufload()* |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3402 Ensure the buffer {expr} is loaded. When the buffer name |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3403 refers to an existing file then the file is read. Otherwise |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3404 the buffer will be empty. If the buffer was already loaded |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3405 then there is no change. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3406 If there is an existing swap file for the file of the buffer, |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3407 there will be no dialog, the buffer will be loaded anyway. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3408 The {expr} argument is used like with |bufexists()|. |
|
a8fc7d97b54d
patch 8.1.1610: there is no way to add or load a buffer without side effects
Bram Moolenaar <Bram@vim.org>
parents:
17172
diff
changeset
|
3409 |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3410 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3411 eval 'somename'->bufload() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3412 |
| 7 | 3413 bufloaded({expr}) *bufloaded()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3414 The result is a Number, which is |TRUE| if a buffer called |
| 7 | 3415 {expr} exists and is loaded (shown in a window or hidden). |
| 9 | 3416 The {expr} argument is used like with |bufexists()|. |
| 7 | 3417 |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3418 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3419 let loaded = 'somename'->bufloaded() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3420 |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3421 bufname([{expr}]) *bufname()* |
| 7 | 3422 The result is the name of a buffer, as it is displayed by the |
| 3423 ":ls" command. | |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3424 If {expr} is omitted the current buffer is used. |
| 7 | 3425 If {expr} is a Number, that buffer number's name is given. |
| 3426 Number zero is the alternate buffer for the current window. | |
| 3427 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
|
3428 with the buffer names. This is always done like 'magic' is |
| 7 | 3429 set and 'cpoptions' is empty. When there is more than one |
| 3430 match an empty string is returned. | |
| 3431 "" or "%" can be used for the current buffer, "#" for the | |
| 3432 alternate buffer. | |
| 3433 A full match is preferred, otherwise a match at the start, end | |
| 1156 | 3434 or middle of the buffer name is accepted. If you only want a |
| 3435 full match then put "^" at the start and "$" at the end of the | |
| 3436 pattern. | |
| 7 | 3437 Listed buffers are found first. If there is a single match |
| 3438 with a listed buffer, that one is returned. Next unlisted | |
| 3439 buffers are searched for. | |
| 3440 If the {expr} is a String, but you want to use it as a buffer | |
| 3441 number, force it to be a Number by adding zero to it: > | |
| 3442 :echo bufname("3" + 0) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3443 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3444 echo bufnr->bufname() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3445 |
| 7 | 3446 < If the buffer doesn't exist, or doesn't have a name, an empty |
| 3447 string is returned. > | |
| 3448 bufname("#") alternate buffer name | |
| 3449 bufname(3) name of buffer 3 | |
| 3450 bufname("%") name of current buffer | |
| 3451 bufname("file2") name of buffer where "file2" matches. | |
| 3452 < *buffer_name()* | |
| 3453 Obsolete name: buffer_name(). | |
| 3454 | |
| 3455 *bufnr()* | |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3456 bufnr([{expr} [, {create}]]) |
| 707 | 3457 The result is the number of a buffer, as it is displayed by |
| 7 | 3458 the ":ls" command. For the use of {expr}, see |bufname()| |
| 707 | 3459 above. |
|
18170
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3460 |
| 707 | 3461 If the buffer doesn't exist, -1 is returned. Or, if the |
| 22171 | 3462 {create} argument is present and TRUE, a new, unlisted, |
|
18170
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3463 buffer is created and its number is returned. Example: > |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3464 let newbuf = bufnr('Scratch001', 1) |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3465 < Using an empty name uses the current buffer. To create a new |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3466 buffer with an empty name use |bufadd()|. |
|
4ac8161e92e0
patch 8.1.2080: the terminal API is limited and can't be disabled
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
3467 |
| 7 | 3468 bufnr("$") is the last buffer: > |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
3469 :let last_buffer = bufnr("$") |
| 7 | 3470 < The result is a Number, which is the highest buffer number |
| 3471 of existing buffers. Note that not all buffers with a smaller | |
| 3472 number necessarily exist, because ":bwipeout" may have removed | |
| 3473 them. Use bufexists() to test for the existence of a buffer. | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3474 |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3475 Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3476 echo bufref->bufnr() |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3477 < |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
3478 Obsolete name: buffer_number(). *buffer_number()* |
| 7 | 3479 *last_buffer_nr()* |
| 3480 Obsolete name for bufnr("$"): last_buffer_nr(). | |
| 3481 | |
|
9219
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3482 bufwinid({expr}) *bufwinid()* |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
3483 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
|
3484 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
|
3485 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
|
3486 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
|
3487 |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3488 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
|
3489 < |
|
7363f5cc4cb8
commit https://github.com/vim/vim/commit/b3619a90eae2702553ff9494ecc4c9b20c13c224
Christian Brabandt <cb@256bit.org>
parents:
9121
diff
changeset
|
3490 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
|
3491 |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3492 Can also be used as a |method|: > |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3493 FindBuffer()->bufwinid() |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3494 |
| 7 | 3495 bufwinnr({expr}) *bufwinnr()* |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3496 Like |bufwinid()| but return the window number instead of the |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3497 |window-ID|. |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3498 If buffer {expr} doesn't exist or there is no such window, -1 |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3499 is returned. Example: > |
| 7 | 3500 |
| 3501 echo "A window containing buffer 1 is " . (bufwinnr(1)) | |
| 3502 | |
| 3503 < The number can be used with |CTRL-W_w| and ":wincmd w" | |
| 3504 |:wincmd|. | |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3505 |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3506 Can also be used as a |method|: > |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
3507 FindBuffer()->bufwinnr() |
| 7 | 3508 |
| 3509 byte2line({byte}) *byte2line()* | |
| 3510 Return the line number that contains the character at byte | |
| 3511 count {byte} in the current buffer. This includes the | |
| 3512 end-of-line character, depending on the 'fileformat' option | |
| 3513 for the current buffer. The first character has byte count | |
| 3514 one. | |
| 3515 Also see |line2byte()|, |go| and |:goto|. | |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3516 |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3517 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3518 GetOffset()->byte2line() |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3519 |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3520 < {not available when compiled without the |+byte_offset| |
| 7 | 3521 feature} |
| 3522 | |
| 18 | 3523 byteidx({expr}, {nr}) *byteidx()* |
| 3524 Return byte index of the {nr}'th character in the string | |
|
21935
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
3525 {expr}. Use zero for the first character, it then returns |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
3526 zero. |
| 22958 | 3527 If there are no multibyte characters the returned value is |
| 3528 equal to {nr}. | |
| 5413 | 3529 Composing characters are not counted separately, their byte |
| 3530 length is added to the preceding base character. See | |
| 3531 |byteidxcomp()| below for counting composing characters | |
| 3532 separately. | |
| 18 | 3533 Example : > |
| 3534 echo matchstr(str, ".", byteidx(str, 3)) | |
| 3535 < will display the fourth character. Another way to do the | |
| 3536 same: > | |
| 3537 let s = strpart(str, byteidx(str, 3)) | |
| 3538 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
|
3539 < Also see |strgetchar()| and |strcharpart()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3540 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
3541 If there are less than {nr} characters -1 is returned. |
| 18 | 3542 If there are exactly {nr} characters the length of the string |
| 5413 | 3543 in bytes is returned. |
| 3544 | |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3545 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3546 GetName()->byteidx(idx) |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3547 |
| 5413 | 3548 byteidxcomp({expr}, {nr}) *byteidxcomp()* |
| 3549 Like byteidx(), except that a composing character is counted | |
| 3550 as a separate character. Example: > | |
| 3551 let s = 'e' . nr2char(0x301) | |
| 3552 echo byteidx(s, 1) | |
| 3553 echo byteidxcomp(s, 1) | |
| 3554 echo byteidxcomp(s, 2) | |
| 3555 < The first and third echo result in 3 ('e' plus composing | |
| 3556 character is 3 bytes), the second echo results in 1 ('e' is | |
| 3557 one byte). | |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3558 Only works differently from byteidx() when 'encoding' is set |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3559 to a Unicode encoding. |
| 18 | 3560 |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3561 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3562 GetName()->byteidxcomp(idx) |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3563 |
| 102 | 3564 call({func}, {arglist} [, {dict}]) *call()* *E699* |
| 685 | 3565 Call function {func} with the items in |List| {arglist} as |
| 79 | 3566 arguments. |
| 685 | 3567 {func} can either be a |Funcref| or the name of a function. |
| 79 | 3568 a:firstline and a:lastline are set to the cursor line. |
| 3569 Returns the return value of the called function. | |
| 102 | 3570 {dict} is for functions with the "dict" attribute. It will be |
| 3571 used to set the local variable "self". |Dictionary-function| | |
| 79 | 3572 |
|
17829
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3573 Can also be used as a |method|: > |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3574 GetFunc()->call([arg, arg], dict) |
|
1090d6637cfd
patch 8.1.1911: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17825
diff
changeset
|
3575 |
| 1621 | 3576 ceil({expr}) *ceil()* |
| 3577 Return the smallest integral value greater than or equal to | |
| 3578 {expr} as a |Float| (round up). | |
| 3579 {expr} must evaluate to a |Float| or a |Number|. | |
| 3580 Examples: > | |
| 3581 echo ceil(1.456) | |
| 3582 < 2.0 > | |
| 3583 echo ceil(-5.456) | |
| 3584 < -5.0 > | |
| 3585 echo ceil(4.0) | |
| 3586 < 4.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3587 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3588 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3589 Compute()->ceil() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3590 < |
| 1621 | 3591 {only available when compiled with the |+float| feature} |
| 3592 | |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3593 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3594 ch_ functions are documented here: |channel-functions-details| |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3595 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
3596 |
| 11062 | 3597 changenr() *changenr()* |
| 3598 Return the number of the most recent change. This is the same | |
| 3599 number as what is displayed with |:undolist| and can be used | |
| 3600 with the |:undo| command. | |
| 3601 When a change was made it is the number of that change. After | |
| 3602 redo it is the number of the redone change. After undo it is | |
| 3603 one less than the number of the undone change. | |
| 3604 | |
| 12785 | 3605 char2nr({expr} [, {utf8}]) *char2nr()* |
| 11062 | 3606 Return number value of the first char in {expr}. Examples: > |
| 3607 char2nr(" ") returns 32 | |
| 3608 char2nr("ABC") returns 65 | |
| 3609 < When {utf8} is omitted or zero, the current 'encoding' is used. | |
| 3610 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
|
3611 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
|
3612 char2nr("á"[0]) returns 195 |
| 22171 | 3613 < With {utf8} set to TRUE, always treat as utf-8 characters. |
| 11062 | 3614 A combining character is a separate character. |
| 3615 |nr2char()| does the opposite. | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3616 To turn a string into a list of character numbers: > |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3617 let str = "ABC" |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3618 let list = map(split(str, '\zs'), {_, val -> char2nr(val)}) |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3619 < Result: [65, 66, 67] |
| 11062 | 3620 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3621 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3622 GetChar()->char2nr() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3623 |
|
21973
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3624 |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3625 charclass({string}) *charclass()* |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3626 Return the character class of the first character in {string}. |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3627 The character class is one of: |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3628 0 blank |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3629 1 punctuation |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3630 2 word character |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3631 3 emoji |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3632 other specific Unicode class |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3633 The class is used in patterns and word motions. |
|
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3634 |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3635 *charcol()* |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3636 charcol({expr}) Same as |col()| but returns the character index of the column |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3637 position given with {expr} instead of the byte position. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3638 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3639 Example: |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3640 With the cursor on '세' in line 5 with text "여보세요": > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3641 charcol('.') returns 3 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3642 col('.') returns 7 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3643 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3644 < Can also be used as a |method|: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3645 GetPos()->col() |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3646 < |
|
23380
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3647 *charidx()* |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3648 charidx({string}, {idx} [, {countcc}]) |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3649 Return the character index of the byte at {idx} in {string}. |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3650 The index of the first character is zero. |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3651 If there are no multibyte characters the returned value is |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3652 equal to {idx}. |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3653 When {countcc} is omitted or zero, then composing characters |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3654 are not counted separately, their byte length is added to the |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3655 preceding base character. |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3656 When {countcc} is set to 1, then composing characters are |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3657 counted as separate characters. |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3658 Returns -1 if the arguments are invalid or if {idx} is greater |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3659 than the index of the last byte in {string}. An error is |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3660 given if the first argument is not a string, the second |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3661 argument is not a number or when the third argument is present |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3662 and is not zero or one. |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3663 See |byteidx()| and |byteidxcomp()| for getting the byte index |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3664 from the character index. |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3665 Examples: > |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3666 echo charidx('áb́ć', 3) returns 1 |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3667 echo charidx('áb́ć', 6, 1) returns 4 |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3668 echo charidx('áb́ć', 16) returns -1 |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3669 < |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3670 Can also be used as a |method|: > |
|
2351b40af967
patch 8.2.2233: cannot convert a byte index into a character index
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
3671 GetName()->charidx(idx) |
|
21973
85add08e6a2d
patch 8.2.1536: cannot get the class of a character; emoji widths are wrong
Bram Moolenaar <Bram@vim.org>
parents:
21971
diff
changeset
|
3672 |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3673 chdir({dir}) *chdir()* |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3674 Change the current working directory to {dir}. The scope of |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3675 the directory change depends on the directory of the current |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3676 window: |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3677 - If the current window has a window-local directory |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3678 (|:lcd|), then changes the window local directory. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3679 - Otherwise, if the current tabpage has a local |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3680 directory (|:tcd|) then changes the tabpage local |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3681 directory. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3682 - Otherwise, changes the global directory. |
| 19303 | 3683 {dir} must be a String. |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3684 If successful, returns the previous working directory. Pass |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3685 this to another chdir() to restore the directory. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3686 On failure, returns an empty string. |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3687 |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3688 Example: > |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3689 let save_dir = chdir(newdir) |
| 16808 | 3690 if save_dir != "" |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3691 " ... do some work |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3692 call chdir(save_dir) |
|
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3693 endif |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3694 |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3695 < Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3696 GetDir()->chdir() |
|
16576
bcc343175103
patch 8.1.1291: not easy to change directory and restore
Bram Moolenaar <Bram@vim.org>
parents:
16553
diff
changeset
|
3697 < |
| 11062 | 3698 cindent({lnum}) *cindent()* |
| 3699 Get the amount of indent for line {lnum} according the C | |
| 3700 indenting rules, as with 'cindent'. | |
| 3701 The indent is counted in spaces, the value of 'tabstop' is | |
| 3702 relevant. {lnum} is used just like in |getline()|. | |
| 3703 When {lnum} is invalid or Vim was not compiled the |+cindent| | |
| 3704 feature, -1 is returned. | |
| 3705 See |C-indenting|. | |
| 3706 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3707 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3708 GetLnum()->cindent() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3709 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3710 clearmatches([{win}]) *clearmatches()* |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3711 Clears all matches previously defined for the current window |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3712 by |matchadd()| and the |:match| commands. |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3713 If {win} is specified, use the window with this number or |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
3714 window ID instead of the current window. |
| 11062 | 3715 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3716 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3717 GetWin()->clearmatches() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3718 < |
| 11062 | 3719 *col()* |
| 3720 col({expr}) The result is a Number, which is the byte index of the column | |
| 3721 position given with {expr}. The accepted positions are: | |
| 3722 . the cursor position | |
| 3723 $ the end of the cursor line (the result is the | |
| 3724 number of bytes in the cursor line plus one) | |
| 3725 'x position of mark x (if the mark is not set, 0 is | |
| 3726 returned) | |
| 3727 v In Visual mode: the start of the Visual area (the | |
| 3728 cursor is the end). When not in Visual mode | |
| 3729 returns the cursor position. Differs from |'<| in | |
| 3730 that it's updated right away. | |
| 3731 Additionally {expr} can be [lnum, col]: a |List| with the line | |
| 3732 and column number. Most useful when the column is "$", to get | |
| 3733 the last column of a specific line. When "lnum" or "col" is | |
| 3734 out of range then col() returns zero. | |
| 3735 To get the line number use |line()|. To get both use | |
| 3736 |getpos()|. | |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3737 For the screen column position use |virtcol()|. For the |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
3738 character position use |charcol()|. |
| 11062 | 3739 Note that only marks in the current file can be used. |
| 3740 Examples: > | |
| 3741 col(".") column of cursor | |
| 3742 col("$") length of cursor line plus one | |
| 3743 col("'t") column of mark t | |
| 3744 col("'" . markname) column of mark markname | |
| 3745 < The first column is 1. 0 is returned for an error. | |
| 3746 For an uppercase mark the column may actually be in another | |
| 3747 buffer. | |
| 3748 For the cursor position, when 'virtualedit' is active, the | |
| 3749 column is one higher if the cursor is after the end of the | |
| 3750 line. This can be used to obtain the column in Insert mode: > | |
| 3751 :imap <F2> <C-O>:let save_ve = &ve<CR> | |
| 3752 \<C-O>:set ve=all<CR> | |
| 3753 \<C-O>:echo col(".") . "\n" <Bar> | |
| 3754 \let &ve = save_ve<CR> | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3755 |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3756 < Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3757 GetPos()->col() |
| 11062 | 3758 < |
| 3759 | |
| 3760 complete({startcol}, {matches}) *complete()* *E785* | |
| 3761 Set the matches for Insert mode completion. | |
| 3762 Can only be used in Insert mode. You need to use a mapping | |
| 3763 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O | |
| 3764 or with an expression mapping. | |
| 3765 {startcol} is the byte offset in the line where the completed | |
| 3766 text start. The text up to the cursor is the original text | |
| 3767 that will be replaced by the matches. Use col('.') for an | |
| 3768 empty string. "col('.') - 1" will replace one character by a | |
| 3769 match. | |
| 3770 {matches} must be a |List|. Each |List| item is one match. | |
| 3771 See |complete-items| for the kind of items that are possible. | |
| 3772 Note that the after calling this function you need to avoid | |
| 3773 inserting anything that would cause completion to stop. | |
| 3774 The match can be selected with CTRL-N and CTRL-P as usual with | |
| 3775 Insert mode completion. The popup menu will appear if | |
| 3776 specified, see |ins-completion-menu|. | |
| 3777 Example: > | |
| 3778 inoremap <F5> <C-R>=ListMonths()<CR> | |
| 3779 | |
| 3780 func! ListMonths() | |
| 3781 call complete(col('.'), ['January', 'February', 'March', | |
| 3782 \ 'April', 'May', 'June', 'July', 'August', 'September', | |
| 3783 \ 'October', 'November', 'December']) | |
| 3784 return '' | |
| 3785 endfunc | |
| 3786 < This isn't very useful, but it shows how it works. Note that | |
| 3787 an empty string is returned to avoid a zero being inserted. | |
| 3788 | |
| 18343 | 3789 Can also be used as a |method|, the base is passed as the |
| 3790 second argument: > | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3791 GetMatches()->complete(col('.')) |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3792 |
| 11062 | 3793 complete_add({expr}) *complete_add()* |
| 3794 Add {expr} to the list of matches. Only to be used by the | |
| 3795 function specified with the 'completefunc' option. | |
| 3796 Returns 0 for failure (empty string or out of memory), | |
| 3797 1 when the match was added, 2 when the match was already in | |
| 3798 the list. | |
| 3799 See |complete-functions| for an explanation of {expr}. It is | |
| 3800 the same as one item in the list that 'omnifunc' would return. | |
| 3801 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3802 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3803 GetMoreMatches()->complete_add() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3804 |
| 11062 | 3805 complete_check() *complete_check()* |
| 3806 Check for a key typed while looking for completion matches. | |
| 3807 This is to be used when looking for matches takes some time. | |
| 3808 Returns |TRUE| when searching for matches is to be aborted, | |
| 3809 zero otherwise. | |
| 3810 Only to be used by the function specified with the | |
| 3811 'completefunc' option. | |
| 3812 | |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3813 *complete_info()* |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3814 complete_info([{what}]) |
| 21093 | 3815 Returns a |Dictionary| with information about Insert mode |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3816 completion. See |ins-completion|. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3817 The items are: |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3818 mode Current completion mode name string. |
| 16208 | 3819 See |complete_info_mode| for the values. |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3820 pum_visible |TRUE| if popup menu is visible. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3821 See |pumvisible()|. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3822 items List of completion matches. Each item is a |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3823 dictionary containing the entries "word", |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3824 "abbr", "menu", "kind", "info" and "user_data". |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3825 See |complete-items|. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3826 selected Selected item index. First index is zero. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3827 Index is -1 if no item is selected (showing |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3828 typed text only) |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3829 inserted Inserted string. [NOT IMPLEMENT YET] |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3830 |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3831 *complete_info_mode* |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3832 mode values are: |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3833 "" Not in completion mode |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3834 "keyword" Keyword completion |i_CTRL-X_CTRL-N| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3835 "ctrl_x" Just pressed CTRL-X |i_CTRL-X| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3836 "whole_line" Whole lines |i_CTRL-X_CTRL-L| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3837 "files" File names |i_CTRL-X_CTRL-F| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3838 "tags" Tags |i_CTRL-X_CTRL-]| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3839 "path_defines" Definition completion |i_CTRL-X_CTRL-D| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3840 "path_patterns" Include completion |i_CTRL-X_CTRL-I| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3841 "dictionary" Dictionary |i_CTRL-X_CTRL-K| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3842 "thesaurus" Thesaurus |i_CTRL-X_CTRL-T| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3843 "cmdline" Vim Command line |i_CTRL-X_CTRL-V| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3844 "function" User defined completion |i_CTRL-X_CTRL-U| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3845 "omni" Omni completion |i_CTRL-X_CTRL-O| |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3846 "spell" Spelling suggestions |i_CTRL-X_s| |
| 20965 | 3847 "eval" |complete()| completion |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3848 "unknown" Other internal modes |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3849 |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3850 If the optional {what} list argument is supplied, then only |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3851 the items listed in {what} are returned. Unsupported items in |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3852 {what} are silently ignored. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3853 |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3854 To get the position and size of the popup menu, see |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3855 |pum_getpos()|. It's also available in |v:event| during the |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3856 |CompleteChanged| event. |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
3857 |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3858 Examples: > |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3859 " Get all items |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3860 call complete_info() |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3861 " Get only 'mode' |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3862 call complete_info(['mode']) |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3863 " Get only 'mode' and 'pum_visible' |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3864 call complete_info(['mode', 'pum_visible']) |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3865 |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3866 < Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3867 GetItems()->complete_info() |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
3868 < |
| 11062 | 3869 *confirm()* |
| 3870 confirm({msg} [, {choices} [, {default} [, {type}]]]) | |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
3871 confirm() offers the user a dialog, from which a choice can be |
| 11062 | 3872 made. It returns the number of the choice. For the first |
| 3873 choice this is 1. | |
| 3874 Note: confirm() is only supported when compiled with dialog | |
| 3875 support, see |+dialog_con| and |+dialog_gui|. | |
| 3876 | |
| 3877 {msg} is displayed in a |dialog| with {choices} as the | |
| 3878 alternatives. When {choices} is missing or empty, "&OK" is | |
| 3879 used (and translated). | |
| 3880 {msg} is a String, use '\n' to include a newline. Only on | |
| 3881 some systems the string is wrapped when it doesn't fit. | |
| 3882 | |
| 3883 {choices} is a String, with the individual choices separated | |
| 3884 by '\n', e.g. > | |
| 3885 confirm("Save changes?", "&Yes\n&No\n&Cancel") | |
| 3886 < The letter after the '&' is the shortcut key for that choice. | |
| 3887 Thus you can type 'c' to select "Cancel". The shortcut does | |
| 3888 not need to be the first letter: > | |
| 3889 confirm("file has been modified", "&Save\nSave &All") | |
| 3890 < For the console, the first letter of each choice is used as | |
| 22824 | 3891 the default shortcut key. Case is ignored. |
| 11062 | 3892 |
| 3893 The optional {default} argument is the number of the choice | |
| 3894 that is made if the user hits <CR>. Use 1 to make the first | |
| 3895 choice the default one. Use 0 to not set a default. If | |
| 3896 {default} is omitted, 1 is used. | |
| 3897 | |
| 3898 The optional {type} argument gives the type of dialog. This | |
| 3899 is only used for the icon of the GTK, Mac, Motif and Win32 | |
| 3900 GUI. It can be one of these values: "Error", "Question", | |
| 3901 "Info", "Warning" or "Generic". Only the first character is | |
| 3902 relevant. When {type} is omitted, "Generic" is used. | |
| 3903 | |
| 3904 If the user aborts the dialog by pressing <Esc>, CTRL-C, | |
| 3905 or another valid interrupt key, confirm() returns 0. | |
| 3906 | |
| 3907 An example: > | |
| 3908 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2) | |
| 3909 :if choice == 0 | |
| 3910 : echo "make up your mind!" | |
| 3911 :elseif choice == 3 | |
| 3912 : echo "tasteful" | |
| 3913 :else | |
| 3914 : echo "I prefer bananas myself." | |
| 3915 :endif | |
| 3916 < In a GUI dialog, buttons are used. The layout of the buttons | |
| 3917 depends on the 'v' flag in 'guioptions'. If it is included, | |
| 3918 the buttons are always put vertically. Otherwise, confirm() | |
| 3919 tries to put the buttons in one horizontal line. If they | |
| 3920 don't fit, a vertical layout is used anyway. For some systems | |
| 3921 the horizontal layout is always used. | |
| 3922 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3923 Can also be used as a |method|in: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
3924 BuildMessage()->confirm("&Yes\n&No") |
| 18343 | 3925 < |
| 55 | 3926 *copy()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
3927 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 3928 different from using {expr} directly. |
| 685 | 3929 When {expr} is a |List| a shallow copy is created. This means |
| 3930 that the original |List| can be changed without changing the | |
| 1621 | 3931 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
|
3932 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
|
3933 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
|
3934 Also see |deepcopy()|. |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3935 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3936 mylist->copy() |
| 55 | 3937 |
| 1621 | 3938 cos({expr}) *cos()* |
| 3939 Return the cosine of {expr}, measured in radians, as a |Float|. | |
| 3940 {expr} must evaluate to a |Float| or a |Number|. | |
| 3941 Examples: > | |
| 3942 :echo cos(100) | |
| 3943 < 0.862319 > | |
| 3944 :echo cos(-4.01) | |
| 3945 < -0.646043 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3946 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3947 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3948 Compute()->cos() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3949 < |
| 1621 | 3950 {only available when compiled with the |+float| feature} |
| 3951 | |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3952 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3953 cosh({expr}) *cosh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3954 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
|
3955 [1, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
3956 {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
|
3957 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3958 :echo cosh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3959 < 1.127626 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3960 :echo cosh(-0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3961 < -1.127626 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3962 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3963 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3964 Compute()->cosh() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
3965 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
3966 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3967 |
| 12785 | 3968 |
| 102 | 3969 count({comp}, {expr} [, {ic} [, {start}]]) *count()* |
| 79 | 3970 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
|
3971 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
|
3972 |
| 102 | 3973 If {start} is given then start with the item with this index. |
| 685 | 3974 {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
|
3975 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
3976 When {ic} is given and it's |TRUE| then case is ignored. |
| 79 | 3977 |
|
11828
5a07a3ff56c1
patch 8.0.0794: checking translations fails with multiple NL
Christian Brabandt <cb@256bit.org>
parents:
11763
diff
changeset
|
3978 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
|
3979 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
|
3980 {expr} is an empty string. |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
3981 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3982 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
3983 mylist->count(val) |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
3984 < |
| 7 | 3985 *cscope_connection()* |
| 3986 cscope_connection([{num} , {dbpath} [, {prepend}]]) | |
| 3987 Checks for the existence of a |cscope| connection. If no | |
| 3988 parameters are specified, then the function returns: | |
| 3989 0, if cscope was not available (not compiled in), or | |
| 3990 if there are no cscope connections; | |
| 3991 1, if there is at least one cscope connection. | |
| 3992 | |
| 3993 If parameters are specified, then the value of {num} | |
| 3994 determines how existence of a cscope connection is checked: | |
| 3995 | |
| 3996 {num} Description of existence check | |
| 3997 ----- ------------------------------ | |
| 3998 0 Same as no parameters (e.g., "cscope_connection()"). | |
| 3999 1 Ignore {prepend}, and use partial string matches for | |
| 4000 {dbpath}. | |
| 4001 2 Ignore {prepend}, and use exact string matches for | |
| 4002 {dbpath}. | |
| 4003 3 Use {prepend}, use partial string matches for both | |
| 4004 {dbpath} and {prepend}. | |
| 4005 4 Use {prepend}, use exact string matches for both | |
| 4006 {dbpath} and {prepend}. | |
| 4007 | |
| 4008 Note: All string comparisons are case sensitive! | |
| 4009 | |
| 4010 Examples. Suppose we had the following (from ":cs show"): > | |
| 4011 | |
| 4012 # pid database name prepend path | |
| 4013 0 27664 cscope.out /usr/local | |
| 4014 < | |
| 4015 Invocation Return Val ~ | |
| 4016 ---------- ---------- > | |
| 4017 cscope_connection() 1 | |
| 4018 cscope_connection(1, "out") 1 | |
| 4019 cscope_connection(2, "out") 0 | |
| 4020 cscope_connection(3, "out") 0 | |
| 4021 cscope_connection(3, "out", "local") 1 | |
| 4022 cscope_connection(4, "out") 0 | |
| 4023 cscope_connection(4, "out", "local") 0 | |
| 4024 cscope_connection(4, "cscope.out", "/usr/local") 1 | |
| 4025 < | |
| 703 | 4026 cursor({lnum}, {col} [, {off}]) *cursor()* |
| 4027 cursor({list}) | |
| 1156 | 4028 Positions the cursor at the column (byte count) {col} in the |
| 4029 line {lnum}. The first column is one. | |
| 5938 | 4030 |
| 703 | 4031 When there is one argument {list} this is used as a |List| |
| 5938 | 4032 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
|
4033 [{lnum}, {col}] |
| 5938 | 4034 [{lnum}, {col}, {off}] |
| 4035 [{lnum}, {col}, {off}, {curswant}] | |
| 6009 | 4036 This is like the return value of |getpos()| or |getcurpos()|, |
| 5944 | 4037 but without the first item. |
| 5938 | 4038 |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
4039 To position the cursor using the character count, use |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
4040 |setcursorcharpos()|. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
4041 |
| 7 | 4042 Does not change the jumplist. |
| 4043 If {lnum} is greater than the number of lines in the buffer, | |
| 4044 the cursor will be positioned at the last line in the buffer. | |
| 4045 If {lnum} is zero, the cursor will stay in the current line. | |
| 493 | 4046 If {col} is greater than the number of bytes in the line, |
| 7 | 4047 the cursor will be positioned at the last character in the |
| 4048 line. | |
| 4049 If {col} is zero, the cursor will stay in the current column. | |
| 5944 | 4050 If {curswant} is given it is used to set the preferred column |
| 6180 | 4051 for vertical movement. Otherwise {col} is used. |
| 6385 | 4052 |
| 703 | 4053 When 'virtualedit' is used {off} specifies the offset in |
| 4054 screen columns from the start of the character. E.g., a | |
| 1266 | 4055 position within a <Tab> or after the last character. |
| 1851 | 4056 Returns 0 when the position could be set, -1 otherwise. |
| 7 | 4057 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4058 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4059 GetCursorPos()->cursor() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4060 |
|
14147
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
4061 debugbreak({pid}) *debugbreak()* |
|
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
4062 Specifically used to interrupt a program being debugged. It |
|
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
4063 will cause process {pid} to get a SIGTRAP. Behavior for other |
|
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
4064 processes is undefined. See |terminal-debugger|. |
|
de75c249723d
patch 8.1.0091: MS-Windows: Cannot interrupt gdb when program is running
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
4065 {only available on MS-Windows} |
| 55 | 4066 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4067 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4068 GetPid()->debugbreak() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4069 |
| 12785 | 4070 deepcopy({expr} [, {noref}]) *deepcopy()* *E698* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4071 Make a copy of {expr}. For Numbers and Strings this isn't |
| 55 | 4072 different from using {expr} directly. |
| 685 | 4073 When {expr} is a |List| a full copy is created. This means |
| 4074 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
|
4075 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
|
4076 |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
|
4077 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
|
4078 the original |List|. |
|
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
4079 A |Dictionary| is copied in a similar way as a |List|. |
| 21250 | 4080 |
| 685 | 4081 When {noref} is omitted or zero a contained |List| or |
| 4082 |Dictionary| is only copied once. All references point to | |
| 4083 this single copy. With {noref} set to 1 every occurrence of a | |
| 4084 |List| or |Dictionary| results in a new copy. This also means | |
| 4085 that a cyclic reference causes deepcopy() to fail. | |
| 114 | 4086 *E724* |
| 4087 Nesting is possible up to 100 levels. When there is an item | |
| 164 | 4088 that refers back to a higher level making a deep copy with |
| 4089 {noref} set to 1 will fail. | |
| 55 | 4090 Also see |copy()|. |
| 4091 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4092 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4093 GetObject()->deepcopy() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4094 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
4095 delete({fname} [, {flags}]) *delete()* |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
4096 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
|
4097 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
|
4098 |
|
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
4099 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
|
4100 {fname}. This fails when directory {fname} is not empty. |
| 12785 | 4101 |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
4102 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
|
4103 {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
|
4104 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
|
4105 that is being used. |
|
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
10000
diff
changeset
|
4106 |
|
7629
befbed72da87
commit https://github.com/vim/vim/commit/43a34f9f74fdce462fa250baab620264c28b6165
Christian Brabandt <cb@256bit.org>
parents:
7615
diff
changeset
|
4107 A symbolic link itself is deleted, not what it points to. |
| 12785 | 4108 |
| 23666 | 4109 The result is a Number, which is 0/false if the delete |
| 4110 operation was successful and -1/true when the deletion failed | |
| 4111 or partly failed. | |
|
7615
228ff048db20
commit https://github.com/vim/vim/commit/da440d21a6b94d7f525fa7be9b1417c78dd9aa4c
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
4112 |
| 685 | 4113 Use |remove()| to delete an item from a |List|. |
|
14043
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4114 To delete a line from the buffer use |:delete| or |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4115 |deletebufline()|. |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4116 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4117 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4118 GetName()->delete() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4119 |
| 14519 | 4120 deletebufline({expr}, {first} [, {last}]) *deletebufline()* |
|
14043
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4121 Delete lines {first} to {last} (inclusive) from buffer {expr}. |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4122 If {last} is omitted then delete line {first} only. |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4123 On success 0 is returned, on failure 1 is returned. |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4124 |
| 18343 | 4125 This function works only for loaded buffers. First call |
| 4126 |bufload()| if needed. | |
| 4127 | |
|
14043
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4128 For the use of {expr}, see |bufname()| above. |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4129 |
| 14864 | 4130 {first} and {last} are used like with |getline()|. Note that |
|
14043
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4131 when using |line()| this refers to the current buffer. Use "$" |
|
cbad3b3f46b2
patch 8.1.0039: cannot easily delete lines in another buffer
Christian Brabandt <cb@256bit.org>
parents:
14039
diff
changeset
|
4132 to refer to the last line in buffer {expr}. |
| 7 | 4133 |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4134 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4135 GetBuffer()->deletebufline(1) |
| 18343 | 4136 < |
| 7 | 4137 *did_filetype()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4138 did_filetype() Returns |TRUE| when autocommands are being executed and the |
| 7 | 4139 FileType event has been triggered at least once. Can be used |
| 4140 to avoid triggering the FileType event again in the scripts | |
| 4141 that detect the file type. |FileType| | |
| 11473 | 4142 Returns |FALSE| when `:setf FALLBACK` was used. |
| 7 | 4143 When editing another file, the counter is reset, thus this |
| 4144 really checks if the FileType event has been triggered for the | |
| 4145 current buffer. This allows an autocommand that starts | |
| 4146 editing another buffer to set 'filetype' and load a syntax | |
| 4147 file. | |
| 4148 | |
| 32 | 4149 diff_filler({lnum}) *diff_filler()* |
| 4150 Returns the number of filler lines above line {lnum}. | |
| 4151 These are the lines that were inserted at this point in | |
| 4152 another diff'ed window. These filler lines are shown in the | |
| 4153 display but don't exist in the buffer. | |
| 4154 {lnum} is used like with |getline()|. Thus "." is the current | |
| 4155 line, "'m" mark m, etc. | |
| 4156 Returns 0 if the current window is not in diff mode. | |
| 4157 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4158 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4159 GetLnum()->diff_filler() |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4160 |
| 32 | 4161 diff_hlID({lnum}, {col}) *diff_hlID()* |
| 4162 Returns the highlight ID for diff mode at line {lnum} column | |
| 4163 {col} (byte index). When the current line does not have a | |
| 4164 diff change zero is returned. | |
| 4165 {lnum} is used like with |getline()|. Thus "." is the current | |
| 4166 line, "'m" mark m, etc. | |
| 4167 {col} is 1 for the leftmost column, {lnum} is 1 for the first | |
| 4168 line. | |
| 4169 The highlight ID can be used with |synIDattr()| to obtain | |
| 4170 syntax information about the highlighting. | |
| 4171 | |
|
17837
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4172 Can also be used as a |method|: > |
|
f71ee7b04f0b
patch 8.1.1915: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17833
diff
changeset
|
4173 GetLnum()->diff_hlID(col) |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
4174 |
|
19400
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4175 |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4176 echoraw({expr}) *echoraw()* |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4177 Output {expr} as-is, including unprintable characters. This |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4178 can be used to output a terminal code. For example, to disable |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4179 modifyOtherKeys: > |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4180 call echoraw(&t_TE) |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4181 < and to enable it again: > |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4182 call echoraw(&t_TI) |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4183 < Use with care, you can mess up the terminal this way. |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4184 |
|
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
4185 |
| 85 | 4186 empty({expr}) *empty()* |
| 4187 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
|
4188 - 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
|
4189 items. |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4190 - A |String| is empty when its length is zero. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4191 - A |Number| and |Float| are empty when their value is zero. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4192 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not. |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4193 - A |Job| is empty when it failed to start. |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
4194 - A |Channel| is empty when it is closed. |
| 15512 | 4195 - A |Blob| is empty when its length is zero. |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
4196 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
4197 For a long |List| this is much faster than comparing the |
| 685 | 4198 length with zero. |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4199 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4200 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4201 mylist->empty() |
| 85 | 4202 |
| 19099 | 4203 environ() *environ()* |
| 4204 Return all of environment variables as dictionary. You can | |
| 4205 check if an environment variable exists like this: > | |
| 4206 :echo has_key(environ(), 'HOME') | |
| 4207 < Note that the variable name may be CamelCase; to ignore case | |
| 4208 use this: > | |
| 4209 :echo index(keys(environ()), 'HOME', 0, 1) != -1 | |
| 4210 | |
| 7 | 4211 escape({string}, {chars}) *escape()* |
| 4212 Escape the characters in {chars} that occur in {string} with a | |
| 4213 backslash. Example: > | |
| 4214 :echo escape('c:\program files\vim', ' \') | |
| 4215 < results in: > | |
| 4216 c:\\program\ files\\vim | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
4217 < Also see |shellescape()| and |fnameescape()|. |
| 1621 | 4218 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4219 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4220 GetText()->escape(' \') |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4221 < |
| 1621 | 4222 *eval()* |
| 95 | 4223 eval({string}) Evaluate {string} and return the result. Especially useful to |
| 4224 turn the result of |string()| back into the original value. | |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4225 This works for Numbers, Floats, Strings, Blobs and composites |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
4226 of them. Also works for |Funcref|s that refer to existing |
| 1621 | 4227 functions. |
| 95 | 4228 |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4229 Can also be used as a |method|: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4230 argv->join()->eval() |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4231 |
| 7 | 4232 eventhandler() *eventhandler()* |
| 4233 Returns 1 when inside an event handler. That is that Vim got | |
| 4234 interrupted while waiting for the user to type a character, | |
| 4235 e.g., when dropping a file on Vim. This means interactive | |
| 4236 commands cannot be used. Otherwise zero is returned. | |
| 4237 | |
| 4238 executable({expr}) *executable()* | |
| 4239 This function checks if an executable with the name {expr} | |
| 4240 exists. {expr} must be the name of the program without any | |
| 10 | 4241 arguments. |
| 4242 executable() uses the value of $PATH and/or the normal | |
| 4243 searchpath for programs. *PATHEXT* | |
| 18972 | 4244 On MS-Windows the ".exe", ".bat", etc. can optionally be |
| 4245 included. Then the extensions in $PATHEXT are tried. Thus if | |
| 4246 "foo.exe" does not exist, "foo.exe.bat" can be found. If | |
|
20593
89b0f161e6a6
patch 8.2.0850: MS-Windows: exepath() works different from cmd.exe
Bram Moolenaar <Bram@vim.org>
parents:
20552
diff
changeset
|
4247 $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot |
| 18972 | 4248 by itself can be used in $PATHEXT to try using the name |
| 4249 without an extension. When 'shell' looks like a Unix shell, | |
| 4250 then the name is also tried without adding an extension. | |
| 4251 On MS-Windows it only checks if the file exists and is not a | |
| 4252 directory, not if it's really executable. | |
| 819 | 4253 On MS-Windows an executable in the same directory as Vim is |
| 4254 always found. Since this directory is added to $PATH it | |
| 4255 should also work to execute it |win32-PATH|. | |
| 7 | 4256 The result is a Number: |
| 4257 1 exists | |
| 4258 0 does not exist | |
| 4259 -1 not implemented on this system | |
|
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14193
diff
changeset
|
4260 |exepath()| can be used to get the full path of an executable. |
| 7 | 4261 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4262 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4263 GetCommand()->executable() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4264 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4265 execute({command} [, {silent}]) *execute()* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4266 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
|
4267 string. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4268 {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
|
4269 lines are executed one by one. |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4270 This is equivalent to: > |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4271 redir => var |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4272 {command} |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4273 redir END |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4274 < |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4275 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
|
4276 "" no `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4277 "silent" `:silent` used |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4278 "silent!" `:silent!` used |
| 11062 | 4279 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
|
4280 `: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
|
4281 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
|
4282 *E930* |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4283 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
|
4284 |
|
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4285 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
|
4286 split(execute('args'), "\n") |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4287 |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4288 < To execute a command in another window than the current one |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4289 use `win_execute()`. |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4290 |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
4291 When used recursively the output of the recursive call is not |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
4292 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
|
4293 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4294 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4295 GetCommand()->execute() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4296 |
| 5782 | 4297 exepath({expr}) *exepath()* |
| 4298 If {expr} is an executable and is either an absolute path, a | |
| 4299 relative path or found in $PATH, return the full path. | |
| 4300 Note that the current directory is used when {expr} starts | |
| 4301 with "./", which may be a problem for Vim: > | |
| 4302 echo exepath(v:progpath) | |
| 5814 | 4303 < If {expr} cannot be found in $PATH or is not executable then |
| 5782 | 4304 an empty string is returned. |
| 4305 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4306 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4307 GetCommand()->exepath() |
| 18343 | 4308 < |
| 7 | 4309 *exists()* |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4310 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
|
4311 zero otherwise. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4312 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4313 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
|
4314 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
|
4315 |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
4316 The {expr} argument is a string, which contains one of these: |
| 7 | 4317 &option-name Vim option (only checks if it exists, |
| 4318 not if it really works) | |
| 4319 +option-name Vim option that works. | |
| 4320 $ENVNAME environment variable (could also be | |
| 4321 done by comparing with an empty | |
| 4322 string) | |
| 4323 *funcname built-in function (see |functions|) | |
| 4324 or user defined function (see | |
|
19805
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4325 |user-functions|) that is implemented. |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4326 Also works for a variable that is a |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4327 Funcref. |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4328 ?funcname built-in function that could be |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4329 implemented; to be used to check if |
|
2dc5e6ddeb4c
patch 8.2.0459: cannot check if a function name is correct
Bram Moolenaar <Bram@vim.org>
parents:
19783
diff
changeset
|
4330 "funcname" is valid |
| 7 | 4331 varname internal variable (see |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4332 |internal-variables|). Also works |
| 685 | 4333 for |curly-braces-names|, |Dictionary| |
| 4334 entries, |List| items, etc. Beware | |
| 1668 | 4335 that evaluating an index may cause an |
| 4336 error message for an invalid | |
| 4337 expression. E.g.: > | |
| 4338 :let l = [1, 2, 3] | |
| 4339 :echo exists("l[5]") | |
| 4340 < 0 > | |
| 4341 :echo exists("l[xx]") | |
| 4342 < E121: Undefined variable: xx | |
| 4343 0 | |
| 7 | 4344 :cmdname Ex command: built-in command, user |
| 4345 command or command modifier |:command|. | |
| 4346 Returns: | |
| 4347 1 for match with start of a command | |
| 4348 2 full match with a command | |
| 4349 3 matches several user commands | |
| 4350 To check for a supported command | |
| 4351 always check the return value to be 2. | |
| 864 | 4352 :2match The |:2match| command. |
| 4353 :3match The |:3match| command. | |
| 7 | 4354 #event autocommand defined for this event |
| 4355 #event#pattern autocommand defined for this event and | |
| 4356 pattern (the pattern is taken | |
| 4357 literally and compared to the | |
| 4358 autocommand patterns character by | |
| 4359 character) | |
| 613 | 4360 #group autocommand group exists |
| 4361 #group#event autocommand defined for this group and | |
| 4362 event. | |
| 4363 #group#event#pattern | |
| 856 | 4364 autocommand defined for this group, |
| 613 | 4365 event and pattern. |
| 615 | 4366 ##event autocommand for this event is |
| 4367 supported. | |
| 7 | 4368 |
| 4369 Examples: > | |
| 4370 exists("&shortname") | |
| 4371 exists("$HOSTNAME") | |
| 4372 exists("*strftime") | |
| 4373 exists("*s:MyFunc") | |
| 4374 exists("bufcount") | |
| 4375 exists(":Make") | |
| 613 | 4376 exists("#CursorHold") |
| 7 | 4377 exists("#BufReadPre#*.gz") |
| 613 | 4378 exists("#filetypeindent") |
| 4379 exists("#filetypeindent#FileType") | |
| 4380 exists("#filetypeindent#FileType#*") | |
| 615 | 4381 exists("##ColorScheme") |
| 7 | 4382 < There must be no space between the symbol (&/$/*/#) and the |
| 4383 name. | |
| 867 | 4384 There must be no extra characters after the name, although in |
| 4385 a few cases this is ignored. That may become more strict in | |
| 4386 the future, thus don't count on it! | |
| 4387 Working example: > | |
| 4388 exists(":make") | |
| 4389 < NOT working example: > | |
| 4390 exists(":make install") | |
| 859 | 4391 |
| 4392 < Note that the argument must be a string, not the name of the | |
| 4393 variable itself. For example: > | |
| 7 | 4394 exists(bufcount) |
| 4395 < This doesn't check for existence of the "bufcount" variable, | |
| 853 | 4396 but gets the value of "bufcount", and checks if that exists. |
| 7 | 4397 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4398 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4399 Varname()->exists() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4400 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4401 exp({expr}) *exp()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4402 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
|
4403 [0, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
4404 {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
|
4405 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4406 :echo exp(2) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4407 < 7.389056 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4408 :echo exp(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4409 < 0.367879 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4410 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4411 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4412 Compute()->exp() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4413 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4414 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4415 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4416 |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4417 expand({expr} [, {nosuf} [, {list}]]) *expand()* |
| 7 | 4418 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
|
4419 'wildignorecase' applies. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
4420 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4421 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
|
4422 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
|
4423 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
|
4424 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
|
4425 file name contains a space] |
| 7 | 4426 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4427 If the expansion fails, the result is an empty string. A name |
| 4869 | 4428 for a non-existing file is not included, unless {expr} does |
| 4429 not start with '%', '#' or '<', see below. | |
| 7 | 4430 |
| 4431 When {expr} starts with '%', '#' or '<', the expansion is done | |
| 4432 like for the |cmdline-special| variables with their associated | |
| 4433 modifiers. Here is a short overview: | |
| 4434 | |
| 4435 % current file name | |
| 4436 # alternate file name | |
| 4437 #n alternate file name n | |
| 4438 <cfile> file name under the cursor | |
| 4439 <afile> autocmd file name | |
| 4440 <abuf> autocmd buffer number (as a String!) | |
| 4441 <amatch> autocmd matched name | |
| 22328 | 4442 <cexpr> C expression under the cursor |
| 5734 | 4443 <sfile> sourced script file or function name |
|
14700
0a3b9ecf7cb8
patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
4444 <slnum> sourced script line number or function |
|
0a3b9ecf7cb8
patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
4445 line number |
|
0a3b9ecf7cb8
patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
4446 <sflnum> script file line number, also when in |
|
0a3b9ecf7cb8
patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
4447 a function |
|
21608
24cb89db078d
patch 8.2.1354: test 59 is old style
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
4448 <SID> "<SNR>123_" where "123" is the |
|
24cb89db078d
patch 8.2.1354: test 59 is old style
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
4449 current script ID |<SID>| |
| 22328 | 4450 <stack> call stack |
| 7 | 4451 <cword> word under the cursor |
| 4452 <cWORD> WORD under the cursor | |
| 4453 <client> the {clientid} of the last received | |
| 4454 message |server2client()| | |
| 4455 Modifiers: | |
| 4456 :p expand to full path | |
| 4457 :h head (last path component removed) | |
| 4458 :t tail (last path component only) | |
| 4459 :r root (one extension removed) | |
| 4460 :e extension only | |
| 4461 | |
| 4462 Example: > | |
| 4463 :let &tags = expand("%:p:h") . "/tags" | |
| 4464 < Note that when expanding a string that starts with '%', '#' or | |
| 4465 '<', any following text is ignored. This does NOT work: > | |
| 4466 :let doesntwork = expand("%:h.bak") | |
| 4467 < Use this: > | |
| 4468 :let doeswork = expand("%:h") . ".bak" | |
| 4469 < Also note that expanding "<cfile>" and others only returns the | |
| 4470 referenced file name without further expansion. If "<cfile>" | |
| 4471 is "~/.cshrc", you need to do another expand() to have the | |
| 4472 "~/" expanded into the path of the home directory: > | |
| 4473 :echo expand(expand("<cfile>")) | |
| 4474 < | |
| 4475 There cannot be white space between the variables and the | |
| 4476 following modifier. The |fnamemodify()| function can be used | |
| 4477 to modify normal file names. | |
| 4478 | |
| 4479 When using '%' or '#', and the current or alternate file name | |
| 4480 is not defined, an empty string is used. Using "%:p" in a | |
| 4481 buffer with no name, results in the current directory, with a | |
| 4482 '/' added. | |
| 4483 | |
| 4484 When {expr} does not start with '%', '#' or '<', it is | |
| 4485 expanded like a file name is expanded on the command line. | |
| 4486 '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
|
4487 {nosuf} argument is given and it is |TRUE|. |
| 3398 | 4488 Names for non-existing files are included. The "**" item can |
| 4489 be used to search in a directory tree. For example, to find | |
| 4490 all "README" files in the current directory and below: > | |
| 444 | 4491 :echo expand("**/README") |
| 4492 < | |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
4493 expand() can also be used to expand variables and environment |
| 7 | 4494 variables that are only known in a shell. But this can be |
| 6180 | 4495 slow, because a shell may be used to do the expansion. See |
| 4496 |expr-env-expand|. | |
| 7 | 4497 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
|
4498 names. When an environment variable cannot be expanded, it is |
| 7 | 4499 left unchanged. Thus ":echo expand('$FOOBAR')" results in |
| 4500 "$FOOBAR". | |
| 4501 | |
| 4502 See |glob()| for finding existing files. See |system()| for | |
| 4503 getting the raw output of an external command. | |
| 4504 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4505 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4506 Getpattern()->expand() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4507 |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4508 expandcmd({expr}) *expandcmd()* |
|
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4509 Expand special items in {expr} like what is done for an Ex |
|
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4510 command such as `:edit`. This expands special keywords, like |
|
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4511 with |expand()|, and environment variables, anywhere in |
| 18456 | 4512 {expr}. "~user" and "~/path" are only expanded at the start. |
| 4513 Returns the expanded string. Example: > | |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4514 :echo expandcmd('make %<.o') |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4515 |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4516 < Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4517 GetCommand()->expandcmd() |
|
17020
1841c03a9b5e
patch 8.1.1510: a plugin cannot easily expand a command like done internally
Bram Moolenaar <Bram@vim.org>
parents:
17004
diff
changeset
|
4518 < |
| 102 | 4519 extend({expr1}, {expr2} [, {expr3}]) *extend()* |
| 692 | 4520 {expr1} and {expr2} must be both |Lists| or both |
| 4521 |Dictionaries|. | |
| 4522 | |
| 4523 If they are |Lists|: Append {expr2} to {expr1}. | |
| 22824 | 4524 If {expr3} is given insert the items of {expr2} before the |
| 4525 item with index {expr3} in {expr1}. When {expr3} is zero | |
| 4526 insert before the first item. When {expr3} is equal to | |
| 4527 len({expr1}) then {expr2} is appended. | |
| 79 | 4528 Examples: > |
| 4529 :echo sort(extend(mylist, [7, 5])) | |
| 4530 :call extend(mylist, [2, 3], 1) | |
| 1699 | 4531 < When {expr1} is the same List as {expr2} then the number of |
| 4532 items copied is equal to the original length of the List. | |
| 4533 E.g., when {expr3} is 1 you get N new copies of the first item | |
| 4534 (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
|
4535 Use |add()| to concatenate one item to a list. To concatenate |
| 82 | 4536 two lists into a new list use the + operator: > |
| 79 | 4537 :let newlist = [1, 2, 3] + [4, 5] |
| 102 | 4538 < |
| 692 | 4539 If they are |Dictionaries|: |
| 102 | 4540 Add all entries from {expr2} to {expr1}. |
| 4541 If a key exists in both {expr1} and {expr2} then {expr3} is | |
| 4542 used to decide what to do: | |
| 4543 {expr3} = "keep": keep the value of {expr1} | |
| 4544 {expr3} = "force": use the value of {expr2} | |
| 856 | 4545 {expr3} = "error": give an error message *E737* |
| 102 | 4546 When {expr3} is omitted then "force" is assumed. |
| 4547 | |
| 4548 {expr1} is changed when {expr2} is not empty. If necessary | |
| 4549 make a copy of {expr1} first. | |
| 4550 {expr2} remains unchanged. | |
| 6823 | 4551 When {expr1} is locked and {expr2} is not empty the operation |
| 4552 fails. | |
| 102 | 4553 Returns {expr1}. |
| 4554 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4555 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4556 mylist->extend(otherlist) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4557 |
| 79 | 4558 |
|
23588
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
4559 extendnew({expr1}, {expr2} [, {expr3}]) *extendnew()* |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
4560 Like |extend()| but instead of adding items to {expr1} a new |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
4561 List or Dictionary is created and returned. {expr1} remains |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
4562 unchanged. Items can still be changed by {expr2}, if you |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
4563 don't want that use |deepcopy()| first. |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
4564 |
|
510088f8c66f
patch 8.2.2336: Vim9: not possible to extend dictionary with different type
Bram Moolenaar <Bram@vim.org>
parents:
23563
diff
changeset
|
4565 |
| 842 | 4566 feedkeys({string} [, {mode}]) *feedkeys()* |
| 4567 Characters in {string} are queued for processing as if they | |
| 6549 | 4568 come from a mapping or were typed by the user. |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4569 |
| 6549 | 4570 By default the string is added to the end of the typeahead |
| 4571 buffer, thus if a mapping is still being executed the | |
| 4572 characters come after them. Use the 'i' flag to insert before | |
| 4573 other characters, they will be executed next, before any | |
| 4574 characters from a mapping. | |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4575 |
| 842 | 4576 The function does not wait for processing of keys contained in |
| 4577 {string}. | |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4578 |
| 842 | 4579 To include special keys into {string}, use double-quotes |
| 4580 and "\..." notation |expr-quote|. For example, | |
| 1215 | 4581 feedkeys("\<CR>") simulates pressing of the <Enter> key. But |
| 842 | 4582 feedkeys('\<CR>') pushes 5 characters. |
|
16600
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
4583 A special code that might be useful is <Ignore>, it exits the |
|
ff3c99bd1038
patch 8.1.1303: not possible to hide a balloon
Bram Moolenaar <Bram@vim.org>
parents:
16576
diff
changeset
|
4584 wait for a character without doing anything. *<Ignore>* |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4585 |
| 842 | 4586 {mode} is a String, which can contain these character flags: |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4587 'm' Remap keys. This is default. If {mode} is absent, |
|
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4588 keys are remapped. |
| 843 | 4589 'n' Do not remap keys. |
| 4590 't' Handle keys as if typed; otherwise they are handled as | |
| 4591 if coming from a mapping. This matters for undo, | |
| 4592 opening folds, etc. | |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
4593 'L' Lowlevel input. Only works for Unix or when using the |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
4594 GUI. Keys are used as if they were coming from the |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
4595 terminal. Other flags are not used. *E980* |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
4596 When a CTRL-C interrupts and 't' is included it sets |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
4597 the internal "got_int" flag. |
| 6549 | 4598 '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
|
4599 '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
|
4600 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
|
4601 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
|
4602 (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
|
4603 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
|
4604 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
|
4605 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
|
4606 script continues. |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
4607 Note that if you manage to call feedkeys() while |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
4608 executing commands, thus calling it recursively, then |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
4609 all typeahead will be consumed by the last call. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
4610 '!' 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
|
4611 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
|
4612 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
|
4613 |
| 842 | 4614 Return value is always 0. |
| 4615 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4616 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4617 GetInput()->feedkeys() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4618 |
| 7 | 4619 filereadable({file}) *filereadable()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
4620 The result is a Number, which is |TRUE| when a file with the |
| 7 | 4621 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
|
4622 or is a directory, the result is |FALSE|. {file} is any |
| 7 | 4623 expression, which is used as a String. |
| 1156 | 4624 If you don't care about the file being readable you can use |
| 4625 |glob()|. | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4626 {file} is used as-is, you may want to expand wildcards first: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4627 echo filereadable('~/.vimrc') |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4628 0 |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4629 echo filereadable(expand('~/.vimrc')) |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4630 1 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4631 |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4632 < Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4633 GetName()->filereadable() |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
4634 < *file_readable()* |
| 7 | 4635 Obsolete name: file_readable(). |
| 4636 | |
| 95 | 4637 |
| 1156 | 4638 filewritable({file}) *filewritable()* |
| 4639 The result is a Number, which is 1 when a file with the | |
| 4640 name {file} exists, and can be written. If {file} doesn't | |
| 1621 | 4641 exist, or is not writable, the result is 0. If {file} is a |
| 1156 | 4642 directory, and we can write to it, the result is 2. |
| 4643 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4644 Can also be used as a |method|: > |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
4645 GetName()->filewritable() |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4646 |
| 1156 | 4647 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4648 filter({expr1}, {expr2}) *filter()* |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4649 {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
|
4650 For each item in {expr1} evaluate {expr2} and when the result |
| 685 | 4651 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
|
4652 {expr2} must be a |string| or |Funcref|. |
| 12785 | 4653 |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
4654 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
|
4655 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
|
4656 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
|
4657 the current item. |
| 102 | 4658 Examples: > |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4659 call filter(mylist, 'v:val !~ "OLD"') |
| 102 | 4660 < 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
|
4661 call filter(mydict, 'v:key >= 8') |
| 102 | 4662 < 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
|
4663 call filter(var, 0) |
| 685 | 4664 < Removes all the items, thus clears the |List| or |Dictionary|. |
| 99 | 4665 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4666 Note that {expr2} is the result of expression and is then |
| 102 | 4667 used as an expression again. Often it is good to use a |
| 4668 |literal-string| to avoid having to double backslashes. | |
| 4669 | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4670 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
|
4671 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
|
4672 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
|
4673 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
|
4674 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
|
4675 func Odd(idx, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4676 return a:idx % 2 == 1 |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4677 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4678 call filter(mylist, function('Odd')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
4679 < 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
|
4680 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
|
4681 < 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
|
4682 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
|
4683 < |
| 685 | 4684 The operation is done in-place. If you want a |List| or |
| 4685 |Dictionary| to remain unmodified make a copy first: > | |
| 650 | 4686 :let l = filter(copy(mylist), 'v:val =~ "KEEP"') |
| 102 | 4687 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
4688 < 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
|
4689 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
|
4690 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
|
4691 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
|
4692 defined with the "abort" flag. |
| 95 | 4693 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4694 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
4695 mylist->filter(expr2) |
| 95 | 4696 |
| 12785 | 4697 finddir({name} [, {path} [, {count}]]) *finddir()* |
| 1095 | 4698 Find directory {name} in {path}. Supports both downwards and |
| 4699 upwards recursive directory searches. See |file-searching| | |
| 4700 for the syntax of {path}. | |
| 4701 Returns the path of the first found match. When the found | |
| 4702 directory is below the current directory a relative path is | |
| 4703 returned. Otherwise a full path is returned. | |
| 19 | 4704 If {path} is omitted or empty then 'path' is used. |
| 4705 If the optional {count} is given, find {count}'s occurrence of | |
| 794 | 4706 {name} in {path} instead of the first one. |
| 809 | 4707 When {count} is negative return all the matches in a |List|. |
| 19 | 4708 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
|
4709 {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
|
4710 feature} |
| 794 | 4711 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4712 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4713 GetName()->finddir() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4714 |
| 12785 | 4715 findfile({name} [, {path} [, {count}]]) *findfile()* |
| 794 | 4716 Just like |finddir()|, but find a file instead of a directory. |
| 4717 Uses 'suffixesadd'. | |
| 19 | 4718 Example: > |
| 4719 :echo findfile("tags.vim", ".;") | |
| 1156 | 4720 < Searches from the directory of the current file upwards until |
| 4721 it finds the file "tags.vim". | |
| 7 | 4722 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4723 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4724 GetName()->findfile() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4725 |
|
20766
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4726 flatten({list} [, {maxdepth}]) *flatten()* |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4727 Flatten {list} up to {maxdepth} levels. Without {maxdepth} |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4728 the result is a |List| without nesting, as if {maxdepth} is |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4729 a very large number. |
|
23816
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
4730 The {list} is changed in place, use |flattennew()| if you do |
|
20766
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4731 not want that. |
|
23816
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
4732 In Vim9 script flatten() cannot be used, you must always use |
|
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
4733 |flattennew()|. |
| 20965 | 4734 *E900* |
|
20766
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4735 {maxdepth} means how deep in nested lists changes are made. |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4736 {list} is not modified when {maxdepth} is 0. |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4737 {maxdepth} must be positive number. |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4738 |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4739 If there is an error the number zero is returned. |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4740 |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4741 Example: > |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4742 :echo flatten([1, [2, [3, 4]], 5]) |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4743 < [1, 2, 3, 4, 5] > |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4744 :echo flatten([1, [2, [3, 4]], 5], 1) |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4745 < [1, 2, [3, 4], 5] |
|
821925509d8c
patch 8.2.0935: flattening a list with existing code is slow
Bram Moolenaar <Bram@vim.org>
parents:
20753
diff
changeset
|
4746 |
|
23816
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
4747 flattennew({list} [, {maxdepth}]) *flattennew()* |
|
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
4748 Like |flatten()| but first make a copy of {list}. |
|
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
4749 |
|
525c9e218c69
patch 8.2.2449: Vim9: flatten() always changes the list type
Bram Moolenaar <Bram@vim.org>
parents:
23788
diff
changeset
|
4750 |
| 1621 | 4751 float2nr({expr}) *float2nr()* |
| 4752 Convert {expr} to a Number by omitting the part after the | |
| 4753 decimal point. | |
| 4754 {expr} must evaluate to a |Float| or a Number. | |
| 4755 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
|
4756 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
|
4757 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
|
4758 -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
|
4759 64-bit Number support is enabled, -0x8000000000000000). |
| 1621 | 4760 Examples: > |
| 4761 echo float2nr(3.95) | |
| 4762 < 3 > | |
| 4763 echo float2nr(-23.45) | |
| 4764 < -23 > | |
| 4765 echo float2nr(1.0e100) | |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
4766 < 2147483647 (or 9223372036854775807) > |
| 1621 | 4767 echo float2nr(-1.0e150) |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
4768 < -2147483647 (or -9223372036854775807) > |
| 1621 | 4769 echo float2nr(1.0e-100) |
| 4770 < 0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4771 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4772 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4773 Compute()->float2nr() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4774 < |
| 1621 | 4775 {only available when compiled with the |+float| feature} |
| 4776 | |
| 4777 | |
| 4778 floor({expr}) *floor()* | |
| 4779 Return the largest integral value less than or equal to | |
| 4780 {expr} as a |Float| (round down). | |
| 4781 {expr} must evaluate to a |Float| or a |Number|. | |
| 4782 Examples: > | |
| 4783 echo floor(1.856) | |
| 4784 < 1.0 > | |
| 4785 echo floor(-5.456) | |
| 4786 < -6.0 > | |
| 4787 echo floor(4.0) | |
| 4788 < 4.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4789 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4790 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4791 Compute()->floor() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4792 < |
| 1621 | 4793 {only available when compiled with the |+float| feature} |
| 12785 | 4794 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4795 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4796 fmod({expr1}, {expr2}) *fmod()* |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4797 Return the remainder of {expr1} / {expr2}, even if the |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4798 division is not representable. Returns {expr1} - i * {expr2} |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4799 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
|
4800 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
|
4801 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
|
4802 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
|
4803 {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
|
4804 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4805 :echo fmod(12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4806 < 0.13 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4807 :echo fmod(-12.33, 1.22) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4808 < -0.13 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4809 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4810 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4811 Compute()->fmod(1.22) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
4812 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
4813 {only available when compiled with |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4814 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
4815 |
| 1586 | 4816 fnameescape({string}) *fnameescape()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4817 Escape {string} for use as file name command argument. All |
| 1586 | 4818 characters that have a special meaning, such as '%' and '|' |
| 4819 are escaped with a backslash. | |
| 1621 | 4820 For most systems the characters escaped are |
| 4821 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash | |
| 4822 appears in a filename, it depends on the value of 'isfname'. | |
| 1700 | 4823 A leading '+' and '>' is also escaped (special after |:edit| |
| 4824 and |:write|). And a "-" by itself (special after |:cd|). | |
| 1586 | 4825 Example: > |
| 1700 | 4826 :let fname = '+some str%nge|name' |
| 1586 | 4827 :exe "edit " . fnameescape(fname) |
| 4828 < results in executing: > | |
| 1700 | 4829 edit \+some\ str\%nge\|name |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4830 < |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4831 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4832 GetName()->fnameescape() |
| 1586 | 4833 |
| 7 | 4834 fnamemodify({fname}, {mods}) *fnamemodify()* |
| 4835 Modify file name {fname} according to {mods}. {mods} is a | |
| 4836 string of characters like it is used for file names on the | |
| 4837 command line. See |filename-modifiers|. | |
| 4838 Example: > | |
| 4839 :echo fnamemodify("main.c", ":p:h") | |
| 4840 < results in: > | |
| 4841 /home/mool/vim/vim/src | |
| 23305 | 4842 < If {mods} is empty then {fname} is returned. |
| 4843 Note: Environment variables don't work in {fname}, use | |
| 7 | 4844 |expand()| first then. |
| 4845 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4846 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4847 GetName()->fnamemodify(':p:h') |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4848 |
| 7 | 4849 foldclosed({lnum}) *foldclosed()* |
| 4850 The result is a Number. If the line {lnum} is in a closed | |
| 4851 fold, the result is the number of the first line in that fold. | |
| 4852 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4853 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4854 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4855 GetLnum()->foldclosed() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4856 |
| 7 | 4857 foldclosedend({lnum}) *foldclosedend()* |
| 4858 The result is a Number. If the line {lnum} is in a closed | |
| 4859 fold, the result is the number of the last line in that fold. | |
| 4860 If the line {lnum} is not in a closed fold, -1 is returned. | |
| 4861 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4862 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4863 GetLnum()->foldclosedend() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4864 |
| 7 | 4865 foldlevel({lnum}) *foldlevel()* |
| 4866 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
|
4867 in the current buffer. For nested folds the deepest level is |
| 7 | 4868 returned. If there is no fold at line {lnum}, zero is |
| 4869 returned. It doesn't matter if the folds are open or closed. | |
| 4870 When used while updating folds (from 'foldexpr') -1 is | |
| 4871 returned for lines where folds are still to be updated and the | |
| 4872 foldlevel is unknown. As a special case the level of the | |
| 4873 previous line is usually available. | |
| 4874 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4875 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4876 GetLnum()->foldlevel() |
| 18343 | 4877 < |
| 7 | 4878 *foldtext()* |
| 4879 foldtext() Returns a String, to be displayed for a closed fold. This is | |
| 4880 the default function used for the 'foldtext' option and should | |
| 4881 only be called from evaluating 'foldtext'. It uses the | |
| 4882 |v:foldstart|, |v:foldend| and |v:folddashes| variables. | |
| 4883 The returned string looks like this: > | |
| 4884 +-- 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
|
4885 < 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
|
4886 "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
|
4887 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
|
4888 "//" 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
|
4889 '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
|
4890 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
|
4891 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
|
4892 setting. |
| 7 | 4893 {not available when compiled without the |+folding| feature} |
| 4894 | |
| 29 | 4895 foldtextresult({lnum}) *foldtextresult()* |
| 4896 Returns the text that is displayed for the closed fold at line | |
| 4897 {lnum}. Evaluates 'foldtext' in the appropriate context. | |
| 4898 When there is no closed fold at {lnum} an empty string is | |
| 4899 returned. | |
| 4900 {lnum} is used like with |getline()|. Thus "." is the current | |
| 4901 line, "'m" mark m, etc. | |
| 4902 Useful when exporting folded text, e.g., to HTML. | |
| 4903 {not available when compiled without the |+folding| feature} | |
| 4904 | |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4905 |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4906 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4907 GetLnum()->foldtextresult() |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4908 < |
| 7 | 4909 *foreground()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
4910 foreground() Move the Vim window to the foreground. Useful when sent from |
| 7 | 4911 a client to a Vim server. |remote_send()| |
| 4912 On Win32 systems this might not work, the OS does not always | |
| 4913 allow a window to bring itself to the foreground. Use | |
| 4914 |remote_foreground()| instead. | |
| 4915 {only in the Win32, Athena, Motif and GTK GUI versions and the | |
| 4916 Win32 console version} | |
| 4917 | |
|
23853
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4918 fullcommand({name}) *fullcommand()* |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4919 Get the full command name from a short abbreviated command |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4920 name; see |20.2| for details on command abbreviations. |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4921 |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4922 {name} may start with a `:` and can include a [range], these |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4923 are skipped and not returned. |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4924 Returns an empty string if a command doesn't exist or if it's |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4925 ambiguous (for user-defined functions). |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4926 |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4927 For example `fullcommand('s')`, `fullcommand('sub')`, |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4928 `fullcommand(':%substitute')` all return "substitute". |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4929 |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4930 Can also be used as a |method|: > |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4931 GetName()->fullcommand() |
|
a9ed31ab85c3
patch 8.2.2468: not easy to get the full command name from a shortened one
Bram Moolenaar <Bram@vim.org>
parents:
23816
diff
changeset
|
4932 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4933 *funcref()* |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4934 funcref({name} [, {arglist}] [, {dict}]) |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4935 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
|
4936 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
|
4937 function {name} is redefined later. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4938 |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4939 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
|
4940 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
|
4941 function. |
| 82 | 4942 |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4943 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4944 GetFuncname()->funcref([arg]) |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
4945 < |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4946 *function()* *E700* *E922* *E923* |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4947 function({name} [, {arglist}] [, {dict}]) |
| 685 | 4948 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
|
4949 {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
|
4950 internal function. |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4951 |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4952 {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
|
4953 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
|
4954 argument is not allowed. E.g.: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4955 let FuncWithArg = function(dict.Func, [arg]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
4956 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
|
4957 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4958 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
|
4959 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
|
4960 same function. |
|
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
4961 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4962 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
|
4963 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
|
4964 the Funcref and will be used when the Funcref is called. |
| 12785 | 4965 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4966 The arguments are passed to the function in front of other |
| 17667 | 4967 arguments, but after any argument from |method|. Example: > |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4968 func Callback(arg1, arg2, name) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4969 ... |
| 17667 | 4970 let Partial = function('Callback', ['one', 'two']) |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4971 ... |
| 17667 | 4972 call Partial('name') |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4973 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4974 call Callback('one', 'two', 'name') |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4975 |
| 17667 | 4976 < With a |method|: > |
| 4977 func Callback(one, two, three) | |
| 4978 ... | |
| 4979 let Partial = function('Callback', ['two']) | |
| 4980 ... | |
| 4981 eval 'one'->Partial('three') | |
| 4982 < Invokes the function as with: > | |
| 4983 call Callback('one', 'two', 'three') | |
| 4984 | |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4985 < 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
|
4986 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
|
4987 arguments. Example: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4988 func Callback(arg1, arg2, name) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4989 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4990 let Func = function('Callback', ['one']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4991 let Func2 = function(Func, ['two']) |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4992 ... |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4993 call Func2('name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4994 < Invokes the function as with: > |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4995 call Callback('one', 'two', 'name') |
|
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
4996 |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
4997 < 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
|
4998 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
|
4999 function Callback() dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5000 echo "called for " . self.name |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5001 endfunction |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5002 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5003 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5004 let Func = function('Callback', context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5005 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5006 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
|
5007 < 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
|
5008 arguments, these two are equivalent: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5009 let Func = function('Callback', context) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
5010 let Func = context.Callback |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5011 |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5012 < 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
|
5013 function Callback(arg1, count) dict |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5014 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5015 let context = {"name": "example"} |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5016 let Func = function('Callback', ['one'], context) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5017 ... |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5018 call Func(500) |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5019 < Invokes the function as with: > |
|
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5020 call context.Callback('one', 500) |
|
17849
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
5021 < |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
5022 Can also be used as a |method|: > |
|
73ddc462979d
patch 8.1.1921: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17837
diff
changeset
|
5023 GetFuncname()->function([arg]) |
|
8538
c337c813c64d
commit https://github.com/vim/vim/commit/1735bc988c546cc962c5f94792815b4d7cb79710
Christian Brabandt <cb@256bit.org>
parents:
8536
diff
changeset
|
5024 |
| 82 | 5025 |
| 3224 | 5026 garbagecollect([{atexit}]) *garbagecollect()* |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5027 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
|
5028 that have circular references. |
| 12785 | 5029 |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5030 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
|
5031 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
|
5032 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
|
5033 circular references are always freed when they become unused. |
| 685 | 5034 This is useful if you have deleted a very big |List| and/or |
| 5035 |Dictionary| with circular references in a script that runs | |
| 5036 for a long time. | |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5037 |
| 3224 | 5038 When the optional {atexit} argument is one, garbage |
| 1405 | 5039 collection will also be done when exiting Vim, if it wasn't |
| 5040 done before. This is useful when checking for memory leaks. | |
| 370 | 5041 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
5042 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
|
5043 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
|
5044 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
|
5045 |test_garbagecollect_now()|. |
|
8881
ed0b39dd7fd6
commit https://github.com/vim/vim/commit/ebf7dfa6f121c82f97d2adca3d45fbaba9ad8f7e
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5046 |
| 140 | 5047 get({list}, {idx} [, {default}]) *get()* |
| 685 | 5048 Get item {idx} from |List| {list}. When this item is not |
| 82 | 5049 available return {default}. Return zero when {default} is |
| 5050 omitted. | |
| 21250 | 5051 Preferably used as a |method|: > |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
5052 mylist->get(idx) |
|
15498
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
5053 get({blob}, {idx} [, {default}]) |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
5054 Get byte {idx} from |Blob| {blob}. When this byte is not |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
5055 available return {default}. Return -1 when {default} is |
|
e1de20a47fa9
patch 8.1.0757: not enough documentation for Blobs
Bram Moolenaar <Bram@vim.org>
parents:
15456
diff
changeset
|
5056 omitted. |
| 21250 | 5057 Preferably used as a |method|: > |
| 5058 myblob->get(idx) | |
| 102 | 5059 get({dict}, {key} [, {default}]) |
| 685 | 5060 Get item with key {key} from |Dictionary| {dict}. When this |
| 102 | 5061 item is not available return {default}. Return zero when |
| 17571 | 5062 {default} is omitted. Useful example: > |
| 5063 let val = get(g:, 'var_name', 'default') | |
| 5064 < This gets the value of g:var_name if it exists, and uses | |
| 5065 'default' when it does not exist. | |
| 21250 | 5066 Preferably used as a |method|: > |
| 5067 mydict->get(key) | |
|
9117
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
5068 get({func}, {what}) |
|
0cc48b3cd884
commit https://github.com/vim/vim/commit/03e19a04ac2ca55643663b97b6ab94043233dcbd
Christian Brabandt <cb@256bit.org>
parents:
9110
diff
changeset
|
5069 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
|
5070 {what} are: |
| 11062 | 5071 "name" The function name |
| 5072 "func" The function | |
| 5073 "dict" The dictionary | |
| 5074 "args" The list with arguments | |
| 21250 | 5075 Preferably used as a |method|: > |
| 5076 myfunc->get(what) | |
| 5077 < | |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5078 *getbufinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5079 getbufinfo([{expr}]) |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5080 getbufinfo([{dict}]) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
5081 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
|
5082 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5083 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
|
5084 returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5085 |
| 21093 | 5086 When the argument is a |Dictionary| only the buffers matching |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5087 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
|
5088 be specified in {dict}: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5089 buflisted include only listed buffers. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5090 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
|
5091 bufmodified include only modified buffers. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5092 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5093 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
|
5094 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
|
5095 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
|
5096 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
|
5097 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5098 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
|
5099 entries: |
| 21676 | 5100 bufnr Buffer number. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5101 changed TRUE if the buffer is modified. |
| 21676 | 5102 changedtick Number of changes made to the buffer. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5103 hidden TRUE if the buffer is hidden. |
| 21676 | 5104 lastused Timestamp in seconds, like |
|
18463
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
5105 |localtime()|, when the buffer was |
|
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
5106 last used. |
|
18d7337b6837
patch 8.1.2225: the "last used" info of a buffer is under used
Bram Moolenaar <Bram@vim.org>
parents:
18456
diff
changeset
|
5107 {only with the |+viminfo| feature} |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5108 listed TRUE if the buffer is listed. |
| 21676 | 5109 lnum Line number used for the buffer when |
| 5110 opened in the current window. | |
| 24278 | 5111 Only valid if the buffer has been |
| 5112 displayed in the window in the past. | |
| 5113 If you want the line number of the | |
| 5114 last known cursor position in a given | |
| 5115 window, use |line()|: > | |
| 5116 :echo line('.', {winid}) | |
| 5117 < | |
| 21676 | 5118 linecount Number of lines in the buffer (only |
|
18916
cf051bdefb3f
patch 8.2.0019: cannot number of lines of another buffer
Bram Moolenaar <Bram@vim.org>
parents:
18912
diff
changeset
|
5119 valid when loaded) |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5120 loaded TRUE if the buffer is loaded. |
| 21676 | 5121 name Full path to the file in the buffer. |
| 5122 signs List of signs placed in the buffer. | |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5123 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
|
5124 the following fields: |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5125 id sign identifier |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5126 lnum line number |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5127 name sign name |
| 21676 | 5128 variables A reference to the dictionary with |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5129 buffer-local variables. |
| 21676 | 5130 windows List of |window-ID|s that display this |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5131 buffer |
| 21676 | 5132 popups List of popup |window-ID|s that |
|
17253
26e0352613ec
patch 8.1.1626: no test for closing a popup window with a modified buffer
Bram Moolenaar <Bram@vim.org>
parents:
17221
diff
changeset
|
5133 display this buffer |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5134 |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5135 Examples: > |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5136 for buf in getbufinfo() |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5137 echo buf.name |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5138 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5139 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
|
5140 if buf.changed |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5141 .... |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5142 endif |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5143 endfor |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5144 < |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5145 To get buffer-local options use: > |
| 14519 | 5146 getbufvar({bufnr}, '&option_name') |
|
21381
95e6fb6a5c86
patch 8.2.1241: cannot use getbufinfo() as a method
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
5147 < |
|
95e6fb6a5c86
patch 8.2.1241: cannot use getbufinfo() as a method
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
5148 Can also be used as a |method|: > |
|
95e6fb6a5c86
patch 8.2.1241: cannot use getbufinfo() as a method
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
5149 GetBufnr()->getbufinfo() |
|
95e6fb6a5c86
patch 8.2.1241: cannot use getbufinfo() as a method
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
5150 < |
|
95e6fb6a5c86
patch 8.2.1241: cannot use getbufinfo() as a method
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
5151 |
| 435 | 5152 *getbufline()* |
| 5153 getbufline({expr}, {lnum} [, {end}]) | |
| 685 | 5154 Return a |List| with the lines starting from {lnum} to {end} |
| 5155 (inclusive) in the buffer {expr}. If {end} is omitted, a | |
| 5156 |List| with only the line {lnum} is returned. | |
| 435 | 5157 |
| 5158 For the use of {expr}, see |bufname()| above. | |
| 5159 | |
| 448 | 5160 For {lnum} and {end} "$" can be used for the last line of the |
| 5161 buffer. Otherwise a number must be used. | |
| 435 | 5162 |
| 5163 When {lnum} is smaller than 1 or bigger than the number of | |
| 685 | 5164 lines in the buffer, an empty |List| is returned. |
| 435 | 5165 |
| 5166 When {end} is greater than the number of lines in the buffer, | |
| 5167 it is treated as {end} is set to the number of lines in the | |
| 685 | 5168 buffer. When {end} is before {lnum} an empty |List| is |
| 435 | 5169 returned. |
| 5170 | |
| 448 | 5171 This function works only for loaded buffers. For unloaded and |
| 685 | 5172 non-existing buffers, an empty |List| is returned. |
| 435 | 5173 |
| 5174 Example: > | |
| 5175 :let lines = getbufline(bufnr("myfile"), 1, "$") | |
| 82 | 5176 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5177 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5178 GetBufnr()->getbufline(lnum) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5179 |
| 4157 | 5180 getbufvar({expr}, {varname} [, {def}]) *getbufvar()* |
| 82 | 5181 The result is the value of option or local buffer variable |
| 5182 {varname} in buffer {expr}. Note that the name without "b:" | |
| 5183 must be used. | |
| 23164 | 5184 When {varname} is empty returns a |Dictionary| with all the |
| 1668 | 5185 buffer-local variables. |
| 23164 | 5186 When {varname} is equal to "&" returns a |Dictionary| with all |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5187 the buffer-local options. |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5188 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
|
5189 a buffer-local option. |
| 216 | 5190 This also works for a global or buffer-local option, but it |
| 5191 doesn't work for a global variable, window-local variable or | |
| 5192 window-local option. | |
| 82 | 5193 For the use of {expr}, see |bufname()| above. |
| 4157 | 5194 When the buffer or variable doesn't exist {def} or an empty |
| 5195 string is returned, there is no error message. | |
| 82 | 5196 Examples: > |
| 5197 :let bufmodified = getbufvar(1, "&mod") | |
| 5198 :echo "todo myvar = " . getbufvar("todo", "myvar") | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5199 |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5200 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5201 GetBufnr()->getbufvar(varname) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5202 < |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5203 getchangelist([{expr}]) *getchangelist()* |
|
13280
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
5204 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
|
5205 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
|
5206 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
|
5207 |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
5208 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
|
5209 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
|
5210 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
|
5211 entries: |
|
fbda23eb0996
patch 8.0.1514: getting the list of changes is not easy
Christian Brabandt <cb@256bit.org>
parents:
13272
diff
changeset
|
5212 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
|
5213 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
|
5214 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
|
5215 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
|
5216 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
|
5217 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
|
5218 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5219 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5220 GetBufnr()->getchangelist() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5221 |
| 7 | 5222 getchar([expr]) *getchar()* |
| 867 | 5223 Get a single character from the user or input stream. |
| 7 | 5224 If [expr] is omitted, wait until a character is available. |
| 5225 If [expr] is 0, only get a character when one is available. | |
| 867 | 5226 Return zero otherwise. |
| 7 | 5227 If [expr] is 1, only check if a character is available, it is |
| 867 | 5228 not consumed. Return zero if no character available. |
| 5229 | |
| 5555 | 5230 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
|
5231 special key is returned. If it is a single character, the |
| 867 | 5232 result is a number. Use nr2char() to convert it to a String. |
| 5233 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
|
5234 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
|
5235 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
|
5236 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
|
5237 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
|
5238 that is not included in the character. |
| 867 | 5239 |
| 5968 | 5240 When [expr] is 0 and Esc is typed, there will be a short delay |
| 5241 while Vim waits to see if this is the start of an escape | |
| 5242 sequence. | |
| 5243 | |
| 5555 | 5244 When [expr] is 1 only the first byte is returned. For a |
| 872 | 5245 one-byte character it is the character itself as a number. |
| 5246 Use nr2char() to convert it to a String. | |
| 867 | 5247 |
| 3224 | 5248 Use getcharmod() to obtain any additional modifiers. |
| 5249 | |
| 1029 | 5250 When the user clicks a mouse button, the mouse event will be |
| 5251 returned. The position can then be found in |v:mouse_col|, | |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5252 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. |
|
21230
e67123c115d2
patch 8.2.1166: once mouse move events are enabled getchar() returns them
Bram Moolenaar <Bram@vim.org>
parents:
21093
diff
changeset
|
5253 |getmousepos()| can also be used. Mouse move events will be |
|
e67123c115d2
patch 8.2.1166: once mouse move events are enabled getchar() returns them
Bram Moolenaar <Bram@vim.org>
parents:
21093
diff
changeset
|
5254 ignored. |
|
e67123c115d2
patch 8.2.1166: once mouse move events are enabled getchar() returns them
Bram Moolenaar <Bram@vim.org>
parents:
21093
diff
changeset
|
5255 This example positions the mouse as it would normally happen: > |
| 1029 | 5256 let c = getchar() |
| 1621 | 5257 if c == "\<LeftMouse>" && v:mouse_win > 0 |
| 1029 | 5258 exe v:mouse_win . "wincmd w" |
| 5259 exe v:mouse_lnum | |
| 5260 exe "normal " . v:mouse_col . "|" | |
| 5261 endif | |
| 5262 < | |
| 10734 | 5263 When using bracketed paste only the first character is |
| 5264 returned, the rest of the pasted text is dropped. | |
| 5265 |xterm-bracketed-paste|. | |
| 5266 | |
| 7 | 5267 There is no prompt, you will somehow have to make clear to the |
| 23305 | 5268 user that a character has to be typed. The screen is not |
| 5269 redrawn, e.g. when resizing the window. When using a popup | |
| 5270 window it should work better with a |popup-filter|. | |
| 5271 | |
| 7 | 5272 There is no mapping for the character. |
| 5273 Key codes are replaced, thus when the user presses the <Del> | |
| 5274 key you get the code for the <Del> key, not the raw character | |
| 5275 sequence. Examples: > | |
| 5276 getchar() == "\<Del>" | |
| 5277 getchar() == "\<S-Left>" | |
| 5278 < This example redefines "f" to ignore case: > | |
| 5279 :nmap f :call FindChar()<CR> | |
| 5280 :function FindChar() | |
| 5281 : let c = nr2char(getchar()) | |
| 5282 : while col('.') < col('$') - 1 | |
| 5283 : normal l | |
| 5284 : if getline('.')[col('.') - 1] ==? c | |
| 5285 : break | |
| 5286 : endif | |
| 5287 : endwhile | |
| 5288 :endfunction | |
| 6421 | 5289 < |
| 6647 | 5290 You may also receive synthetic characters, such as |
| 6421 | 5291 |<CursorHold>|. Often you will want to ignore this and get |
| 5292 another character: > | |
| 5293 :function GetKey() | |
| 5294 : let c = getchar() | |
| 5295 : while c == "\<CursorHold>" | |
| 5296 : let c = getchar() | |
| 5297 : endwhile | |
| 5298 : return c | |
| 5299 :endfunction | |
| 7 | 5300 |
| 5301 getcharmod() *getcharmod()* | |
| 5302 The result is a Number which is the state of the modifiers for | |
| 5303 the last obtained character with getchar() or in another way. | |
| 5304 These values are added together: | |
| 5305 2 shift | |
| 5306 4 control | |
| 5307 8 alt (meta) | |
| 3224 | 5308 16 meta (when it's different from ALT) |
| 5309 32 mouse double click | |
| 5310 64 mouse triple click | |
| 5311 96 mouse quadruple click (== 32 + 64) | |
| 5312 128 command (Macintosh only) | |
| 7 | 5313 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
|
5314 character itself are obtained. Thus Shift-a results in "A" |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
5315 without a modifier. |
| 7 | 5316 |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5317 *getcharpos()* |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5318 getcharpos({expr}) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5319 Get the position for {expr}. Same as |getpos()| but the column |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5320 number in the returned List is a character index instead of |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5321 a byte index. |
| 24103 | 5322 If |getpos()| returns a very large column number, such as |
| 5323 2147483647, then getcharpos() will return the character index | |
| 5324 of the last character. | |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5325 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5326 Example: |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5327 With the cursor on '세' in line 5 with text "여보세요": > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5328 getcharpos('.') returns [0, 5, 3, 0] |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5329 getpos('.') returns [0, 5, 7, 0] |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5330 < |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5331 Can also be used as a |method|: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5332 GetMark()->getcharpos() |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5333 |
| 6991 | 5334 getcharsearch() *getcharsearch()* |
| 5335 Return the current character search information as a {dict} | |
| 5336 with the following entries: | |
| 5337 | |
| 5338 char character previously used for a character | |
| 5339 search (|t|, |f|, |T|, or |F|); empty string | |
| 5340 if no character search has been performed | |
| 5341 forward direction of character search; 1 for forward, | |
| 5342 0 for backward | |
| 5343 until type of character search; 1 for a |t| or |T| | |
| 5344 character search, 0 for an |f| or |F| | |
| 5345 character search | |
| 5346 | |
| 5347 This can be useful to always have |;| and |,| search | |
| 5348 forward/backward regardless of the direction of the previous | |
| 5349 character search: > | |
| 5350 :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' | |
| 5351 :nnoremap <expr> , getcharsearch().forward ? ',' : ';' | |
| 5352 < Also see |setcharsearch()|. | |
| 5353 | |
| 7 | 5354 getcmdline() *getcmdline()* |
| 5355 Return the current command-line. Only works when the command | |
| 5356 line is being edited, thus requires use of |c_CTRL-\_e| or | |
| 5357 |c_CTRL-R_=|. | |
| 5358 Example: > | |
| 5359 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> | |
| 531 | 5360 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|. |
| 14864 | 5361 Returns an empty string when entering a password or using |
| 5362 |inputsecret()|. | |
| 7 | 5363 |
| 95 | 5364 getcmdpos() *getcmdpos()* |
| 7 | 5365 Return the position of the cursor in the command line as a |
| 5366 byte count. The first column is 1. | |
| 5367 Only works when editing the command line, thus requires use of | |
| 3456 | 5368 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 5369 Returns 0 otherwise. | |
| 531 | 5370 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|. |
| 5371 | |
| 5372 getcmdtype() *getcmdtype()* | |
| 5373 Return the current command-line type. Possible return values | |
| 5374 are: | |
| 532 | 5375 : normal Ex command |
| 5376 > debug mode command |debug-mode| | |
| 5377 / forward search command | |
| 5378 ? backward search command | |
| 5379 @ |input()| command | |
| 5380 - |:insert| or |:append| command | |
| 6213 | 5381 = |i_CTRL-R_=| |
| 531 | 5382 Only works when editing the command line, thus requires use of |
| 3456 | 5383 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping. |
| 5384 Returns an empty string otherwise. | |
| 531 | 5385 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|. |
| 7 | 5386 |
| 6153 | 5387 getcmdwintype() *getcmdwintype()* |
| 5388 Return the current |command-line-window| type. Possible return | |
| 5389 values are the same as |getcmdtype()|. Returns an empty string | |
| 5390 when not in the command-line window. | |
| 5391 | |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
5392 getcompletion({pat}, {type} [, {filtered}]) *getcompletion()* |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5393 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
|
5394 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
|
5395 supported: |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5396 |
|
13551
1fd0f8392946
patch 8.0.1649: no completion for argument list commands
Christian Brabandt <cb@256bit.org>
parents:
13513
diff
changeset
|
5397 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
|
5398 augroup autocmd groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5399 buffer buffer names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5400 behave :behave suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5401 color color schemes |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5402 command Ex command (and arguments) |
|
20745
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5403 cmdline |cmdline-completion| result |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5404 compiler compilers |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5405 cscope |:cscope| suboptions |
|
18987
e378907d79bf
patch 8.2.0054: :diffget and :diffput don't have good completion
Bram Moolenaar <Bram@vim.org>
parents:
18973
diff
changeset
|
5406 diff_buffer |:diffget| and |:diffput| completion |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5407 dir directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5408 environment environment variable names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5409 event autocommand events |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5410 expression Vim expression |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5411 file file and directory names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5412 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
|
5413 filetype filetype names |'filetype'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5414 function function name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5415 help help subjects |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5416 highlight highlight groups |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5417 history :history suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5418 locale locale names (as output of locale -a) |
| 20965 | 5419 mapclear buffer argument |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5420 mapping mapping name |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5421 menu menus |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
5422 messages |:messages| suboptions |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5423 option options |
|
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
5424 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
|
5425 shellcmd Shell command |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5426 sign |:sign| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5427 syntax syntax file names |'syntax'| |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5428 syntime |:syntime| suboptions |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5429 tag tags |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5430 tag_listfiles tags, file names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5431 user user names |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5432 var user variables |
|
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5433 |
|
20745
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5434 If {pat} is an empty string, then all the matches are |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5435 returned. Otherwise only items matching {pat} are returned. |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5436 See |wildcards| for the use of special characters in {pat}. |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5437 |
|
9861
74f67cb4f7e1
commit https://github.com/vim/vim/commit/e9d58a6459687a1228b5aa85bd7b31f8f1e528a8
Christian Brabandt <cb@256bit.org>
parents:
9858
diff
changeset
|
5438 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
|
5439 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
|
5440 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
|
5441 |
|
20745
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5442 If {type} is "cmdline", then the |cmdline-completion| result is |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5443 returned. For example, to complete the possible values after |
|
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5444 a ":call" command: > |
| 20965 | 5445 echo getcompletion('call ', 'cmdline') |
|
20745
49673325ca13
patch 8.2.0925: getcompletion() does not return command line arguments
Bram Moolenaar <Bram@vim.org>
parents:
20743
diff
changeset
|
5446 < |
|
9460
cdffa812f9d1
commit https://github.com/vim/vim/commit/aa4d73235bf4deee167aa5314b89ae3d3db334b7
Christian Brabandt <cb@256bit.org>
parents:
9454
diff
changeset
|
5447 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
|
5448 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
|
5449 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5450 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5451 GetPattern()->getcompletion('color') |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5452 < |
| 5944 | 5453 *getcurpos()* |
|
22357
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5454 getcurpos([{winid}]) |
|
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5455 Get the position of the cursor. This is like getpos('.'), but |
| 19968 | 5456 includes an extra "curswant" item in the list: |
| 5457 [0, lnum, col, off, curswant] ~ | |
| 5944 | 5458 The "curswant" number is the preferred column when moving the |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5459 cursor vertically. Also see |getcursorcharpos()| and |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5460 |getpos()|. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5461 The first "bufnum" item is always zero. The byte position of |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5462 the cursor is returned in 'col'. To get the character |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5463 position, use |getcursorcharpos()|. |
| 11347 | 5464 |
|
22357
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5465 The optional {winid} argument can specify the window. It can |
|
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5466 be the window number or the |window-ID|. The last known |
|
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5467 cursor position is returned, this may be invalid for the |
|
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5468 current value of the buffer if it is not the current window. |
|
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5469 If {winid} is invalid a list with zeroes is returned. |
|
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5470 |
| 5944 | 5471 This can be used to save and restore the cursor position: > |
| 5472 let save_cursor = getcurpos() | |
| 5473 MoveTheCursorAround | |
| 5474 call setpos('.', save_cursor) | |
| 11347 | 5475 < Note that this only works within the window. See |
| 5476 |winrestview()| for restoring more state. | |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5477 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5478 Can also be used as a |method|: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5479 GetWinid()->getcurpos() |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5480 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5481 < *getcursorcharpos()* |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5482 getcursorcharpos([{winid}]) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5483 Same as |getcurpos()| but the column number in the returned |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5484 List is a character index instead of a byte index. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5485 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5486 Example: |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5487 With the cursor on '보' in line 3 with text "여보세요": > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5488 getcursorcharpos() returns [0, 3, 2, 0, 3] |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5489 getcurpos() returns [0, 3, 4, 0, 3] |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5490 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5491 < Can also be used as a |method|: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5492 GetWinid()->getcursorcharpos() |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5493 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5494 < *getcwd()* |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5495 getcwd([{winnr} [, {tabnr}]]) |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5496 The result is a String, which is the name of the current |
| 7 | 5497 working directory. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5498 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5499 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
|
5500 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
|
5501 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
|
5502 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
|
5503 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
|
5504 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5505 With {winnr} and {tabnr} return the local current directory of |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5506 the window in the specified tab page. If {winnr} is -1 return |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5507 the working directory of the tabpage. |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5508 If {winnr} is zero use the current window, if {tabnr} is zero |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5509 use the current tabpage. |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5510 Without any arguments, return the working directory of the |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5511 current window. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
5512 Return an empty string if the arguments are invalid. |
| 7 | 5513 |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5514 Examples: > |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5515 " Get the working directory of the current window |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5516 :echo getcwd() |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5517 :echo getcwd(0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5518 :echo getcwd(0, 0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5519 " Get the working directory of window 3 in tabpage 2 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5520 :echo getcwd(3, 2) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5521 " Get the global working directory |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5522 :echo getcwd(-1) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5523 " Get the working directory of tabpage 3 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5524 :echo getcwd(-1, 3) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5525 " Get the working directory of current tabpage |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5526 :echo getcwd(-1, 0) |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5527 |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5528 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5529 GetWinnr()->getcwd() |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
5530 < |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5531 getenv({name}) *getenv()* |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5532 Return the value of environment variable {name}. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5533 When the variable does not exist |v:null| is returned. That |
| 17571 | 5534 is different from a variable set to an empty string, although |
| 5535 some systems interpret the empty value as the variable being | |
| 5536 deleted. See also |expr-env|. | |
| 7 | 5537 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5538 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5539 GetVarname()->getenv() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5540 |
| 37 | 5541 getfontname([{name}]) *getfontname()* |
| 5542 Without an argument returns the name of the normal font being | |
| 5543 used. Like what is used for the Normal highlight group | |
| 5544 |hl-Normal|. | |
| 5545 With an argument a check is done whether {name} is a valid | |
| 5546 font name. If not then an empty string is returned. | |
| 5547 Otherwise the actual font name is returned, or {name} if the | |
| 5548 GUI does not support obtaining the real name. | |
| 824 | 5549 Only works when the GUI is running, thus not in your vimrc or |
| 819 | 5550 gvimrc file. Use the |GUIEnter| autocommand to use this |
| 5551 function just after the GUI has started. | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
5552 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
|
5553 a valid name does not work. |
| 37 | 5554 |
| 20 | 5555 getfperm({fname}) *getfperm()* |
| 5556 The result is a String, which is the read, write, and execute | |
| 5557 permissions of the given file {fname}. | |
| 5558 If {fname} does not exist or its directory cannot be read, an | |
| 5559 empty string is returned. | |
| 5560 The result is of the form "rwxrwxrwx", where each group of | |
| 5561 "rwx" flags represent, in turn, the permissions of the owner | |
| 5562 of the file, the group the file belongs to, and other users. | |
| 5563 If a user does not have a given permission the flag for this | |
| 3750 | 5564 is replaced with the string "-". Examples: > |
| 20 | 5565 :echo getfperm("/etc/passwd") |
| 3750 | 5566 :echo getfperm(expand("~/.vimrc")) |
| 20 | 5567 < This will hopefully (from a security point of view) display |
| 5568 the string "rw-r--r--" or even "rw-------". | |
| 205 | 5569 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5570 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5571 GetFilename()->getfperm() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5572 < |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10237
diff
changeset
|
5573 For setting permissions use |setfperm()|. |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
5574 |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5575 getfsize({fname}) *getfsize()* |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5576 The result is a Number, which is the size in bytes of the |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5577 given file {fname}. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5578 If {fname} is a directory, 0 is returned. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5579 If the file {fname} can't be found, -1 is returned. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5580 If the size of {fname} is too big to fit in a Number then -2 |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5581 is returned. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
5582 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5583 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5584 GetFilename()->getfsize() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5585 |
| 7 | 5586 getftime({fname}) *getftime()* |
| 5587 The result is a Number, which is the last modification time of | |
| 5588 the given file {fname}. The value is measured as seconds | |
| 5589 since 1st Jan 1970, and may be passed to strftime(). See also | |
| 5590 |localtime()| and |strftime()|. | |
| 5591 If the file {fname} can't be found -1 is returned. | |
| 5592 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5593 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5594 GetFilename()->getftime() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5595 |
| 20 | 5596 getftype({fname}) *getftype()* |
| 5597 The result is a String, which is a description of the kind of | |
| 5598 file of the given file {fname}. | |
| 5599 If {fname} does not exist an empty string is returned. | |
| 5600 Here is a table over different kinds of files and their | |
| 5601 results: | |
| 5602 Normal file "file" | |
| 5603 Directory "dir" | |
| 5604 Symbolic link "link" | |
| 5605 Block device "bdev" | |
| 5606 Character device "cdev" | |
| 5607 Socket "socket" | |
| 5608 FIFO "fifo" | |
| 5609 All other "other" | |
| 5610 Example: > | |
| 5611 getftype("/home") | |
| 5612 < Note that a type such as "link" will only be returned on | |
| 5613 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
|
5614 "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
|
5615 directory returns "dir" instead of "link". |
| 20 | 5616 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5617 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5618 GetFilename()->getftype() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5619 |
|
18008
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5620 getimstatus() *getimstatus()* |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5621 The result is a Number, which is |TRUE| when the IME status is |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5622 active. |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5623 See 'imstatusfunc'. |
|
8ae333756614
patch 8.1.2000: plugin cannot get the current IME status
Bram Moolenaar <Bram@vim.org>
parents:
18000
diff
changeset
|
5624 |
|
13298
a88c5e12b860
patch 8.0.1523: cannot write and read terminal screendumps
Christian Brabandt <cb@256bit.org>
parents:
13280
diff
changeset
|
5625 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
|
5626 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
|
5627 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5628 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
|
5629 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
|
5630 {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
|
5631 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
|
5632 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
|
5633 |
|
dd3b2ecf91f6
patch 8.0.1497: getting the jump list requires parsing the output of :jumps
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
5634 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
|
5635 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
|
5636 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
|
5637 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
|
5638 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
|
5639 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
|
5640 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
|
5641 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
|
5642 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
|
5643 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5644 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5645 GetWinnr()->getjumplist() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5646 |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5647 < *getline()* |
| 82 | 5648 getline({lnum} [, {end}]) |
| 5649 Without {end} the result is a String, which is line {lnum} | |
| 5650 from the current buffer. Example: > | |
| 7 | 5651 getline(1) |
| 5652 < When {lnum} is a String that doesn't start with a | |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
5653 digit, |line()| is called to translate the String into a Number. |
| 7 | 5654 To get the line under the cursor: > |
| 5655 getline(".") | |
| 5656 < When {lnum} is smaller than 1 or bigger than the number of | |
| 5657 lines in the buffer, an empty string is returned. | |
| 5658 | |
| 685 | 5659 When {end} is given the result is a |List| where each item is |
| 5660 a line from the current buffer in the range {lnum} to {end}, | |
| 82 | 5661 including line {end}. |
| 5662 {end} is used in the same way as {lnum}. | |
| 5663 Non-existing lines are silently omitted. | |
| 685 | 5664 When {end} is before {lnum} an empty |List| is returned. |
| 82 | 5665 Example: > |
| 5666 :let start = line('.') | |
| 5667 :let end = search("^$") - 1 | |
| 5668 :let lines = getline(start, end) | |
| 5669 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5670 < Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5671 ComputeLnum()->getline() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5672 |
| 1156 | 5673 < To get lines from another buffer see |getbufline()| |
| 5674 | |
| 12785 | 5675 getloclist({nr} [, {what}]) *getloclist()* |
| 21093 | 5676 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
|
5677 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
|
5678 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
|
5679 |
| 647 | 5680 For a location list window, the displayed location list is |
| 648 | 5681 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
|
5682 returned. Otherwise, same as |getqflist()|. |
| 82 | 5683 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5684 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
|
5685 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
|
5686 |getqflist()| for the supported items in {what}. |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5687 |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5688 In addition to the items supported by |getqflist()| in {what}, |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5689 the following item is supported by |getloclist()|: |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5690 |
| 16808 | 5691 filewinid id of the window used to display files |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5692 from the location list. This field is |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5693 applicable only when called from a |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5694 location list window. See |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5695 |location-list-file-window| for more |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5696 details. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5697 |
| 23164 | 5698 Returns a |Dictionary| with default values if there is no |
| 5699 location list for the window {nr}. | |
|
22357
0e231e8e70f8
patch 8.2.1727: a popup created with "cursorline" will ignore "firstline"
Bram Moolenaar <Bram@vim.org>
parents:
22355
diff
changeset
|
5700 Returns an empty Dictionary if window {nr} does not exist. |
| 21093 | 5701 |
| 5702 Examples (See also |getqflist-examples|): > | |
| 5703 :echo getloclist(3, {'all': 0}) | |
| 5704 :echo getloclist(5, {'filewinid': 0}) | |
| 5705 | |
| 5706 | |
| 21676 | 5707 getmarklist([{expr}]) *getmarklist()* |
|
20615
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5708 Without the {expr} argument returns a |List| with information |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5709 about all the global marks. |mark| |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5710 |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5711 If the optional {expr} argument is specified, returns the |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5712 local marks defined in buffer {expr}. For the use of {expr}, |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5713 see |bufname()|. |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5714 |
| 22328 | 5715 Each item in the returned List is a |Dict| with the following: |
|
20615
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5716 name - name of the mark prefixed by "'" |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5717 pos - a |List| with the position of the mark: |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5718 [bufnum, lnum, col, off] |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5719 Refer to |getpos()| for more information. |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5720 file - file name |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5721 |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5722 Refer to |getpos()| for getting information about a specific |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5723 mark. |
|
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5724 |
|
20635
3e36a51ff152
patch 8.2.0871: cannot use getmarklist() as a method
Bram Moolenaar <Bram@vim.org>
parents:
20631
diff
changeset
|
5725 Can also be used as a |method|: > |
|
3e36a51ff152
patch 8.2.0871: cannot use getmarklist() as a method
Bram Moolenaar <Bram@vim.org>
parents:
20631
diff
changeset
|
5726 GetBufnr()->getmarklist() |
|
20615
8eed1e9389bb
patch 8.2.0861: cannot easily get all the current marks
Bram Moolenaar <Bram@vim.org>
parents:
20603
diff
changeset
|
5727 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
5728 getmatches([{win}]) *getmatches()* |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5729 Returns a |List| with all matches previously defined for the |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5730 current window by |matchadd()| and the |:match| commands. |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5731 |getmatches()| is useful in combination with |setmatches()|, |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5732 as |setmatches()| can restore a list of matches saved by |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
5733 |getmatches()|. |
| 1326 | 5734 Example: > |
| 5735 :echo getmatches() | |
| 5736 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 5737 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 5738 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 5739 :let m = getmatches() | |
| 5740 :call clearmatches() | |
| 5741 :echo getmatches() | |
| 5742 < [] > | |
| 5743 :call setmatches(m) | |
| 5744 :echo getmatches() | |
| 5745 < [{'group': 'MyGroup1', 'pattern': 'TODO', | |
| 5746 'priority': 10, 'id': 1}, {'group': 'MyGroup2', | |
| 5747 'pattern': 'FIXME', 'priority': 10, 'id': 2}] > | |
| 5748 :unlet m | |
| 5749 < | |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5750 getmousepos() *getmousepos()* |
| 21093 | 5751 Returns a |Dictionary| with the last known position of the |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5752 mouse. This can be used in a mapping for a mouse click or in |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5753 a filter of a popup window. The items are: |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5754 screenrow screen row |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5755 screencol screen column |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5756 winid Window ID of the click |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5757 winrow row inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5758 wincol column inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5759 line text line inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5760 column text column inside "winid" |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5761 All numbers are 1-based. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5762 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5763 If not over a window, e.g. when in the command line, then only |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5764 "screenrow" and "screencol" are valid, the others are zero. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5765 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5766 When on the status line below a window or the vertical |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
5767 separator right of a window, the "line" and "column" values |
|
18623
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5768 are zero. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5769 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5770 When the position is after the text then "column" is the |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5771 length of the text in bytes. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5772 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5773 If the mouse is over a popup window then that window is used. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5774 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5775 |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5776 When using |getchar()| the Vim variables |v:mouse_lnum|, |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5777 |v:mouse_col| and |v:mouse_winid| also provide these values. |
|
3089b422b9dc
patch 8.1.2304: cannot get the mouse position when getting a mouse click
Bram Moolenaar <Bram@vim.org>
parents:
18594
diff
changeset
|
5778 |
| 5968 | 5779 *getpid()* |
| 5780 getpid() Return a Number which is the process ID of the Vim process. | |
| 5781 On Unix and MS-Windows this is a unique number, until Vim | |
| 18972 | 5782 exits. |
| 5968 | 5783 |
| 5784 *getpos()* | |
| 5785 getpos({expr}) Get the position for {expr}. For possible values of {expr} | |
| 5786 see |line()|. For getting the cursor position see | |
| 5787 |getcurpos()|. | |
| 5788 The result is a |List| with four numbers: | |
| 5789 [bufnum, lnum, col, off] | |
| 5790 "bufnum" is zero, unless a mark like '0 or 'A is used, then it | |
| 5791 is the buffer number of the mark. | |
| 5792 "lnum" and "col" are the position in the buffer. The first | |
| 5793 column is 1. | |
| 5794 The "off" number is zero, unless 'virtualedit' is used. Then | |
| 5795 it is the offset in screen columns from the start of the | |
| 5796 character. E.g., a position within a <Tab> or after the last | |
| 5797 character. | |
| 5798 Note that for '< and '> Visual mode matters: when it is "V" | |
| 5799 (visual line mode) the column of '< is zero and the column of | |
| 5800 '> is a large number. | |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5801 The column number in the returned List is the byte position |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5802 within the line. To get the character position in the line, |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5803 use |getcharpos()| |
| 24103 | 5804 The column number can be very large, e.g. 2147483647, in which |
| 5805 case it means "after the end of the line". | |
| 5968 | 5806 This can be used to save and restore the position of a mark: > |
| 5807 let save_a_mark = getpos("'a") | |
| 5808 ... | |
| 6421 | 5809 call setpos("'a", save_a_mark) |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
5810 < Also see |getcharpos()|, |getcurpos()| and |setpos()|. |
| 5968 | 5811 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5812 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5813 GetMark()->getpos() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5814 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5815 getqflist([{what}]) *getqflist()* |
| 23164 | 5816 Returns a |List| with all the current quickfix errors. Each |
| 230 | 5817 list item is a dictionary with these entries: |
| 5818 bufnr number of buffer that has the file name, use | |
| 5819 bufname() to get the name | |
|
13821
98274127d675
patch 8.0.1782: no simple way to label quickfix entries
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
5820 module module name |
| 230 | 5821 lnum line number in the buffer (first line is 1) |
| 5822 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
|
5823 vcol |TRUE|: "col" is visual column |
|
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5824 |FALSE|: "col" is byte index |
| 230 | 5825 nr error number |
| 1065 | 5826 pattern search pattern used to locate the error |
| 230 | 5827 text description of the error |
| 5828 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
|
5829 valid |TRUE|: recognized error message |
| 230 | 5830 |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
5831 When there is no error list or it's empty, an empty list is |
| 1065 | 5832 returned. Quickfix list entries with non-existing buffer |
| 5833 number are returned with "bufnr" set to zero. | |
| 515 | 5834 |
| 230 | 5835 Useful application: Find pattern matches in multiple files and |
| 5836 do something with them: > | |
| 5837 :vimgrep /theword/jg *.c | |
| 5838 :for d in getqflist() | |
| 5839 : echo bufname(d.bufnr) ':' d.lnum '=' d.text | |
| 5840 :endfor | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5841 < |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5842 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
|
5843 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
|
5844 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
|
5845 changedtick get the total number of changes made |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5846 to the list |quickfix-changedtick| |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5847 context get the |quickfix-context| |
|
12321
2779d593a706
patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents:
12319
diff
changeset
|
5848 efm errorformat to use when parsing "lines". If |
| 12968 | 5849 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
|
5850 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
|
5851 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
|
5852 |quickfix-ID|; zero means the id for the |
| 12968 | 5853 current list or the list specified by "nr" |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5854 idx get information for the quickfix entry at this |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5855 index in the list specified by 'id' or 'nr'. |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5856 If set to zero, then uses the current entry. |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
5857 See |quickfix-index| |
|
11549
f5add45f9848
patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents:
11543
diff
changeset
|
5858 items quickfix list entries |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5859 lines parse a list of lines using 'efm' and return |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5860 the resulting entries. Only a |List| type is |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5861 accepted. The current quickfix list is not |
|
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5862 modified. See |quickfix-parse|. |
|
10237
197795e3530d
commit https://github.com/vim/vim/commit/890680ca6364386fabb271c85e0755bcaa6a33c1
Christian Brabandt <cb@256bit.org>
parents:
10233
diff
changeset
|
5863 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
|
5864 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
|
5865 the last quickfix list |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5866 qfbufnr number of the buffer displayed in the quickfix |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5867 window. Returns 0 if the quickfix buffer is |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5868 not present. See |quickfix-buffer|. |
|
12465
805f7fd40e0d
patch 8.0.1112: can't get size or current index from quickfix list
Christian Brabandt <cb@256bit.org>
parents:
12427
diff
changeset
|
5869 size number of entries in the quickfix list |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5870 title get the list title |quickfix-title| |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
5871 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
|
5872 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
|
5873 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
|
5874 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
|
5875 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
|
5876 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
|
5877 specified by "id" is used. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
5878 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
|
5879 "$" 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
|
5880 contains the quickfix stack size. |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
5881 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
|
5882 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
|
5883 "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
|
5884 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5885 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
|
5886 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
|
5887 list |quickfix-changedtick| |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5888 context quickfix list context. See |quickfix-context| |
|
13026
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5889 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
|
5890 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
|
5891 present, set to 0. |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
5892 idx index of the quickfix entry in the list. If not |
|
13026
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5893 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
|
5894 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
|
5895 an empty list. |
|
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5896 nr quickfix list number. If not present, set to 0 |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5897 qfbufnr number of the buffer displayed in the quickfix |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
5898 window. If not present, set to 0. |
|
13026
7c0e0e923537
patch 8.0.1389: getqflist() items are missing if not set
Christian Brabandt <cb@256bit.org>
parents:
13020
diff
changeset
|
5899 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
|
5900 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
|
5901 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
|
5902 to "". |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
5903 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
|
5904 |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
5905 Examples (See also |getqflist-examples|): > |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5906 :echo getqflist({'all': 1}) |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
5907 :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
|
5908 :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
|
5909 < |
| 5796 | 5910 getreg([{regname} [, 1 [, {list}]]]) *getreg()* |
| 7 | 5911 The result is a String, which is the contents of register |
| 236 | 5912 {regname}. Example: > |
| 7 | 5913 :let cliptext = getreg('*') |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
5914 < 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
|
5915 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
5916 getreg('=') returns the last evaluated value of the expression |
| 236 | 5917 register. (For use in maps.) |
| 282 | 5918 getreg('=', 1) returns the expression itself, so that it can |
| 5919 be restored with |setreg()|. For other registers the extra | |
| 5920 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
|
5921 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
5922 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
|
5923 to |List|. Each list item is one text line. Use it if you care |
| 5796 | 5924 about zero bytes possibly present inside register: without |
| 5925 third argument both NLs and zero bytes are represented as NLs | |
| 5926 (see |NL-used-for-Nul|). | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
5927 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
|
5928 |
| 7 | 5929 If {regname} is not specified, |v:register| is used. |
| 23931 | 5930 In |Vim9-script| {regname} must be one character. |
| 7 | 5931 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5932 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5933 GetRegname()->getreg() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5934 |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5935 getreginfo([{regname}]) *getreginfo()* |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5936 Returns detailed information about register {regname} as a |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5937 Dictionary with the following entries: |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5938 regcontents List of lines contained in register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5939 {regname}, like |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5940 |getreg|({regname}, 1, 1). |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5941 regtype the type of register {regname}, as in |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5942 |getregtype()|. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5943 isunnamed Boolean flag, v:true if this register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5944 is currently pointed to by the unnamed |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5945 register. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5946 points_to for the unnamed register, gives the |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5947 single letter name of the register |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5948 currently pointed to (see |quotequote|). |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5949 For example, after deleting a line |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5950 with `dd`, this field will be "1", |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5951 which is the register that got the |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5952 deleted text. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5953 |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5954 If {regname} is invalid or not set, an empty Dictionary |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5955 will be returned. |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5956 If {regname} is not specified, |v:register| is used. |
| 21991 | 5957 The returned Dictionary can be passed to |setreg()|. |
| 23931 | 5958 In |Vim9-script| {regname} must be one character. |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5959 |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5960 Can also be used as a |method|: > |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
5961 GetRegname()->getreginfo() |
| 82 | 5962 |
| 7 | 5963 getregtype([{regname}]) *getregtype()* |
| 5964 The result is a String, which is type of register {regname}. | |
| 5965 The value will be one of: | |
| 5966 "v" for |characterwise| text | |
| 5967 "V" for |linewise| text | |
| 5968 "<CTRL-V>{width}" for |blockwise-visual| text | |
| 5596 | 5969 "" for an empty or unknown register |
| 7 | 5970 <CTRL-V> is one character with value 0x16. |
| 5971 If {regname} is not specified, |v:register| is used. | |
| 23931 | 5972 In |Vim9-script| {regname} must be one character. |
| 7 | 5973 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5974 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5975 GetRegname()->getregtype() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5976 |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5977 gettabinfo([{arg}]) *gettabinfo()* |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5978 If {arg} is not specified, then information about all the tab |
| 21093 | 5979 pages is returned as a |List|. Each List item is a |Dictionary|. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5980 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
|
5981 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
|
5982 empty List is returned. |
|
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5983 |
| 21093 | 5984 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
|
5985 tabnr tab page number. |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
5986 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
|
5987 tabpage-local variables |
| 15932 | 5988 windows List of |window-ID|s in the tab page. |
|
9858
3e96d9ed2ca1
commit https://github.com/vim/vim/commit/b5ae48e9ffd3b8eb6ca4057de11f1bddcde8ce6f
Christian Brabandt <cb@256bit.org>
parents:
9850
diff
changeset
|
5989 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5990 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5991 GetTabnr()->gettabinfo() |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
5992 |
| 4157 | 5993 gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5994 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
|
5995 {tabnr}. |t:var| |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5996 Tabs are numbered starting with one. |
| 6197 | 5997 When {varname} is empty a dictionary with all tab-local |
| 5998 variables is returned. | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
5999 Note that the name without "t:" must be used. |
| 4157 | 6000 When the tab or variable doesn't exist {def} or an empty |
| 6001 string is returned, there is no error message. | |
| 6002 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
6003 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
6004 GetTabnr()->gettabvar(varname) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
6005 |
| 4157 | 6006 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* |
| 1156 | 6007 Get the value of window-local variable {varname} in window |
| 6008 {winnr} in tab page {tabnr}. | |
| 4157 | 6009 When {varname} is empty a dictionary with all window-local |
| 6010 variables is returned. | |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6011 When {varname} is equal to "&" get the values of all |
| 21093 | 6012 window-local options in a |Dictionary|. |
|
10000
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
6013 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
|
6014 window-local option. |
| 4157 | 6015 Note that {varname} must be the name without "w:". |
| 831 | 6016 Tabs are numbered starting with one. For the current tabpage |
| 6017 use |getwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6018 {winnr} can be the window number or the |window-ID|. |
| 831 | 6019 When {winnr} is zero the current window is used. |
| 6020 This also works for a global option, buffer-local option and | |
| 6021 window-local option, but it doesn't work for a global variable | |
| 6022 or buffer-local variable. | |
| 4157 | 6023 When the tab, window or variable doesn't exist {def} or an |
| 6024 empty string is returned, there is no error message. | |
| 831 | 6025 Examples: > |
| 6026 :let list_is_on = gettabwinvar(1, 2, '&list') | |
| 6027 :echo "myvar = " . gettabwinvar(3, 1, 'myvar') | |
| 1266 | 6028 < |
| 14347 | 6029 To obtain all window-local variables use: > |
| 6030 gettabwinvar({tabnr}, {winnr}, '&') | |
| 6031 | |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
6032 < Can also be used as a |method|: > |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6033 GetTabnr()->gettabwinvar(winnr, varname) |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
6034 |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6035 gettagstack([{nr}]) *gettagstack()* |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6036 The result is a Dict, which is the tag stack of window {nr}. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6037 {nr} can be the window number or the |window-ID|. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6038 When {nr} is not specified, the current window is used. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6039 When window {nr} doesn't exist, an empty Dict is returned. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6040 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6041 The returned dictionary contains the following entries: |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6042 curidx Current index in the stack. When at |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6043 top of the stack, set to (length + 1). |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6044 Index of bottom of the stack is 1. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6045 items List of items in the stack. Each item |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6046 is a dictionary containing the |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6047 entries described below. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6048 length Number of entries in the stack. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6049 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6050 Each item in the stack is a dictionary with the following |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6051 entries: |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6052 bufnr buffer number of the current jump |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6053 from cursor position before the tag jump. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6054 See |getpos()| for the format of the |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6055 returned list. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6056 matchnr current matching tag number. Used when |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6057 multiple matching tags are found for a |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6058 name. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6059 tagname name of the tag |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6060 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6061 See |tagstack| for more information about the tag stack. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
6062 |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6063 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6064 GetWinnr()->gettagstack() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6065 |
|
21989
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6066 |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6067 gettext({text}) *gettext()* |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6068 Translate {text} if possible. |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6069 This is mainly for use in the distributed Vim scripts. When |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6070 generating message translations the {text} is extracted by |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6071 xgettext, the translator can add the translated message in the |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6072 .po file and Vim will lookup the translation when gettext() is |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6073 called. |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6074 For {text} double quoted strings are preferred, because |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6075 xgettext does not understand escaping in single quoted |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6076 strings. |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6077 |
|
52e970719f4b
patch 8.2.1544: cannot translate messages in a Vim script
Bram Moolenaar <Bram@vim.org>
parents:
21973
diff
changeset
|
6078 |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6079 getwininfo([{winid}]) *getwininfo()* |
| 21093 | 6080 Returns information about windows as a |List| with Dictionaries. |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6081 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6082 If {winid} is given Information about the window with that ID |
| 21093 | 6083 is returned, as a |List| with one item. If the window does not |
| 20965 | 6084 exist the result is an empty list. |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6085 |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6086 Without {winid} information about all the windows in all the |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6087 tab pages is returned. |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6088 |
| 21093 | 6089 Each List item is a |Dictionary| with the following entries: |
|
15977
7fbdceabad64
patch 8.1.0994: relative cursor position is not calculated correctly
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
6090 botline last displayed buffer line |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6091 bufnr number of buffer in the window |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6092 height window height (excluding winbar) |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6093 loclist 1 if showing a location list |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6094 {only with the +quickfix feature} |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6095 quickfix 1 if quickfix or location list window |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6096 {only with the +quickfix feature} |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6097 terminal 1 if a terminal window |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6098 {only with the +terminal feature} |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6099 tabnr tab page number |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
6100 topline first displayed buffer line |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6101 variables a reference to the dictionary with |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6102 window-local variables |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6103 width window width |
| 14347 | 6104 winbar 1 if the window has a toolbar, 0 |
| 6105 otherwise | |
| 24278 | 6106 wincol leftmost screen column of the window; |
| 6107 "col" from |win_screenpos()| | |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6108 winid |window-ID| |
|
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6109 winnr window number |
| 24278 | 6110 winrow topmost screen line of the window; |
| 6111 "row" from |win_screenpos()| | |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
6112 |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6113 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6114 GetWinnr()->getwininfo() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6115 |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
6116 getwinpos([{timeout}]) *getwinpos()* |
| 21093 | 6117 The result is a |List| with two numbers, the result of |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
6118 |getwinposx()| and |getwinposy()| combined: |
|
13379
0f9dd1b43244
patch 8.0.1563: timeout of getwinposx() can be too short
Christian Brabandt <cb@256bit.org>
parents:
13341
diff
changeset
|
6119 [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
|
6120 {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
|
6121 a response from the terminal. When omitted 100 msec is used. |
| 13437 | 6122 Use a longer time for a remote terminal. |
| 6123 When using a value less than 10 and no response is received | |
| 6124 within that time, a previously reported position is returned, | |
| 6125 if available. This can be used to poll for the position and | |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
6126 do some work in the meantime: > |
| 13437 | 6127 while 1 |
| 6128 let res = getwinpos(1) | |
| 6129 if res[0] >= 0 | |
| 6130 break | |
| 6131 endif | |
| 6132 " Do some work here | |
| 6133 endwhile | |
| 6134 < | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6135 |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6136 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6137 GetTimeout()->getwinpos() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6138 < |
| 7 | 6139 *getwinposx()* |
| 6140 getwinposx() The result is a Number, which is the X coordinate in pixels of | |
| 11347 | 6141 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
|
6142 xterm (uses a timeout of 100 msec). |
| 11347 | 6143 The result will be -1 if the information is not available. |
| 6144 The value can be used with `:winpos`. | |
| 7 | 6145 |
| 6146 *getwinposy()* | |
| 6147 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
|
6148 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
|
6149 a timeout of 100 msec). |
| 11347 | 6150 The result will be -1 if the information is not available. |
| 6151 The value can be used with `:winpos`. | |
| 7 | 6152 |
| 4157 | 6153 getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* |
| 831 | 6154 Like |gettabwinvar()| for the current tabpage. |
| 7 | 6155 Examples: > |
| 6156 :let list_is_on = getwinvar(2, '&list') | |
| 6157 :echo "myvar = " . getwinvar(1, 'myvar') | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6158 |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6159 < Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6160 GetWinnr()->getwinvar(varname) |
| 7 | 6161 < |
| 6663 | 6162 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |
| 1754 | 6163 Expand the file wildcards in {expr}. See |wildcards| for the |
| 1156 | 6164 use of special characters. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
6165 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6166 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 6167 the 'suffixes' and 'wildignore' options apply: Names matching |
| 6168 one of the patterns in 'wildignore' will be skipped and | |
| 6169 'suffixes' affect the ordering of matches. | |
| 2662 | 6170 'wildignorecase' always applies. |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
6171 |
| 21093 | 6172 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
|
6173 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
|
6174 you also get filenames containing newlines correctly. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
6175 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
|
6176 matches, they are separated by <NL> characters. |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
6177 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
6178 If the expansion fails, the result is an empty String or List. |
| 6663 | 6179 |
| 16267 | 6180 You can also use |readdir()| if you need to do complicated |
| 6181 things, such as limiting the number of matches. | |
| 6182 | |
| 3445 | 6183 A name for a non-existing file is not included. A symbolic |
| 6184 link is only included if it points to an existing file. | |
| 6663 | 6185 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
|
6186 |TRUE| then all symbolic links are included. |
| 7 | 6187 |
| 6188 For most systems backticks can be used to get files names from | |
| 6189 any external command. Example: > | |
| 6190 :let tagfiles = glob("`find . -name tags -print`") | |
| 6191 :let &tags = substitute(tagfiles, "\n", ",", "g") | |
| 6192 < 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
|
6193 item per line. Spaces inside an item are allowed. |
| 7 | 6194 |
| 6195 See |expand()| for expanding special Vim variables. See | |
| 6196 |system()| for getting the raw output of an external command. | |
| 6197 | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6198 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6199 GetExpr()->glob() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6200 |
| 6697 | 6201 glob2regpat({expr}) *glob2regpat()* |
| 6202 Convert a file pattern, as used by glob(), into a search | |
| 6203 pattern. The result can be used to match with a string that | |
| 6204 is a file name. E.g. > | |
| 6205 if filename =~ glob2regpat('Make*.mak') | |
| 6206 < This is equivalent to: > | |
| 6207 if filename =~ '^Make.*\.mak$' | |
|
7788
192ae655ac91
commit https://github.com/vim/vim/commit/3b5f929b18492fec291d1ec95a91f54e5912c03b
Christian Brabandt <cb@256bit.org>
parents:
7782
diff
changeset
|
6208 < 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
|
6209 empty string. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
6210 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
|
6211 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
|
6212 |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6213 Can also be used as a |method|: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6214 GetExpr()->glob2regpat() |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6215 < *globpath()* |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6216 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]]) |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6217 Perform glob() for {expr} on all directories in {path} and |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6218 concatenate the results. Example: > |
| 7 | 6219 :echo globpath(&rtp, "syntax/c.vim") |
| 5873 | 6220 < |
| 6221 {path} is a comma-separated list of directory names. Each | |
| 7 | 6222 directory name is prepended to {expr} and expanded like with |
| 1754 | 6223 |glob()|. A path separator is inserted when needed. |
| 7 | 6224 To add a comma inside a directory name escape it with a |
| 6225 backslash. Note that on MS-Windows a directory may have a | |
| 6226 trailing backslash, remove it if you put a comma after it. | |
| 6227 If the expansion fails for one of the directories, there is no | |
| 6228 error message. | |
| 5873 | 6229 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6230 Unless the optional {nosuf} argument is given and is |TRUE|, |
| 1754 | 6231 the 'suffixes' and 'wildignore' options apply: Names matching |
| 6232 one of the patterns in 'wildignore' will be skipped and | |
| 6233 'suffixes' affect the ordering of matches. | |
| 7 | 6234 |
| 21093 | 6235 When {list} is present and it is |TRUE| the result is a |List| |
| 5873 | 6236 with all matching files. The advantage of using a List is, you |
| 6237 also get filenames containing newlines correctly. Otherwise | |
| 6238 the result is a String and when there are several matches, | |
| 6239 they are separated by <NL> characters. Example: > | |
| 6240 :echo globpath(&rtp, "syntax/c.vim", 0, 1) | |
| 6241 < | |
|
8031
ece323e2b57f
commit https://github.com/vim/vim/commit/6463ca229cb9412581419497924c85fcbfc854ab
Christian Brabandt <cb@256bit.org>
parents:
8019
diff
changeset
|
6242 {alllinks} is used as with |glob()|. |
| 6663 | 6243 |
| 444 | 6244 The "**" item can be used to search in a directory tree. |
| 6245 For example, to find all "README.txt" files in the directories | |
| 6246 in 'runtimepath' and below: > | |
| 6247 :echo globpath(&rtp, "**/README.txt") | |
| 1668 | 6248 < Upwards search and limiting the depth of "**" is not |
| 6249 supported, thus using 'path' will not always work properly. | |
| 6250 | |
|
17912
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6251 Can also be used as a |method|, the base is passed as the |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6252 second argument: > |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6253 GetExpr()->globpath(&rtp) |
|
9fac6d0de69a
patch 8.1.1952: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17909
diff
changeset
|
6254 < |
| 7 | 6255 *has()* |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6256 has({feature} [, {check}]) |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6257 When {check} is omitted or is zero: The result is a Number, |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6258 which is 1 if the feature {feature} is supported, zero |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6259 otherwise. The {feature} argument is a string, case is |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6260 ignored. See |feature-list| below. |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6261 |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6262 When {check} is present and not zero: The result is a Number, |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6263 which is 1 if the feature {feature} could ever be supported, |
|
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6264 zero otherwise. This is useful to check for a typo in |
| 19813 | 6265 {feature} and to detect dead code. Keep in mind that an older |
| 6266 Vim version will not know about a feature added later and | |
| 21991 | 6267 features that have been abandoned will not be known by the |
| 19813 | 6268 current Vim version. |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6269 |
| 7 | 6270 Also see |exists()|. |
|
19742
810eee1b42e3
patch 8.2.0427: it is not possible to check for a typo in a feature name
Bram Moolenaar <Bram@vim.org>
parents:
19721
diff
changeset
|
6271 |
| 19646 | 6272 Note that to skip code that has a syntax error when the |
| 6273 feature is not available, Vim may skip the rest of the line | |
| 20241 | 6274 and miss a following `endif`. Therefore put the `endif` on a |
| 19646 | 6275 separate line: > |
| 6276 if has('feature') | |
| 6277 let x = this->breaks->without->the->feature | |
| 6278 endif | |
| 19721 | 6279 < If the `endif` would be moved to the second line as "| endif" it |
| 6280 would not be found. | |
| 7 | 6281 |
| 102 | 6282 |
| 6283 has_key({dict}, {key}) *has_key()* | |
| 23666 | 6284 The result is a Number, which is TRUE if |Dictionary| {dict} |
| 6285 has an entry with key {key}. FALSE otherwise. | |
| 102 | 6286 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
6287 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
6288 mydict->has_key(key) |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
6289 |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
6290 haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6291 The result is a Number: |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6292 1 when the window has set a local directory via |:lcd| |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6293 2 when the tab-page has set a local directory via |:tcd| |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6294 0 otherwise. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
6295 |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
6296 Without arguments use the current window. |
|
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
6297 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
|
6298 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
|
6299 page. |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
6300 {winnr} can be the window number or the |window-ID|. |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6301 If {winnr} is -1 it is ignored and only the tabpage is used. |
|
7653
d4370fef0175
commit https://github.com/vim/vim/commit/c970330676eaae7ba7cd05cfa46df5a413853ef9
Christian Brabandt <cb@256bit.org>
parents:
7651
diff
changeset
|
6302 Return 0 if the arguments are invalid. |
|
16427
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6303 Examples: > |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6304 if haslocaldir() == 1 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6305 " window local directory case |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6306 elseif haslocaldir() == 2 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6307 " tab-local directory case |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6308 else |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6309 " global directory case |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6310 endif |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6311 |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6312 " current window |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6313 :echo haslocaldir() |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6314 :echo haslocaldir(0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6315 :echo haslocaldir(0, 0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6316 " window n in current tab page |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6317 :echo haslocaldir(n) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6318 :echo haslocaldir(n, 0) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6319 " window n in tab page m |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6320 :echo haslocaldir(n, m) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6321 " tab page m |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6322 :echo haslocaldir(-1, m) |
|
8c3a1bd270bb
patch 8.1.1218: cannot set a directory for a tab page
Bram Moolenaar <Bram@vim.org>
parents:
16411
diff
changeset
|
6323 < |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6324 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6325 GetWinnr()->haslocaldir() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6326 |
| 782 | 6327 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* |
| 23666 | 6328 The result is a Number, which is TRUE if there is a mapping |
| 6329 that contains {what} in somewhere in the rhs (what it is | |
| 6330 mapped to) and this mapping exists in one of the modes | |
| 6331 indicated by {mode}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6332 When {abbr} is there and it is |TRUE| use abbreviations |
| 786 | 6333 instead of mappings. Don't forget to specify Insert and/or |
| 6334 Command-line mode. | |
| 7 | 6335 Both the global mappings and the mappings local to the current |
| 6336 buffer are checked for a match. | |
| 23666 | 6337 If no matching mapping is found FALSE is returned. |
| 7 | 6338 The following characters are recognized in {mode}: |
| 6339 n Normal mode | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6340 v Visual and Select mode |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6341 x Visual mode |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6342 s Select mode |
| 7 | 6343 o Operator-pending mode |
| 6344 i Insert mode | |
| 6345 l Language-Argument ("r", "f", "t", etc.) | |
| 6346 c Command-line mode | |
| 6347 When {mode} is omitted, "nvo" is used. | |
| 6348 | |
| 6349 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
|
6350 to a function in a Vim script. Example: > |
| 7 | 6351 :if !hasmapto('\ABCdoit') |
| 6352 : map <Leader>d \ABCdoit | |
| 6353 :endif | |
| 6354 < This installs the mapping to "\ABCdoit" only if there isn't | |
| 6355 already a mapping to "\ABCdoit". | |
| 6356 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6357 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6358 GetRHS()->hasmapto() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6359 |
| 7 | 6360 histadd({history}, {item}) *histadd()* |
| 6361 Add the String {item} to the history {history} which can be | |
| 6362 one of: *hist-names* | |
| 6363 "cmd" or ":" command line history | |
| 6364 "search" or "/" search pattern history | |
| 1621 | 6365 "expr" or "=" typed expression history |
| 7 | 6366 "input" or "@" input line history |
| 3682 | 6367 "debug" or ">" debug command history |
|
10228
8a1481e59d64
commit https://github.com/vim/vim/commit/3e496b0ea31996b665824f45664dee1fdd73c4d0
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
6368 empty the current or last used history |
| 3682 | 6369 The {history} string does not need to be the whole name, one |
| 6370 character is sufficient. | |
| 7 | 6371 If {item} does already exist in the history, it will be |
| 6372 shifted to become the newest entry. | |
| 23666 | 6373 The result is a Number: TRUE if the operation was successful, |
| 6374 otherwise FALSE is returned. | |
| 7 | 6375 |
| 6376 Example: > | |
| 6377 :call histadd("input", strftime("%Y %b %d")) | |
| 6378 :let date=input("Enter date: ") | |
| 6379 < This function is not available in the |sandbox|. | |
| 6380 | |
| 18343 | 6381 Can also be used as a |method|, the base is passed as the |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6382 second argument: > |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
6383 GetHistory()->histadd('search') |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6384 |
| 7 | 6385 histdel({history} [, {item}]) *histdel()* |
| 236 | 6386 Clear {history}, i.e. delete all its entries. See |hist-names| |
| 7 | 6387 for the possible values of {history}. |
| 6388 | |
| 1668 | 6389 If the parameter {item} evaluates to a String, it is used as a |
| 6390 regular expression. All entries matching that expression will | |
| 6391 be removed from the history (if there are any). | |
| 7 | 6392 Upper/lowercase must match, unless "\c" is used |/\c|. |
| 1668 | 6393 If {item} evaluates to a Number, it will be interpreted as |
| 6394 an index, see |:history-indexing|. The respective entry will | |
| 6395 be removed if it exists. | |
| 7 | 6396 |
| 23666 | 6397 The result is TRUE for a successful operation, otherwise FALSE |
| 6398 is returned. | |
| 7 | 6399 |
| 6400 Examples: | |
| 6401 Clear expression register history: > | |
| 6402 :call histdel("expr") | |
| 6403 < | |
| 6404 Remove all entries starting with "*" from the search history: > | |
| 6405 :call histdel("/", '^\*') | |
| 6406 < | |
| 6407 The following three are equivalent: > | |
| 6408 :call histdel("search", histnr("search")) | |
| 6409 :call histdel("search", -1) | |
| 6410 :call histdel("search", '^'.histget("search", -1).'$') | |
| 6411 < | |
| 6412 To delete the last search pattern and use the last-but-one for | |
| 6413 the "n" command and 'hlsearch': > | |
| 6414 :call histdel("search", -1) | |
| 6415 :let @/ = histget("search", -1) | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6416 < |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6417 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6418 GetHistory()->histdel() |
| 7 | 6419 |
| 6420 histget({history} [, {index}]) *histget()* | |
| 6421 The result is a String, the entry with Number {index} from | |
| 6422 {history}. See |hist-names| for the possible values of | |
| 6423 {history}, and |:history-indexing| for {index}. If there is | |
| 6424 no such entry, an empty String is returned. When {index} is | |
| 6425 omitted, the most recent item from the history is used. | |
| 6426 | |
| 6427 Examples: | |
| 6428 Redo the second last search from history. > | |
| 6429 :execute '/' . histget("search", -2) | |
| 6430 | |
| 6431 < Define an Ex command ":H {num}" that supports re-execution of | |
| 6432 the {num}th entry from the output of |:history|. > | |
| 6433 :command -nargs=1 H execute histget("cmd", 0+<args>) | |
| 6434 < | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6435 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6436 GetHistory()->histget() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6437 |
| 7 | 6438 histnr({history}) *histnr()* |
| 6439 The result is the Number of the current entry in {history}. | |
| 6440 See |hist-names| for the possible values of {history}. | |
| 6441 If an error occurred, -1 is returned. | |
| 6442 | |
| 6443 Example: > | |
| 6444 :let inp_index = histnr("expr") | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6445 |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6446 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6447 GetHistory()->histnr() |
| 7 | 6448 < |
| 6449 hlexists({name}) *hlexists()* | |
| 23666 | 6450 The result is a Number, which is TRUE if a highlight group |
| 7 | 6451 called {name} exists. This is when the group has been |
| 6452 defined in some way. Not necessarily when highlighting has | |
| 6453 been defined for it, it may also have been used for a syntax | |
| 6454 item. | |
| 6455 *highlight_exists()* | |
| 6456 Obsolete name: highlight_exists(). | |
| 6457 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6458 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6459 GetName()->hlexists() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6460 < |
| 7 | 6461 *hlID()* |
| 6462 hlID({name}) The result is a Number, which is the ID of the highlight group | |
| 6463 with name {name}. When the highlight group doesn't exist, | |
| 6464 zero is returned. | |
| 6465 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
|
6466 group. For example, to get the background color of the |
| 7 | 6467 "Comment" group: > |
| 6468 :echo synIDattr(synIDtrans(hlID("Comment")), "bg") | |
| 6469 < *highlightID()* | |
| 6470 Obsolete name: highlightID(). | |
| 6471 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6472 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6473 GetName()->hlID() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6474 |
| 7 | 6475 hostname() *hostname()* |
| 6476 The result is a String, which is the name of the machine on | |
| 236 | 6477 which Vim is currently running. Machine names greater than |
| 7 | 6478 256 characters long are truncated. |
| 6479 | |
| 6480 iconv({expr}, {from}, {to}) *iconv()* | |
| 6481 The result is a String, which is the text {expr} converted | |
| 6482 from encoding {from} to encoding {to}. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6483 When the conversion completely fails an empty string is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6484 returned. When some characters could not be converted they |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6485 are replaced with "?". |
| 7 | 6486 The encoding names are whatever the iconv() library function |
| 6487 can accept, see ":!man 3 iconv". | |
| 6488 Most conversions require Vim to be compiled with the |+iconv| | |
| 6489 feature. Otherwise only UTF-8 to latin1 conversion and back | |
| 6490 can be done. | |
| 6491 This can be used to display messages with special characters, | |
| 6492 no matter what 'encoding' is set to. Write the message in | |
| 6493 UTF-8 and use: > | |
| 6494 echo iconv(utf8_str, "utf-8", &enc) | |
| 6495 < Note that Vim uses UTF-8 for all Unicode encodings, conversion | |
| 6496 from/to UCS-2 is automatically changed to use UTF-8. You | |
| 6497 cannot use UCS-2 in a string anyway, because of the NUL bytes. | |
| 6498 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6499 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6500 GetText()->iconv('latin1', 'utf-8') |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6501 < |
| 7 | 6502 *indent()* |
| 6503 indent({lnum}) The result is a Number, which is indent of line {lnum} in the | |
| 6504 current buffer. The indent is counted in spaces, the value | |
| 6505 of 'tabstop' is relevant. {lnum} is used just like in | |
| 6506 |getline()|. | |
| 6507 When {lnum} is invalid -1 is returned. | |
| 6508 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6509 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6510 GetLnum()->indent() |
| 79 | 6511 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6512 index({object}, {expr} [, {start} [, {ic}]]) *index()* |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6513 If {object} is a |List| return the lowest index where the item |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6514 has a value equal to {expr}. There is no automatic |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6515 conversion, so the String "4" is different from the Number 4. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6516 And the number 4 is different from the Float 4.0. The value |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6517 of 'ignorecase' is not used here, case always matters. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6518 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6519 If {object} is |Blob| return the lowest index where the byte |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6520 value is equal to {expr}. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6521 |
| 153 | 6522 If {start} is given then start looking at the item with index |
| 6523 {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
|
6524 When {ic} is given and it is |TRUE|, ignore case. Otherwise |
| 79 | 6525 case must match. |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6526 -1 is returned when {expr} is not found in {object}. |
| 79 | 6527 Example: > |
| 6528 :let idx = index(words, "the") | |
| 87 | 6529 :if index(numbers, 123) >= 0 |
| 79 | 6530 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6531 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6532 GetObject()->index(what) |
| 79 | 6533 |
| 531 | 6534 input({prompt} [, {text} [, {completion}]]) *input()* |
| 7 | 6535 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
|
6536 the command-line. The {prompt} argument is either a prompt |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6537 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
|
6538 in the prompt to start a new line. |
| 531 | 6539 The highlighting set with |:echohl| is used for the prompt. |
| 6540 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
|
6541 editing commands and mappings. There is a separate history |
| 531 | 6542 for lines typed for input(). |
| 6543 Example: > | |
| 6544 :if input("Coffee or beer? ") == "beer" | |
| 6545 : echo "Cheers!" | |
| 6546 :endif | |
| 6547 < | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6548 If the optional {text} argument is present and not empty, this |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6549 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
|
6550 Example: > |
| 531 | 6551 :let color = input("Color? ", "white") |
| 6552 | |
| 6553 < The optional {completion} argument specifies the type of | |
| 6554 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
|
6555 not performed. The supported completion types are the same as |
| 531 | 6556 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
|
6557 "-complete=" argument. Refer to |:command-completion| for |
| 531 | 6558 more information. Example: > |
| 6559 let fname = input("File: ", "", "file") | |
| 6560 < | |
| 6561 NOTE: This function must not be used in a startup file, for | |
| 6562 the versions that only run in GUI mode (e.g., the Win32 GUI). | |
| 7 | 6563 Note: When input() is called from within a mapping it will |
| 6564 consume remaining characters from that mapping, because a | |
| 6565 mapping is handled like the characters were typed. | |
| 6566 Use |inputsave()| before input() and |inputrestore()| | |
| 6567 after input() to avoid that. Another solution is to avoid | |
| 6568 that further characters follow in the mapping, e.g., by using | |
| 6569 |:execute| or |:normal|. | |
| 6570 | |
| 531 | 6571 Example with a mapping: > |
| 7 | 6572 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR> |
| 6573 :function GetFoo() | |
| 6574 : call inputsave() | |
| 6575 : let g:Foo = input("enter search pattern: ") | |
| 6576 : call inputrestore() | |
| 6577 :endfunction | |
| 6578 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6579 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6580 GetPrompt()->input() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6581 |
| 7 | 6582 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6583 Like |input()|, but when the GUI is running and text dialogs |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6584 are supported, a dialog window pops up to input the text. |
| 7 | 6585 Example: > |
| 3875 | 6586 :let n = inputdialog("value for shiftwidth", shiftwidth()) |
| 6587 :if n != "" | |
| 6588 : let &sw = n | |
| 6589 :endif | |
| 7 | 6590 < When the dialog is cancelled {cancelreturn} is returned. When |
| 6591 omitted an empty string is returned. | |
| 6592 Hitting <Enter> works like pressing the OK button. Hitting | |
| 6593 <Esc> works like pressing the Cancel button. | |
| 531 | 6594 NOTE: Command-line completion is not supported. |
| 7 | 6595 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6596 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6597 GetPrompt()->inputdialog() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6598 |
| 519 | 6599 inputlist({textlist}) *inputlist()* |
| 819 | 6600 {textlist} must be a |List| of strings. This |List| is |
| 6601 displayed, one string per line. The user will be prompted to | |
| 6602 enter a number, which is returned. | |
| 519 | 6603 The user can also select an item by clicking on it with the |
| 20856 | 6604 mouse, if the mouse is enabled in the command line ('mouse' is |
| 6605 "a" or includes "c"). For the first string 0 is returned. | |
| 6606 When clicking above the first item a negative number is | |
| 6607 returned. When clicking on the prompt one more than the | |
| 6608 length of {textlist} is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6609 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
|
6610 it won't work. It's a good idea to put the entry number at |
| 1156 | 6611 the start of the string. And put a prompt in the first item. |
| 6612 Example: > | |
| 519 | 6613 let color = inputlist(['Select color:', '1. red', |
| 6614 \ '2. green', '3. blue']) | |
| 6615 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6616 < Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6617 GetChoices()->inputlist() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6618 |
| 7 | 6619 inputrestore() *inputrestore()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6620 Restore typeahead that was saved with a previous |inputsave()|. |
| 7 | 6621 Should be called the same number of times inputsave() is |
| 6622 called. Calling it more often is harmless though. | |
| 23666 | 6623 Returns TRUE when there is nothing to restore, FALSE otherwise. |
| 7 | 6624 |
| 6625 inputsave() *inputsave()* | |
| 6626 Preserve typeahead (also from mappings) and clear it, so that | |
| 6627 a following prompt gets input from the user. Should be | |
| 6628 followed by a matching inputrestore() after the prompt. Can | |
| 6629 be used several times, in which case there must be just as | |
| 6630 many inputrestore() calls. | |
| 23666 | 6631 Returns TRUE when out of memory, FALSE otherwise. |
| 7 | 6632 |
| 6633 inputsecret({prompt} [, {text}]) *inputsecret()* | |
| 6634 This function acts much like the |input()| function with but | |
| 6635 two exceptions: | |
| 6636 a) the user's response will be displayed as a sequence of | |
| 6637 asterisks ("*") thereby keeping the entry secret, and | |
| 6638 b) the user's response will not be recorded on the input | |
| 6639 |history| stack. | |
| 6640 The result is a String, which is whatever the user actually | |
| 6641 typed on the command-line in response to the issued prompt. | |
| 531 | 6642 NOTE: Command-line completion is not supported. |
| 7 | 6643 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6644 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6645 GetPrompt()->inputsecret() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6646 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6647 insert({object}, {item} [, {idx}]) *insert()* |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6648 When {object} is a |List| or a |Blob| insert {item} at the start |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6649 of it. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6650 |
| 55 | 6651 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
|
6652 {idx}. If {idx} is zero it goes before the first item, just |
| 55 | 6653 like omitting {idx}. A negative {idx} is also possible, see |
| 6654 |list-index|. -1 inserts just before the last item. | |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6655 |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
6656 Returns the resulting |List| or |Blob|. Examples: > |
| 55 | 6657 :let mylist = insert([2, 3, 5], 1) |
| 6658 :call insert(mylist, 4, -1) | |
| 6659 :call insert(mylist, 6, len(mylist)) | |
| 82 | 6660 < The last example can be done simpler with |add()|. |
| 685 | 6661 Note that when {item} is a |List| it is inserted as a single |
| 692 | 6662 item. Use |extend()| to concatenate |Lists|. |
| 55 | 6663 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6664 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6665 mylist->insert(item) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6666 |
|
18699
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6667 interrupt() *interrupt()* |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6668 Interrupt script execution. It works more or less like the |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6669 user typing CTRL-C, most commands won't execute and control |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6670 returns to the user. This is useful to abort execution |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6671 from lower down, e.g. in an autocommand. Example: > |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6672 :function s:check_typoname(file) |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6673 : if fnamemodify(a:file, ':t') == '[' |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6674 : echomsg 'Maybe typo' |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6675 : call interrupt() |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6676 : endif |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6677 :endfunction |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6678 :au BufWritePre * call s:check_typoname(expand('<amatch>')) |
|
1febd1aa9930
patch 8.1.2341: not so easy to interrupt a script programatically
Bram Moolenaar <Bram@vim.org>
parents:
18669
diff
changeset
|
6679 |
| 3214 | 6680 invert({expr}) *invert()* |
| 6681 Bitwise invert. The argument is converted to a number. A | |
| 6682 List, Dict or Float argument causes an error. Example: > | |
| 6683 :let bits = invert(bits) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
6684 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
6685 :let bits = bits->invert() |
| 3214 | 6686 |
| 7 | 6687 isdirectory({directory}) *isdirectory()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6688 The result is a Number, which is |TRUE| when a directory |
| 7 | 6689 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
|
6690 exist, or isn't a directory, the result is |FALSE|. {directory} |
| 7 | 6691 is any expression, which is used as a String. |
| 6692 | |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6693 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6694 GetName()->isdirectory() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6695 |
|
16213
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6696 isinf({expr}) *isinf()* |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6697 Return 1 if {expr} is a positive infinity, or -1 a negative |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6698 infinity, otherwise 0. > |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6699 :echo isinf(1.0 / 0.0) |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6700 < 1 > |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6701 :echo isinf(-1.0 / 0.0) |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6702 < -1 |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6703 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6704 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6705 Compute()->isinf() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6706 < |
|
16213
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6707 {only available when compiled with the |+float| feature} |
|
2c33b119ba92
patch 8.1.1111: it is not easy to check for infinity
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
6708 |
| 819 | 6709 islocked({expr}) *islocked()* *E786* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6710 The result is a Number, which is |TRUE| when {expr} is the |
| 148 | 6711 name of a locked variable. |
| 685 | 6712 {expr} must be the name of a variable, |List| item or |
| 6713 |Dictionary| entry, not the variable itself! Example: > | |
| 148 | 6714 :let alist = [0, ['a', 'b'], 2, 3] |
| 6715 :lockvar 1 alist | |
| 6716 :echo islocked('alist') " 1 | |
| 6717 :echo islocked('alist[1]') " 0 | |
| 6718 | |
| 6719 < When {expr} is a variable that does not exist you get an error | |
| 843 | 6720 message. Use |exists()| to check for existence. |
| 148 | 6721 |
|
17914
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6722 Can also be used as a |method|: > |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6723 GetName()->islocked() |
|
af3d441845cd
patch 8.1.1953: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17912
diff
changeset
|
6724 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
6725 isnan({expr}) *isnan()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
6726 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
|
6727 echo isnan(0.0 / 0.0) |
|
16219
bd49e1656c72
patch 8.1.1114: confusing overloaded operator "." for string concatenation
Bram Moolenaar <Bram@vim.org>
parents:
16213
diff
changeset
|
6728 < 1 |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
6729 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6730 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6731 Compute()->isnan() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
6732 < |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8218
diff
changeset
|
6733 {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
|
6734 |
| 140 | 6735 items({dict}) *items()* |
| 685 | 6736 Return a |List| with all the key-value pairs of {dict}. Each |
| 6737 |List| item is a list with two items: the key of a {dict} | |
| 6738 entry and the value of this entry. The |List| is in arbitrary | |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6739 order. Also see |keys()| and |values()|. |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6740 Example: > |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6741 for [key, value] in items(mydict) |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6742 echo key . ': ' . value |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6743 endfor |
| 140 | 6744 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6745 < Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6746 mydict->items() |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
6747 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
6748 job_ functions are documented here: |job-functions-details| |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
6749 |
|
7957
b74549818500
commit https://github.com/vim/vim/commit/835dc636a5350f610b62f110227d2363b5b2880a
Christian Brabandt <cb@256bit.org>
parents:
7935
diff
changeset
|
6750 |
| 95 | 6751 join({list} [, {sep}]) *join()* |
| 6752 Join the items in {list} together into one String. | |
| 6753 When {sep} is specified it is put in between the items. If | |
| 6754 {sep} is omitted a single space is used. | |
| 6755 Note that {sep} is not added at the end. You might want to | |
| 6756 add it there too: > | |
| 6757 let lines = join(mylist, "\n") . "\n" | |
| 692 | 6758 < String items are used as-is. |Lists| and |Dictionaries| are |
| 95 | 6759 converted into a string like with |string()|. |
| 6760 The opposite function is |split()|. | |
| 6761 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6762 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6763 mylist->join() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6764 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6765 js_decode({string}) *js_decode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6766 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
|
6767 - 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
|
6768 - 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
|
6769 - 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
|
6770 result in v:none items. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6771 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6772 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6773 ReadObject()->js_decode() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6774 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6775 js_encode({expr}) *js_encode()* |
|
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6776 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
|
6777 - 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
|
6778 - 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
|
6779 commas. |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6780 For example, the Vim object: |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6781 [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
|
6782 Will be encoded as: |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6783 [1,,{one:1},,] ~ |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6784 While json_encode() would produce: |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6785 [1,null,{"one":1},null] ~ |
|
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6786 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
|
6787 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
|
6788 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6789 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6790 GetObject()->js_encode() |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6791 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6792 json_decode({string}) *json_decode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6793 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
|
6794 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
|
6795 JSON and Vim values. |
|
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6796 The decoding is permissive: |
| 11347 | 6797 - A trailing comma in an array and object is ignored, e.g. |
| 6798 "[1, 2, ]" is the same as "[1, 2]". | |
| 15512 | 6799 - Integer keys are accepted in objects, e.g. {1:2} is the |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6800 same as {"1":2}. |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6801 - More floating point numbers are recognized, e.g. "1." for |
| 11347 | 6802 "1.0", or "001.2" for "1.2". Special floating point values |
|
15446
8ac454818352
patch 8.1.0731: JS encoding does not handle negative infinity
Bram Moolenaar <Bram@vim.org>
parents:
15424
diff
changeset
|
6803 "Infinity", "-Infinity" and "NaN" (capitalization ignored) |
|
8ac454818352
patch 8.1.0731: JS encoding does not handle negative infinity
Bram Moolenaar <Bram@vim.org>
parents:
15424
diff
changeset
|
6804 are accepted. |
| 11347 | 6805 - Leading zeroes in integer numbers are ignored, e.g. "012" |
| 6806 for "12" or "-012" for "-12". | |
| 6807 - Capitalization is ignored in literal names null, true or | |
| 6808 false, e.g. "NULL" for "null", "True" for "true". | |
| 6809 - Control characters U+0000 through U+001F which are not | |
| 6810 escaped in strings are accepted, e.g. " " (tab | |
| 6811 character in string) for "\t". | |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6812 - An empty JSON expression or made of only spaces is accepted |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6813 and results in v:none. |
| 11347 | 6814 - Backslash in an invalid 2-character sequence escape is |
| 6815 ignored, e.g. "\a" is decoded as "a". | |
| 6816 - A correct surrogate pair in JSON strings should normally be | |
| 6817 a 12 character sequence such as "\uD834\uDD1E", but | |
| 6818 json_decode() silently accepts truncated surrogate pairs | |
| 6819 such as "\uD834" or "\uD834\u" | |
| 6820 *E938* | |
| 6821 A duplicate key in an object, valid in rfc7159, is not | |
| 6822 accepted by json_decode() as the result must be a valid Vim | |
| 6823 type, e.g. this fails: {"a":"b", "a":"c"} | |
| 6824 | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6825 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6826 ReadObject()->json_decode() |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6827 |
|
8019
d685893d852e
commit https://github.com/vim/vim/commit/7823a3bd2eed6ff9e544d201de96710bd5344aaf
Christian Brabandt <cb@256bit.org>
parents:
7992
diff
changeset
|
6828 json_encode({expr}) *json_encode()* |
|
7742
5f6f35a3cb12
commit https://github.com/vim/vim/commit/705ada1aff27ecd9c47c690df817d043c2ceb5e2
Christian Brabandt <cb@256bit.org>
parents:
7712
diff
changeset
|
6829 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
|
6830 The encoding is specified in: |
|
7782
3a99194bd187
commit https://github.com/vim/vim/commit/009d84a34f3678ec93921bee3bc05be2fd606264
Christian Brabandt <cb@256bit.org>
parents:
7742
diff
changeset
|
6831 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
|
6832 Vim values are converted as follows: |
| 15512 | 6833 |Number| decimal number |
| 6834 |Float| floating point number | |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6835 Float nan "NaN" |
|
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6836 Float inf "Infinity" |
|
15446
8ac454818352
patch 8.1.0731: JS encoding does not handle negative infinity
Bram Moolenaar <Bram@vim.org>
parents:
15424
diff
changeset
|
6837 Float -inf "-Infinity" |
| 15512 | 6838 |String| in double quotes (possibly null) |
| 6839 |Funcref| not possible, error | |
| 6840 |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
|
6841 used recursively: [] |
| 15512 | 6842 |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
|
6843 used recursively: {} |
| 15512 | 6844 |Blob| as an array of the individual bytes |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6845 v:false "false" |
|
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6846 v:true "true" |
|
7967
45ea5ebf3a98
commit https://github.com/vim/vim/commit/595e64e259faefb330866852e1b9f6168544572a
Christian Brabandt <cb@256bit.org>
parents:
7957
diff
changeset
|
6847 v:none "null" |
|
7712
bce3b5ddb393
commit https://github.com/vim/vim/commit/520e1e41f35b063ede63b41738c82d6636e78c34
Christian Brabandt <cb@256bit.org>
parents:
7707
diff
changeset
|
6848 v:null "null" |
|
8275
ff900e499f79
commit https://github.com/vim/vim/commit/7ce686c990ea8c490d16be7f1c6bd95eb48816f9
Christian Brabandt <cb@256bit.org>
parents:
8251
diff
changeset
|
6849 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
|
6850 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
|
6851 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
|
6852 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6853 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6854 GetObject()->json_encode() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6855 |
| 99 | 6856 keys({dict}) *keys()* |
| 685 | 6857 Return a |List| with all the keys of {dict}. The |List| is in |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
6858 arbitrary order. Also see |items()| and |values()|. |
| 99 | 6859 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6860 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6861 mydict->keys() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6862 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6863 < *len()* *E701* |
| 55 | 6864 len({expr}) The result is a Number, which is the length of the argument. |
| 6865 When {expr} is a String or a Number the length in bytes is | |
| 6866 used, as with |strlen()|. | |
| 685 | 6867 When {expr} is a |List| the number of items in the |List| is |
| 55 | 6868 returned. |
| 15512 | 6869 When {expr} is a |Blob| the number of bytes is returned. |
| 685 | 6870 When {expr} is a |Dictionary| the number of entries in the |
| 6871 |Dictionary| is returned. | |
| 55 | 6872 Otherwise an error is given. |
| 6873 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6874 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6875 mylist->len() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6876 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
6877 < *libcall()* *E364* *E368* |
| 7 | 6878 libcall({libname}, {funcname}, {argument}) |
| 6879 Call function {funcname} in the run-time library {libname} | |
| 6880 with single argument {argument}. | |
| 6881 This is useful to call functions in a library that you | |
| 6882 especially made to be used with Vim. Since only one argument | |
| 6883 is possible, calling standard library functions is rather | |
| 6884 limited. | |
| 6885 The result is the String returned by the function. If the | |
| 6886 function returns NULL, this will appear as an empty string "" | |
| 6887 to Vim. | |
| 6888 If the function returns a number, use libcallnr()! | |
| 6889 If {argument} is a number, it is passed to the function as an | |
| 6890 int; if {argument} is a string, it is passed as a | |
| 6891 null-terminated string. | |
| 6892 This function will fail in |restricted-mode|. | |
| 6893 | |
| 6894 libcall() allows you to write your own 'plug-in' extensions to | |
| 6895 Vim without having to recompile the program. It is NOT a | |
| 6896 means to call system functions! If you try to do so Vim will | |
| 6897 very probably crash. | |
| 6898 | |
| 6899 For Win32, the functions you write must be placed in a DLL | |
| 6900 and use the normal C calling convention (NOT Pascal which is | |
| 6901 used in Windows System DLLs). The function must take exactly | |
| 6902 one parameter, either a character pointer or a long integer, | |
| 6903 and must return a character pointer or NULL. The character | |
| 6904 pointer returned must point to memory that will remain valid | |
| 6905 after the function has returned (e.g. in static data in the | |
| 6906 DLL). If it points to allocated memory, that memory will | |
| 6907 leak away. Using a static buffer in the function should work, | |
| 6908 it's then freed when the DLL is unloaded. | |
| 6909 | |
| 6910 WARNING: If the function returns a non-valid pointer, Vim may | |
| 1621 | 6911 crash! This also happens if the function returns a number, |
| 7 | 6912 because Vim thinks it's a pointer. |
| 6913 For Win32 systems, {libname} should be the filename of the DLL | |
| 6914 without the ".DLL" suffix. A full path is only required if | |
| 6915 the DLL is not in the usual places. | |
| 6916 For Unix: When compiling your own plugins, remember that the | |
| 6917 object code must be compiled as position-independent ('PIC'). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6918 {only in Win32 and some Unix versions, when the |+libcall| |
| 7 | 6919 feature is present} |
| 6920 Examples: > | |
| 6921 :echo libcall("libc.so", "getenv", "HOME") | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6922 |
| 18343 | 6923 < Can also be used as a |method|, the base is passed as the |
| 6924 third argument: > | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6925 GetValue()->libcall("libc.so", "getenv") |
| 7 | 6926 < |
| 6927 *libcallnr()* | |
| 6928 libcallnr({libname}, {funcname}, {argument}) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
6929 Just like |libcall()|, but used for a function that returns an |
| 7 | 6930 int instead of a string. |
| 6931 {only in Win32 on some Unix versions, when the |+libcall| | |
| 6932 feature is present} | |
| 1621 | 6933 Examples: > |
| 6934 :echo libcallnr("/usr/lib/libc.so", "getpid", "") | |
| 7 | 6935 :call libcallnr("libc.so", "printf", "Hello World!\n") |
| 6936 :call libcallnr("libc.so", "sleep", 10) | |
| 6937 < | |
| 18343 | 6938 Can also be used as a |method|, the base is passed as the |
| 6939 third argument: > | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6940 GetValue()->libcallnr("libc.so", "printf") |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6941 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6942 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6943 line({expr} [, {winid}]) *line()* |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6944 The result is a Number, which is the line number of the file |
| 7 | 6945 position given with {expr}. The accepted positions are: |
| 6946 . the cursor position | |
| 6947 $ the last line in the current buffer | |
| 6948 'x position of mark x (if the mark is not set, 0 is | |
| 6949 returned) | |
|
11313
327a04a762f6
patch 8.0.0542: getpos() can return a negative line number
Christian Brabandt <cb@256bit.org>
parents:
11263
diff
changeset
|
6950 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
|
6951 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
|
6952 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
|
6953 less than "w0" if no lines are visible) |
| 1609 | 6954 v In Visual mode: the start of the Visual area (the |
| 6955 cursor is the end). When not in Visual mode | |
| 6956 returns the cursor position. Differs from |'<| in | |
| 6957 that it's updated right away. | |
| 1156 | 6958 Note that a mark in another file can be used. The line number |
| 6959 then applies to another buffer. | |
| 703 | 6960 To get the column number use |col()|. To get both use |
| 6961 |getpos()|. | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6962 With the optional {winid} argument the values are obtained for |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6963 that window instead of the current window. |
| 7 | 6964 Examples: > |
| 6965 line(".") line number of the cursor | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
6966 line(".", winid) idem, in window "winid" |
| 7 | 6967 line("'t") line number of mark t |
| 6968 line("'" . marker) line number of mark marker | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6969 < |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6970 To jump to the last known position when opening a file see |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
6971 |last-position-jump|. |
| 9 | 6972 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6973 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6974 GetValue()->line() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6975 |
| 7 | 6976 line2byte({lnum}) *line2byte()* |
| 6977 Return the byte count from the start of the buffer for line | |
| 6978 {lnum}. This includes the end-of-line character, depending on | |
| 6979 the 'fileformat' option for the current buffer. The first | |
| 3237 | 6980 line returns 1. 'encoding' matters, 'fileencoding' is ignored. |
| 7 | 6981 This can also be used to get the byte count for the line just |
| 6982 below the last line: > | |
| 6983 line2byte(line("$") + 1) | |
| 3237 | 6984 < This is the buffer size plus one. If 'fileencoding' is empty |
| 6985 it is the file size plus one. | |
| 7 | 6986 When {lnum} is invalid, or the |+byte_offset| feature has been |
| 6987 disabled at compile time, -1 is returned. | |
| 6988 Also see |byte2line()|, |go| and |:goto|. | |
| 6989 | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6990 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6991 GetLnum()->line2byte() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
6992 |
| 7 | 6993 lispindent({lnum}) *lispindent()* |
| 6994 Get the amount of indent for line {lnum} according the lisp | |
| 6995 indenting rules, as with 'lisp'. | |
| 6996 The indent is counted in spaces, the value of 'tabstop' is | |
| 6997 relevant. {lnum} is used just like in |getline()|. | |
| 6998 When {lnum} is invalid or Vim was not compiled the | |
| 6999 |+lispindent| feature, -1 is returned. | |
| 7000 | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7001 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7002 GetLnum()->lispindent() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7003 |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7004 list2str({list} [, {utf8}]) *list2str()* |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7005 Convert each number in {list} to a character string can |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7006 concatenate them all. Examples: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7007 list2str([32]) returns " " |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7008 list2str([65, 66, 67]) returns "ABC" |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7009 < The same can be done (slowly) with: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7010 join(map(list, {nr, val -> nr2char(val)}), '') |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7011 < |str2list()| does the opposite. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7012 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7013 When {utf8} is omitted or zero, the current 'encoding' is used. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7014 With {utf8} is 1, always return utf-8 characters. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7015 With utf-8 composing characters work as expected: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7016 list2str([97, 769]) returns "á" |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
7017 < |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7018 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7019 GetList()->list2str() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7020 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7021 listener_add({callback} [, {buf}]) *listener_add()* |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7022 Add a callback function that will be invoked when changes have |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7023 been made to buffer {buf}. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7024 {buf} refers to a buffer name or number. For the accepted |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7025 values, see |bufname()|. When {buf} is omitted the current |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7026 buffer is used. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7027 Returns a unique ID that can be passed to |listener_remove()|. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7028 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
7029 The {callback} is invoked with five arguments: |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7030 a:bufnr the buffer that was changed |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7031 a:start first changed line number |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7032 a:end first line number below the change |
| 18456 | 7033 a:added number of lines added, negative if lines were |
| 7034 deleted | |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7035 a:changes a List of items with details about the changes |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7036 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7037 Example: > |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7038 func Listener(bufnr, start, end, added, changes) |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7039 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed' |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7040 endfunc |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7041 call listener_add('Listener', bufnr) |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7042 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7043 < The List cannot be changed. Each item in a:changes is a |
|
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
7044 dictionary with these entries: |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7045 lnum the first line number of the change |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7046 end the first line below the change |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7047 added number of lines added; negative if lines were |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7048 deleted |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7049 col first column in "lnum" that was affected by |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7050 the change; one if unknown or the whole line |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7051 was affected; this is a byte index, first |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7052 character has a value of one. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7053 When lines are inserted the values are: |
| 16808 | 7054 lnum line above which the new line is added |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7055 end equal to "lnum" |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7056 added number of lines inserted |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7057 col 1 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7058 When lines are deleted the values are: |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7059 lnum the first deleted line |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7060 end the line below the first deleted line, before |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7061 the deletion was done |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7062 added negative, number of lines deleted |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7063 col 1 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7064 When lines are changed: |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7065 lnum the first changed line |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7066 end the line below the last changed line |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7067 added 0 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7068 col first column with a change or 1 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7069 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7070 The entries are in the order the changes were made, thus the |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7071 most recent change is at the end. The line numbers are valid |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7072 when the callback is invoked, but later changes may make them |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7073 invalid, thus keeping a copy for later might not work. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7074 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7075 The {callback} is invoked just before the screen is updated, |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7076 when |listener_flush()| is called or when a change is being |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7077 made that changes the line count in a way it causes a line |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7078 number in the list of changes to become invalid. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7079 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7080 The {callback} is invoked with the text locked, see |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7081 |textlock|. If you do need to make changes to the buffer, use |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7082 a timer to do this later |timer_start()|. |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7083 |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7084 The {callback} is not invoked when the buffer is first loaded. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7085 Use the |BufReadPost| autocmd event to handle the initial text |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7086 of a buffer. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7087 The {callback} is also not invoked when the buffer is |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7088 unloaded, use the |BufUnload| autocmd event for that. |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7089 |
| 18343 | 7090 Can also be used as a |method|, the base is passed as the |
| 7091 second argument: > | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7092 GetBuffer()->listener_add(callback) |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7093 |
|
16660
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7094 listener_flush([{buf}]) *listener_flush()* |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7095 Invoke listener callbacks for buffer {buf}. If there are no |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7096 pending changes then no callbacks are invoked. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7097 |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7098 {buf} refers to a buffer name or number. For the accepted |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7099 values, see |bufname()|. When {buf} is omitted the current |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7100 buffer is used. |
|
04c2614af21c
patch 8.1.1332: cannot flush listeners without redrawing, mix of changes
Bram Moolenaar <Bram@vim.org>
parents:
16648
diff
changeset
|
7101 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7102 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7103 GetBuffer()->listener_flush() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7104 |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7105 listener_remove({id}) *listener_remove()* |
|
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7106 Remove a listener previously added with listener_add(). |
| 23666 | 7107 Returns FALSE when {id} could not be found, TRUE when {id} was |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
7108 removed. |
|
16638
4790302965fc
patch 8.1.1321: no docs or tests for listener functions
Bram Moolenaar <Bram@vim.org>
parents:
16615
diff
changeset
|
7109 |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7110 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7111 GetListenerId()->listener_remove() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7112 |
| 7 | 7113 localtime() *localtime()* |
| 7114 Return the current time, measured as seconds since 1st Jan | |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
7115 1970. See also |strftime()|, |strptime()| and |getftime()|. |
| 7 | 7116 |
| 95 | 7117 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7118 log({expr}) *log()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
7119 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
|
7120 {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
|
7121 (0, inf]. |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7122 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7123 :echo log(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7124 < 2.302585 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7125 :echo log(exp(5)) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7126 < 5.0 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7127 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7128 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7129 Compute()->log() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7130 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
7131 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7132 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
7133 |
| 1621 | 7134 log10({expr}) *log10()* |
| 7135 Return the logarithm of Float {expr} to base 10 as a |Float|. | |
| 7136 {expr} must evaluate to a |Float| or a |Number|. | |
| 7137 Examples: > | |
| 7138 :echo log10(1000) | |
| 7139 < 3.0 > | |
| 7140 :echo log10(0.01) | |
| 7141 < -2.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7142 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7143 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7144 Compute()->log10() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7145 < |
| 1621 | 7146 {only available when compiled with the |+float| feature} |
| 12785 | 7147 |
| 7148 luaeval({expr} [, {expr}]) *luaeval()* | |
| 7149 Evaluate Lua expression {expr} and return its result converted | |
| 7150 to Vim data structures. Second {expr} may hold additional | |
| 3492 | 7151 argument accessible as _A inside first {expr}. |
| 7152 Strings are returned as they are. | |
| 7153 Boolean objects are converted to numbers. | |
| 12785 | 7154 Numbers are converted to |Float| values if vim was compiled |
| 3492 | 7155 with |+float| and to numbers otherwise. |
| 12785 | 7156 Dictionaries and lists obtained by vim.eval() are returned |
| 3492 | 7157 as-is. |
| 7158 Other objects are returned as zero without any errors. | |
| 7159 See |lua-luaeval| for more details. | |
|
17916
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7160 |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7161 Can also be used as a |method|: > |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7162 GetExpr()->luaeval() |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7163 |
|
2e53305f2239
patch 8.1.1954: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17914
diff
changeset
|
7164 < {only available when compiled with the |+lua| feature} |
| 3492 | 7165 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7166 map({expr1}, {expr2}) *map()* |
|
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7167 {expr1} must be a |List|, |Blob| or |Dictionary|. |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7168 Replace each item in {expr1} with the result of evaluating |
|
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7169 {expr2}. For a |Blob| each byte is replaced. |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7170 If the item type changes you may want to use |mapnew()| to |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7171 create a new List or Dictionary. This is required when using |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7172 Vim9 script. |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7173 |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7174 {expr2} must be a |string| or |Funcref|. |
| 12785 | 7175 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7176 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
|
7177 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
|
7178 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
|
7179 the current item. |
| 102 | 7180 Example: > |
| 7181 :call map(mylist, '"> " . v:val . " <"') | |
| 95 | 7182 < This puts "> " before and " <" after each item in "mylist". |
| 102 | 7183 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7184 Note that {expr2} is the result of an expression and is then |
| 102 | 7185 used as an expression again. Often it is good to use a |
| 158 | 7186 |literal-string| to avoid having to double backslashes. You |
| 7187 still have to double ' quotes | |
| 102 | 7188 |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7189 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
|
7190 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
|
7191 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
|
7192 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
|
7193 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
|
7194 func KeyValue(key, val) |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7195 return a:key . '-' . a:val |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7196 endfunc |
|
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7197 call map(myDict, function('KeyValue')) |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
7198 < 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
|
7199 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
|
7200 < 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
|
7201 call map(myDict, {key -> 'item: ' . key}) |
| 17667 | 7202 < If you do not use "key" you can use a short name: > |
| 7203 call map(myDict, {_, val -> 'item: ' . val}) | |
|
9416
cbf052ccb120
commit https://github.com/vim/vim/commit/b33c7eb5b813cb631b2b0ca5c4029e1788a09bde
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
7204 < |
| 685 | 7205 The operation is done in-place. If you want a |List| or |
| 7206 |Dictionary| to remain unmodified make a copy first: > | |
| 3682 | 7207 :let tlist = map(copy(mylist), ' v:val . "\t"') |
| 102 | 7208 |
|
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7209 < Returns {expr1}, the |List|, |Blob| or |Dictionary| that was |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7210 filtered. When an error is encountered while evaluating |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7211 {expr2} no further items in {expr1} are processed. When |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7212 {expr2} is a Funcref errors inside a function are ignored, |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7213 unless it was defined with the "abort" flag. |
| 95 | 7214 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7215 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7216 mylist->map(expr2) |
| 95 | 7217 |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7218 |
| 12785 | 7219 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* |
| 2610 | 7220 When {dict} is omitted or zero: Return the rhs of mapping |
| 7221 {name} in mode {mode}. The returned String has special | |
| 7222 characters translated like in the output of the ":map" command | |
| 7223 listing. | |
| 12785 | 7224 |
| 2610 | 7225 When there is no mapping for {name}, an empty String is |
| 14006 | 7226 returned. When the mapping for {name} is empty, then "<Nop>" |
| 7227 is returned. | |
| 2610 | 7228 |
| 7229 The {name} can have special key names, like in the ":map" | |
| 7230 command. | |
| 7231 | |
| 644 | 7232 {mode} can be one of these strings: |
| 7 | 7233 "n" Normal |
| 2610 | 7234 "v" Visual (including Select) |
| 7 | 7235 "o" Operator-pending |
| 7236 "i" Insert | |
| 7237 "c" Cmd-line | |
| 2610 | 7238 "s" Select |
| 7239 "x" Visual | |
| 7 | 7240 "l" langmap |language-mapping| |
| 12499 | 7241 "t" Terminal-Job |
| 7 | 7242 "" Normal, Visual and Operator-pending |
| 644 | 7243 When {mode} is omitted, the modes for "" are used. |
| 2610 | 7244 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
7245 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 7246 instead of mappings. |
| 2610 | 7247 |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
7248 When {dict} is there and it is |TRUE| return a dictionary |
| 2610 | 7249 containing all the information of the mapping with the |
| 7250 following items: | |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7251 "lhs" The {lhs} of the mapping as it would be typed |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7252 "lhsraw" The {lhs} of the mapping as raw bytes |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7253 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7254 form, only present when it differs from "lhsraw" |
| 2610 | 7255 "rhs" The {rhs} of the mapping as typed. |
| 7256 "silent" 1 for a |:map-silent| mapping, else 0. | |
| 2625 | 7257 "noremap" 1 if the {rhs} of the mapping is not remappable. |
|
19870
658248b68f7c
patch 8.2.0491: cannot recognize a <script> mapping using maparg()
Bram Moolenaar <Bram@vim.org>
parents:
19813
diff
changeset
|
7258 "script" 1 if mapping was defined with <script>. |
| 2610 | 7259 "expr" 1 for an expression mapping (|:map-<expr>|). |
| 7260 "buffer" 1 for a buffer local mapping (|:map-local|). | |
| 7261 "mode" Modes for which the mapping is defined. In | |
| 7262 addition to the modes mentioned above, these | |
| 7263 characters will be used: | |
| 7264 " " Normal, Visual and Operator-pending | |
| 7265 "!" Insert and Commandline mode | |
| 2642 | 7266 (|mapmode-ic|) |
| 2625 | 7267 "sid" The script local ID, used for <sid> mappings |
| 7268 (|<SID>|). | |
|
14700
0a3b9ecf7cb8
patch 8.1.0362: cannot get the script line number when executing a function
Christian Brabandt <cb@256bit.org>
parents:
14695
diff
changeset
|
7269 "lnum" The line number in "sid", zero if unknown. |
| 5555 | 7270 "nowait" Do not wait for other, longer mappings. |
| 7271 (|:map-<nowait>|). | |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7272 |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7273 The dictionary can be used to restore a mapping with |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7274 |mapset()|. |
| 2610 | 7275 |
| 7 | 7276 The mappings local to the current buffer are checked first, |
| 7277 then the global mappings. | |
| 626 | 7278 This function can be used to map a key even when it's already |
| 7279 mapped, and have it do the original mapping too. Sketch: > | |
| 7280 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n') | |
| 7281 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7282 < Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7283 GetKey()->maparg('n') |
| 7 | 7284 |
| 12785 | 7285 mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* |
| 7 | 7286 Check if there is a mapping that matches with {name} in mode |
| 7287 {mode}. See |maparg()| for {mode} and special names in | |
| 7288 {name}. | |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
7289 When {abbr} is there and it is |TRUE| use abbreviations |
| 782 | 7290 instead of mappings. |
| 7 | 7291 A match happens with a mapping that starts with {name} and |
| 7292 with a mapping which is equal to the start of {name}. | |
| 7293 | |
| 1621 | 7294 matches mapping "a" "ab" "abc" ~ |
| 7 | 7295 mapcheck("a") yes yes yes |
| 7296 mapcheck("abc") yes yes yes | |
| 7297 mapcheck("ax") yes no no | |
| 7298 mapcheck("b") no no no | |
| 7299 | |
| 7300 The difference with maparg() is that mapcheck() finds a | |
| 7301 mapping that matches with {name}, while maparg() only finds a | |
| 7302 mapping for {name} exactly. | |
| 7303 When there is no mapping that starts with {name}, an empty | |
| 14006 | 7304 String is returned. If there is one, the RHS of that mapping |
| 7 | 7305 is returned. If there are several mappings that start with |
| 14006 | 7306 {name}, the RHS of one of them is returned. This will be |
| 7307 "<Nop>" if the RHS is empty. | |
| 7 | 7308 The mappings local to the current buffer are checked first, |
| 7309 then the global mappings. | |
| 7310 This function can be used to check if a mapping can be added | |
| 7311 without being ambiguous. Example: > | |
| 7312 :if mapcheck("_vv") == "" | |
| 7313 : map _vv :set guifont=7x13<CR> | |
| 7314 :endif | |
| 7315 < This avoids adding the "_vv" mapping when there already is a | |
| 7316 mapping for "_v" or for "_vvv". | |
| 7317 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7318 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7319 GetKey()->mapcheck('n') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7320 |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7321 |
|
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7322 mapnew({expr1}, {expr2}) *mapnew()* |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7323 Like |map()| but instead of replacing items in {expr1} a new |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7324 List or Dictionary is created and returned. {expr1} remains |
| 23164 | 7325 unchanged. Items can still be changed by {expr2}, if you |
| 7326 don't want that use |deepcopy()| first. | |
|
22844
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7327 |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7328 |
|
36fc73078bce
patch 8.2.1969: Vim9: map() may change the list or dict item type
Bram Moolenaar <Bram@vim.org>
parents:
22824
diff
changeset
|
7329 mapset({mode}, {abbr}, {dict}) *mapset()* |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7330 Restore a mapping from a dictionary returned by |maparg()|. |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7331 {mode} and {abbr} should be the same as for the call to |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7332 |maparg()|. *E460* |
|
20506
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7333 {mode} is used to define the mode in which the mapping is set, |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7334 not the "mode" entry in {dict}. |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7335 Example for saving and restoring a mapping: > |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7336 let save_map = maparg('K', 'n', 0, 1) |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7337 nnoremap K somethingelse |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7338 ... |
|
aee0b72ca6d6
patch 8.2.0807: cannot easily restore a mapping
Bram Moolenaar <Bram@vim.org>
parents:
20386
diff
changeset
|
7339 call mapset('n', 0, save_map) |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7340 < Note that if you are going to replace a map in several modes, |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7341 e.g. with `:map!`, you need to save the mapping for all of |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
7342 them, since they can differ. |
|
20522
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7343 |
|
729853a754ea
patch 8.2.0815: maparg() does not provide enough information for mapset()
Bram Moolenaar <Bram@vim.org>
parents:
20506
diff
changeset
|
7344 |
| 12785 | 7345 match({expr}, {pat} [, {start} [, {count}]]) *match()* |
| 685 | 7346 When {expr} is a |List| then this returns the index of the |
| 7347 first item where {pat} matches. Each item is used as a | |
| 692 | 7348 String, |Lists| and |Dictionaries| are used as echoed. |
| 14695 | 7349 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7350 Otherwise, {expr} is used as a String. The result is a |
| 95 | 7351 Number, which gives the index (byte offset) in {expr} where |
| 7352 {pat} matches. | |
| 14695 | 7353 |
| 685 | 7354 A match at the first character or |List| item returns zero. |
| 19 | 7355 If there is no match -1 is returned. |
| 14695 | 7356 |
| 2833 | 7357 For getting submatches see |matchlist()|. |
| 19 | 7358 Example: > |
| 95 | 7359 :echo match("testing", "ing") " results in 4 |
| 714 | 7360 :echo match([1, 'x'], '\a') " results in 1 |
| 95 | 7361 < See |string-match| for how {pat} is used. |
| 170 | 7362 *strpbrk()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
7363 Vim doesn't have a strpbrk() function. But you can do: > |
| 170 | 7364 :let sepidx = match(line, '[.,;: \t]') |
| 7365 < *strcasestr()* | |
| 7366 Vim doesn't have a strcasestr() function. But you can add | |
| 7367 "\c" to the pattern to ignore case: > | |
| 7368 :let idx = match(haystack, '\cneedle') | |
| 7369 < | |
| 95 | 7370 If {start} is given, the search starts from byte index |
| 685 | 7371 {start} in a String or item {start} in a |List|. |
| 7 | 7372 The result, however, is still the index counted from the |
| 236 | 7373 first character/item. Example: > |
| 7 | 7374 :echo match("testing", "ing", 2) |
| 7375 < result is again "4". > | |
| 7376 :echo match("testing", "ing", 4) | |
| 7377 < result is again "4". > | |
| 7378 :echo match("testing", "t", 2) | |
| 7379 < result is "3". | |
| 694 | 7380 For a String, if {start} > 0 then it is like the string starts |
| 703 | 7381 {start} bytes later, thus "^" will match at {start}. Except |
| 7382 when {count} is given, then it's like matches before the | |
| 7383 {start} byte are ignored (this is a bit complicated to keep it | |
| 7384 backwards compatible). | |
| 95 | 7385 For a String, if {start} < 0, it will be set to 0. For a list |
| 7386 the index is counted from the end. | |
| 697 | 7387 If {start} is out of range ({start} > strlen({expr}) for a |
| 7388 String or {start} > len({expr}) for a |List|) -1 is returned. | |
| 95 | 7389 |
| 694 | 7390 When {count} is given use the {count}'th match. When a match |
| 697 | 7391 is found in a String the search for the next one starts one |
| 694 | 7392 character further. Thus this example results in 1: > |
| 7393 echo match("testing", "..", 0, 2) | |
| 7394 < In a |List| the search continues in the next item. | |
| 703 | 7395 Note that when {count} is added the way {start} works changes, |
| 7396 see above. | |
| 694 | 7397 |
| 7 | 7398 See |pattern| for the patterns that are accepted. |
| 7399 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
|
7400 the pattern. 'smartcase' is NOT used. The matching is always |
| 7 | 7401 done like 'magic' is set and 'cpoptions' is empty. |
| 19523 | 7402 Note that a match at the start is preferred, thus when the |
| 7403 pattern is using "*" (any number of matches) it tends to find | |
| 7404 zero matches at the start instead of a number of matches | |
| 7405 further down in the text. | |
| 7 | 7406 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7407 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7408 GetList()->match('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7409 < |
|
14407
631344964949
patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents:
14347
diff
changeset
|
7410 *matchadd()* *E798* *E799* *E801* *E957* |
| 12785 | 7411 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) |
| 1326 | 7412 Defines a pattern to be highlighted in the current window (a |
| 7413 "match"). It will be highlighted with {group}. Returns an | |
| 7414 identification number (ID), which can be used to delete the | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7415 match using |matchdelete()|. The ID is bound to the window. |
| 5466 | 7416 Matching is case sensitive and magic, unless case sensitivity |
| 7417 or magicness are explicitly overridden in {pattern}. The | |
| 7418 'magic', 'smartcase' and 'ignorecase' options are not used. | |
|
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6947
diff
changeset
|
7419 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
|
7420 concealed. |
| 1326 | 7421 |
| 7422 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
|
7423 match. A match with a high priority will have its |
| 1326 | 7424 highlighting overrule that of a match with a lower priority. |
| 7425 A priority is specified as an integer (negative numbers are no | |
| 7426 exception). If the {priority} argument is not specified, the | |
| 7427 default priority is 10. The priority of 'hlsearch' is zero, | |
| 7428 hence all matches with a priority greater than zero will | |
| 7429 overrule it. Syntax highlighting (see 'syntax') is a separate | |
| 7430 mechanism, and regardless of the chosen priority a match will | |
| 7431 always overrule syntax highlighting. | |
| 7432 | |
| 7433 The optional {id} argument allows the request for a specific | |
| 7434 match ID. If a specified ID is already taken, an error | |
| 7435 message will appear and the match will not be added. An ID | |
| 7436 is specified as a positive integer (zero excluded). IDs 1, 2 | |
| 7437 and 3 are reserved for |:match|, |:2match| and |:3match|, | |
| 6947 | 7438 respectively. If the {id} argument is not specified or -1, |
| 1326 | 7439 |matchadd()| automatically chooses a free ID. |
| 7440 | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7653
diff
changeset
|
7441 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
|
7442 values. Currently this is used to specify a match specific |
| 6947 | 7443 conceal character that will be shown for |hl-Conceal| |
| 7444 highlighted matches. The dict can have the following members: | |
| 7445 | |
| 7446 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
|
7447 match (only for |hl-Conceal| highlighted |
| 6947 | 7448 matches, see |:syn-cchar|) |
|
14407
631344964949
patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents:
14347
diff
changeset
|
7449 window Instead of the current window use the |
|
631344964949
patch 8.1.0218: cannot add matches to another window
Christian Brabandt <cb@256bit.org>
parents:
14347
diff
changeset
|
7450 window with this number or window ID. |
| 6947 | 7451 |
| 1326 | 7452 The number of matches is not limited, as it is the case with |
| 7453 the |:match| commands. | |
| 7454 | |
| 7455 Example: > | |
| 7456 :highlight MyGroup ctermbg=green guibg=green | |
| 7457 :let m = matchadd("MyGroup", "TODO") | |
| 7458 < Deletion of the pattern: > | |
| 7459 :call matchdelete(m) | |
| 7460 | |
| 7461 < 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
|
7462 available from |getmatches()|. All matches can be deleted in |
| 1326 | 7463 one operation by |clearmatches()|. |
| 819 | 7464 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7465 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7466 GetGroup()->matchadd('TODO') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7467 < |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
7468 *matchaddpos()* |
| 12785 | 7469 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) |
| 5979 | 7470 Same as |matchadd()|, but requires a list of positions {pos} |
| 7471 instead of a pattern. This command is faster than |matchadd()| | |
| 7472 because it does not require to handle regular expressions and | |
| 7473 sets buffer line boundaries to redraw screen. It is supposed | |
| 7474 to be used when fast match additions and deletions are | |
| 7475 required, for example to highlight matching parentheses. | |
| 7476 | |
| 24103 | 7477 {pos} is a list of positions. Each position can be one of |
| 7478 these: | |
| 6007 | 7479 - A number. This whole line will be highlighted. The first |
| 5979 | 7480 line has number 1. |
| 7481 - A list with one number, e.g., [23]. The whole line with this | |
| 7482 number will be highlighted. | |
| 7483 - A list with two numbers, e.g., [23, 11]. The first number is | |
| 6007 | 7484 the line number, the second one is the column number (first |
| 7485 column is 1, the value must correspond to the byte index as | |
| 7486 |col()| would return). The character at this position will | |
| 7487 be highlighted. | |
| 5979 | 7488 - A list with three numbers, e.g., [23, 11, 3]. As above, but |
| 6007 | 7489 the third number gives the length of the highlight in bytes. |
| 12785 | 7490 |
| 24103 | 7491 The maximum number of positions in {pos} is 8. |
| 5979 | 7492 |
| 7493 Example: > | |
| 7494 :highlight MyGroup ctermbg=green guibg=green | |
| 7495 :let m = matchaddpos("MyGroup", [[23, 24], 34]) | |
| 7496 < Deletion of the pattern: > | |
| 7497 :call matchdelete(m) | |
| 7498 | |
| 7499 < Matches added by |matchaddpos()| are returned by | |
| 24103 | 7500 |getmatches()|. |
| 5979 | 7501 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7502 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7503 GetGroup()->matchaddpos([23, 11]) |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7504 |
| 819 | 7505 matcharg({nr}) *matcharg()* |
| 856 | 7506 Selects the {nr} match item, as set with a |:match|, |
| 819 | 7507 |:2match| or |:3match| command. |
| 7508 Return a |List| with two elements: | |
| 7509 The name of the highlight group used | |
| 7510 The pattern used. | |
| 7511 When {nr} is not 1, 2 or 3 returns an empty |List|. | |
| 7512 When there is no match item set returns ['', '']. | |
| 1326 | 7513 This is useful to save and restore a |:match|. |
| 7514 Highlighting matches using the |:match| commands are limited | |
| 7515 to three matches. |matchadd()| does not have this limitation. | |
| 7516 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7517 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7518 GetMatch()->matcharg() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7519 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7520 matchdelete({id} [, {win}) *matchdelete()* *E802* *E803* |
| 1326 | 7521 Deletes a match with ID {id} previously defined by |matchadd()| |
| 1621 | 7522 or one of the |:match| commands. Returns 0 if successful, |
| 1326 | 7523 otherwise -1. See example for |matchadd()|. All matches can |
| 7524 be deleted in one operation by |clearmatches()|. | |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7525 If {win} is specified, use the window with this number or |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7526 window ID instead of the current window. |
| 819 | 7527 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7528 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7529 GetMatch()->matchdelete() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7530 |
| 12785 | 7531 matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7532 Same as |match()|, but return the index of first character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7533 after the match. Example: > |
| 7 | 7534 :echo matchend("testing", "ing") |
| 7535 < results in "7". | |
| 170 | 7536 *strspn()* *strcspn()* |
| 7537 Vim doesn't have a strspn() or strcspn() function, but you can | |
| 7538 do it with matchend(): > | |
| 7539 :let span = matchend(line, '[a-zA-Z]') | |
| 7540 :let span = matchend(line, '[^a-zA-Z]') | |
| 7541 < Except that -1 is returned when there are no matches. | |
| 7542 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7543 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 7544 :echo matchend("testing", "ing", 2) |
| 7545 < results in "7". > | |
| 7546 :echo matchend("testing", "ing", 5) | |
| 7547 < result is "-1". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7548 When {expr} is a |List| the result is equal to |match()|. |
| 7 | 7549 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7550 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7551 GetText()->matchend('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7552 |
|
22232
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7553 |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7554 matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()* |
| 23164 | 7555 If {list} is a list of strings, then returns a |List| with all |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7556 the strings in {list} that fuzzy match {str}. The strings in |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7557 the returned list are sorted based on the matching score. |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7558 |
|
22689
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7559 The optional {dict} argument always supports the following |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7560 items: |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7561 matchseq When this item is present and {str} contains |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7562 multiple words separated by white space, then |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7563 returns only matches that contain the words in |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7564 the given sequence. |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7565 |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7566 If {list} is a list of dictionaries, then the optional {dict} |
|
22689
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7567 argument supports the following additional items: |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7568 key key of the item which is fuzzy matched against |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7569 {str}. The value of this item should be a |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7570 string. |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7571 text_cb |Funcref| that will be called for every item |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7572 in {list} to get the text for fuzzy matching. |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7573 This should accept a dictionary item as the |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7574 argument and return the text for that item to |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7575 use for fuzzy matching. |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7576 |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7577 {str} is treated as a literal string and regular expression |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7578 matching is NOT supported. The maximum supported {str} length |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7579 is 256. |
|
22232
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7580 |
|
22689
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7581 When {str} has multiple words each separated by white space, |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7582 then the list of strings that have all the words is returned. |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7583 |
|
22232
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7584 If there are no matching strings or there is an error, then an |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7585 empty list is returned. If length of {str} is greater than |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7586 256, then returns an empty list. |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7587 |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7588 Example: > |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7589 :echo matchfuzzy(["clay", "crow"], "cay") |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7590 < results in ["clay"]. > |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7591 :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl") |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7592 < results in a list of buffer names fuzzy matching "ndl". > |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7593 :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'}) |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7594 < results in a list of buffer information dicts with buffer |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7595 names fuzzy matching "ndl". > |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7596 :echo getbufinfo()->matchfuzzy("spl", |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7597 \ {'text_cb' : {v -> v.name}}) |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7598 < results in a list of buffer information dicts with buffer |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7599 names fuzzy matching "spl". > |
|
22232
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7600 :echo v:oldfiles->matchfuzzy("test") |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7601 < results in a list of file names fuzzy matching "test". > |
|
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7602 :let l = readfile("buffer.c")->matchfuzzy("str") |
|
22689
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7603 < results in a list of lines in "buffer.c" fuzzy matching "str". > |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7604 :echo ['one two', 'two one']->matchfuzzy('two one') |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7605 < results in ['two one', 'one two']. > |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7606 :echo ['one two', 'two one']->matchfuzzy('two one', |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7607 \ {'matchseq': 1}) |
|
f8bf2c122452
patch 8.2.1893: fuzzy matching does not support multiple words
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
7608 < results in ['two one']. |
|
22232
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7609 |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7610 matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()* |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7611 Same as |matchfuzzy()|, but returns the list of matched |
|
23475
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7612 strings, the list of character positions where characters |
|
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7613 in {str} matches and a list of matching scores. You can |
|
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7614 use |byteidx()|to convert a character position to a byte |
|
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7615 position. |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7616 |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7617 If {str} matches multiple times in a string, then only the |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7618 positions for the best match is returned. |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7619 |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7620 If there are no matching strings or there is an error, then a |
|
23475
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7621 list with three empty list items is returned. |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7622 |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7623 Example: > |
|
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7624 :echo matchfuzzypos(['testing'], 'tsg') |
|
23475
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7625 < results in [['testing'], [[0, 2, 6]], [99]] > |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7626 :echo matchfuzzypos(['clay', 'lacy'], 'la') |
|
23475
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7627 < results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] > |
|
22355
0491b9cafd44
patch 8.2.1726: fuzzy matching only works on strings
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
7628 :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'}) |
|
23475
79fd5217b125
patch 8.2.2280: fuzzy matching doesn't give access to the scores
Bram Moolenaar <Bram@vim.org>
parents:
23466
diff
changeset
|
7629 < results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]] |
|
22232
f22acf6472da
patch 8.2.1665: cannot do fuzzy string matching
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
7630 |
| 12785 | 7631 matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7632 Same as |match()|, but return a |List|. The first item in the |
| 158 | 7633 list is the matched string, same as what matchstr() would |
| 7634 return. Following items are submatches, like "\1", "\2", etc. | |
| 842 | 7635 in |:substitute|. When an optional submatch didn't match an |
| 7636 empty string is used. Example: > | |
| 7637 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') | |
| 7638 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] | |
| 158 | 7639 When there is no match an empty list is returned. |
| 7640 | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7641 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7642 GetList()->matchlist('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7643 |
| 12785 | 7644 matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()* |
| 1621 | 7645 Same as |match()|, but return the matched string. Example: > |
| 7 | 7646 :echo matchstr("testing", "ing") |
| 7647 < results in "ing". | |
| 7648 When there is no match "" is returned. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
7649 The {start}, if given, has the same meaning as for |match()|. > |
| 7 | 7650 :echo matchstr("testing", "ing", 2) |
| 7651 < results in "ing". > | |
| 7652 :echo matchstr("testing", "ing", 5) | |
| 7653 < result is "". | |
| 685 | 7654 When {expr} is a |List| then the matching item is returned. |
| 95 | 7655 The type isn't changed, it's not necessarily a String. |
| 7 | 7656 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7657 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7658 GetText()->matchstr('word') |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7659 |
| 12785 | 7660 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
|
7661 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
|
7662 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
|
7663 :echo matchstrpos("testing", "ing") |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7664 < results in ["ing", 4, 7]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7665 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
|
7666 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
|
7667 :echo matchstrpos("testing", "ing", 2) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7668 < results in ["ing", 4, 7]. > |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7669 :echo matchstrpos("testing", "ing", 5) |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7670 < result is ["", -1, -1]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7671 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
|
7672 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
|
7673 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
|
7674 :echo matchstrpos([1, '__x'], '\a') |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7675 < result is ["x", 1, 2, 3]. |
|
dda254280bab
commit https://github.com/vim/vim/commit/7fed5c18f8577b75404b80d8b9a9907b1bbd27e4
Christian Brabandt <cb@256bit.org>
parents:
8749
diff
changeset
|
7676 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
|
7677 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7678 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7679 GetText()->matchstrpos('word') |
| 18343 | 7680 < |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7681 |
| 87 | 7682 *max()* |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7683 max({expr}) Return the maximum value of all items in {expr}. Example: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7684 echo max([apples, pears, oranges]) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7685 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7686 < {expr} can be a |List| or a |Dictionary|. For a Dictionary, |
| 19099 | 7687 it returns the maximum of all values in the Dictionary. |
| 7688 If {expr} is neither a List nor a Dictionary, or one of the | |
| 10734 | 7689 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
|
7690 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 7691 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7692 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7693 mylist->max() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7694 |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7695 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7696 menu_info({name} [, {mode}]) *menu_info()* |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7697 Return information about the specified menu {name} in |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7698 mode {mode}. The menu name should be specified without the |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7699 shortcut character ('&'). |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7700 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7701 {mode} can be one of these strings: |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7702 "n" Normal |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7703 "v" Visual (including Select) |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7704 "o" Operator-pending |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7705 "i" Insert |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7706 "c" Cmd-line |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7707 "s" Select |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7708 "x" Visual |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7709 "t" Terminal-Job |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7710 "" Normal, Visual and Operator-pending |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7711 "!" Insert and Cmd-line |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7712 When {mode} is omitted, the modes for "" are used. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7713 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7714 Returns a |Dictionary| containing the following items: |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7715 accel menu item accelerator text |menu-text| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7716 display display name (name without '&') |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7717 enabled v:true if this menu item is enabled |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7718 Refer to |:menu-enable| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7719 icon name of the icon file (for toolbar) |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7720 |toolbar-icon| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7721 iconidx index of a built-in icon |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7722 modes modes for which the menu is defined. In |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7723 addition to the modes mentioned above, these |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7724 characters will be used: |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7725 " " Normal, Visual and Operator-pending |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7726 name menu item name. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7727 noremenu v:true if the {rhs} of the menu item is not |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7728 remappable else v:false. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7729 priority menu order priority |menu-priority| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7730 rhs right-hand-side of the menu item. The returned |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7731 string has special characters translated like |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7732 in the output of the ":menu" command listing. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7733 When the {rhs} of a menu item is empty, then |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7734 "<Nop>" is returned. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7735 script v:true if script-local remapping of {rhs} is |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7736 allowed else v:false. See |:menu-script|. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7737 shortcut shortcut key (character after '&' in |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7738 the menu name) |menu-shortcut| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7739 silent v:true if the menu item is created |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7740 with <silent> argument |:menu-silent| |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7741 submenus |List| containing the names of |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7742 all the submenus. Present only if the menu |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7743 item has submenus. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7744 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7745 Returns an empty dictionary if the menu item is not found. |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7746 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7747 Examples: > |
| 19721 | 7748 :echo menu_info('Edit.Cut') |
| 7749 :echo menu_info('File.Save', 'n') | |
| 7750 < | |
| 7751 Can also be used as a |method|: > | |
| 7752 GetMenuName()->menu_info('v') | |
|
19657
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7753 |
|
da791e5c0139
patch 8.2.0385: menu functionality insufficiently tested
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
7754 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7755 < *min()* |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7756 min({expr}) Return the minimum value of all items in {expr}. Example: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7757 echo min([apples, pears, oranges]) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7758 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7759 < {expr} can be a |List| or a |Dictionary|. For a Dictionary, |
| 19099 | 7760 it returns the minimum of all values in the Dictionary. |
| 7761 If {expr} is neither a List nor a Dictionary, or one of the | |
| 10734 | 7762 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
|
7763 an error. An empty |List| or |Dictionary| results in zero. |
| 87 | 7764 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7765 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7766 mylist->min() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7767 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
7768 < *mkdir()* *E739* |
| 168 | 7769 mkdir({name} [, {path} [, {prot}]]) |
| 7770 Create directory {name}. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7771 |
| 168 | 7772 If {path} is "p" then intermediate directories are created as |
| 7773 necessary. Otherwise it must be "". | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7774 |
| 168 | 7775 If {prot} is given it is used to set the protection bits of |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7776 the new directory. The default is 0o755 (rwxr-xr-x: r/w for |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7777 the user, readable for others). Use 0o700 to make it |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7778 unreadable for others. This is only used for the last part of |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7779 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7780 created with 0o755. |
| 1702 | 7781 Example: > |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
7782 :call mkdir($HOME . "/tmp/foo/bar", "p", 0o700) |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7783 |
| 1702 | 7784 < This function is not available in the |sandbox|. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7785 |
|
13672
4a1efd1a6018
patch 8.0.1708: mkdir with 'p' flag fails on existing directory
Christian Brabandt <cb@256bit.org>
parents:
13626
diff
changeset
|
7786 There is no error if the directory already exists and the "p" |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7787 flag is passed (since patch 8.0.1708). However, without the |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
7788 "p" option the call will fail. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
7789 |
| 23666 | 7790 The function result is a Number, which is TRUE if the call was |
| 7791 successful or FALSE if the directory creation failed or partly | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7792 failed. |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
7793 |
| 168 | 7794 Not available on all systems. To check use: > |
| 7795 :if exists("*mkdir") | |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7796 |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7797 < Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7798 GetName()->mkdir() |
| 168 | 7799 < |
| 7 | 7800 *mode()* |
| 1621 | 7801 mode([expr]) Return a string that indicates the current mode. |
| 1661 | 7802 If [expr] is supplied and it evaluates to a non-zero Number or |
| 7803 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
|
7804 returned, otherwise only the first letter is returned. |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
7805 Also see |state()|. |
| 1621 | 7806 |
|
14422
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7807 n Normal, Terminal-Normal |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7808 no Operator-pending |
|
15279
54457fc4af0b
patch 8.1.0648: custom operators can't act upon a forced motion
Bram Moolenaar <Bram@vim.org>
parents:
15271
diff
changeset
|
7809 nov Operator-pending (forced characterwise |o_v|) |
|
54457fc4af0b
patch 8.1.0648: custom operators can't act upon a forced motion
Bram Moolenaar <Bram@vim.org>
parents:
15271
diff
changeset
|
7810 noV Operator-pending (forced linewise |o_V|) |
|
54457fc4af0b
patch 8.1.0648: custom operators can't act upon a forced motion
Bram Moolenaar <Bram@vim.org>
parents:
15271
diff
changeset
|
7811 noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|); |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
7812 CTRL-V is one character |
|
14422
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7813 niI Normal using |i_CTRL-O| in |Insert-mode| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7814 niR Normal using |i_CTRL-O| in |Replace-mode| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7815 niV Normal using |i_CTRL-O| in |Virtual-Replace-mode| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7816 v Visual by character |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7817 V Visual by line |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7818 CTRL-V Visual blockwise |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7819 s Select by character |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7820 S Select by line |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7821 CTRL-S Select blockwise |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7822 i Insert |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7823 ic Insert mode completion |compl-generic| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7824 ix Insert mode |i_CTRL-X| completion |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7825 R Replace |R| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7826 Rc Replace mode completion |compl-generic| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7827 Rv Virtual Replace |gR| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7828 Rx Replace mode |i_CTRL-X| completion |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7829 c Command-line editing |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7830 cv Vim Ex mode |gQ| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7831 ce Normal Ex mode |Q| |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7832 r Hit-enter prompt |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7833 rm The -- more -- prompt |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7834 r? A |:confirm| query of some sort |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7835 ! Shell or external command is executing |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7836 t Terminal-Job mode: keys go to the job |
| 1621 | 7837 This is useful in the 'statusline' option or when used |
| 7838 with |remote_expr()| In most other places it always returns | |
| 7839 "c" or "n". | |
|
14422
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7840 Note that in the future more modes and more specific modes may |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7841 be added. It's better not to compare the whole string but only |
|
06316dbd66bc
patch 8.1.0225: mode() does not indicate using CTRL-O from Insert mode
Christian Brabandt <cb@256bit.org>
parents:
14421
diff
changeset
|
7842 the leading character(s). |
| 1621 | 7843 Also see |visualmode()|. |
| 7 | 7844 |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7845 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7846 DoFull()->mode() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7847 |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7848 mzeval({expr}) *mzeval()* |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7849 Evaluate MzScheme expression {expr} and return its result |
| 3492 | 7850 converted to Vim data structures. |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7851 Numbers and strings are returned as they are. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7852 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
|
7853 returned as Vim |Lists|. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7854 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
|
7855 converted to strings. |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7856 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
|
7857 Examples: > |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7858 :mz (define l (list 1 2 3)) |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7859 :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
|
7860 :echo mzeval("l") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7861 :echo mzeval("h") |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7862 < |
|
17930
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7863 Can also be used as a |method|: > |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7864 GetExpr()->mzeval() |
|
0cdb6ac20748
patch 8.1.1961: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17916
diff
changeset
|
7865 < |
|
2050
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7866 {only available when compiled with the |+mzscheme| feature} |
|
afcf9db31561
updated for version 7.2.336
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
7867 |
| 7 | 7868 nextnonblank({lnum}) *nextnonblank()* |
| 7869 Return the line number of the first line at or below {lnum} | |
| 7870 that is not blank. Example: > | |
| 7871 if getline(nextnonblank(1)) =~ "Java" | |
| 7872 < When {lnum} is invalid or there is no non-blank line at or | |
| 7873 below it, zero is returned. | |
| 7874 See also |prevnonblank()|. | |
| 7875 | |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7876 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7877 GetLnum()->nextnonblank() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7878 |
| 12785 | 7879 nr2char({expr} [, {utf8}]) *nr2char()* |
| 7 | 7880 Return a string with a single character, which has the number |
| 7881 value {expr}. Examples: > | |
| 7882 nr2char(64) returns "@" | |
| 7883 nr2char(32) returns " " | |
| 4051 | 7884 < When {utf8} is omitted or zero, the current 'encoding' is used. |
| 7885 Example for "utf-8": > | |
| 7 | 7886 nr2char(300) returns I with bow character |
| 4051 | 7887 < With {utf8} set to 1, always return utf-8 characters. |
| 7888 Note that a NUL character in the file is specified with | |
| 7 | 7889 nr2char(10), because NULs are represented with newline |
| 7890 characters. nr2char(0) is a real NUL and terminates the | |
| 119 | 7891 string, thus results in an empty string. |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7892 To turn a list of character numbers into a string: > |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7893 let list = [65, 66, 67] |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7894 let str = join(map(list, {_, val -> nr2char(val)}), '') |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
7895 < Result: "ABC" |
| 7 | 7896 |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7897 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7898 GetNumber()->nr2char() |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
7899 |
| 3214 | 7900 or({expr}, {expr}) *or()* |
| 7901 Bitwise OR on the two arguments. The arguments are converted | |
| 7902 to a number. A List, Dict or Float argument causes an error. | |
| 7903 Example: > | |
| 7904 :let bits = or(bits, 0x80) | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
7905 < Can also be used as a |method|: > |
|
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
7906 :let bits = bits->or(0x80) |
| 3214 | 7907 |
| 7908 | |
|
22385
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
7909 pathshorten({expr} [, {len}]) *pathshorten()* |
| 819 | 7910 Shorten directory names in the path {expr} and return the |
| 7911 result. The tail, the file name, is kept as-is. The other | |
|
22385
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
7912 components in the path are reduced to {len} letters in length. |
|
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
7913 If {len} is omitted or smaller than 1 then 1 is used (single |
|
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
7914 letters). Leading '~' and '.' characters are kept. Examples: > |
| 819 | 7915 :echo pathshorten('~/.vim/autoload/myfile.vim') |
| 7916 < ~/.v/a/myfile.vim ~ | |
|
22385
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
7917 > |
|
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
7918 :echo pathshorten('~/.vim/autoload/myfile.vim', 2) |
|
770fe121ca64
patch 8.2.1741: pathshorten() only supports using one character
Bram Moolenaar <Bram@vim.org>
parents:
22357
diff
changeset
|
7919 < ~/.vi/au/myfile.vim ~ |
| 819 | 7920 It doesn't matter if the path exists or not. |
| 7921 | |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7922 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7923 GetDirectories()->pathshorten() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7924 |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7925 perleval({expr}) *perleval()* |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7926 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
|
7927 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
|
7928 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
|
7929 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
|
7930 reference to it. |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7931 Example: > |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7932 :echo perleval('[1 .. 4]') |
|
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7933 < [1, 2, 3, 4] |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7934 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7935 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7936 GetExpr()->perleval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7937 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7938 < {only available when compiled with the |+perl| feature} |
|
7651
c7575b07de98
commit https://github.com/vim/vim/commit/e9b892ebcd8596bf813793a1eed5a460a9495a28
Christian Brabandt <cb@256bit.org>
parents:
7629
diff
changeset
|
7939 |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
7940 |
| 22171 | 7941 popup_ functions are documented here: |popup-functions| |
|
17257
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
7942 |
|
cb0ca75f0c26
patch 8.1.1628: popup window functions not in list of functions
Bram Moolenaar <Bram@vim.org>
parents:
17253
diff
changeset
|
7943 |
| 1621 | 7944 pow({x}, {y}) *pow()* |
| 7945 Return the power of {x} to the exponent {y} as a |Float|. | |
| 7946 {x} and {y} must evaluate to a |Float| or a |Number|. | |
| 7947 Examples: > | |
| 7948 :echo pow(3, 3) | |
| 7949 < 27.0 > | |
| 7950 :echo pow(2, 16) | |
| 7951 < 65536.0 > | |
| 7952 :echo pow(32, 0.20) | |
| 7953 < 2.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7954 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7955 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7956 Compute()->pow(3) |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
7957 < |
| 1621 | 7958 {only available when compiled with the |+float| feature} |
| 12785 | 7959 |
| 667 | 7960 prevnonblank({lnum}) *prevnonblank()* |
| 7961 Return the line number of the first line at or above {lnum} | |
| 7962 that is not blank. Example: > | |
| 7963 let ind = indent(prevnonblank(v:lnum - 1)) | |
| 7964 < When {lnum} is invalid or there is no non-blank line at or | |
| 7965 above it, zero is returned. | |
| 7966 Also see |nextnonblank()|. | |
| 7967 | |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7968 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
7969 GetLnum()->prevnonblank() |
| 667 | 7970 |
| 449 | 7971 printf({fmt}, {expr1} ...) *printf()* |
| 7972 Return a String with {fmt}, where "%" items are replaced by | |
| 7973 the formatted form of their respective arguments. Example: > | |
| 452 | 7974 printf("%4d: E%d %.30s", lnum, errno, msg) |
| 449 | 7975 < May result in: |
| 452 | 7976 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ |
| 449 | 7977 |
|
17676
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7978 When used as a |method| the base is passed as the second |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7979 argument: > |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7980 Compute()->printf("result: %d") |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7981 |
|
14ac8c31e598
patch 8.1.1835: cannot use printf() as a method
Bram Moolenaar <Bram@vim.org>
parents:
17674
diff
changeset
|
7982 < Often used items are: |
| 856 | 7983 %s string |
| 3914 | 7984 %6S string right-aligned in 6 display cells |
| 653 | 7985 %6s string right-aligned in 6 bytes |
| 1621 | 7986 %.9s string truncated to 9 bytes |
| 7987 %c single byte | |
| 7988 %d decimal number | |
| 7989 %5d decimal number padded with spaces to 5 characters | |
| 7990 %x hex number | |
| 7991 %04x hex number padded with zeros to at least 4 characters | |
| 7992 %X hex number using upper case letters | |
| 7993 %o octal number | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7994 %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
|
7995 %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
|
7996 %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
|
7997 %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
|
7998 %E floating point number as 1.23E3, INF, -INF or NAN |
| 1621 | 7999 %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
|
8000 %G floating point number, as %F or %E depending on value |
| 1621 | 8001 %% the % character itself |
| 449 | 8002 |
| 8003 Conversion specifications start with '%' and end with the | |
| 8004 conversion type. All other characters are copied unchanged to | |
| 8005 the result. | |
| 8006 | |
| 8007 The "%" starts a conversion specification. The following | |
| 452 | 8008 arguments appear in sequence: |
| 8009 | |
| 8010 % [flags] [field-width] [.precision] type | |
| 8011 | |
| 856 | 8012 flags |
| 452 | 8013 Zero or more of the following flags: |
| 8014 | |
| 449 | 8015 # The value should be converted to an "alternate |
| 8016 form". For c, d, and s conversions, this option | |
| 8017 has no effect. For o conversions, the precision | |
| 8018 of the number is increased to force the first | |
| 8019 character of the output string to a zero (except | |
| 8020 if a zero value is printed with an explicit | |
| 8021 precision of zero). | |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8022 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
|
8023 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
|
8024 prepended to it. |
| 449 | 8025 For x and X conversions, a non-zero result has |
| 8026 the string "0x" (or "0X" for X conversions) | |
| 8027 prepended to it. | |
| 452 | 8028 |
| 449 | 8029 0 (zero) Zero padding. For all conversions the converted |
| 8030 value is padded on the left with zeros rather | |
| 8031 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
|
8032 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
|
8033 flag is ignored. |
| 452 | 8034 |
| 449 | 8035 - A negative field width flag; the converted value |
| 8036 is to be left adjusted on the field boundary. | |
| 8037 The converted value is padded on the right with | |
| 8038 blanks, rather than on the left with blanks or | |
| 8039 zeros. A - overrides a 0 if both are given. | |
| 452 | 8040 |
| 449 | 8041 ' ' (space) A blank should be left before a positive |
| 8042 number produced by a signed conversion (d). | |
| 452 | 8043 |
| 449 | 8044 + 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
|
8045 produced by a signed conversion. A + overrides |
| 449 | 8046 a space if both are used. |
| 452 | 8047 |
| 8048 field-width | |
| 8049 An optional decimal digit string specifying a minimum | |
| 653 | 8050 field width. If the converted value has fewer bytes |
| 8051 than the field width, it will be padded with spaces on | |
| 8052 the left (or right, if the left-adjustment flag has | |
| 8053 been given) to fill out the field width. | |
| 452 | 8054 |
| 8055 .precision | |
| 8056 An optional precision, in the form of a period '.' | |
| 8057 followed by an optional digit string. If the digit | |
| 8058 string is omitted, the precision is taken as zero. | |
| 8059 This gives the minimum number of digits to appear for | |
| 8060 d, o, x, and X conversions, or the maximum number of | |
| 653 | 8061 bytes to be printed from a string for s conversions. |
| 1621 | 8062 For floating point it is the number of digits after |
| 8063 the decimal point. | |
| 452 | 8064 |
| 8065 type | |
| 8066 A character that specifies the type of conversion to | |
| 8067 be applied, see below. | |
| 8068 | |
| 449 | 8069 A field width or precision, or both, may be indicated by an |
| 8070 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
|
8071 Number argument supplies the field width or precision. A |
| 449 | 8072 negative field width is treated as a left adjustment flag |
| 8073 followed by a positive field width; a negative precision is | |
| 8074 treated as though it were missing. Example: > | |
| 452 | 8075 :echo printf("%d: %.*s", nr, width, line) |
| 449 | 8076 < This limits the length of the text used from "line" to |
| 452 | 8077 "width" bytes. |
| 449 | 8078 |
| 856 | 8079 The conversion specifiers and their meanings are: |
| 452 | 8080 |
|
9894
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8081 *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
|
8082 *printf-x* *printf-X* |
|
b01afb4e8f66
commit https://github.com/vim/vim/commit/91984b9034d3b698459622be277d963e0c6df60e
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
8083 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
|
8084 (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
|
8085 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
|
8086 "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
|
8087 "ABCDEF" are used for X conversions. |
| 452 | 8088 The precision, if any, gives the minimum number of |
| 8089 digits that must appear; if the converted value | |
| 8090 requires fewer digits, it is padded on the left with | |
| 8091 zeros. | |
| 8092 In no case does a non-existent or small field width | |
| 8093 cause truncation of a numeric field; if the result of | |
| 8094 a conversion is wider than the field width, the field | |
| 8095 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
|
8096 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
|
8097 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
|
8098 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
|
8099 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
|
8100 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
|
8101 |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
8102 i alias for d |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
8103 D alias for ld |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
8104 U alias for lu |
|
233289599874
commit https://github.com/vim/vim/commit/3056735ae8a366aa7fcb51872520895251858637
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
8105 O alias for lo |
| 452 | 8106 |
| 1621 | 8107 *printf-c* |
| 452 | 8108 c The Number argument is converted to a byte, and the |
| 8109 resulting character is written. | |
| 8110 | |
| 1621 | 8111 *printf-s* |
| 452 | 8112 s The text of the String argument is used. If a |
| 8113 precision is specified, no more bytes than the number | |
| 8114 specified are used. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
8115 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
|
8116 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
|
8117 as ":echo". |
| 6583 | 8118 *printf-S* |
| 3914 | 8119 S The text of the String argument is used. If a |
| 8120 precision is specified, no more display cells than the | |
| 15878 | 8121 number specified are used. |
| 452 | 8122 |
| 1621 | 8123 *printf-f* *E807* |
| 12785 | 8124 f F The Float argument is converted into a string of the |
| 1621 | 8125 form 123.456. The precision specifies the number of |
| 8126 digits after the decimal point. When the precision is | |
| 8127 zero the decimal point is omitted. When the precision | |
| 8128 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
|
8129 (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
|
8130 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
|
8131 "0.0 / 0.0" results in "nan" with %f (NAN with %F). |
| 1621 | 8132 Example: > |
| 8133 echo printf("%.2f", 12.115) | |
| 8134 < 12.12 | |
| 8135 Note that roundoff depends on the system libraries. | |
| 8136 Use |round()| when in doubt. | |
| 8137 | |
| 8138 *printf-e* *printf-E* | |
| 8139 e E The Float argument is converted into a string of the | |
| 8140 form 1.234e+03 or 1.234E+03 when using 'E'. The | |
| 8141 precision specifies the number of digits after the | |
| 8142 decimal point, like with 'f'. | |
| 8143 | |
| 8144 *printf-g* *printf-G* | |
| 8145 g G The Float argument is converted like with 'f' if the | |
| 8146 value is between 0.001 (inclusive) and 10000000.0 | |
| 8147 (exclusive). Otherwise 'e' is used for 'g' and 'E' | |
| 8148 for 'G'. When no precision is specified superfluous | |
| 8149 zeroes and '+' signs are removed, except for the zero | |
| 8150 immediately after the decimal point. Thus 10000000.0 | |
| 8151 results in 1.0e7. | |
| 8152 | |
| 8153 *printf-%* | |
| 449 | 8154 % A '%' is written. No argument is converted. The |
| 8155 complete conversion specification is "%%". | |
| 452 | 8156 |
| 1668 | 8157 When a Number argument is expected a String argument is also |
| 8158 accepted and automatically converted. | |
| 8159 When a Float or String argument is expected a Number argument | |
| 8160 is also accepted and automatically converted. | |
| 8161 Any other argument type results in an error message. | |
| 449 | 8162 |
| 459 | 8163 *E766* *E767* |
| 449 | 8164 The number of {exprN} arguments must exactly match the number |
| 8165 of "%" items. If there are not sufficient or too many | |
| 452 | 8166 arguments an error is given. Up to 18 arguments can be used. |
| 449 | 8167 |
| 8168 | |
|
22077
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8169 prompt_getprompt({buf}) *prompt_getprompt()* |
| 22723 | 8170 Returns the effective prompt text for buffer {buf}. {buf} can |
| 8171 be a buffer name or number. See |prompt-buffer|. | |
|
22077
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8172 |
|
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8173 If the buffer doesn't exist or isn't a prompt buffer, an empty |
|
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8174 string is returned. |
|
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8175 |
|
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8176 Can also be used as a |method|: > |
|
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8177 GetBuffer()->prompt_getprompt() |
|
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8178 |
|
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8179 |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8180 prompt_setcallback({buf}, {expr}) *prompt_setcallback()* |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8181 Set prompt callback for buffer {buf} to {expr}. When {expr} |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8182 is an empty string the callback is removed. This has only |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8183 effect if {buf} has 'buftype' set to "prompt". |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8184 |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8185 The callback is invoked when pressing Enter. The current |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8186 buffer will always be the prompt buffer. A new line for a |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8187 prompt is added before invoking the callback, thus the prompt |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8188 for which the callback was invoked will be in the last but one |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8189 line. |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8190 If the callback wants to add text to the buffer, it must |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8191 insert it above the last line, since that is where the current |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8192 prompt is. This can also be done asynchronously. |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8193 The callback is invoked with one argument, which is the text |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8194 that was entered at the prompt. This can be an empty string |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8195 if the user only typed Enter. |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8196 Example: > |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
8197 call prompt_setcallback(bufnr(), function('s:TextEntered')) |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8198 func s:TextEntered(text) |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8199 if a:text == 'exit' || a:text == 'quit' |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8200 stopinsert |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8201 close |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8202 else |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8203 call append(line('$') - 1, 'Entered: "' . a:text . '"') |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8204 " Reset 'modified' to allow the buffer to be closed. |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8205 set nomodified |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8206 endif |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8207 endfunc |
|
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8208 |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8209 < Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8210 GetBuffer()->prompt_setcallback(callback) |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8211 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8212 |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8213 prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()* |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8214 Set a callback for buffer {buf} to {expr}. When {expr} is an |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8215 empty string the callback is removed. This has only effect if |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8216 {buf} has 'buftype' set to "prompt". |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8217 |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8218 This callback will be invoked when pressing CTRL-C in Insert |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8219 mode. Without setting a callback Vim will exit Insert mode, |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8220 as in any buffer. |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8221 |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8222 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8223 GetBuffer()->prompt_setinterrupt(callback) |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8224 |
|
14103
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8225 prompt_setprompt({buf}, {text}) *prompt_setprompt()* |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8226 Set prompt for buffer {buf} to {text}. You most likely want |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8227 {text} to end in a space. |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8228 The result is only visible if {buf} has 'buftype' set to |
|
d053ec57d886
patch 8.1.0069: cannot handle pressing CTRL-C in a prompt buffer
Christian Brabandt <cb@256bit.org>
parents:
14043
diff
changeset
|
8229 "prompt". Example: > |
|
17855
285f7a700185
patch 8.1.1924: using empty string for current buffer is unexpected
Bram Moolenaar <Bram@vim.org>
parents:
17849
diff
changeset
|
8230 call prompt_setprompt(bufnr(), 'command: ') |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
8231 < |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8232 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8233 GetBuffer()->prompt_setprompt('command: ') |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8234 |
|
22077
335365fcbb60
patch 8.2.1588: cannot read back the prompt of a prompt buffer
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
8235 prop_ functions are documented here: |text-prop-functions| |
|
14019
dc67449d648c
patch 8.1.0027: difficult to make a plugin that feeds a line to a job
Christian Brabandt <cb@256bit.org>
parents:
14006
diff
changeset
|
8236 |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8237 pum_getpos() *pum_getpos()* |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8238 If the popup menu (see |ins-completion-menu|) is not visible, |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8239 returns an empty |Dictionary|, otherwise, returns a |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8240 |Dictionary| with the following keys: |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8241 height nr of items visible |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8242 width screen cells |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8243 row top screen row (0 first row) |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8244 col leftmost screen column (0 first col) |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8245 size total nr of items |
| 18456 | 8246 scrollbar |TRUE| if scrollbar is visible |
|
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8247 |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8248 The values are the same as in |v:event| during |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8249 |CompleteChanged|. |
|
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17680
diff
changeset
|
8250 |
| 667 | 8251 pumvisible() *pumvisible()* |
| 8252 Returns non-zero when the popup menu is visible, zero | |
| 8253 otherwise. See |ins-completion-menu|. | |
| 712 | 8254 This can be used to avoid some things that would remove the |
| 8255 popup menu. | |
| 7 | 8256 |
| 3682 | 8257 py3eval({expr}) *py3eval()* |
| 8258 Evaluate Python expression {expr} and return its result | |
| 8259 converted to Vim data structures. | |
| 12785 | 8260 Numbers and strings are returned as they are (strings are |
| 8261 copied though, Unicode strings are additionally converted to | |
| 3682 | 8262 'encoding'). |
| 8263 Lists are represented as Vim |List| type. | |
| 12785 | 8264 Dictionaries are represented as Vim |Dictionary| type with |
| 3682 | 8265 keys converted to strings. |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8266 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8267 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8268 GetExpr()->py3eval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8269 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8270 < {only available when compiled with the |+python3| feature} |
| 3682 | 8271 |
| 8272 *E858* *E859* | |
| 8273 pyeval({expr}) *pyeval()* | |
| 8274 Evaluate Python expression {expr} and return its result | |
| 8275 converted to Vim data structures. | |
| 12785 | 8276 Numbers and strings are returned as they are (strings are |
| 3682 | 8277 copied though). |
| 8278 Lists are represented as Vim |List| type. | |
| 12785 | 8279 Dictionaries are represented as Vim |Dictionary| type, |
| 3830 | 8280 non-string keys result in error. |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8281 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8282 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8283 GetExpr()->pyeval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8284 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8285 < {only available when compiled with the |+python| feature} |
| 3682 | 8286 |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
8287 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
|
8288 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
|
8289 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
|
8290 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
|
8291 See also: |pyeval()|, |py3eval()| |
|
17976
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8292 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8293 Can also be used as a |method|: > |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8294 GetExpr()->pyxeval() |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8295 |
|
6d11a0d5751d
patch 8.1.1984: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17930
diff
changeset
|
8296 < {only available when compiled with the |+python| or the |
|
10722
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
8297 |+python3| feature} |
|
7598ce51bf2a
patch 8.0.0251: not easy to select Python 2 or 3
Christian Brabandt <cb@256bit.org>
parents:
10617
diff
changeset
|
8298 |
| 114 | 8299 *E726* *E727* |
| 99 | 8300 range({expr} [, {max} [, {stride}]]) *range()* |
| 685 | 8301 Returns a |List| with Numbers: |
| 99 | 8302 - If only {expr} is specified: [0, 1, ..., {expr} - 1] |
| 8303 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] | |
| 8304 - If {stride} is specified: [{expr}, {expr} + {stride}, ..., | |
| 8305 {max}] (increasing {expr} with {stride} each time, not | |
| 8306 producing a value past {max}). | |
| 336 | 8307 When the maximum is one before the start the result is an |
| 8308 empty list. When the maximum is more than one before the | |
| 8309 start this is an error. | |
| 99 | 8310 Examples: > |
| 856 | 8311 range(4) " [0, 1, 2, 3] |
| 99 | 8312 range(2, 4) " [2, 3, 4] |
| 8313 range(2, 9, 3) " [2, 5, 8] | |
| 856 | 8314 range(2, -2, -1) " [2, 1, 0, -1, -2] |
| 336 | 8315 range(0) " [] |
| 8316 range(2, 0) " error! | |
| 99 | 8317 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8318 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8319 GetExpr()->range() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8320 < |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
8321 |
| 20115 | 8322 rand([{expr}]) *rand()* *random* |
|
18732
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
8323 Return a pseudo-random Number generated with an xoshiro128** |
| 18719 | 8324 algorithm using seed {expr}. The returned number is 32 bits, |
| 8325 also on 64 bits systems, for consistency. | |
| 8326 {expr} can be initialized by |srand()| and will be updated by | |
| 8327 rand(). If {expr} is omitted, an internal seed value is used | |
| 8328 and updated. | |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
8329 |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
8330 Examples: > |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
8331 :echo rand() |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
8332 :let seed = srand() |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
8333 :echo rand(seed) |
| 18719 | 8334 :echo rand(seed) % 16 " random number 0 - 15 |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
8335 < |
|
23602
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8336 |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8337 readblob({fname}) *readblob()* |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8338 Read file {fname} in binary mode and return a |Blob|. |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8339 When the file can't be opened an error message is given and |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8340 the result is an empty |Blob|. |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8341 Also see |readfile()| and |writefile()|. |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8342 |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8343 |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8344 readdir({directory} [, {expr} [, {dict}]]) *readdir()* |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8345 Return a list with file and directory names in {directory}. |
| 16267 | 8346 You can also use |glob()| if you don't need to do complicated |
| 8347 things, such as limiting the number of matches. | |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8348 The list will be sorted (case sensitive), see the {dict} |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8349 argument below for changing the sort order. |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8350 |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8351 When {expr} is omitted all entries are included. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8352 When {expr} is given, it is evaluated to check what to do: |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8353 If {expr} results in -1 then no further entries will |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8354 be handled. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8355 If {expr} results in 0 then this entry will not be |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8356 added to the list. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8357 If {expr} results in 1 then this entry will be added |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8358 to the list. |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8359 The entries "." and ".." are always excluded. |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8360 Each time {expr} is evaluated |v:val| is set to the entry name. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8361 When {expr} is a function the name is passed as the argument. |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8362 For example, to get a list of files ending in ".txt": > |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8363 readdir(dirname, {n -> n =~ '.txt$'}) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8364 < To skip hidden and backup files: > |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8365 readdir(dirname, {n -> n !~ '^\.\|\~$'}) |
|
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8366 |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8367 < The optional {dict} argument allows for further custom |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8368 values. Currently this is used to specify if and how sorting |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8369 should be performed. The dict can have the following members: |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8370 |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8371 sort How to sort the result returned from the system. |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8372 Valid values are: |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8373 "none" do not sort (fastest method) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8374 "case" sort case sensitive (byte value of |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8375 each character, technically, using |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8376 strcmp()) (default) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8377 "icase" sort case insensitive (technically |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8378 using strcasecmp()) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8379 "collate" sort using the collation order |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8380 of the "POSIX" or "C" |locale| |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8381 (technically using strcoll()) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8382 Other values are silently ignored. |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8383 |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8384 For example, to get a list of all files in the current |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8385 directory without sorting the individual entries: > |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8386 readdir('.', '1', #{sort: 'none'}) |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8387 < If you want to get a directory tree: > |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8388 function! s:tree(dir) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8389 return {a:dir : map(readdir(a:dir), |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8390 \ {_, x -> isdirectory(x) ? |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8391 \ {x : s:tree(a:dir . '/' . x)} : x})} |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8392 endfunction |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8393 echo s:tree(".") |
|
16231
0761a4c111a7
patch 8.1.1120: cannot easily get directory entry matches
Bram Moolenaar <Bram@vim.org>
parents:
16223
diff
changeset
|
8394 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8395 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8396 GetDirName()->readdir() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8397 < |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8398 readdirex({directory} [, {expr} [, {dict}]]) *readdirex()* |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8399 Extended version of |readdir()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8400 Return a list of Dictionaries with file and directory |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8401 information in {directory}. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8402 This is useful if you want to get the attributes of file and |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8403 directory at the same time as getting a list of a directory. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8404 This is much faster than calling |readdir()| then calling |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8405 |getfperm()|, |getfsize()|, |getftime()| and |getftype()| for |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8406 each file and directory especially on MS-Windows. |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8407 The list will by default be sorted by name (case sensitive), |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8408 the sorting can be changed by using the optional {dict} |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8409 argument, see |readdir()|. |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8410 |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8411 The Dictionary for file and directory information has the |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8412 following items: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8413 group Group name of the entry. (Only on Unix) |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8414 name Name of the entry. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8415 perm Permissions of the entry. See |getfperm()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8416 size Size of the entry. See |getfsize()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8417 time Timestamp of the entry. See |getftime()|. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8418 type Type of the entry. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8419 On Unix, almost same as |getftype()| except: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8420 Symlink to a dir "linkd" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8421 Other symlink "link" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8422 On MS-Windows: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8423 Normal file "file" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8424 Directory "dir" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8425 Junction "junction" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8426 Symlink to a dir "linkd" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8427 Other symlink "link" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8428 Other reparse point "reparse" |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8429 user User name of the entry's owner. (Only on Unix) |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8430 On Unix, if the entry is a symlink, the Dictionary includes |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8431 the information of the target (except the "type" item). |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8432 On MS-Windows, it includes the information of the symlink |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8433 itself because of performance reasons. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8434 |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8435 When {expr} is omitted all entries are included. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8436 When {expr} is given, it is evaluated to check what to do: |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8437 If {expr} results in -1 then no further entries will |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8438 be handled. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8439 If {expr} results in 0 then this entry will not be |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8440 added to the list. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8441 If {expr} results in 1 then this entry will be added |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8442 to the list. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8443 The entries "." and ".." are always excluded. |
| 21093 | 8444 Each time {expr} is evaluated |v:val| is set to a |Dictionary| |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8445 of the entry. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8446 When {expr} is a function the entry is passed as the argument. |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8447 For example, to get a list of files ending in ".txt": > |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8448 readdirex(dirname, {e -> e.name =~ '.txt$'}) |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8449 < |
|
20873
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8450 For example, to get a list of all files in the current |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8451 directory without sorting the individual entries: > |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8452 readdirex(dirname, '1', #{sort: 'none'}) |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8453 |
|
69055d27e85e
patch 8.2.0988: getting directory contents is always case sorted
Bram Moolenaar <Bram@vim.org>
parents:
20856
diff
changeset
|
8454 < |
|
20643
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8455 Can also be used as a |method|: > |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8456 GetDirName()->readdirex() |
|
c2beb6baa42c
patch 8.2.0875: getting attributes for directory entries is slow
Bram Moolenaar <Bram@vim.org>
parents:
20635
diff
changeset
|
8457 < |
|
23602
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8458 |
| 158 | 8459 *readfile()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8460 readfile({fname} [, {type} [, {max}]]) |
| 685 | 8461 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
|
8462 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
|
8463 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
|
8464 (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
|
8465 All NUL characters are replaced with a NL character. |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8466 When {type} contains "b" binary mode is used: |
| 158 | 8467 - When the last line ends in a NL an extra empty list item is |
| 8468 added. | |
| 8469 - No CR characters are removed. | |
| 8470 Otherwise: | |
| 8471 - CR characters that appear before a NL are removed. | |
| 8472 - 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
|
8473 - 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
|
8474 removed from the text. |
| 168 | 8475 When {max} is given this specifies the maximum number of lines |
| 8476 to be read. Useful if you only want to check the first ten | |
| 8477 lines of a file: > | |
| 8478 :for line in readfile(fname, '', 10) | |
| 8479 : if line =~ 'Date' | echo line | endif | |
| 8480 :endfor | |
| 233 | 8481 < When {max} is negative -{max} lines from the end of the file |
| 8482 are returned, or as many as there are. | |
| 8483 When {max} is zero the result is an empty list. | |
| 168 | 8484 Note that without {max} the whole file is read into memory. |
| 8485 Also note that there is no recognition of encoding. Read a | |
| 8486 file into a buffer if you need to. | |
|
23602
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8487 Deprecated (use |readblob()| instead): When {type} contains |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8488 "B" a |Blob| is returned with the binary data of the file |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
8489 unmodified. |
| 158 | 8490 When the file can't be opened an error message is given and |
| 8491 the result is an empty list. | |
| 8492 Also see |writefile()|. | |
| 8493 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8494 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8495 GetFileName()->readfile() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8496 |
|
20649
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8497 reduce({object}, {func} [, {initial}]) *reduce()* *E998* |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8498 {func} is called for every item in {object}, which can be a |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8499 |List| or a |Blob|. {func} is called with two arguments: the |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8500 result so far and current item. After processing all items |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8501 the result is returned. |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8502 |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8503 {initial} is the initial result. When omitted, the first item |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8504 in {object} is used and {func} is first called for the second |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8505 item. If {initial} is not given and {object} is empty no |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8506 result can be computed, an E998 error is given. |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8507 |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8508 Examples: > |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8509 echo reduce([1, 3, 5], { acc, val -> acc + val }) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8510 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a') |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8511 echo reduce(0z1122, { acc, val -> 2 * acc + val }) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8512 < |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8513 Can also be used as a |method|: > |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8514 echo mylist->reduce({ acc, val -> acc + val }, 0) |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8515 |
|
1fa0ace0ba65
patch 8.2.0878: no reduce() function
Bram Moolenaar <Bram@vim.org>
parents:
20647
diff
changeset
|
8516 |
|
14004
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8517 reg_executing() *reg_executing()* |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8518 Returns the single letter name of the register being executed. |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8519 Returns an empty string when no register is being executed. |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8520 See |@|. |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8521 |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8522 reg_recording() *reg_recording()* |
|
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8523 Returns the single letter name of the register being recorded. |
| 16267 | 8524 Returns an empty string when not recording. See |q|. |
|
14004
e124262d435e
patch 8.1.0020: cannot tell whether a register is executing or recording
Christian Brabandt <cb@256bit.org>
parents:
13967
diff
changeset
|
8525 |
| 794 | 8526 reltime([{start} [, {end}]]) *reltime()* |
| 22824 | 8527 Return an item that represents a time value. The item is a |
| 8528 list with items that depend on the system. In Vim 9 script | |
| 8529 list<any> can be used. | |
| 8530 The item can be passed to |reltimestr()| to convert it to a | |
| 8531 string or |reltimefloat()| to convert to a Float. | |
| 8532 | |
| 8533 Without an argument reltime() returns the current time. | |
| 794 | 8534 With one argument is returns the time passed since the time |
| 8535 specified in the argument. | |
| 843 | 8536 With two arguments it returns the time passed between {start} |
| 794 | 8537 and {end}. |
| 22824 | 8538 |
| 794 | 8539 The {start} and {end} arguments must be values returned by |
| 8540 reltime(). | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8541 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8542 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8543 GetStart()->reltime() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8544 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
8545 {only available when compiled with the |+reltime| feature} |
| 794 | 8546 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8547 reltimefloat({time}) *reltimefloat()* |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8548 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
|
8549 Example: > |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8550 let start = reltime() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8551 call MyFunction() |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8552 let seconds = reltimefloat(reltime(start)) |
|
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8553 < 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
|
8554 Also see |profiling|. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8555 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8556 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8557 reltime(start)->reltimefloat() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8558 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8559 < {only available when compiled with the |+reltime| feature} |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
8560 |
| 794 | 8561 reltimestr({time}) *reltimestr()* |
| 8562 Return a String that represents the time value of {time}. | |
| 8563 This is the number of seconds, a dot and the number of | |
| 8564 microseconds. Example: > | |
| 8565 let start = reltime() | |
| 8566 call MyFunction() | |
| 8567 echo reltimestr(reltime(start)) | |
| 8568 < Note that overhead for the commands will be added to the time. | |
| 8569 The accuracy depends on the system. | |
| 1156 | 8570 Leading spaces are used to make the string align nicely. You |
| 8571 can use split() to remove it. > | |
| 8572 echo split(reltimestr(reltime(start)))[0] | |
| 8573 < Also see |profiling|. | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8574 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8575 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8576 reltime(start)->reltimestr() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8577 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8578 < {only available when compiled with the |+reltime| feature} |
| 794 | 8579 |
| 7 | 8580 *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
|
8581 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
|
8582 Send the {string} to {server}. The string is sent as an |
| 7 | 8583 expression and the result is returned after evaluation. |
| 714 | 8584 The result must be a String or a |List|. A |List| is turned |
| 8585 into a String by joining the items with a line break in | |
| 8586 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
|
8587 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
|
8588 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
|
8589 |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
|
8590 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
|
8591 seconds. Otherwise a timeout of 600 seconds is used. |
| 7 | 8592 See also |clientserver| |RemoteReply|. |
| 8593 This function is not available in the |sandbox|. | |
| 8594 {only available when compiled with the |+clientserver| feature} | |
| 8595 Note: Any errors will cause a local error message to be issued | |
| 8596 and the result will be the empty string. | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8597 |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8598 Variables will be evaluated in the global namespace, |
| 12785 | 8599 independent of a function currently being active. Except |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8600 when in debug mode, then local function variables and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8601 arguments can be evaluated. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
8602 |
| 7 | 8603 Examples: > |
| 8604 :echo remote_expr("gvim", "2+2") | |
| 8605 :echo remote_expr("gvim1", "b:current_syntax") | |
| 8606 < | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8607 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8608 ServerName()->remote_expr(expr) |
| 7 | 8609 |
| 8610 remote_foreground({server}) *remote_foreground()* | |
| 8611 Move the Vim server with the name {server} to the foreground. | |
| 8612 This works like: > | |
| 8613 remote_expr({server}, "foreground()") | |
| 8614 < Except that on Win32 systems the client does the work, to work | |
| 8615 around the problem that the OS doesn't always allow the server | |
| 8616 to bring itself to the foreground. | |
| 574 | 8617 Note: This does not restore the window if it was minimized, |
| 8618 like foreground() does. | |
| 7 | 8619 This function is not available in the |sandbox|. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8620 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8621 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8622 ServerName()->remote_foreground() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8623 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8624 < {only in the Win32, Athena, Motif and GTK GUI versions and the |
| 7 | 8625 Win32 console version} |
| 8626 | |
| 8627 | |
| 8628 remote_peek({serverid} [, {retvar}]) *remote_peek()* | |
| 8629 Returns a positive number if there are available strings | |
| 8630 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
|
8631 {retvar} if specified. {retvar} must be a string with the |
| 7 | 8632 name of a variable. |
| 8633 Returns zero if none are available. | |
| 8634 Returns -1 if something is wrong. | |
| 8635 See also |clientserver|. | |
| 8636 This function is not available in the |sandbox|. | |
| 8637 {only available when compiled with the |+clientserver| feature} | |
| 8638 Examples: > | |
| 8639 :let repl = "" | |
| 8640 :echo "PEEK: ".remote_peek(id, "repl").": ".repl | |
| 8641 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8642 < Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8643 ServerId()->remote_peek() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8644 |
|
11211
71311d899b42
patch 8.0.0492: a failing client-server request can make Vim hang
Christian Brabandt <cb@256bit.org>
parents:
11181
diff
changeset
|
8645 remote_read({serverid}, [{timeout}]) *remote_read()* |
| 7 | 8646 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
|
8647 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
|
8648 reply is available. |
| 7 | 8649 See also |clientserver|. |
| 8650 This function is not available in the |sandbox|. | |
| 8651 {only available when compiled with the |+clientserver| feature} | |
| 8652 Example: > | |
| 8653 :echo remote_read(id) | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8654 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8655 < Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8656 ServerId()->remote_read() |
| 7 | 8657 < |
| 8658 *remote_send()* *E241* | |
| 8659 remote_send({server}, {string} [, {idvar}]) | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
8660 Send the {string} to {server}. The string is sent as input |
| 22 | 8661 keys and the function returns immediately. At the Vim server |
| 8662 the keys are not mapped |:map|. | |
| 667 | 8663 If {idvar} is present, it is taken as the name of a variable |
| 8664 and a {serverid} for later use with remote_read() is stored | |
| 8665 there. | |
| 7 | 8666 See also |clientserver| |RemoteReply|. |
| 8667 This function is not available in the |sandbox|. | |
| 8668 {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
|
8669 |
| 7 | 8670 Note: Any errors will be reported in the server and may mess |
| 8671 up the display. | |
| 8672 Examples: > | |
| 8673 :echo remote_send("gvim", ":DropAndReply ".file, "serverid"). | |
| 8674 \ remote_read(serverid) | |
| 8675 | |
| 8676 :autocmd NONE RemoteReply * | |
| 8677 \ echo remote_read(expand("<amatch>")) | |
| 8678 :echo remote_send("gvim", ":sleep 10 | echo ". | |
| 8679 \ 'server2client(expand("<client>"), "HELLO")<CR>') | |
| 82 | 8680 < |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8681 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8682 ServerName()->remote_send(keys) |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8683 < |
|
11177
76fb679a310e
patch 8.0.0475: not enough testing for the client-server feature
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
8684 *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
|
8685 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
|
8686 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
|
8687 server, when |v:servername| is not empty. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8688 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8689 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8690 ServerName()->remote_startserver() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8691 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8692 < {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
|
8693 |
| 79 | 8694 remove({list}, {idx} [, {end}]) *remove()* |
| 685 | 8695 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
|
8696 return the item. |
| 79 | 8697 With {end}: Remove items from {idx} to {end} (inclusive) and |
| 21093 | 8698 return a |List| with these items. When {idx} points to the same |
| 79 | 8699 item as {end} a list with one item is returned. When {end} |
| 8700 points to an item before {idx} this is an error. | |
| 8701 See |list-index| for possible values of {idx} and {end}. | |
| 55 | 8702 Example: > |
| 8703 :echo "last item: " . remove(mylist, -1) | |
| 79 | 8704 :call remove(mylist, 0, 9) |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8705 < |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8706 Use |delete()| to remove a file. |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8707 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8708 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8709 mylist->remove(idx) |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8710 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8711 remove({blob}, {idx} [, {end}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8712 Without {end}: Remove the byte at {idx} from |Blob| {blob} and |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8713 return the byte. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8714 With {end}: Remove bytes from {idx} to {end} (inclusive) and |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8715 return a |Blob| with these bytes. When {idx} points to the same |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8716 byte as {end} a |Blob| with one byte is returned. When {end} |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8717 points to a byte before {idx} this is an error. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8718 Example: > |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8719 :echo "last byte: " . remove(myblob, -1) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8720 :call remove(mylist, 0, 9) |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
8721 |
| 99 | 8722 remove({dict}, {key}) |
| 17571 | 8723 Remove the entry from {dict} with key {key} and return it. |
| 8724 Example: > | |
| 99 | 8725 :echo "removed " . remove(dict, "one") |
| 8726 < If there is no {key} in {dict} this is an error. | |
| 8727 | |
| 7 | 8728 rename({from}, {to}) *rename()* |
| 8729 Rename the file by the name {from} to the name {to}. This | |
| 8730 should also work to move files across file systems. The | |
| 8731 result is a Number, which is 0 if the file was renamed | |
| 8732 successfully, and non-zero when the renaming failed. | |
| 1851 | 8733 NOTE: If {to} exists it is overwritten without warning. |
| 7 | 8734 This function is not available in the |sandbox|. |
| 8735 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8736 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8737 GetOldName()->rename(newname) |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8738 |
| 18 | 8739 repeat({expr}, {count}) *repeat()* |
| 8740 Repeat {expr} {count} times and return the concatenated | |
| 8741 result. Example: > | |
| 843 | 8742 :let separator = repeat('-', 80) |
| 18 | 8743 < When {count} is zero or negative the result is empty. |
| 685 | 8744 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
|
8745 {count} times. Example: > |
| 79 | 8746 :let longlist = repeat(['a', 'b'], 3) |
| 8747 < Results in ['a', 'b', 'a', 'b', 'a', 'b']. | |
| 18 | 8748 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8749 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8750 mylist->repeat(count) |
| 82 | 8751 |
| 7 | 8752 resolve({filename}) *resolve()* *E655* |
| 8753 On MS-Windows, when {filename} is a shortcut (a .lnk file), | |
| 8754 returns the path the shortcut points to in a simplified form. | |
|
15774
c4efa095f323
patch 8.1.0894: MS-Windows: resolve() does not return a reparse point
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8755 When {filename} is a symbolic link or junction point, return |
|
c4efa095f323
patch 8.1.0894: MS-Windows: resolve() does not return a reparse point
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8756 the full path to the target. If the target of junction is |
|
c4efa095f323
patch 8.1.0894: MS-Windows: resolve() does not return a reparse point
Bram Moolenaar <Bram@vim.org>
parents:
15746
diff
changeset
|
8757 removed, return {filename}. |
| 7 | 8758 On Unix, repeat resolving symbolic links in all path |
| 8759 components of {filename} and return the simplified result. | |
| 8760 To cope with link cycles, resolving of symbolic links is | |
| 8761 stopped after 100 iterations. | |
| 8762 On other systems, return the simplified {filename}. | |
| 8763 The simplification step is done as by |simplify()|. | |
| 8764 resolve() keeps a leading path component specifying the | |
| 8765 current directory (provided the result is still a relative | |
| 8766 path name) and also keeps a trailing path separator. | |
| 8767 | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8768 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8769 GetName()->resolve() |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8770 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8771 reverse({object}) *reverse()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8772 Reverse the order of items in {object} in-place. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8773 {object} can be a |List| or a |Blob|. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8774 Returns {object}. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
8775 If you want an object to remain unmodified make a copy first: > |
| 82 | 8776 :let revlist = reverse(copy(mylist)) |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8777 < Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
8778 mylist->reverse() |
| 82 | 8779 |
| 1621 | 8780 round({expr}) *round()* |
| 1668 | 8781 Round off {expr} to the nearest integral value and return it |
| 1621 | 8782 as a |Float|. If {expr} lies halfway between two integral |
| 8783 values, then use the larger one (away from zero). | |
| 8784 {expr} must evaluate to a |Float| or a |Number|. | |
| 8785 Examples: > | |
| 8786 echo round(0.456) | |
| 8787 < 0.0 > | |
| 8788 echo round(4.5) | |
| 8789 < 5.0 > | |
| 8790 echo round(-4.5) | |
| 8791 < -5.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8792 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8793 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8794 Compute()->round() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
8795 < |
| 1621 | 8796 {only available when compiled with the |+float| feature} |
| 3996 | 8797 |
|
16103
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8798 rubyeval({expr}) *rubyeval()* |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8799 Evaluate Ruby expression {expr} and return its result |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8800 converted to Vim data structures. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8801 Numbers, floats and strings are returned as they are (strings |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8802 are copied though). |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8803 Arrays are represented as Vim |List| type. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8804 Hashes are represented as Vim |Dictionary| type. |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8805 Other objects are represented as strings resulted from their |
|
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8806 "Object#to_s" method. |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8807 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8808 Can also be used as a |method|: > |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8809 GetRubyExpr()->rubyeval() |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8810 |
|
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
8811 < {only available when compiled with the |+ruby| feature} |
|
16103
518f44125207
patch 8.1.1056: no eval function for Ruby
Bram Moolenaar <Bram@vim.org>
parents:
16086
diff
changeset
|
8812 |
| 12785 | 8813 screenattr({row}, {col}) *screenattr()* |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
10004
diff
changeset
|
8814 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
|
8815 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
|
8816 attribute at other positions. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8817 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8818 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8819 GetRow()->screenattr(col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8820 |
| 12785 | 8821 screenchar({row}, {col}) *screenchar()* |
|
4835
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8822 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
|
8823 [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
|
8824 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
|
8825 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
|
8826 The character excludes composing characters. For double-byte |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8827 encodings it may only be the first byte. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8828 This is mainly to be used for testing. |
|
4db0bf9f1b44
updated for version 7.3.1164
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8829 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
|
8830 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8831 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8832 GetRow()->screenchar(col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8833 |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8834 screenchars({row}, {col}) *screenchars()* |
| 21093 | 8835 The result is a |List| of Numbers. The first number is the same |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8836 as what |screenchar()| returns. Further numbers are |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8837 composing characters on top of the base character. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8838 This is mainly to be used for testing. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8839 Returns an empty List when row or col is out of range. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8840 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8841 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8842 GetRow()->screenchars(col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8843 |
| 3996 | 8844 screencol() *screencol()* |
| 8845 The result is a Number, which is the current screen column of | |
| 8846 the cursor. The leftmost column has number 1. | |
| 8847 This function is mainly used for testing. | |
| 8848 | |
| 8849 Note: Always returns the current screen column, thus if used | |
| 8850 in a command (e.g. ":echo screencol()") it will return the | |
| 8851 column inside the command line, which is 1 when the command is | |
| 8852 executed. To get the cursor position in the file use one of | |
| 8853 the following mappings: > | |
| 8854 nnoremap <expr> GG ":echom ".screencol()."\n" | |
| 8855 nnoremap <silent> GG :echom screencol()<CR> | |
|
22862
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22844
diff
changeset
|
8856 nnoremap GG <Cmd>echom screencol()<CR> |
| 3996 | 8857 < |
|
17292
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8858 screenpos({winid}, {lnum}, {col}) *screenpos()* |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8859 The result is a Dict with the screen position of the text |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8860 character in window {winid} at buffer line {lnum} and column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8861 {col}. {col} is a one-based byte index. |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8862 The Dict has these members: |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8863 row screen row |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8864 col first screen column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8865 endcol last screen column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8866 curscol cursor screen column |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8867 If the specified position is not visible, all values are zero. |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8868 The "endcol" value differs from "col" when the character |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8869 occupies more than one screen cell. E.g. for a Tab "col" can |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8870 be 1 and "endcol" can be 8. |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8871 The "curscol" value is where the cursor would be placed. For |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8872 a Tab it would be the same as "endcol", while for a double |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8873 width character it would be the same as "col". |
|
8a095d343c59
patch 8.1.1645: cannot use a popup window for a balloon
Bram Moolenaar <Bram@vim.org>
parents:
17259
diff
changeset
|
8874 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8875 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8876 GetWinid()->screenpos(lnum, col) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8877 |
| 3996 | 8878 screenrow() *screenrow()* |
| 8879 The result is a Number, which is the current screen row of the | |
| 8880 cursor. The top line has number one. | |
| 8881 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
|
8882 Alternatively you can use |winline()|. |
| 3996 | 8883 |
| 8884 Note: Same restrictions as with |screencol()|. | |
| 8885 | |
|
16133
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8886 screenstring({row}, {col}) *screenstring()* |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8887 The result is a String that contains the base character and |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8888 any composing characters at position [row, col] on the screen. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8889 This is like |screenchars()| but returning a String with the |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8890 characters. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8891 This is mainly to be used for testing. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8892 Returns an empty String when row or col is out of range. |
|
eb087f8a26a8
patch 8.1.1071: cannot get composing characters from the screen
Bram Moolenaar <Bram@vim.org>
parents:
16127
diff
changeset
|
8893 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8894 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8895 GetRow()->screenstring(col) |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8896 < |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8897 *search()* |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8898 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 7 | 8899 Search for regexp pattern {pattern}. The search starts at the |
| 119 | 8900 cursor position (you can use |cursor()| to set it). |
| 707 | 8901 |
| 3967 | 8902 When a match has been found its line number is returned. |
| 3312 | 8903 If there is no match a 0 is returned and the cursor doesn't |
| 8904 move. No error message is given. | |
| 8905 | |
| 7 | 8906 {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
|
8907 'b' search Backward instead of forward |
|
6fbeef3b65e6
commit https://github.com/vim/vim/commit/ad4d8a192abf44b89371af87d70b971cd654b799
Christian Brabandt <cb@256bit.org>
parents:
7315
diff
changeset
|
8908 'c' accept a match at the Cursor position |
| 712 | 8909 'e' move to the End of the match |
| 20 | 8910 '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
|
8911 '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
|
8912 '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
|
8913 '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
|
8914 '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
|
8915 'z' start searching at the cursor column instead of zero |
| 7 | 8916 If neither 'w' or 'W' is given, the 'wrapscan' option applies. |
| 8917 | |
| 444 | 8918 If the 's' flag is supplied, the ' mark is set, only if the |
| 8919 cursor is moved. The 's' flag cannot be combined with the 'n' | |
| 8920 flag. | |
| 8921 | |
| 1156 | 8922 'ignorecase', 'smartcase' and 'magic' are used. |
| 12785 | 8923 |
| 22958 | 8924 When the 'z' flag is not given, forward searching always |
| 8925 starts in column zero and then matches before the cursor are | |
| 8926 skipped. When the 'c' flag is present in 'cpo' the next | |
| 8927 search starts after the match. Without the 'c' flag the next | |
| 8928 search starts one column further. This matters for | |
| 8929 overlapping matches. | |
| 8930 When searching backwards and the 'z' flag is given then the | |
| 8931 search starts in column zero, thus no match in the current | |
| 8932 line will be found (unless wrapping around the end of the | |
| 8933 file). | |
| 1156 | 8934 |
| 692 | 8935 When the {stopline} argument is given then the search stops |
| 8936 after searching this line. This is useful to restrict the | |
| 8937 search to a range of lines. Examples: > | |
| 8938 let match = search('(', 'b', line("w0")) | |
| 8939 let end = search('END', '', line("w$")) | |
| 8940 < When {stopline} is used and it is not zero this also implies | |
| 8941 that the search does not wrap around the end of the file. | |
| 1496 | 8942 A zero value is equal to not giving the argument. |
| 8943 | |
| 8944 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
|
8945 more than this many milliseconds have passed. Thus when |
| 1496 | 8946 {timeout} is 500 the search stops after half a second. |
| 8947 The value must not be negative. A zero value is like not | |
| 8948 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
|
8949 {only available when compiled with the |+reltime| feature} |
| 692 | 8950 |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8951 If the {skip} expression is given it is evaluated with the |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8952 cursor positioned on the start of a match. If it evaluates to |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8953 non-zero this match is skipped. This can be used, for |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8954 example, to skip a match in a comment or a string. |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8955 {skip} can be a string, which is evaluated as an expression, a |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8956 function reference or a lambda. |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8957 When {skip} is omitted or empty, every match is accepted. |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8958 When evaluating {skip} causes an error the search is aborted |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
8959 and -1 returned. |
| 714 | 8960 *search()-sub-match* |
| 8961 With the 'p' flag the returned value is one more than the | |
| 8962 first sub-match in \(\). One if none of them matched but the | |
| 8963 whole pattern did match. | |
| 712 | 8964 To get the column number too use |searchpos()|. |
| 8965 | |
| 20 | 8966 The cursor will be positioned at the match, unless the 'n' |
| 707 | 8967 flag is used. |
| 7 | 8968 |
| 8969 Example (goes over all files in the argument list): > | |
| 8970 :let n = 1 | |
| 8971 :while n <= argc() " loop over all files in arglist | |
| 8972 : exe "argument " . n | |
| 8973 : " start at the last char in the file and wrap for the | |
| 8974 : " first search to find match at start of file | |
| 8975 : normal G$ | |
| 8976 : let flags = "w" | |
| 8977 : while search("foo", flags) > 0 | |
| 1621 | 8978 : s/foo/bar/g |
| 7 | 8979 : let flags = "W" |
| 8980 : endwhile | |
| 8981 : update " write the file if modified | |
| 8982 : let n = n + 1 | |
| 8983 :endwhile | |
| 8984 < | |
| 712 | 8985 Example for using some flags: > |
| 8986 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') | |
| 8987 < This will search for the keywords "if", "else", and "endif" | |
| 8988 under or after the cursor. Because of the 'p' flag, it | |
| 8989 returns 1, 2, or 3 depending on which keyword is found, or 0 | |
| 8990 if the search fails. With the cursor on the first word of the | |
| 8991 line: | |
| 8992 if (foo == 0) | let foo = foo + 1 | endif ~ | |
| 8993 the function returns 1. Without the 'c' flag, the function | |
| 8994 finds the "endif" and returns 3. The same thing happens | |
| 8995 without the 'e' flag if the cursor is on the "f" of "if". | |
| 8996 The 'n' flag tells the function not to move the cursor. | |
| 8997 | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8998 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
8999 GetPattern()->search() |
| 504 | 9000 |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9001 searchcount([{options}]) *searchcount()* |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9002 Get or update the last search count, like what is displayed |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9003 without the "S" flag in 'shortmess'. This works even if |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9004 'shortmess' does contain the "S" flag. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9005 |
| 21093 | 9006 This returns a |Dictionary|. The dictionary is empty if the |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9007 previous pattern was not set and "pattern" was not specified. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9008 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9009 key type meaning ~ |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9010 current |Number| current position of match; |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9011 0 if the cursor position is |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9012 before the first match |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9013 exact_match |Boolean| 1 if "current" is matched on |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9014 "pos", otherwise 0 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9015 total |Number| total count of matches found |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9016 incomplete |Number| 0: search was fully completed |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9017 1: recomputing was timed out |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9018 2: max count exceeded |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9019 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9020 For {options} see further down. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9021 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9022 To get the last search count when |n| or |N| was pressed, call |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9023 this function with `recompute: 0` . This sometimes returns |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9024 wrong information because |n| and |N|'s maximum count is 99. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9025 If it exceeded 99 the result must be max count + 1 (100). If |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9026 you want to get correct information, specify `recompute: 1`: > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9027 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9028 " result == maxcount + 1 (100) when many matches |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9029 let result = searchcount(#{recompute: 0}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9030 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9031 " Below returns correct result (recompute defaults |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9032 " to 1) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9033 let result = searchcount() |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9034 < |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9035 The function is useful to add the count to |statusline|: > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9036 function! LastSearchCount() abort |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9037 let result = searchcount(#{recompute: 0}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9038 if empty(result) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9039 return '' |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9040 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9041 if result.incomplete ==# 1 " timed out |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9042 return printf(' /%s [?/??]', @/) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9043 elseif result.incomplete ==# 2 " max count exceeded |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9044 if result.total > result.maxcount && |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9045 \ result.current > result.maxcount |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9046 return printf(' /%s [>%d/>%d]', @/, |
| 20965 | 9047 \ result.current, result.total) |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9048 elseif result.total > result.maxcount |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9049 return printf(' /%s [%d/>%d]', @/, |
| 20965 | 9050 \ result.current, result.total) |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9051 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9052 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9053 return printf(' /%s [%d/%d]', @/, |
| 20965 | 9054 \ result.current, result.total) |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9055 endfunction |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9056 let &statusline .= '%{LastSearchCount()}' |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9057 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9058 " Or if you want to show the count only when |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9059 " 'hlsearch' was on |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9060 " let &statusline .= |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9061 " \ '%{v:hlsearch ? LastSearchCount() : ""}' |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9062 < |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9063 You can also update the search count, which can be useful in a |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9064 |CursorMoved| or |CursorMovedI| autocommand: > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9065 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9066 autocmd CursorMoved,CursorMovedI * |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9067 \ let s:searchcount_timer = timer_start( |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9068 \ 200, function('s:update_searchcount')) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9069 function! s:update_searchcount(timer) abort |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9070 if a:timer ==# s:searchcount_timer |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9071 call searchcount(#{ |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9072 \ recompute: 1, maxcount: 0, timeout: 100}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9073 redrawstatus |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9074 endif |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9075 endfunction |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9076 < |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9077 This can also be used to count matched texts with specified |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9078 pattern in the current buffer using "pattern": > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9079 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9080 " Count '\<foo\>' in this buffer |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9081 " (Note that it also updates search count) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9082 let result = searchcount(#{pattern: '\<foo\>'}) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9083 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9084 " To restore old search count by old pattern, |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9085 " search again |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9086 call searchcount() |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9087 < |
| 21093 | 9088 {options} must be a |Dictionary|. It can contain: |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9089 key type meaning ~ |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9090 recompute |Boolean| if |TRUE|, recompute the count |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9091 like |n| or |N| was executed. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9092 otherwise returns the last |
|
20687
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
9093 computed result (when |n| or |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
9094 |N| was used when "S" is not |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
9095 in 'shortmess', or this |
|
770a8e9c4781
patch 8.2.0897: list of functions in patched version is outdated
Bram Moolenaar <Bram@vim.org>
parents:
20679
diff
changeset
|
9096 function was called). |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9097 (default: |TRUE|) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9098 pattern |String| recompute if this was given |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9099 and different with |@/|. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9100 this works as same as the |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9101 below command is executed |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9102 before calling this function > |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9103 let @/ = pattern |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9104 < (default: |@/|) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9105 timeout |Number| 0 or negative number is no |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9106 timeout. timeout milliseconds |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9107 for recomputing the result |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9108 (default: 0) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9109 maxcount |Number| 0 or negative number is no |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9110 limit. max count of matched |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9111 text while recomputing the |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9112 result. if search exceeded |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9113 total count, "total" value |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9114 becomes `maxcount + 1` |
| 23466 | 9115 (default: 99) |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9116 pos |List| `[lnum, col, off]` value |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9117 when recomputing the result. |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9118 this changes "current" result |
| 21676 | 9119 value. see |cursor()|, |
| 9120 |getpos()| | |
|
20647
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9121 (default: cursor's position) |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9122 |
|
8a2b86a39ef4
patch 8.2.0877: cannot get the search statistics
Bram Moolenaar <Bram@vim.org>
parents:
20643
diff
changeset
|
9123 |
| 523 | 9124 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* |
| 9125 Search for the declaration of {name}. | |
| 856 | 9126 |
| 523 | 9127 With a non-zero {global} argument it works like |gD|, find |
| 9128 first match in the file. Otherwise it works like |gd|, find | |
| 9129 first match in the function. | |
| 9130 | |
| 9131 With a non-zero {thisblock} argument matches in a {} block | |
| 9132 that ends before the cursor position are ignored. Avoids | |
| 9133 finding variable declarations only valid in another scope. | |
| 9134 | |
| 504 | 9135 Moves the cursor to the found match. |
| 9136 Returns zero for success, non-zero for failure. | |
| 9137 Example: > | |
| 9138 if searchdecl('myvar') == 0 | |
| 9139 echo getline('.') | |
| 9140 endif | |
| 9141 < | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9142 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9143 GetName()->searchdecl() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9144 < |
| 7 | 9145 *searchpair()* |
| 1496 | 9146 searchpair({start}, {middle}, {end} [, {flags} [, {skip} |
| 9147 [, {stopline} [, {timeout}]]]]) | |
| 7 | 9148 Search for the match of a nested start-end pair. This can be |
| 9149 used to find the "endif" that matches an "if", while other | |
| 9150 if/endif pairs in between are ignored. | |
| 677 | 9151 The search starts at the cursor. The default is to search |
| 9152 forward, include 'b' in {flags} to search backward. | |
| 9153 If a match is found, the cursor is positioned at it and the | |
| 9154 line number is returned. If no match is found 0 or -1 is | |
| 9155 returned and the cursor doesn't move. No error message is | |
| 9156 given. | |
| 7 | 9157 |
| 9158 {start}, {middle} and {end} are patterns, see |pattern|. They | |
| 9159 must not contain \( \) pairs. Use of \%( \) is allowed. When | |
| 9160 {middle} is not empty, it is found when searching from either | |
| 9161 direction, but only when not in a nested start-end pair. A | |
| 9162 typical use is: > | |
| 9163 searchpair('\<if\>', '\<else\>', '\<endif\>') | |
| 9164 < By leaving {middle} empty the "else" is skipped. | |
| 9165 | |
| 712 | 9166 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with |
| 9167 |search()|. Additionally: | |
| 7 | 9168 'r' Repeat until no more matches found; will find the |
| 1621 | 9169 outer pair. Implies the 'W' flag. |
| 9170 'm' Return number of matches instead of line number with | |
| 712 | 9171 the match; will be > 1 when 'r' is used. |
| 1621 | 9172 Note: it's nearly always a good idea to use the 'W' flag, to |
| 9173 avoid wrapping around the end of the file. | |
| 7 | 9174 |
| 9175 When a match for {start}, {middle} or {end} is found, the | |
| 9176 {skip} expression is evaluated with the cursor positioned on | |
| 9177 the start of the match. It should return non-zero if this | |
| 9178 match is to be skipped. E.g., because it is inside a comment | |
| 9179 or a string. | |
| 9180 When {skip} is omitted or empty, every match is accepted. | |
| 9181 When evaluating {skip} causes an error the search is aborted | |
| 9182 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
|
9183 {skip} can be a string, a lambda, a funcref or a partial. |
| 14193 | 9184 Anything else makes the function fail. |
| 7 | 9185 |
| 1496 | 9186 For {stopline} and {timeout} see |search()|. |
| 692 | 9187 |
| 7 | 9188 The value of 'ignorecase' is used. 'magic' is ignored, the |
| 9189 patterns are used like it's on. | |
| 9190 | |
| 9191 The search starts exactly at the cursor. A match with | |
| 9192 {start}, {middle} or {end} at the next character, in the | |
| 9193 direction of searching, is the first one found. Example: > | |
| 9194 if 1 | |
| 9195 if 2 | |
| 9196 endif 2 | |
| 9197 endif 1 | |
| 9198 < When starting at the "if 2", with the cursor on the "i", and | |
| 9199 searching forwards, the "endif 2" is found. When starting on | |
| 9200 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
|
9201 found. That's because the "if 2" will be found first, and |
| 7 | 9202 then this is considered to be a nested if/endif from "if 2" to |
| 9203 "endif 2". | |
| 9204 When searching backwards and {end} is more than one character, | |
| 9205 it may be useful to put "\zs" at the end of the pattern, so | |
| 9206 that when the cursor is inside a match with the end it finds | |
| 9207 the matching start. | |
| 9208 | |
| 9209 Example, to find the "endif" command in a Vim script: > | |
| 9210 | |
| 9211 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', | |
| 9212 \ 'getline(".") =~ "^\\s*\""') | |
| 9213 | |
| 9214 < The cursor must be at or after the "if" for which a match is | |
| 9215 to be found. Note that single-quote strings are used to avoid | |
| 9216 having to double the backslashes. The skip expression only | |
| 9217 catches comments at the start of a line, not after a command. | |
| 9218 Also, a word "en" or "if" halfway a line is considered a | |
| 9219 match. | |
| 9220 Another example, to search for the matching "{" of a "}": > | |
| 9221 | |
| 9222 :echo searchpair('{', '', '}', 'bW') | |
| 9223 | |
| 9224 < This works when the cursor is at or before the "}" for which a | |
| 9225 match is to be found. To reject matches that syntax | |
| 9226 highlighting recognized as strings: > | |
| 9227 | |
| 9228 :echo searchpair('{', '', '}', 'bW', | |
| 9229 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') | |
| 9230 < | |
| 667 | 9231 *searchpairpos()* |
| 1496 | 9232 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} |
| 9233 [, {stopline} [, {timeout}]]]]) | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9234 Same as |searchpair()|, but returns a |List| with the line and |
| 685 | 9235 column position of the match. The first element of the |List| |
| 9236 is the line number and the second element is the byte index of | |
| 667 | 9237 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
|
9238 returns [0, 0]. > |
|
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9239 |
| 667 | 9240 :let [lnum,col] = searchpairpos('{', '', '}', 'n') |
| 9241 < | |
| 9242 See |match-parens| for a bigger and more useful example. | |
| 9243 | |
|
20725
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
9244 *searchpos()* |
|
f4455c71a8aa
patch 8.2.0915: search() cannot skip over matches like searchpair() can
Bram Moolenaar <Bram@vim.org>
parents:
20687
diff
changeset
|
9245 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) |
| 692 | 9246 Same as |search()|, but returns a |List| with the line and |
| 685 | 9247 column position of the match. The first element of the |List| |
| 9248 is the line number and the second element is the byte index of | |
| 9249 the column position of the match. If no match is found, | |
| 9250 returns [0, 0]. | |
| 714 | 9251 Example: > |
| 9252 :let [lnum, col] = searchpos('mypattern', 'n') | |
| 9253 | |
| 9254 < When the 'p' flag is given then there is an extra item with | |
| 9255 the sub-pattern match number |search()-sub-match|. Example: > | |
| 9256 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') | |
| 9257 < In this example "submatch" is 2 when a lowercase letter is | |
| 9258 found |/\l|, 3 when an uppercase letter is found |/\u|. | |
| 9259 | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9260 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9261 GetPattern()->searchpos() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9262 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
9263 server2client({clientid}, {string}) *server2client()* |
| 7 | 9264 Send a reply string to {clientid}. The most recent {clientid} |
| 9265 that sent a string can be retrieved with expand("<client>"). | |
| 9266 {only available when compiled with the |+clientserver| feature} | |
| 23666 | 9267 Returns zero for success, -1 for failure. |
| 7 | 9268 Note: |
| 9269 This id has to be stored before the next command can be | |
| 236 | 9270 received. I.e. before returning from the received command and |
| 7 | 9271 before calling any commands that waits for input. |
| 9272 See also |clientserver|. | |
| 9273 Example: > | |
| 9274 :echo server2client(expand("<client>"), "HELLO") | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9275 |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9276 < Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9277 GetClientId()->server2client(string) |
| 7 | 9278 < |
| 9279 serverlist() *serverlist()* | |
| 9280 Return a list of available server names, one per line. | |
| 9281 When there are no servers or the information is not available | |
| 9282 an empty string is returned. See also |clientserver|. | |
| 9283 {only available when compiled with the |+clientserver| feature} | |
| 9284 Example: > | |
| 9285 :echo serverlist() | |
| 9286 < | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9287 setbufline({expr}, {lnum}, {text}) *setbufline()* |
| 18343 | 9288 Set line {lnum} to {text} in buffer {expr}. This works like |
| 9289 |setline()| for the specified buffer. | |
| 9290 | |
| 9291 This function works only for loaded buffers. First call | |
| 9292 |bufload()| if needed. | |
| 9293 | |
| 9294 To insert lines use |appendbufline()|. | |
| 9295 Any text properties in {lnum} are cleared. | |
| 9296 | |
| 9297 {text} can be a string to set one line, or a list of strings | |
| 9298 to set multiple lines. If the list extends below the last | |
| 9299 line then those lines are added. | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9300 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9301 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
|
9302 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9303 {lnum} is used like with |setline()|. |
| 18343 | 9304 When {lnum} is just below the last line the {text} will be |
| 9305 added below the last line. | |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
9306 |
|
17259
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
9307 When {expr} is not a valid buffer, the buffer is not loaded or |
|
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
9308 {lnum} is not valid then 1 is returned. On success 0 is |
|
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
9309 returned. |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9310 |
| 18343 | 9311 Can also be used as a |method|, the base is passed as the |
| 9312 third argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9313 GetText()->setbufline(buf, lnum) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9314 |
| 7 | 9315 setbufvar({expr}, {varname}, {val}) *setbufvar()* |
| 9316 Set option or local variable {varname} in buffer {expr} to | |
| 9317 {val}. | |
| 9318 This also works for a global or local window option, but it | |
| 9319 doesn't work for a global or local window variable. | |
| 9320 For a local window option the global value is unchanged. | |
| 9321 For the use of {expr}, see |bufname()| above. | |
| 9322 Note that the variable name without "b:" must be used. | |
| 9323 Examples: > | |
| 9324 :call setbufvar(1, "&mod", 1) | |
| 9325 :call setbufvar("todo", "myvar", "foobar") | |
| 9326 < This function is not available in the |sandbox|. | |
| 9327 | |
| 18343 | 9328 Can also be used as a |method|, the base is passed as the |
| 9329 third argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9330 GetValue()->setbufvar(buf, varname) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9331 |
|
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9332 |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9333 setcellwidths({list}) *setcellwidths()* |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9334 Specify overrides for cell widths of character ranges. This |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9335 tells Vim how wide characters are, counted in screen cells. |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9336 This overrides 'ambiwidth'. Example: > |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9337 setcellwidths([[0xad, 0xad, 1], |
| 21991 | 9338 \ [0x2194, 0x2199, 2]]) |
|
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9339 |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9340 < *E1109* *E1110* *E1111* *E1112* *E1113* |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9341 The {list} argument is a list of lists with each three |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9342 numbers. These three numbers are [low, high, width]. "low" |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9343 and "high" can be the same, in which case this refers to one |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9344 character. Otherwise it is the range of characters from "low" |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9345 to "high" (inclusive). "width" is either 1 or 2, indicating |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9346 the character width in screen cells. |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9347 An error is given if the argument is invalid, also when a |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9348 range overlaps with another. |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9349 Only characters with value 0x100 and higher can be used. |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9350 |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9351 To clear the overrides pass an empty list: > |
|
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9352 setcellwidths([]); |
| 21991 | 9353 < You can use the script $VIMRUNTIME/tools/emoji_list.vim to see |
| 9354 the effect for known emoji characters. | |
|
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9355 |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9356 setcharpos({expr}, {list}) *setcharpos()* |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9357 Same as |setpos()| but uses the specified column number as the |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9358 character index instead of the byte index in the line. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9359 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9360 Example: |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9361 With the text "여보세요" in line 8: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9362 call setcharpos('.', [0, 8, 4, 0]) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9363 < positions the cursor on the fourth character '요'. > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9364 call setpos('.', [0, 8, 4, 0]) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9365 < positions the cursor on the second character '보'. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9366 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9367 Can also be used as a |method|: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9368 GetPosition()->setcharpos('.') |
|
21971
0bc43a704f56
patch 8.2.1535: it is not possible to specify cell widths of characters
Bram Moolenaar <Bram@vim.org>
parents:
21935
diff
changeset
|
9369 |
|
7100
f717d96a39b3
commit https://github.com/vim/vim/commit/12969c04fe7bd27dc0cbf37709eb40a86d4a27f9
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
9370 setcharsearch({dict}) *setcharsearch()* |
| 6991 | 9371 Set the current character search information to {dict}, |
| 9372 which contains one or more of the following entries: | |
| 9373 | |
| 9374 char character which will be used for a subsequent | |
| 9375 |,| or |;| command; an empty string clears the | |
| 9376 character search | |
| 9377 forward direction of character search; 1 for forward, | |
| 9378 0 for backward | |
| 9379 until type of character search; 1 for a |t| or |T| | |
| 9380 character search, 0 for an |f| or |F| | |
| 9381 character search | |
| 9382 | |
| 9383 This can be useful to save/restore a user's character search | |
| 9384 from a script: > | |
| 9385 :let prevsearch = getcharsearch() | |
| 9386 :" Perform a command which clobbers user's search | |
| 9387 :call setcharsearch(prevsearch) | |
| 9388 < Also see |getcharsearch()|. | |
| 9389 | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9390 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9391 SavedSearch()->setcharsearch() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9392 |
| 7 | 9393 setcmdpos({pos}) *setcmdpos()* |
| 9394 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
|
9395 {pos}. The first position is 1. |
| 7 | 9396 Use |getcmdpos()| to obtain the current position. |
| 9397 Only works while editing the command line, thus you must use | |
| 99 | 9398 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For |
| 9399 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is | |
| 9400 set after the command line is set to the expression. For | |
| 9401 |c_CTRL-R_=| it is set after evaluating the expression but | |
| 9402 before inserting the resulting text. | |
| 7 | 9403 When the number is too big the cursor is put at the end of the |
| 9404 line. A number smaller than one has undefined results. | |
| 23666 | 9405 Returns FALSE when successful, TRUE when not editing the |
| 9406 command line. | |
| 7 | 9407 |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9408 Can also be used as a |method|: > |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9409 GetPos()->setcmdpos() |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9410 |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9411 setcursorcharpos({lnum}, {col} [, {off}]) *setcursorcharpos()* |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9412 setcursorcharpos({list}) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9413 Same as |cursor()| but uses the specified column number as the |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9414 character index instead of the byte index in the line. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9415 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9416 Example: |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9417 With the text "여보세요" in line 4: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9418 call setcursorcharpos(4, 3) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9419 < positions the cursor on the third character '세'. > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9420 call cursor(4, 3) |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9421 < positions the cursor on the first character '여'. |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9422 |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9423 Can also be used as a |method|: > |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9424 GetCursorPos()->setcursorcharpos() |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9425 |
|
16604
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
9426 setenv({name}, {val}) *setenv()* |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
9427 Set environment variable {name} to {val}. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
9428 When {val} is |v:null| the environment variable is deleted. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
9429 See also |expr-env|. |
|
1e0a5f09fdf1
patch 8.1.1305: there is no easy way to manipulate environment variables
Bram Moolenaar <Bram@vim.org>
parents:
16600
diff
changeset
|
9430 |
| 18343 | 9431 Can also be used as a |method|, the base is passed as the |
| 9432 second argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9433 GetPath()->setenv('PATH') |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9434 |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9435 setfperm({fname}, {mode}) *setfperm()* *chmod* |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9436 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
|
9437 {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
|
9438 "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
|
9439 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
|
9440 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
|
9441 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
|
9442 characters are not supported. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9443 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9444 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
|
9445 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
|
9446 would do the same thing. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9447 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9448 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
|
9449 |
|
17857
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
9450 Can also be used as a |method|: > |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
9451 GetFilename()->setfperm(mode) |
|
4935244c1128
patch 8.1.1925: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17855
diff
changeset
|
9452 < |
|
8451
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9453 To read permissions see |getfperm()|. |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9454 |
|
c0b5c2b0a5ee
commit https://github.com/vim/vim/commit/8049253b96838b3584600e5ad229abad37a95b10
Christian Brabandt <cb@256bit.org>
parents:
8440
diff
changeset
|
9455 |
| 1621 | 9456 setline({lnum}, {text}) *setline()* |
| 3312 | 9457 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
|
9458 lines use |append()|. To set lines in another buffer use |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
9459 |setbufline()|. Any text properties in {lnum} are cleared. |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9460 |
| 236 | 9461 {lnum} is used like with |getline()|. |
| 1621 | 9462 When {lnum} is just below the last line the {text} will be |
| 18343 | 9463 added below the last line. |
|
23788
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
9464 {text} can be any type or a List of any type, each item is |
|
d12ef361d9de
patch 8.2.2435: setline() gives an error for some types
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
9465 converted to a String. |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9466 |
| 23666 | 9467 If this succeeds, FALSE is returned. If this fails (most likely |
| 9468 because {lnum} is invalid) TRUE is returned. | |
|
12319
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9469 |
|
c7e95667d14b
patch 8.0.1039: cannot change a line in not current buffer
Christian Brabandt <cb@256bit.org>
parents:
12317
diff
changeset
|
9470 Example: > |
| 7 | 9471 :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
|
9472 |
| 1621 | 9473 < When {text} is a |List| then line {lnum} and following lines |
| 282 | 9474 will be set to the items in the list. Example: > |
| 9475 :call setline(5, ['aaa', 'bbb', 'ccc']) | |
| 9476 < This is equivalent to: > | |
| 3465 | 9477 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] |
| 282 | 9478 : call setline(n, l) |
| 9479 :endfor | |
|
12427
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
9480 |
| 7 | 9481 < Note: The '[ and '] marks are not set. |
| 9482 | |
| 18343 | 9483 Can also be used as a |method|, the base is passed as the |
| 9484 second argument: > | |
|
17994
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9485 GetText()->setline(lnum) |
|
0dcc2ee838dd
patch 8.1.1993: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17982
diff
changeset
|
9486 |
| 12785 | 9487 setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()* |
| 647 | 9488 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
|
9489 {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
|
9490 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
|
9491 |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
9492 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
|
9493 modified. For an invalid window number {nr}, -1 is returned. |
| 1326 | 9494 Otherwise, same as |setqflist()|. |
| 9495 Also see |location-list|. | |
| 9496 | |
| 21250 | 9497 For {action} see |setqflist-action|. |
| 9498 | |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9499 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
|
9500 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
|
9501 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
|
9502 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9503 Can also be used as a |method|, the base is passed as the |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9504 second argument: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9505 GetLoclist()->setloclist(winnr) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9506 |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
9507 setmatches({list} [, {win}]) *setmatches()* |
|
20178
2fb397573541
patch 8.2.0644: insufficient testing for invalid function arguments
Bram Moolenaar <Bram@vim.org>
parents:
20115
diff
changeset
|
9508 Restores a list of matches saved by |getmatches()| for the |
|
2fb397573541
patch 8.2.0644: insufficient testing for invalid function arguments
Bram Moolenaar <Bram@vim.org>
parents:
20115
diff
changeset
|
9509 current window. Returns 0 if successful, otherwise -1. All |
|
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
9510 current matches are cleared before the list is restored. See |
|
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
16103
diff
changeset
|
9511 example for |getmatches()|. |
|
16158
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
9512 If {win} is specified, use the window with this number or |
|
aef0f93d3eba
patch 8.1.1084: cannot delete a match from another window
Bram Moolenaar <Bram@vim.org>
parents:
16133
diff
changeset
|
9513 window ID instead of the current window. |
| 230 | 9514 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9515 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9516 GetMatches()->setmatches() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9517 < |
| 707 | 9518 *setpos()* |
| 9519 setpos({expr}, {list}) | |
| 9520 Set the position for {expr}. Possible values: | |
| 9521 . the cursor | |
| 9522 'x mark x | |
| 9523 | |
| 5938 | 9524 {list} must be a |List| with four or five numbers: |
| 707 | 9525 [bufnum, lnum, col, off] |
| 5938 | 9526 [bufnum, lnum, col, off, curswant] |
| 707 | 9527 |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
9528 "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
|
9529 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
|
9530 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
|
9531 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
|
9532 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
|
9533 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
|
9534 since these are associated with a window, not a buffer. |
| 798 | 9535 Does not change the jumplist. |
| 707 | 9536 |
| 9537 "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
|
9538 column is 1. Use a zero "lnum" to delete a mark. If "col" is |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9539 smaller than 1 then 1 is used. To use the character count |
|
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9540 instead of the byte count, use |setcharpos()|. |
| 707 | 9541 |
| 9542 The "off" number is only used when 'virtualedit' is set. Then | |
| 9543 it is the offset in screen columns from the start of the | |
| 1266 | 9544 character. E.g., a position within a <Tab> or after the last |
| 707 | 9545 character. |
| 9546 | |
| 5938 | 9547 The "curswant" number is only used when setting the cursor |
| 9548 position. It sets the preferred column for when moving the | |
| 9549 cursor vertically. When the "curswant" number is missing the | |
| 9550 preferred column is not set. When it is present and setting a | |
| 9551 mark position it is not used. | |
| 9552 | |
| 5555 | 9553 Note that for '< and '> changing the line number may result in |
| 9554 the marks to be effectively be swapped, so that '< is always | |
| 9555 before '>. | |
| 9556 | |
| 1533 | 9557 Returns 0 when the position could be set, -1 otherwise. |
| 9558 An error message is given if {expr} is invalid. | |
| 9559 | |
|
23563
87671ccc6c6b
patch 8.2.2324: not easy to get mark en cursor posotion by character count
Bram Moolenaar <Bram@vim.org>
parents:
23475
diff
changeset
|
9560 Also see |setcharpos()|, |getpos()| and |getcurpos()|. |
| 707 | 9561 |
| 1156 | 9562 This does not restore the preferred column for moving |
| 5938 | 9563 vertically; if you set the cursor position with this, |j| and |
| 9564 |k| motions will jump to previous columns! Use |cursor()| to | |
| 9565 also set the preferred column. Also see the "curswant" key in | |
| 9566 |winrestview()|. | |
| 1156 | 9567 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9568 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9569 GetPosition()->setpos('.') |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9570 |
| 12785 | 9571 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
|
9572 Create or replace or add to the quickfix list. |
| 12785 | 9573 |
| 19646 | 9574 If the optional {what} dictionary argument is supplied, then |
| 9575 only the items listed in {what} are set. The first {list} | |
| 9576 argument is ignored. See below for the supported items in | |
| 9577 {what}. | |
| 21250 | 9578 *setqflist-what* |
| 21676 | 9579 When {what} is not present, the items in {list} are used. Each |
|
12048
ebd313aa5a6c
patch 8.0.0904: cannot set a location list from text
Christian Brabandt <cb@256bit.org>
parents:
12045
diff
changeset
|
9580 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
|
9581 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
|
9582 entries: |
| 230 | 9583 |
| 1065 | 9584 bufnr buffer number; must be the number of a valid |
| 1621 | 9585 buffer |
| 1065 | 9586 filename name of a file; only used when "bufnr" is not |
| 1621 | 9587 present or it is invalid. |
|
13821
98274127d675
patch 8.0.1782: no simple way to label quickfix entries
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
9588 module name of a module; if given it will be used in |
|
98274127d675
patch 8.0.1782: no simple way to label quickfix entries
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
9589 quickfix error window instead of the filename. |
| 230 | 9590 lnum line number in the file |
| 233 | 9591 pattern search pattern used to locate the error |
| 230 | 9592 col column number |
| 233 | 9593 vcol when non-zero: "col" is visual column |
| 856 | 9594 when zero: "col" is byte index |
| 233 | 9595 nr error number |
| 230 | 9596 text description of the error |
| 233 | 9597 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
|
9598 valid recognized error message |
| 233 | 9599 |
| 9600 The "col", "vcol", "nr", "type" and "text" entries are | |
| 9601 optional. Either "lnum" or "pattern" entry can be used to | |
| 9602 locate a matching error line. | |
| 1065 | 9603 If the "filename" and "bufnr" entries are not present or |
| 9604 neither the "lnum" or "pattern" entries are present, then the | |
| 9605 item will not be handled as an error line. | |
| 230 | 9606 If both "pattern" and "lnum" are present then "pattern" will |
| 9607 be used. | |
|
11390
73cfcf11d983
patch 8.0.0580: cannot set the valid flag with setqflist()
Christian Brabandt <cb@256bit.org>
parents:
11347
diff
changeset
|
9608 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
|
9609 set when "bufnr" is a valid buffer or "filename" exists. |
| 2152 | 9610 If you supply an empty {list}, the quickfix list will be |
| 9611 cleared. | |
| 1065 | 9612 Note that the list is not exactly the same as what |
| 9613 |getqflist()| returns. | |
| 230 | 9614 |
| 21250 | 9615 {action} values: *setqflist-action* *E927* |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9616 '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
|
9617 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
|
9618 new list is created. |
| 12785 | 9619 |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9620 '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
|
9621 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
|
9622 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
|
9623 :call setqflist([], 'r') |
| 12785 | 9624 < |
|
11263
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9625 '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
|
9626 freed. |
|
ae5f9f26f81c
patch 8.0.0517: there is no way to remove quickfix lists
Christian Brabandt <cb@256bit.org>
parents:
11262
diff
changeset
|
9627 |
|
9221
17fa362f10be
commit https://github.com/vim/vim/commit/511972d810ea490955161ff5097ec2f57919ceaf
Christian Brabandt <cb@256bit.org>
parents:
9219
diff
changeset
|
9628 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
|
9629 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
|
9630 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
|
9631 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
|
9632 set "nr" in {what} to "$". |
| 277 | 9633 |
| 19646 | 9634 The following items can be specified in dictionary {what}: |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
9635 context quickfix list context. See |quickfix-context| |
|
12321
2779d593a706
patch 8.0.1040: cannot use another error format in getqflist()
Christian Brabandt <cb@256bit.org>
parents:
12319
diff
changeset
|
9636 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
|
9637 "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
|
9638 'errorformat' option value is used. |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9639 See |quickfix-parse| |
|
12287
20641a7e1fc9
patch 8.0.1023: it is not easy to identify a quickfix list
Christian Brabandt <cb@256bit.org>
parents:
12273
diff
changeset
|
9640 id quickfix list identifier |quickfix-ID| |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9641 idx index of the current entry in the quickfix |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9642 list specified by 'id' or 'nr'. If set to '$', |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9643 then the last entry in the list is set as the |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9644 current entry. See |quickfix-index| |
|
11549
f5add45f9848
patch 8.0.0657: cannot get and set quickfix list items
Christian Brabandt <cb@256bit.org>
parents:
11543
diff
changeset
|
9645 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
|
9646 argument. |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
9647 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
|
9648 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
|
9649 {nr} or {id}. Only a |List| value is supported. |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9650 See |quickfix-parse| |
|
11502
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
9651 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
|
9652 means the current quickfix list and "$" means |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9653 the last quickfix list. |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9654 quickfixtextfunc |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9655 function to get the text to display in the |
|
21409
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
9656 quickfix window. The value can be the name of |
|
2c40e60017a8
patch 8.2.1255: cannot use a lambda with quickfix functions
Bram Moolenaar <Bram@vim.org>
parents:
21381
diff
changeset
|
9657 a function or a funcref or a lambda. Refer to |
|
20631
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9658 |quickfix-window-function| for an explanation |
|
d6827bd31d1d
patch 8.2.0869: it is not possible to customize the quickfix window contents
Bram Moolenaar <Bram@vim.org>
parents:
20629
diff
changeset
|
9659 of how to write the function and an example. |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
9660 title quickfix list title text. See |quickfix-title| |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9661 Unsupported keys in {what} are ignored. |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9662 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
|
9663 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
|
9664 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
|
9665 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
|
9666 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
|
9667 specify the list. |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9668 |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
9669 Examples (See also |setqflist-examples|): > |
|
12303
ec7a4fd21dd5
patch 8.0.1031: "text" argument for getqflist() is confusing
Christian Brabandt <cb@256bit.org>
parents:
12287
diff
changeset
|
9670 :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
|
9671 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'}) |
|
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13796
diff
changeset
|
9672 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]}) |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
9673 < |
| 230 | 9674 Returns zero for success, -1 for failure. |
| 9675 | |
| 9676 This function can be used to create a quickfix list | |
| 9677 independent of the 'errorformat' setting. Use a command like | |
|
11400
0f8713fe20dc
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
11390
diff
changeset
|
9678 `:cc 1` to jump to the first position. |
| 230 | 9679 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9680 Can also be used as a |method|, the base is passed as the |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9681 second argument: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9682 GetErrorlist()->setqflist() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9683 < |
| 7 | 9684 *setreg()* |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8094
diff
changeset
|
9685 setreg({regname}, {value} [, {options}]) |
| 7 | 9686 Set the register {regname} to {value}. |
|
19783
546bdeef35f1
patch 8.2.0448: various functions not properly tested
Bram Moolenaar <Bram@vim.org>
parents:
19742
diff
changeset
|
9687 If {regname} is "" or "@", the unnamed register '"' is used. |
| 23931 | 9688 In |Vim9-script| {regname} must be one character. |
| 21093 | 9689 |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9690 {value} may be any value returned by |getreg()| or |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9691 |getreginfo()|, including a |List| or |Dict|. |
| 7 | 9692 If {options} contains "a" or {regname} is upper case, |
| 9693 then the value is appended. | |
| 21093 | 9694 |
| 2423 | 9695 {options} can also contain a register type specification: |
| 7 | 9696 "c" or "v" |characterwise| mode |
| 9697 "l" or "V" |linewise| mode | |
| 9698 "b" or "<CTRL-V>" |blockwise-visual| mode | |
| 9699 If a number immediately follows "b" or "<CTRL-V>" then this is | |
| 9700 used as the width of the selection - if it is not specified | |
| 9701 then the width of the block is set to the number of characters | |
| 1266 | 9702 in the longest line (counting a <Tab> as 1 character). |
| 7 | 9703 |
| 9704 If {options} contains no register settings, then the default | |
| 12785 | 9705 is to use character mode unless {value} ends in a <NL> for |
| 9706 string {value} and linewise mode for list {value}. Blockwise | |
| 5798 | 9707 mode is never selected automatically. |
| 9708 Returns zero for success, non-zero for failure. | |
| 9709 | |
| 9710 *E883* | |
| 12785 | 9711 Note: you may not use |List| containing more than one item to |
| 9712 set search and expression registers. Lists containing no | |
| 5798 | 9713 items act like empty strings. |
| 7 | 9714 |
| 9715 Examples: > | |
| 9716 :call setreg(v:register, @*) | |
| 9717 :call setreg('*', @%, 'ac') | |
| 9718 :call setreg('a', "1\n2\n3", 'b5') | |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9719 :call setreg('"', { 'points_to': 'a'}) |
| 7 | 9720 |
| 9721 < 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
|
9722 register: > |
|
20743
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9723 :let var_a = getreginfo() |
|
a672feb8fc4f
patch 8.2.0924: cannot save and restore a register properly
Bram Moolenaar <Bram@vim.org>
parents:
20725
diff
changeset
|
9724 :call setreg('a', var_a) |
| 21093 | 9725 < or: > |
| 5798 | 9726 :let var_a = getreg('a', 1, 1) |
| 7 | 9727 :let var_amode = getregtype('a') |
| 9728 .... | |
| 9729 :call setreg('a', var_a, var_amode) | |
| 12785 | 9730 < Note: you may not reliably restore register value |
| 9731 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
|
9732 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
|
9733 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
|
9734 |
|
fc3e2d5614dd
patch 8.0.1093: various small quickfix issues
Christian Brabandt <cb@256bit.org>
parents:
12389
diff
changeset
|
9735 You can also change the type of a register by appending |
| 7 | 9736 nothing: > |
| 9737 :call setreg('a', '', 'al') | |
| 9738 | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9739 < Can also be used as a |method|, the base is passed as the |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9740 second argument: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9741 GetText()->setreg('a') |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9742 |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9743 settabvar({tabnr}, {varname}, {val}) *settabvar()* |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9744 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
|
9745 |t:var| |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9746 Note that autocommands are blocked, side effects may not be |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9747 triggered, e.g. when setting 'filetype'. |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9748 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
|
9749 Tabs are numbered starting with one. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9750 This function is not available in the |sandbox|. |
|
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2206
diff
changeset
|
9751 |
| 18343 | 9752 Can also be used as a |method|, the base is passed as the |
| 9753 third argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9754 GetValue()->settabvar(tab, name) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9755 |
| 831 | 9756 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* |
| 9757 Set option or local variable {varname} in window {winnr} to | |
| 9758 {val}. | |
| 9759 Tabs are numbered starting with one. For the current tabpage | |
| 9760 use |setwinvar()|. | |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
9761 {winnr} can be the window number or the |window-ID|. |
| 831 | 9762 When {winnr} is zero the current window is used. |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9763 Note that autocommands are blocked, side effects may not be |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
9764 triggered, e.g. when setting 'filetype' or 'syntax'. |
| 7 | 9765 This also works for a global or local buffer option, but it |
| 9766 doesn't work for a global or local buffer variable. | |
| 9767 For a local buffer option the global value is unchanged. | |
| 9768 Note that the variable name without "w:" must be used. | |
| 831 | 9769 Examples: > |
| 9770 :call settabwinvar(1, 1, "&list", 0) | |
| 9771 :call settabwinvar(3, 2, "myvar", "foobar") | |
| 9772 < This function is not available in the |sandbox|. | |
| 9773 | |
| 18343 | 9774 Can also be used as a |method|, the base is passed as the |
| 9775 fourth argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9776 GetValue()->settabvar(tab, winnr, name) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9777 |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9778 settagstack({nr}, {dict} [, {action}]) *settagstack()* |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9779 Modify the tag stack of the window {nr} using {dict}. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9780 {nr} can be the window number or the |window-ID|. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9781 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9782 For a list of supported items in {dict}, refer to |
|
19033
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9783 |gettagstack()|. "curidx" takes effect before changing the tag |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9784 stack. |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9785 *E962* |
|
19033
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9786 How the tag stack is modified depends on the {action} |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9787 argument: |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9788 - If {action} is not present or is set to 'r', then the tag |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9789 stack is replaced. |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9790 - If {action} is set to 'a', then new entries from {dict} are |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9791 pushed (added) onto the tag stack. |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9792 - If {action} is set to 't', then all the entries from the |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9793 current entry in the tag stack or "curidx" in {dict} are |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9794 removed and then new entries are pushed to the stack. |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9795 |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9796 The current index is set to one after the length of the tag |
|
f0312cf3c792
patch 8.2.0077: settagstack() cannot truncate at current index
Bram Moolenaar <Bram@vim.org>
parents:
18987
diff
changeset
|
9797 stack after the modification. |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9798 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9799 Returns zero for success, -1 for failure. |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9800 |
| 21676 | 9801 Examples (for more examples see |tagstack-examples|): |
| 19968 | 9802 Empty the tag stack of window 3: > |
|
15016
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9803 call settagstack(3, {'items' : []}) |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9804 |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9805 < Save and restore the tag stack: > |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9806 let stack = gettagstack(1003) |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9807 " do something else |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9808 call settagstack(1003, stack) |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9809 unlet stack |
|
c338c91086b9
patch 8.1.0519: cannot save and restore the tag stack
Bram Moolenaar <Bram@vim.org>
parents:
15008
diff
changeset
|
9810 < |
| 18343 | 9811 Can also be used as a |method|, the base is passed as the |
| 9812 second argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9813 GetStack()->settagstack(winnr) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9814 |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9815 setwinvar({winnr}, {varname}, {val}) *setwinvar()* |
| 831 | 9816 Like |settabwinvar()| for the current tab page. |
| 7 | 9817 Examples: > |
| 9818 :call setwinvar(1, "&list", 0) | |
| 9819 :call setwinvar(2, "myvar", "foobar") | |
| 9820 | |
| 18343 | 9821 < Can also be used as a |method|, the base is passed as the |
| 9822 third argument: > | |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9823 GetValue()->setwinvar(winnr, name) |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9824 |
| 4126 | 9825 sha256({string}) *sha256()* |
| 6647 | 9826 Returns a String with 64 hex characters, which is the SHA256 |
| 4126 | 9827 checksum of {string}. |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9828 |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9829 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9830 GetText()->sha256() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9831 |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9832 < {only available when compiled with the |+cryptv| feature} |
| 4126 | 9833 |
| 1661 | 9834 shellescape({string} [, {special}]) *shellescape()* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
9835 Escape {string} for use as a shell command argument. |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
9836 On MS-Windows, when 'shellslash' is not set, it will enclose |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
9837 {string} in double quotes and double all double quotes within |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
9838 {string}. |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
9839 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
|
9840 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
|
9841 |
| 1661 | 9842 When the {special} argument is present and it's a non-zero |
| 9843 Number or a non-empty String (|non-zero-arg|), then special | |
| 1698 | 9844 items such as "!", "%", "#" and "<cword>" will be preceded by |
| 9845 a backslash. This backslash will be removed again by the |:!| | |
| 1661 | 9846 command. |
|
11502
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
9847 |
| 1698 | 9848 The "!" character will be escaped (again with a |non-zero-arg| |
| 9849 {special}) when 'shell' contains "csh" in the tail. That is | |
| 9850 because for csh and tcsh "!" is used for history replacement | |
| 9851 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
|
9852 |
|
46bbef0ee9a6
patch 8.0.0634: cannot easily get to the last quickfix list
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
9853 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
|
9854 escaped. When 'shell' containing "csh" in the tail it's |
| 1698 | 9855 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
|
9856 |
| 1661 | 9857 Example of use with a |:!| command: > |
| 9858 :exe '!dir ' . shellescape(expand('<cfile>'), 1) | |
| 9859 < This results in a directory listing for the file under the | |
| 9860 cursor. Example of use with |system()|: > | |
| 9861 :call system("chmod +w -- " . shellescape(expand("%"))) | |
| 5690 | 9862 < See also |::S|. |
| 985 | 9863 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9864 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9865 GetCommand()->shellescape() |
| 985 | 9866 |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9867 shiftwidth([{col}]) *shiftwidth()* |
| 3875 | 9868 Returns the effective value of 'shiftwidth'. This is the |
| 9869 '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
|
9870 'tabstop' value. This function was introduced with patch |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9871 7.3.694 in 2012, everybody should have it by now (however it |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9872 did not allow for the optional {col} argument until 8.1.542). |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9873 |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9874 When there is one argument {col} this is used as column number |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9875 for which to return the 'shiftwidth' value. This matters for the |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9876 'vartabstop' feature. If the 'vartabstop' setting is enabled and |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
15033
diff
changeset
|
9877 no {col} argument is given, column 1 will be assumed. |
| 15033 | 9878 |
|
18000
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9879 Can also be used as a |method|: > |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9880 GetColumn()->shiftwidth() |
|
7a19c8d6bb9e
patch 8.1.1996: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17994
diff
changeset
|
9881 |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
9882 sign_ functions are documented here: |sign-functions-details| |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
9883 |
|
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
9884 |
| 7 | 9885 simplify({filename}) *simplify()* |
| 9886 Simplify the file name as much as possible without changing | |
| 9887 the meaning. Shortcuts (on MS-Windows) or symbolic links (on | |
| 9888 Unix) are not resolved. If the first path component in | |
| 9889 {filename} designates the current directory, this will be | |
| 9890 valid for the result as well. A trailing path separator is | |
| 20965 | 9891 not removed either. On Unix "//path" is unchanged, but |
| 9892 "///path" is simplified to "/path" (this follows the Posix | |
| 9893 standard). | |
| 7 | 9894 Example: > |
| 9895 simplify("./dir/.././/file/") == "./file/" | |
| 9896 < Note: The combination "dir/.." is only removed if "dir" is | |
| 9897 a searchable directory or does not exist. On Unix, it is also | |
| 9898 removed when "dir" is a symbolic link within the same | |
| 9899 directory. In order to resolve all the involved symbolic | |
| 9900 links before simplifying the path name, use |resolve()|. | |
| 9901 | |
|
19952
82ea10d554fb
patch 8.2.0532: cannot use simplify() as a method
Bram Moolenaar <Bram@vim.org>
parents:
19874
diff
changeset
|
9902 Can also be used as a |method|: > |
|
82ea10d554fb
patch 8.2.0532: cannot use simplify() as a method
Bram Moolenaar <Bram@vim.org>
parents:
19874
diff
changeset
|
9903 GetName()->simplify() |
| 82 | 9904 |
| 1621 | 9905 sin({expr}) *sin()* |
| 9906 Return the sine of {expr}, measured in radians, as a |Float|. | |
| 9907 {expr} must evaluate to a |Float| or a |Number|. | |
| 9908 Examples: > | |
| 9909 :echo sin(100) | |
| 9910 < -0.506366 > | |
| 9911 :echo sin(-4.01) | |
| 9912 < 0.763301 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9913 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9914 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9915 Compute()->sin() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9916 < |
| 1621 | 9917 {only available when compiled with the |+float| feature} |
| 12785 | 9918 |
| 1621 | 9919 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9920 sinh({expr}) *sinh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9921 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
|
9922 [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
9923 {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
|
9924 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9925 :echo sinh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9926 < 0.521095 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9927 :echo sinh(-0.9) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9928 < -1.026517 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9929 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9930 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9931 Compute()->sinh() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
9932 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
9933 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9934 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
9935 |
|
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9936 slice({expr}, {start} [, {end}]) *slice()* |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9937 Similar to using a |slice| "expr[start : end]", but "end" is |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9938 used exclusive. And for a string the indexes are used as |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9939 character indexes instead of byte indexes, like in |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
9940 |vim9script|. Also, composing characters are not counted. |
|
23604
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9941 When {end} is omitted the slice continues to the last item. |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9942 When {end} is -1 the last item is omitted. |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9943 |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9944 Can also be used as a |method|: > |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9945 GetList()->slice(offset) |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9946 |
|
1816ea68c022
patch 8.2.2344: using inclusive index for slice is not always desired
Bram Moolenaar <Bram@vim.org>
parents:
23602
diff
changeset
|
9947 |
| 2902 | 9948 sort({list} [, {func} [, {dict}]]) *sort()* *E702* |
| 5747 | 9949 Sort the items in {list} in-place. Returns {list}. |
| 12785 | 9950 |
| 5747 | 9951 If you want a list to remain unmodified make a copy first: > |
| 82 | 9952 :let sortedlist = sort(copy(mylist)) |
| 5968 | 9953 |
| 6009 | 9954 < When {func} is omitted, is empty or zero, then sort() uses the |
| 9955 string representation of each item to sort on. Numbers sort | |
| 9956 after Strings, |Lists| after Numbers. For sorting text in the | |
| 9957 current buffer use |:sort|. | |
| 9958 | |
| 6180 | 9959 When {func} is given and it is '1' or 'i' then case is |
| 6009 | 9960 ignored. |
| 12785 | 9961 |
| 22824 | 9962 When {func} is given and it is 'l' then the current collation |
| 9963 locale is used for ordering. Implementation details: strcoll() | |
| 9964 is used to compare strings. See |:language| check or set the | |
| 9965 collation locale. |v:collate| can also be used to check the | |
| 9966 current locale. Sorting using the locale typically ignores | |
| 9967 case. Example: > | |
| 9968 " ö is sorted similarly to o with English locale. | |
| 9969 :language collate en_US.UTF8 | |
| 9970 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l') | |
| 9971 < ['n', 'o', 'O', 'ö', 'p', 'z'] ~ | |
| 9972 > | |
| 9973 " ö is sorted after z with Swedish locale. | |
| 9974 :language collate sv_SE.UTF8 | |
| 9975 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l') | |
| 9976 < ['n', 'o', 'O', 'p', 'z', 'ö'] ~ | |
| 9977 This does not work properly on Mac. | |
|
22770
3e4981de5636
patch 8.2.1933: cannot sort using locale ordering
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
9978 |
| 6009 | 9979 When {func} is given and it is 'n' then all items will be |
| 22824 | 9980 sorted numerical (Implementation detail: this uses the |
| 6009 | 9981 strtod() function to parse numbers, Strings, Lists, Dicts and |
| 9982 Funcrefs will be considered as being 0). | |
| 9983 | |
|
7291
6ffc75d807bd
commit https://github.com/vim/vim/commit/b00da1d6d1655cb6e415f84ecc3be5ff3b790811
Christian Brabandt <cb@256bit.org>
parents:
7279
diff
changeset
|
9984 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
|
9985 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
|
9986 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
|
9987 |
|
7707
41768bcebc9b
commit https://github.com/vim/vim/commit/13d5aeef56e3140a8eb8f40c7062aa1c5700f76e
Christian Brabandt <cb@256bit.org>
parents:
7703
diff
changeset
|
9988 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
|
9989 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
|
9990 |
| 685 | 9991 When {func} is a |Funcref| or a function name, this function |
| 9992 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
|
9993 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
|
9994 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
|
9995 smaller if the first one sorts before the second one. |
| 5747 | 9996 |
| 9997 {dict} is for functions with the "dict" attribute. It will be | |
| 9998 used to set the local variable "self". |Dictionary-function| | |
| 9999 | |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
10000 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
|
10001 string) will keep their relative position. E.g., when sorting |
| 6051 | 10002 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
|
10003 same order as they were originally. |
|
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
6009
diff
changeset
|
10004 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10005 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10006 mylist->sort() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10007 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10008 < Also see |uniq()|. |
| 5747 | 10009 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10010 Example: > |
| 82 | 10011 func MyCompare(i1, i2) |
| 10012 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 | |
| 10013 endfunc | |
| 10014 let sortedlist = sort(mylist, "MyCompare") | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10015 < A shorter compare version for this specific simple case, which |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10016 ignores overflow: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10017 func MyCompare(i1, i2) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10018 return a:i1 - a:i2 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
10019 endfunc |
| 344 | 10020 < |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
10021 sound_clear() *sound_clear()* |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
10022 Stop playing all sounds. |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10023 {only available when compiled with the |+sound| feature} |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
10024 |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10025 *sound_playevent()* |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10026 sound_playevent({name} [, {callback}]) |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10027 Play a sound identified by {name}. Which event names are |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10028 supported depends on the system. Often the XDG sound names |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10029 are used. On Ubuntu they may be found in |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10030 /usr/share/sounds/freedesktop/stereo. Example: > |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10031 call sound_playevent('bell') |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10032 < On MS-Windows, {name} can be SystemAsterisk, SystemDefault, |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10033 SystemExclamation, SystemExit, SystemHand, SystemQuestion, |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10034 SystemStart, SystemWelcome, etc. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10035 |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10036 When {callback} is specified it is invoked when the sound is |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10037 finished. The first argument is the sound ID, the second |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10038 argument is the status: |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10039 0 sound was played to the end |
| 17036 | 10040 1 sound was interrupted |
| 17161 | 10041 2 error occurred after sound started |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10042 Example: > |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10043 func Callback(id, status) |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10044 echomsg "sound " .. a:id .. " finished with " .. a:status |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10045 endfunc |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10046 call sound_playevent('bell', 'Callback') |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10047 |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10048 < MS-Windows: {callback} doesn't work for this function. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10049 |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10050 Returns the sound ID, which can be passed to `sound_stop()`. |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10051 Returns zero if the sound could not be played. |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10052 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10053 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10054 GetSoundName()->sound_playevent() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10055 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10056 < {only available when compiled with the |+sound| feature} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10057 |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10058 *sound_playfile()* |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
10059 sound_playfile({path} [, {callback}]) |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
10060 Like `sound_playevent()` but play sound file {path}. {path} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10061 must be a full path. On Ubuntu you may find files to play |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10062 with this command: > |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10063 :!find /usr/share/sounds -type f | grep -v index.theme |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10064 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10065 < Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10066 GetSoundPath()->sound_playfile() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10067 |
| 17036 | 10068 < {only available when compiled with the |+sound| feature} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10069 |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10070 |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10071 sound_stop({id}) *sound_stop()* |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10072 Stop playing sound {id}. {id} must be previously returned by |
|
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10073 `sound_playevent()` or `sound_playfile()`. |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10074 |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10075 On MS-Windows, this does not work for event sound started by |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10076 `sound_playevent()`. To stop event sounds, use `sound_clear()`. |
|
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
10077 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10078 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10079 soundid->sound_stop() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10080 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10081 < {only available when compiled with the |+sound| feature} |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
10082 |
| 374 | 10083 *soundfold()* |
| 10084 soundfold({word}) | |
| 10085 Return the sound-folded equivalent of {word}. Uses the first | |
| 1621 | 10086 language in 'spelllang' for the current window that supports |
| 375 | 10087 soundfolding. 'spell' must be set. When no sound folding is |
| 10088 possible the {word} is returned unmodified. | |
| 374 | 10089 This can be used for making spelling suggestions. Note that |
| 10090 the method can be quite slow. | |
| 10091 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10092 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10093 GetWord()->soundfold() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10094 < |
| 344 | 10095 *spellbadword()* |
| 532 | 10096 spellbadword([{sentence}]) |
| 10097 Without argument: The result is the badly spelled word under | |
| 10098 or after the cursor. The cursor is moved to the start of the | |
| 10099 bad word. When no bad word is found in the cursor line the | |
| 10100 result is an empty string and the cursor doesn't move. | |
| 10101 | |
| 10102 With argument: The result is the first word in {sentence} that | |
| 10103 is badly spelled. If there are no spelling mistakes the | |
| 10104 result is an empty string. | |
| 10105 | |
| 10106 The return value is a list with two items: | |
| 10107 - The badly spelled word or an empty string. | |
| 10108 - The type of the spelling error: | |
| 856 | 10109 "bad" spelling mistake |
| 532 | 10110 "rare" rare word |
| 10111 "local" word only valid in another region | |
| 10112 "caps" word should start with Capital | |
| 10113 Example: > | |
| 10114 echo spellbadword("the quik brown fox") | |
| 10115 < ['quik', 'bad'] ~ | |
| 10116 | |
|
20786
90b96fa35e4b
patch 8.2.0945: cannot use "z=" when 'spell' is off
Bram Moolenaar <Bram@vim.org>
parents:
20766
diff
changeset
|
10117 The spelling information for the current window and the value |
|
90b96fa35e4b
patch 8.2.0945: cannot use "z=" when 'spell' is off
Bram Moolenaar <Bram@vim.org>
parents:
20766
diff
changeset
|
10118 of 'spelllang' are used. |
| 344 | 10119 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10120 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10121 GetText()->spellbadword() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10122 < |
| 344 | 10123 *spellsuggest()* |
| 537 | 10124 spellsuggest({word} [, {max} [, {capital}]]) |
| 685 | 10125 Return a |List| with spelling suggestions to replace {word}. |
| 344 | 10126 When {max} is given up to this number of suggestions are |
| 10127 returned. Otherwise up to 25 suggestions are returned. | |
| 10128 | |
| 537 | 10129 When the {capital} argument is given and it's non-zero only |
| 10130 suggestions with a leading capital will be given. Use this | |
| 10131 after a match with 'spellcapcheck'. | |
| 10132 | |
| 344 | 10133 {word} can be a badly spelled word followed by other text. |
| 10134 This allows for joining two words that were split. The | |
| 359 | 10135 suggestions also include the following text, thus you can |
| 10136 replace a line. | |
| 10137 | |
| 10138 {word} may also be a good word. Similar words will then be | |
| 537 | 10139 returned. {word} itself is not included in the suggestions, |
| 10140 although it may appear capitalized. | |
| 344 | 10141 |
| 10142 The spelling information for the current window is used. The | |
|
20786
90b96fa35e4b
patch 8.2.0945: cannot use "z=" when 'spell' is off
Bram Moolenaar <Bram@vim.org>
parents:
20766
diff
changeset
|
10143 values of 'spelllang' and 'spellsuggest' are used. |
| 344 | 10144 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10145 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10146 GetWord()->spellsuggest() |
| 82 | 10147 |
| 282 | 10148 split({expr} [, {pattern} [, {keepempty}]]) *split()* |
| 685 | 10149 Make a |List| out of {expr}. When {pattern} is omitted or |
| 10150 empty each white-separated sequence of characters becomes an | |
| 10151 item. | |
| 82 | 10152 Otherwise the string is split where {pattern} matches, |
| 3920 | 10153 removing the matched characters. 'ignorecase' is not used |
| 10154 here, add \c to ignore case. |/\c| | |
| 282 | 10155 When the first or last item is empty it is omitted, unless the |
| 10156 {keepempty} argument is given and it's non-zero. | |
| 293 | 10157 Other empty items are kept when {pattern} matches at least one |
| 10158 character or when {keepempty} is non-zero. | |
| 82 | 10159 Example: > |
| 95 | 10160 :let words = split(getline('.'), '\W\+') |
| 282 | 10161 < To split a string in individual characters: > |
| 236 | 10162 :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
|
10163 < 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
|
10164 the end of the pattern: > |
| 258 | 10165 :echo split('abc:def:ghi', ':\zs') |
| 10166 < ['abc:', 'def:', 'ghi'] ~ | |
| 282 | 10167 Splitting a table where the first element can be empty: > |
| 10168 :let items = split(line, ':', 1) | |
| 10169 < The opposite function is |join()|. | |
| 82 | 10170 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10171 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10172 GetString()->split() |
| 82 | 10173 |
| 1621 | 10174 sqrt({expr}) *sqrt()* |
| 10175 Return the non-negative square root of Float {expr} as a | |
| 10176 |Float|. | |
| 10177 {expr} must evaluate to a |Float| or a |Number|. When {expr} | |
| 10178 is negative the result is NaN (Not a Number). | |
| 10179 Examples: > | |
| 10180 :echo sqrt(100) | |
| 10181 < 10.0 > | |
| 10182 :echo sqrt(-4.01) | |
| 10183 < nan | |
| 1668 | 10184 "nan" may be different, it depends on system libraries. |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10185 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10186 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10187 Compute()->sqrt() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10188 < |
| 1621 | 10189 {only available when compiled with the |+float| feature} |
| 12785 | 10190 |
| 1621 | 10191 |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10192 srand([{expr}]) *srand()* |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10193 Initialize seed used by |rand()|: |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10194 - If {expr} is not given, seed values are initialized by |
|
18732
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
10195 reading from /dev/urandom, if possible, or using time(NULL) |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
10196 a.k.a. epoch time otherwise; this only has second accuracy. |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
10197 - If {expr} is given it must be a Number. It is used to |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
10198 initialize the seed values. This is useful for testing or |
|
2513e666aa82
patch 8.1.2356: rand() does not use the best algorithm
Bram Moolenaar <Bram@vim.org>
parents:
18719
diff
changeset
|
10199 when a predictable sequence is intended. |
|
18701
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10200 |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10201 Examples: > |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10202 :let seed = srand() |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10203 :let seed = srand(userinput) |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10204 :echo rand(seed) |
|
128662297ddf
patch 8.1.2342: random number generator in Vim script is slow
Bram Moolenaar <Bram@vim.org>
parents:
18699
diff
changeset
|
10205 |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10206 state([{what}]) *state()* |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10207 Return a string which contains characters indicating the |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10208 current state. Mostly useful in callbacks that want to do |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10209 work that may not always be safe. Roughly this works like: |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10210 - callback uses state() to check if work is safe to do. |
| 18130 | 10211 Yes: then do it right away. |
| 10212 No: add to work queue and add a |SafeState| and/or | |
| 10213 |SafeStateAgain| autocommand (|SafeState| triggers at | |
| 10214 toplevel, |SafeStateAgain| triggers after handling | |
| 10215 messages and callbacks). | |
| 10216 - When SafeState or SafeStateAgain is triggered and executes | |
| 10217 your autocommand, check with `state()` if the work can be | |
| 10218 done now, and if yes remove it from the queue and execute. | |
| 10219 Remove the autocommand if the queue is now empty. | |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10220 Also see |mode()|. |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10221 |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10222 When {what} is given only characters in this string will be |
|
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10223 added. E.g, this checks if the screen has scrolled: > |
| 18130 | 10224 if state('s') == '' |
| 10225 " screen has not scrolled | |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10226 < |
|
18116
7f57ea9a4ba8
patch 8.1.2053: SafeStateAgain not triggered if callback uses feedkeys()
Bram Moolenaar <Bram@vim.org>
parents:
18104
diff
changeset
|
10227 These characters indicate the state, generally indicating that |
|
7f57ea9a4ba8
patch 8.1.2053: SafeStateAgain not triggered if callback uses feedkeys()
Bram Moolenaar <Bram@vim.org>
parents:
18104
diff
changeset
|
10228 something is busy: |
| 18130 | 10229 m halfway a mapping, :normal command, feedkeys() or |
| 10230 stuffed command | |
| 21093 | 10231 o operator pending, e.g. after |d| |
| 18130 | 10232 a Insert mode autocomplete active |
| 10233 x executing an autocommand | |
| 18343 | 10234 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and |
| 21093 | 10235 ch_readraw() when reading json |
| 10236 S not triggering SafeState or SafeStateAgain, e.g. after | |
| 10237 |f| or a count | |
| 18130 | 10238 c callback invoked, including timer (repeats for |
| 10239 recursiveness up to "ccc") | |
| 10240 s screen has scrolled for messages | |
|
18104
e59ff7b5d7a7
patch 8.1.2047: cannot check the current state
Bram Moolenaar <Bram@vim.org>
parents:
18080
diff
changeset
|
10241 |
|
8883
b7de875169e6
commit https://github.com/vim/vim/commit/81edd171a9465cf99cede4fa4a7b7bca3d538b0f
Christian Brabandt <cb@256bit.org>
parents:
8881
diff
changeset
|
10242 str2float({expr}) *str2float()* |
| 1621 | 10243 Convert String {expr} to a Float. This mostly works the same |
| 10244 as when using a floating point number in an expression, see | |
| 10245 |floating-point-format|. But it's a bit more permissive. | |
| 10246 E.g., "1e40" is accepted, while in an expression you need to | |
| 15131 | 10247 write "1.0e40". The hexadecimal form "0x123" is also |
| 10248 accepted, but not others, like binary or octal. | |
| 1621 | 10249 Text after the number is silently ignored. |
| 10250 The decimal point is always '.', no matter what the locale is | |
| 10251 set to. A comma ends the number: "12,345.67" is converted to | |
| 10252 12.0. You can strip out thousands separators with | |
| 10253 |substitute()|: > | |
| 10254 let f = str2float(substitute(text, ',', '', 'g')) | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10255 < |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10256 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10257 let f = text->substitute(',', '', 'g')->str2float() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10258 < |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10259 {only available when compiled with the |+float| feature} |
| 1621 | 10260 |
|
16235
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10261 str2list({expr} [, {utf8}]) *str2list()* |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10262 Return a list containing the number values which represent |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10263 each character in String {expr}. Examples: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10264 str2list(" ") returns [32] |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10265 str2list("ABC") returns [65, 66, 67] |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10266 < |list2str()| does the opposite. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10267 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10268 When {utf8} is omitted or zero, the current 'encoding' is used. |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10269 With {utf8} set to 1, always treat the String as utf-8 |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10270 characters. With utf-8 composing characters are handled |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10271 properly: > |
|
219c58b3879c
patch 8.1.1122: char2nr() does not handle composing characters
Bram Moolenaar <Bram@vim.org>
parents:
16231
diff
changeset
|
10272 str2list("á") returns [97, 769] |
| 1621 | 10273 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10274 < Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10275 GetString()->str2list() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10276 |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10277 |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
10278 str2nr({expr} [, {base} [, {quoted}]]) *str2nr()* |
| 782 | 10279 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
|
10280 {base} is the conversion base, it can be 2, 8, 10 or 16. |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
10281 When {quoted} is present and non-zero then embedded single |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
10282 quotes are ignored, thus "1'000'000" is a million. |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10283 |
| 782 | 10284 When {base} is omitted base 10 is used. This also means that |
| 10285 a leading zero doesn't cause octal conversion to be used, as | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10286 with the default String to Number conversion. Example: > |
| 18343 | 10287 let nr = str2nr('0123') |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10288 < |
| 782 | 10289 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
|
10290 different base the result will be zero. Similarly, when |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
10291 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
10292 {base} is 2 a leading "0b" or "0B" is ignored. |
| 782 | 10293 Text after the number is silently ignored. |
| 856 | 10294 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10295 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10296 GetText()->str2nr() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10297 |
|
24130
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10298 |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10299 strcharlen({expr}) *strcharlen()* |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10300 The result is a Number, which is the number of characters |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10301 in String {expr}. Composing characters are ignored. |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10302 |strchars()| can count the number of characters, counting |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10303 composing characters separately. |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10304 |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10305 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10306 |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10307 Can also be used as a |method|: > |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10308 GetText()->strcharlen() |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10309 |
|
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10310 |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10311 strcharpart({src}, {start} [, {len} [, {skipcc}]]) *strcharpart()* |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10312 Like |strpart()| but using character index and length instead |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10313 of byte index and length. |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10314 When {skipcc} is omitted or zero, composing characters are |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10315 counted separately. |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10316 When {skipcc} set to 1, Composing characters are ignored, |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10317 similar to |slice()|. |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10318 When a character index is used where a character does not |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10319 exist it is omitted and counted as one character. For |
|
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10320 example: > |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10321 strcharpart('abc', -1, 2) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10322 < results in 'a'. |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10323 |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10324 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10325 GetText()->strcharpart(5) |
| 782 | 10326 |
|
24130
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10327 |
| 6884 | 10328 strchars({expr} [, {skipcc}]) *strchars()* |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
10329 The result is a Number, which is the number of characters |
| 6884 | 10330 in String {expr}. |
| 10331 When {skipcc} is omitted or zero, composing characters are | |
| 10332 counted separately. | |
| 10333 When {skipcc} set to 1, Composing characters are ignored. | |
|
24132
512f48dc7100
patch 8.2.2607: strcharpart() cannot include composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24130
diff
changeset
|
10334 |strcharlen()| always does this. |
|
24130
c3d1f65365c4
patch 8.2.2606: strchars() defaults to counting composing characters
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
10335 |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
10336 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. |
| 12785 | 10337 |
| 6918 | 10338 {skipcc} is only available after 7.4.755. For backward |
| 10339 compatibility, you can define a wrapper function: > | |
| 10340 if has("patch-7.4.755") | |
| 10341 function s:strchars(str, skipcc) | |
| 10342 return strchars(a:str, a:skipcc) | |
| 10343 endfunction | |
| 10344 else | |
| 10345 function s:strchars(str, skipcc) | |
| 10346 if a:skipcc | |
| 10347 return strlen(substitute(a:str, ".", "x", "g")) | |
| 10348 else | |
| 10349 return strchars(a:str) | |
| 10350 endif | |
| 10351 endfunction | |
| 10352 endif | |
| 10353 < | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10354 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10355 GetText()->strchars() |
| 6918 | 10356 |
| 12785 | 10357 strdisplaywidth({expr} [, {col}]) *strdisplaywidth()* |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
10358 The result is a Number, which is the number of display cells |
| 15878 | 10359 String {expr} occupies on the screen when it starts at {col} |
| 10360 (first column is zero). When {col} is omitted zero is used. | |
| 10361 Otherwise it is the screen column where to start. This | |
| 10362 matters for Tab characters. | |
|
2343
0703d2fd5749
Last few changes for the 7.3a BETA release.
Bram Moolenaar <bram@vim.org>
parents:
2339
diff
changeset
|
10363 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
|
10364 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
|
10365 'tabstop' and 'display'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
10366 When {expr} contains characters with East Asian Width Class |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
10367 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
10368 Also see |strlen()|, |strwidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
10369 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10370 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10371 GetText()->strdisplaywidth() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10372 |
| 7 | 10373 strftime({format} [, {time}]) *strftime()* |
| 10374 The result is a String, which is a formatted date and time, as | |
| 10375 specified by the {format} string. The given {time} is used, | |
| 10376 or the current time if no time is given. The accepted | |
| 10377 {format} depends on your system, thus this is not portable! | |
| 10378 See the manual page of the C function strftime() for the | |
| 10379 format. The maximum length of the result is 80 characters. | |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10380 See also |localtime()|, |getftime()| and |strptime()|. |
| 7 | 10381 The language can be changed with the |:language| command. |
| 10382 Examples: > | |
| 10383 :echo strftime("%c") Sun Apr 27 11:49:23 1997 | |
| 10384 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 | |
| 10385 :echo strftime("%y%m%d %T") 970427 11:53:55 | |
| 10386 :echo strftime("%H:%M") 11:55 | |
| 10387 :echo strftime("%c", getftime("file.c")) | |
| 10388 Show mod time of file.c. | |
| 82 | 10389 < Not available on all systems. To check use: > |
| 10390 :if exists("*strftime") | |
| 10391 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10392 < Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10393 GetFormat()->strftime() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10394 |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
10395 strgetchar({str}, {index}) *strgetchar()* |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
10396 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
|
10397 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
|
10398 separate characters here. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
10399 Also see |strcharpart()| and |strchars()|. |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
10400 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10401 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10402 GetText()->strgetchar(5) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10403 |
| 133 | 10404 stridx({haystack}, {needle} [, {start}]) *stridx()* |
| 10405 The result is a Number, which gives the byte index in | |
| 10406 {haystack} of the first occurrence of the String {needle}. | |
| 140 | 10407 If {start} is specified, the search starts at index {start}. |
| 10408 This can be used to find a second match: > | |
| 2662 | 10409 :let colon1 = stridx(line, ":") |
| 10410 :let colon2 = stridx(line, ":", colon1 + 1) | |
| 140 | 10411 < The search is done case-sensitive. |
| 205 | 10412 For pattern searches use |match()|. |
| 133 | 10413 -1 is returned if the {needle} does not occur in {haystack}. |
| 140 | 10414 See also |strridx()|. |
| 10415 Examples: > | |
| 7 | 10416 :echo stridx("An Example", "Example") 3 |
| 10417 :echo stridx("Starting point", "Start") 0 | |
| 10418 :echo stridx("Starting point", "start") -1 | |
| 856 | 10419 < *strstr()* *strchr()* |
| 170 | 10420 stridx() works similar to the C function strstr(). When used |
| 10421 with a single character it works similar to strchr(). | |
| 10422 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10423 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10424 GetHaystack()->stridx(needle) |
| 18343 | 10425 < |
| 55 | 10426 *string()* |
| 95 | 10427 string({expr}) Return {expr} converted to a String. If {expr} is a Number, |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
10428 Float, String, Blob or a composition of them, then the result |
|
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
10429 can be parsed back with |eval()|. |
| 55 | 10430 {expr} type result ~ |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
10431 String 'string' (single quotes are doubled) |
| 95 | 10432 Number 123 |
| 1621 | 10433 Float 123.123456 or 1.123456e8 |
| 99 | 10434 Funcref function('name') |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
10435 Blob 0z00112233.44556677.8899 |
| 95 | 10436 List [item, item] |
| 323 | 10437 Dictionary {key: value, key: value} |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
10438 |
| 21093 | 10439 When a |List| or |Dictionary| has a recursive reference it is |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
10440 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
|
10441 will then fail. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8738
diff
changeset
|
10442 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10443 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10444 mylist->string() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10445 |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
10446 < Also see |strtrans()|. |
| 55 | 10447 |
| 7 | 10448 *strlen()* |
| 10449 strlen({expr}) The result is a Number, which is the length of the String | |
| 502 | 10450 {expr} in bytes. |
| 55 | 10451 If the argument is a Number it is first converted to a String. |
| 10452 For other types an error is given. | |
|
21935
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10453 If you want to count the number of multibyte characters use |
| 6870 | 10454 |strchars()|. |
| 10455 Also see |len()|, |strdisplaywidth()| and |strwidth()|. | |
| 7 | 10456 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10457 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10458 GetString()->strlen() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10459 |
|
21935
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10460 strpart({src}, {start} [, {len} [, {chars}]]) *strpart()* |
| 7 | 10461 The result is a String, which is part of {src}, starting from |
| 574 | 10462 byte {start}, with the byte length {len}. |
|
21935
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10463 When {chars} is present and TRUE then {len} is the number of |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10464 characters positions (composing characters are not counted |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10465 separately, thus "1" means one base character and any |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10466 following composing characters). |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10467 To count {start} as characters instead of bytes use |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10468 |strcharpart()|. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
10469 |
|
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
10470 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
|
10471 result in an error, the bytes are simply omitted. |
| 7 | 10472 If {len} is missing, the copy continues from {start} till the |
| 10473 end of the {src}. > | |
| 10474 strpart("abcdefg", 3, 2) == "de" | |
| 10475 strpart("abcdefg", -2, 4) == "ab" | |
| 10476 strpart("abcdefg", 5, 4) == "fg" | |
| 1621 | 10477 strpart("abcdefg", 3) == "defg" |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8883
diff
changeset
|
10478 |
| 7 | 10479 < Note: To get the first character, {start} must be 0. For |
|
21935
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10480 example, to get the character under the cursor: > |
|
62f933f64447
patch 8.2.1517: cannot easily get the character under the cursor
Bram Moolenaar <Bram@vim.org>
parents:
21847
diff
changeset
|
10481 strpart(getline("."), col(".") - 1, 1, v:true) |
| 7 | 10482 < |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10483 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10484 GetText()->strpart(5) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10485 |
|
18669
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10486 strptime({format}, {timestring}) *strptime()* |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10487 The result is a Number, which is a unix timestamp representing |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10488 the date and time in {timestring}, which is expected to match |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10489 the format specified in {format}. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10490 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10491 The accepted {format} depends on your system, thus this is not |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10492 portable! See the manual page of the C function strptime() |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10493 for the format. Especially avoid "%c". The value of $TZ also |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10494 matters. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10495 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10496 If the {timestring} cannot be parsed with {format} zero is |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10497 returned. If you do not know the format of {timestring} you |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10498 can try different {format} values until you get a non-zero |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10499 result. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10500 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10501 See also |strftime()|. |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10502 Examples: > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10503 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23") |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10504 < 862156163 > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10505 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55")) |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10506 < Sun Apr 27 11:53:55 1997 > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10507 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600) |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10508 < Sun Apr 27 12:53:55 1997 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10509 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10510 Not available on all systems. To check use: > |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10511 :if exists("*strptime") |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10512 |
|
9007e9896303
patch 8.1.2326: cannot parse a date/time string
Bram Moolenaar <Bram@vim.org>
parents:
18639
diff
changeset
|
10513 |
| 140 | 10514 strridx({haystack}, {needle} [, {start}]) *strridx()* |
| 10515 The result is a Number, which gives the byte index in | |
| 10516 {haystack} of the last occurrence of the String {needle}. | |
| 10517 When {start} is specified, matches beyond this index are | |
| 10518 ignored. This can be used to find a match before a previous | |
| 10519 match: > | |
| 10520 :let lastcomma = strridx(line, ",") | |
| 10521 :let comma2 = strridx(line, ",", lastcomma - 1) | |
| 10522 < The search is done case-sensitive. | |
| 133 | 10523 For pattern searches use |match()|. |
| 10524 -1 is returned if the {needle} does not occur in {haystack}. | |
| 22 | 10525 If the {needle} is empty the length of {haystack} is returned. |
| 236 | 10526 See also |stridx()|. Examples: > |
| 7 | 10527 :echo strridx("an angry armadillo", "an") 3 |
| 856 | 10528 < *strrchr()* |
| 170 | 10529 When used with a single character it works similar to the C |
| 10530 function strrchr(). | |
| 10531 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10532 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10533 GetHaystack()->strridx(needle) |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10534 |
| 7 | 10535 strtrans({expr}) *strtrans()* |
| 10536 The result is a String, which is {expr} with all unprintable | |
| 10537 characters translated into printable characters |'isprint'|. | |
| 10538 Like they are shown in a window. Example: > | |
| 10539 echo strtrans(@a) | |
| 10540 < This displays a newline in register a as "^@" instead of | |
| 10541 starting a new line. | |
| 10542 | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10543 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10544 GetString()->strtrans() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10545 |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
10546 strwidth({expr}) *strwidth()* |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
10547 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
|
10548 String {expr} occupies. A Tab character is counted as one |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
10549 cell, alternatively use |strdisplaywidth()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
10550 When {expr} contains characters with East Asian Width Class |
|
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
10551 Ambiguous, this function's return value depends on 'ambiwidth'. |
|
2339
01e4b4d37842
Added strdisplaywidth() function.
Bram Moolenaar <bram@vim.org>
parents:
2338
diff
changeset
|
10552 Also see |strlen()|, |strdisplaywidth()| and |strchars()|. |
|
2338
da6ec32d8d8f
Added strwidth() and strchars() functions.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
10553 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10554 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10555 GetString()->strwidth() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10556 |
| 12785 | 10557 submatch({nr} [, {list}]) *submatch()* *E935* |
| 2908 | 10558 Only for an expression in a |:substitute| command or |
| 10559 substitute() function. | |
| 10560 Returns the {nr}'th submatch of the matched text. When {nr} | |
| 10561 is 0 the whole matched text is returned. | |
| 5794 | 10562 Note that a NL in the string can stand for a line break of a |
| 10563 multi-line match or a NUL character in the text. | |
| 2908 | 10564 Also see |sub-replace-expression|. |
| 5794 | 10565 |
| 12785 | 10566 If {list} is present and non-zero then submatch() returns |
| 10567 a list of strings, similar to |getline()| with two arguments. | |
| 5794 | 10568 NL characters in the text represent NUL characters in the |
| 10569 text. | |
| 10570 Only returns more than one item for |:substitute|, inside | |
| 10571 |substitute()| this list will always contain one or zero | |
| 10572 items, since there are no real line breaks. | |
| 10573 | |
|
10245
d76ccdacb41e
commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
10574 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
|
10575 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
|
10576 |
| 12968 | 10577 Examples: > |
| 7 | 10578 :s/\d\+/\=submatch(0) + 1/ |
| 12968 | 10579 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '') |
| 7 | 10580 < This finds the first number in the line and adds one to it. |
| 10581 A line break is included as a newline character. | |
| 10582 | |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10583 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10584 GetNr()->submatch() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10585 |
| 7 | 10586 substitute({expr}, {pat}, {sub}, {flags}) *substitute()* |
| 10587 The result is a String, which is a copy of {expr}, in which | |
| 2908 | 10588 the first match of {pat} is replaced with {sub}. |
| 10589 When {flags} is "g", all matches of {pat} in {expr} are | |
| 10590 replaced. Otherwise {flags} should be "". | |
| 12785 | 10591 |
| 2908 | 10592 This works like the ":substitute" command (without any flags). |
| 10593 But the matching with {pat} is always done like the 'magic' | |
| 10594 option is set and 'cpoptions' is empty (to make scripts | |
| 3967 | 10595 portable). 'ignorecase' is still relevant, use |/\c| or |/\C| |
| 10596 if you want to ignore or match case and ignore 'ignorecase'. | |
| 10597 'smartcase' is not used. See |string-match| for how {pat} is | |
| 10598 used. | |
| 2908 | 10599 |
| 10600 A "~" in {sub} is not replaced with the previous {sub}. | |
| 7 | 10601 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
|
10602 |sub-replace-special|. For example, to replace something with |
| 7 | 10603 "\n" (two characters), use "\\\\n" or '\\n'. |
| 2908 | 10604 |
| 7 | 10605 When {pat} does not match in {expr}, {expr} is returned |
| 10606 unmodified. | |
| 2908 | 10607 |
| 7 | 10608 Example: > |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10609 :let &path = substitute(&path, ",\\=[^,]*$", "", "") |
| 7 | 10610 < 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
|
10611 :echo substitute("testing", ".*", "\\U\\0", "") |
| 7 | 10612 < results in "TESTING". |
| 2908 | 10613 |
| 10614 When {sub} starts with "\=", the remainder is interpreted as | |
| 10615 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
|
10616 :echo substitute(s, '%\(\x\x\)', |
| 2833 | 10617 \ '\=nr2char("0x" . submatch(1))', 'g') |
| 7 | 10618 |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10619 < 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
|
10620 optional argument. Example: > |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
10621 :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
|
10622 < 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
|
10623 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
|
10624 |submatch()| returns. Example: > |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
10625 :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
|
10626 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10627 < Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10628 GetString()->substitute(pat, sub, flags) |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10629 |
| 14668 | 10630 swapinfo({fname}) *swapinfo()* |
|
14599
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10631 The result is a dictionary, which holds information about the |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10632 swapfile {fname}. The available fields are: |
| 14864 | 10633 version Vim version |
|
14599
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10634 user user name |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10635 host host name |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10636 fname original file name |
| 14864 | 10637 pid PID of the Vim process that created the swap |
|
14599
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10638 file |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10639 mtime last modification time in seconds |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10640 inode Optional: INODE number of the file |
|
14601
d0ff19a55579
patch 8.1.0314: build failure without the +eval feature
Christian Brabandt <cb@256bit.org>
parents:
14599
diff
changeset
|
10641 dirty 1 if file was modified, 0 if not |
| 14637 | 10642 Note that "user" and "host" are truncated to at most 39 bytes. |
|
14599
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10643 In case of failure an "error" item is added with the reason: |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10644 Cannot open file: file not found or in accessible |
|
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10645 Cannot read file: cannot read first block |
|
14601
d0ff19a55579
patch 8.1.0314: build failure without the +eval feature
Christian Brabandt <cb@256bit.org>
parents:
14599
diff
changeset
|
10646 Not a swap file: does not contain correct block ID |
|
d0ff19a55579
patch 8.1.0314: build failure without the +eval feature
Christian Brabandt <cb@256bit.org>
parents:
14599
diff
changeset
|
10647 Magic number mismatch: Info in first block is invalid |
|
14599
72d6f6f7ead7
patch 8.1.0313: information about a swap file is unavailable
Christian Brabandt <cb@256bit.org>
parents:
14587
diff
changeset
|
10648 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10649 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10650 GetFilename()->swapinfo() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10651 |
|
14778
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
10652 swapname({expr}) *swapname()* |
|
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
10653 The result is the swap file path of the buffer {expr}. |
|
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
10654 For the use of {expr}, see |bufname()| above. |
|
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
10655 If buffer {expr} is the current buffer, the result is equal to |
| 21676 | 10656 |:swapname| (unless there is no swap file). |
|
14778
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
10657 If buffer {expr} has no swap file, returns an empty string. |
|
20653d6f3d95
patch 8.1.0401: can't get swap name of another buffer
Christian Brabandt <cb@256bit.org>
parents:
14756
diff
changeset
|
10658 |
|
18017
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10659 Can also be used as a |method|: > |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10660 GetBufname()->swapname() |
|
988e5a868b60
patch 8.1.2004: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18008
diff
changeset
|
10661 |
| 32 | 10662 synID({lnum}, {col}, {trans}) *synID()* |
| 7 | 10663 The result is a Number, which is the syntax ID at the position |
| 32 | 10664 {lnum} and {col} in the current window. |
| 7 | 10665 The syntax ID can be used with |synIDattr()| and |
| 10666 |synIDtrans()| to obtain syntax information about text. | |
| 419 | 10667 |
| 32 | 10668 {col} is 1 for the leftmost column, {lnum} is 1 for the first |
| 419 | 10669 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
|
10670 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
|
10671 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
|
10672 zero. |
| 419 | 10673 |
|
9454
9da0cb39cbee
commit https://github.com/vim/vim/commit/79815f1ec77406f2f21a618c053e5793b597db7a
Christian Brabandt <cb@256bit.org>
parents:
9430
diff
changeset
|
10674 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
|
10675 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
|
10676 the effective color. When {trans} is |FALSE|, the transparent |
| 7 | 10677 item is returned. This is useful when wanting to know which |
| 10678 syntax item is effective (e.g. inside parens). | |
| 10679 Warning: This function can be very slow. Best speed is | |
| 10680 obtained by going through the file in forward direction. | |
| 10681 | |
| 10682 Example (echoes the name of the syntax item under the cursor): > | |
| 10683 :echo synIDattr(synID(line("."), col("."), 1), "name") | |
| 10684 < | |
|
2401
e7751177126b
Add the synconcealed() function and use it for :TOhtml. (Benjamin Fritz)
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
10685 |
| 7 | 10686 synIDattr({synID}, {what} [, {mode}]) *synIDattr()* |
| 10687 The result is a String, which is the {what} attribute of | |
| 10688 syntax ID {synID}. This can be used to obtain information | |
| 10689 about a syntax item. | |
| 10690 {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
|
10691 for that mode. When {mode} is omitted, or an invalid value is |
| 7 | 10692 used, the attributes for the currently active highlighting are |
| 10693 used (GUI, cterm or term). | |
| 10694 Use synIDtrans() to follow linked highlight groups. | |
| 10695 {what} result | |
| 10696 "name" the name of the syntax item | |
| 10697 "fg" foreground color (GUI: color name used to set | |
| 10698 the color, cterm: color number as a string, | |
| 10699 term: empty string) | |
| 1755 | 10700 "bg" background color (as with "fg") |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
10701 "font" font name (only available in the GUI) |
|
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
10702 |highlight-font| |
|
22446
0cdb03e73ce9
patch 8.2.1771: synIDattr() cannot get the value of ctermul
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
10703 "sp" special color for the GUI (as with "fg") |
|
0cdb03e73ce9
patch 8.2.1771: synIDattr() cannot get the value of ctermul
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
10704 |highlight-guisp| |
|
0cdb03e73ce9
patch 8.2.1771: synIDattr() cannot get the value of ctermul
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
10705 "ul" underline color for cterm: number as a string |
| 7 | 10706 "fg#" like "fg", but for the GUI and the GUI is |
| 10707 running the name in "#RRGGBB" form | |
| 10708 "bg#" like "fg#" for "bg" | |
| 1755 | 10709 "sp#" like "fg#" for "sp" |
| 7 | 10710 "bold" "1" if bold |
| 10711 "italic" "1" if italic | |
| 10712 "reverse" "1" if reverse | |
| 10713 "inverse" "1" if inverse (= reverse) | |
|
2106
15674e198164
updated for version 7.2.389
Bram Moolenaar <bram@zimbu.org>
parents:
2072
diff
changeset
|
10714 "standout" "1" if standout |
| 7 | 10715 "underline" "1" if underlined |
| 205 | 10716 "undercurl" "1" if undercurled |
|
12317
2a8890b80923
patch 8.0.1038: strike-through text not supported
Christian Brabandt <cb@256bit.org>
parents:
12311
diff
changeset
|
10717 "strike" "1" if strikethrough |
| 7 | 10718 |
| 10719 Example (echoes the color of the syntax item under the | |
| 10720 cursor): > | |
| 10721 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") | |
| 10722 < | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10723 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10724 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10725 |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10726 |
| 7 | 10727 synIDtrans({synID}) *synIDtrans()* |
| 10728 The result is a Number, which is the translated syntax ID of | |
| 10729 {synID}. This is the syntax group ID of what is being used to | |
| 10730 highlight the character. Highlight links given with | |
| 10731 ":highlight link" are followed. | |
| 10732 | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10733 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10734 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10735 |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
10736 synconcealed({lnum}, {col}) *synconcealed()* |
| 21093 | 10737 The result is a |List| with currently three items: |
|
11553
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
10738 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
|
10739 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
|
10740 region, 1 if it is. |
|
cbceef33af7a
patch 8.0.0659: no test for conceal mode
Christian Brabandt <cb@256bit.org>
parents:
11549
diff
changeset
|
10741 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
|
10742 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
|
10743 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
|
10744 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
|
10745 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
|
10746 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
|
10747 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
|
10748 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
|
10749 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
|
10750 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
|
10751 the text is "123456" and both "23" and "45" are concealed |
| 14864 | 10752 and replaced by the character "X", then: |
|
11579
52e3a77c097b
patch 8.0.0672: third item of synconcealed() changes too often
Christian Brabandt <cb@256bit.org>
parents:
11561
diff
changeset
|
10753 call returns ~ |
| 12254 | 10754 synconcealed(lnum, 1) [0, '', 0] |
| 10755 synconcealed(lnum, 2) [1, 'X', 1] | |
| 10756 synconcealed(lnum, 3) [1, 'X', 1] | |
| 10757 synconcealed(lnum, 4) [1, 'X', 2] | |
| 10758 synconcealed(lnum, 5) [1, 'X', 2] | |
| 10759 synconcealed(lnum, 6) [0, '', 0] | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
10760 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
10761 |
| 1500 | 10762 synstack({lnum}, {col}) *synstack()* |
| 10763 Return a |List|, which is the stack of syntax items at the | |
| 10764 position {lnum} and {col} in the current window. Each item in | |
| 10765 the List is an ID like what |synID()| returns. | |
| 10766 The first item in the List is the outer region, following are | |
| 10767 items contained in that one. The last one is what |synID()| | |
| 10768 returns, unless not the whole item is highlighted or it is a | |
| 10769 transparent item. | |
| 10770 This function is useful for debugging a syntax file. | |
| 10771 Example that shows the syntax stack under the cursor: > | |
| 10772 for id in synstack(line("."), col(".")) | |
| 10773 echo synIDattr(id, "name") | |
| 10774 endfor | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
10775 < 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
|
10776 nothing is returned. The position just after the last |
|
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2281
diff
changeset
|
10777 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
|
10778 valid positions. |
| 1500 | 10779 |
| 24 | 10780 system({expr} [, {input}]) *system()* *E677* |
| 5808 | 10781 Get the output of the shell command {expr} as a string. See |
| 21093 | 10782 |systemlist()| to get the output as a |List|. |
| 5806 | 10783 |
| 12785 | 10784 When {input} is given and is a string this string is written |
| 10785 to a file and passed as stdin to the command. The string is | |
| 10786 written as-is, you need to take care of using the correct line | |
| 5806 | 10787 separators yourself. |
| 10788 If {input} is given and is a |List| it is written to the file | |
| 10789 in a way |writefile()| does with {binary} set to "b" (i.e. | |
| 10790 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
|
10791 list items converted to NULs). |
|
7232cd9f8a7c
commit https://github.com/vim/vim/commit/12c4492dd35e0cd83c8816be2ec849b836109882
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
10792 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
|
10793 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
|
10794 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
|
10795 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
|
10796 |
|
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
10797 Pipes are not used, the 'shelltemp' option is not used. |
| 5806 | 10798 |
|
10038
7cf4e210cf3c
commit https://github.com/vim/vim/commit/04186095346daa60e82e981dad114de2b641d672
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
10799 When prepended by |:silent| the terminal will not be set to |
| 6183 | 10800 cooked mode. This is meant to be used for commands that do |
| 10801 not need the user to type. It avoids stray characters showing | |
| 10802 up on the screen which require |CTRL-L| to remove. > | |
| 10803 :silent let f = system('ls *.vim') | |
| 10804 < | |
| 12785 | 10805 Note: Use |shellescape()| or |::S| with |expand()| or |
| 10806 |fnamemodify()| to escape special characters in a command | |
| 10807 argument. Newlines in {expr} may cause the command to fail. | |
| 10808 The characters in 'shellquote' and 'shellxquote' may also | |
| 5690 | 10809 cause trouble. |
| 7 | 10810 This is not to be used for interactive commands. |
| 1661 | 10811 |
| 7 | 10812 The result is a String. Example: > |
| 1661 | 10813 :let files = system("ls " . shellescape(expand('%:h'))) |
| 5690 | 10814 :let files = system('ls ' . expand('%:h:S')) |
| 7 | 10815 |
| 10816 < To make the result more system-independent, the shell output | |
| 10817 is filtered to replace <CR> with <NL> for Macintosh, and | |
| 10818 <CR><NL> with <NL> for DOS-like systems. | |
| 5277 | 10819 To avoid the string being truncated at a NUL, all NUL |
| 10820 characters are replaced with SOH (0x01). | |
| 10821 | |
| 7 | 10822 The command executed is constructed using several options: |
| 10823 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote' | |
| 10824 ({tmp} is an automatically generated file name). | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
10825 For Unix, braces are put around {expr} to allow for |
| 7 | 10826 concatenated commands. |
| 10827 | |
| 794 | 10828 The command will be executed in "cooked" mode, so that a |
| 10829 CTRL-C will interrupt the command (on Unix at least). | |
| 10830 | |
| 7 | 10831 The resulting error code can be found in |v:shell_error|. |
| 10832 This function will fail in |restricted-mode|. | |
| 625 | 10833 |
| 10834 Note that any wrong value in the options mentioned above may | |
| 10835 make the function fail. It has also been reported to fail | |
| 10836 when using a security agent application. | |
| 7 | 10837 Unlike ":!cmd" there is no automatic check for changed files. |
| 10838 Use |:checktime| to force a check. | |
| 10839 | |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10840 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10841 :echo GetCmd()->system() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10842 |
| 205 | 10843 |
| 5808 | 10844 systemlist({expr} [, {input}]) *systemlist()* |
| 12785 | 10845 Same as |system()|, but returns a |List| with lines (parts of |
| 10846 output separated by NL) with NULs transformed into NLs. Output | |
| 10847 is the same as |readfile()| will output with {binary} argument | |
| 18186 | 10848 set to "b", except that there is no extra empty item when the |
| 10849 result ends in a NL. | |
| 10850 Note that on MS-Windows you may get trailing CR characters. | |
| 10851 | |
| 10852 To see the difference between "echo hello" and "echo -n hello" | |
| 10853 use |system()| and |split()|: > | |
| 10854 echo system('echo hello')->split('\n', 1) | |
| 10855 < | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
10856 Returns an empty string on error. |
| 5808 | 10857 |
|
17624
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10858 Can also be used as a |method|: > |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10859 :echo GetCmd()->systemlist() |
|
4c7097a980a5
patch 8.1.1809: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17620
diff
changeset
|
10860 |
| 5808 | 10861 |
| 677 | 10862 tabpagebuflist([{arg}]) *tabpagebuflist()* |
| 685 | 10863 The result is a |List|, where each item is the number of the |
| 677 | 10864 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
|
10865 {arg} specifies the number of the tab page to be used. When |
| 677 | 10866 omitted the current tab page is used. |
| 10867 When {arg} is invalid the number zero is returned. | |
| 10868 To get a list of all buffers in all tabs use this: > | |
| 3445 | 10869 let buflist = [] |
| 677 | 10870 for i in range(tabpagenr('$')) |
| 3445 | 10871 call extend(buflist, tabpagebuflist(i + 1)) |
| 677 | 10872 endfor |
| 10873 < Note that a buffer may appear in more than one window. | |
| 10874 | |
|
18031
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10875 Can also be used as a |method|: > |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10876 GetTabpage()->tabpagebuflist() |
| 677 | 10877 |
| 10878 tabpagenr([{arg}]) *tabpagenr()* | |
| 674 | 10879 The result is a Number, which is the number of the current |
| 10880 tab page. The first tab page has number 1. | |
|
21703
22583b9d4efd
patch 8.2.1401: cannot jump to the last used tabpage
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
10881 |
|
22583b9d4efd
patch 8.2.1401: cannot jump to the last used tabpage
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
10882 The optional argument {arg} supports the following values: |
|
22583b9d4efd
patch 8.2.1401: cannot jump to the last used tabpage
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
10883 $ the number of the last tab page (the tab page |
|
22583b9d4efd
patch 8.2.1401: cannot jump to the last used tabpage
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
10884 count). |
|
22583b9d4efd
patch 8.2.1401: cannot jump to the last used tabpage
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
10885 # the number of the last accessed tab page |
|
22583b9d4efd
patch 8.2.1401: cannot jump to the last used tabpage
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
10886 (where |g<Tab>| goes to). if there is no |
|
22583b9d4efd
patch 8.2.1401: cannot jump to the last used tabpage
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
10887 previous tab page 0 is returned. |
| 674 | 10888 The number can be used with the |:tab| command. |
| 10889 | |
| 10890 | |
| 5763 | 10891 tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* |
|
2569
f612f6b0b883
Docs fix for tabpagewinnr(). (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
10892 Like |winnr()| but for tab page {tabarg}. |
| 677 | 10893 {tabarg} specifies the number of tab page to be used. |
| 10894 {arg} is used like with |winnr()|: | |
| 10895 - When omitted the current window number is returned. This is | |
| 10896 the window which will be used when going to this tab page. | |
| 10897 - When "$" the number of windows is returned. | |
| 10898 - When "#" the previous window nr is returned. | |
| 10899 Useful examples: > | |
| 10900 tabpagewinnr(1) " current window of tab page 1 | |
| 10901 tabpagewinnr(4, '$') " number of windows in tab page 4 | |
| 10902 < When {tabarg} is invalid zero is returned. | |
| 10903 | |
|
18031
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10904 Can also be used as a |method|: > |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10905 GetTabpage()->tabpagewinnr() |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10906 < |
| 805 | 10907 *tagfiles()* |
| 10908 tagfiles() Returns a |List| with the file names used to search for tags | |
| 10909 for the current buffer. This is the 'tags' option expanded. | |
| 10910 | |
| 10911 | |
| 12785 | 10912 taglist({expr} [, {filename}]) *taglist()* |
| 23164 | 10913 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
|
10914 |
|
d3415ec1cdaf
patch 8.0.0499: taglist() does not prioritize tags for a buffer
Christian Brabandt <cb@256bit.org>
parents:
11211
diff
changeset
|
10915 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
|
10916 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
|
10917 {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
|
10918 |
| 438 | 10919 Each list item is a dictionary with at least the following |
| 10920 entries: | |
| 648 | 10921 name Name of the tag. |
| 10922 filename Name of the file where the tag is | |
| 1156 | 10923 defined. It is either relative to the |
| 10924 current directory or a full path. | |
| 205 | 10925 cmd Ex command used to locate the tag in |
| 10926 the file. | |
| 648 | 10927 kind Type of the tag. The value for this |
| 205 | 10928 entry depends on the language specific |
| 1156 | 10929 kind values. Only available when |
| 10930 using a tags file generated by | |
| 10931 Exuberant ctags or hdrtag. | |
| 648 | 10932 static A file specific tag. Refer to |
| 205 | 10933 |static-tag| for more information. |
| 1156 | 10934 More entries may be present, depending on the content of the |
| 10935 tags file: access, implementation, inherits and signature. | |
| 10936 Refer to the ctags documentation for information about these | |
| 10937 fields. For C code the fields "struct", "class" and "enum" | |
| 10938 may appear, they give the name of the entity the tag is | |
| 10939 contained in. | |
| 452 | 10940 |
| 11062 | 10941 The ex-command "cmd" can be either an ex search pattern, a |
| 216 | 10942 line number or a line number followed by a byte number. |
| 205 | 10943 |
| 10944 If there are no matching tags, then an empty list is returned. | |
| 10945 | |
| 10946 To get an exact tag match, the anchors '^' and '$' should be | |
| 4073 | 10947 used in {expr}. This also make the function work faster. |
| 10948 Refer to |tag-regexp| for more information about the tag | |
| 10949 search regular expression pattern. | |
| 205 | 10950 |
| 10951 Refer to |'tags'| for information about how the tags file is | |
| 10952 located by Vim. Refer to |tags-file-format| for the format of | |
| 10953 the tags file generated by the different ctags tools. | |
| 10954 | |
|
18031
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10955 Can also be used as a |method|: > |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10956 GetTagpattern()->taglist() |
|
8a2fb21c23c0
patch 8.1.2011: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18017
diff
changeset
|
10957 |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10958 tan({expr}) *tan()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10959 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
|
10960 in the range [-inf, inf]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10961 {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
|
10962 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10963 :echo tan(10) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10964 < 0.648361 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10965 :echo tan(-4.01) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10966 < -1.181502 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10967 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10968 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10969 Compute()->tan() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10970 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
10971 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10972 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10973 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10974 tanh({expr}) *tanh()* |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10975 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
|
10976 range [-1, 1]. |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2320
diff
changeset
|
10977 {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
|
10978 Examples: > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10979 :echo tanh(0.5) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10980 < 0.462117 > |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10981 :echo tanh(-1) |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10982 < -0.761594 |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10983 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10984 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10985 Compute()->tanh() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
10986 < |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2569
diff
changeset
|
10987 {only available when compiled with the |+float| feature} |
|
2206
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10988 |
|
a8afba7027ae
Add extra floating point functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
10989 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10990 tempname() *tempname()* *temp-file-name* |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10991 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
|
10992 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
|
10993 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
|
10994 :let tmpfile = tempname() |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10995 :exe "redir > " . tmpfile |
|
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
10996 < 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
|
10997 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
|
10998 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
|
10999 |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
11000 |
|
17259
6dbb9b3c53e2
patch 8.1.1629: terminal function help is in the wrong file
Bram Moolenaar <Bram@vim.org>
parents:
17257
diff
changeset
|
11001 term_ functions are documented here: |terminal-function-details| |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
11002 |
|
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11003 |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11004 terminalprops() *terminalprops()* |
| 23164 | 11005 Returns a |Dictionary| with properties of the terminal that Vim |
|
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11006 detected from the response to |t_RV| request. See |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11007 |v:termresponse| for the response itself. If |v:termresponse| |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11008 is empty most values here will be 'u' for unknown. |
| 22723 | 11009 cursor_style whether sending |t_RS| works ** |
| 11010 cursor_blink_mode whether sending |t_RC| works ** | |
|
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11011 underline_rgb whether |t_8u| works ** |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11012 mouse mouse type supported |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11013 |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11014 ** value 'u' for unknown, 'y' for yes, 'n' for no |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11015 |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11016 If the |+termresponse| feature is missing then the result is |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11017 an empty dictionary. |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11018 |
| 20965 | 11019 If "cursor_style" is 'y' then |t_RS| will be sent to request the |
|
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11020 current cursor style. |
| 20965 | 11021 If "cursor_blink_mode" is 'y' then |t_RC| will be sent to |
|
20836
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11022 request the cursor blink status. |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11023 "cursor_style" and "cursor_blink_mode" are also set if |t_u7| |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11024 is not empty, Vim will detect the working of sending |t_RS| |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11025 and |t_RC| on startup. |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11026 |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11027 When "underline_rgb" is not 'y', then |t_8u| will be made empty. |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11028 This avoids sending it to xterm, which would clear the colors. |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11029 |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11030 For "mouse" the value 'u' is unknown |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11031 |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11032 Also see: |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11033 - 'ambiwidth' - detected by using |t_u7|. |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11034 - |v:termstyleresp| and |v:termblinkresp| for the response to |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11035 |t_RS| and |t_RC|. |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11036 |
|
2616c5a337e0
patch 8.2.0970: terminal properties are not available in Vim script
Bram Moolenaar <Bram@vim.org>
parents:
20786
diff
changeset
|
11037 |
| 17571 | 11038 test_ functions are documented here: |test-functions-details| |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
17450
diff
changeset
|
11039 |
|
9108
d319453f62b3
commit https://github.com/vim/vim/commit/574860b5ee9da281c875dad07a607454e135eaee
Christian Brabandt <cb@256bit.org>
parents:
9104
diff
changeset
|
11040 |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11041 *timer_info()* |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11042 timer_info([{id}]) |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11043 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
|
11044 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
|
11045 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
|
11046 returned. |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11047 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
|
11048 |
| 21093 | 11049 For each timer the information is stored in a |Dictionary| with |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11050 these items: |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11051 "id" the timer ID |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11052 "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
|
11053 "remaining" time until the timer fires |
|
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11054 "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
|
11055 -1 means forever |
|
9790
34cc6a101340
commit https://github.com/vim/vim/commit/8e97bd74b5377753597e3d98e7123d8985c7fffd
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
11056 "callback" the callback |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11057 "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
|
11058 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11059 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11060 GetTimer()->timer_info() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11061 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11062 < {only available when compiled with the |+timers| feature} |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11063 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11064 timer_pause({timer}, {paused}) *timer_pause()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11065 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
|
11066 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
|
11067 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
|
11068 has passed. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11069 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11070 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
|
11071 for a short time. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11072 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11073 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
|
11074 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
|
11075 See |non-zero-arg|. |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11076 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11077 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11078 GetTimer()->timer_pause(1) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11079 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11080 < {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
|
11081 |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9881
diff
changeset
|
11082 *timer_start()* *timer* *timers* |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11083 timer_start({time}, {callback} [, {options}]) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11084 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
|
11085 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11086 {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
|
11087 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
|
11088 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
|
11089 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11090 {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
|
11091 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
|
11092 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
|
11093 waiting for input. |
| 23305 | 11094 If you want to show a message look at |popup_notification()| |
| 23466 | 11095 to avoid interfering with what the user is doing. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11096 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11097 {options} is a dictionary. Supported entries: |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11098 "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
|
11099 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
|
11100 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
|
11101 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
|
11102 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
|
11103 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
|
11104 messages. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11105 |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11106 Example: > |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11107 func MyHandler(timer) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11108 echo 'Handler called' |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11109 endfunc |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11110 let timer = timer_start(500, 'MyHandler', |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11111 \ {'repeat': 3}) |
|
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11112 < 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
|
11113 intervals. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11114 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11115 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11116 GetMsec()->timer_start(callback) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11117 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11118 < Not available in the |sandbox|. |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11119 {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
|
11120 |
|
8669
06848fe9c816
commit https://github.com/vim/vim/commit/03602ec28ed25739e88b2c835adb0662d3720bb2
Christian Brabandt <cb@256bit.org>
parents:
8577
diff
changeset
|
11121 timer_stop({timer}) *timer_stop()* |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9076
diff
changeset
|
11122 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
|
11123 {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
|
11124 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
|
11125 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11126 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11127 GetTimer()->timer_stop() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11128 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11129 < {only available when compiled with the |+timers| feature} |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11130 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11131 timer_stopall() *timer_stopall()* |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11132 Stop all timers. The timer callbacks will no longer be |
|
17366
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
11133 invoked. Useful if a timer is misbehaving. If there are no |
|
9843fbfa0ee5
patch 8.1.1682: placing a larger number of signs is slow
Bram Moolenaar <Bram@vim.org>
parents:
17292
diff
changeset
|
11134 timers there is no error. |
|
9810
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11135 |
|
6a28d0c6f929
commit https://github.com/vim/vim/commit/b73598e2f022a22fec512ea681c70d2775e8fd87
Christian Brabandt <cb@256bit.org>
parents:
9790
diff
changeset
|
11136 {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
|
11137 |
| 7 | 11138 tolower({expr}) *tolower()* |
| 11139 The result is a copy of the String given, with all uppercase | |
| 11140 characters turned into lowercase (just like applying |gu| to | |
| 11141 the string). | |
| 11142 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11143 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11144 GetText()->tolower() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11145 |
| 7 | 11146 toupper({expr}) *toupper()* |
| 11147 The result is a copy of the String given, with all lowercase | |
| 11148 characters turned into uppercase (just like applying |gU| to | |
| 11149 the string). | |
| 11150 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11151 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11152 GetText()->toupper() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11153 |
| 15 | 11154 tr({src}, {fromstr}, {tostr}) *tr()* |
| 11155 The result is a copy of the {src} string with all characters | |
| 11156 which appear in {fromstr} replaced by the character in that | |
| 11157 position in the {tostr} string. Thus the first character in | |
| 11158 {fromstr} is translated into the first character in {tostr} | |
| 11159 and so on. Exactly like the unix "tr" command. | |
| 11160 This code also deals with multibyte characters properly. | |
| 11161 | |
| 11162 Examples: > | |
| 11163 echo tr("hello there", "ht", "HT") | |
| 11164 < returns "Hello THere" > | |
| 11165 echo tr("<blob>", "<>", "{}") | |
| 11166 < returns "{blob}" | |
| 11167 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11168 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11169 GetText()->tr(from, to) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11170 |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11171 trim({text} [, {mask} [, {dir}]]) *trim()* |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
11172 Return {text} as a String where any character in {mask} is |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11173 removed from the beginning and/or end of {text}. |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11174 |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
11175 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
|
11176 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
|
11177 space character 0xa0. |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11178 |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11179 The optional {dir} argument specifies where to remove the |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11180 characters: |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11181 0 remove from the beginning and end of {text} |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11182 1 remove only at the beginning of {text} |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11183 2 remove only at the end of {text} |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11184 When omitted both ends are trimmed. |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11185 |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11186 This function deals with multibyte characters properly. |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
11187 |
|
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
11188 Examples: > |
| 13563 | 11189 echo trim(" some text ") |
| 11190 < returns "some text" > | |
| 11191 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
|
11192 < returns "RESERVE_TAIL" > |
| 13563 | 11193 echo trim("rm<Xrm<>X>rrm", "rm<>") |
|
20629
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11194 < returns "Xrm<>X" (characters in the middle are not removed) > |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11195 echo trim(" vim ", " ", 2) |
|
7b8ac5e49451
patch 8.2.0868: trim() always trims both ends
Bram Moolenaar <Bram@vim.org>
parents:
20627
diff
changeset
|
11196 < returns " vim" |
|
13513
4064f342bea4
patch 8.0.1630: trimming white space is not that easy
Christian Brabandt <cb@256bit.org>
parents:
13501
diff
changeset
|
11197 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11198 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11199 GetText()->trim() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11200 |
| 1621 | 11201 trunc({expr}) *trunc()* |
| 1668 | 11202 Return the largest integral value with magnitude less than or |
| 1621 | 11203 equal to {expr} as a |Float| (truncate towards zero). |
| 11204 {expr} must evaluate to a |Float| or a |Number|. | |
| 11205 Examples: > | |
| 11206 echo trunc(1.456) | |
| 11207 < 1.0 > | |
| 11208 echo trunc(-5.456) | |
| 11209 < -5.0 > | |
| 11210 echo trunc(4.0) | |
| 11211 < 4.0 | |
|
17765
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
11212 |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
11213 Can also be used as a |method|: > |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
11214 Compute()->trunc() |
|
545119cd5554
patch 8.1.1879: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17758
diff
changeset
|
11215 < |
| 1621 | 11216 {only available when compiled with the |+float| feature} |
| 12785 | 11217 |
| 87 | 11218 *type()* |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11219 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
|
11220 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
|
11221 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
|
11222 Number: 0 |v:t_number| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11223 String: 1 |v:t_string| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11224 Funcref: 2 |v:t_func| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11225 List: 3 |v:t_list| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11226 Dictionary: 4 |v:t_dict| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11227 Float: 5 |v:t_float| |
|
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11228 Boolean: 6 |v:t_bool| (v:false and v:true) |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11229 None: 7 |v:t_none| (v:null and v:none) |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11230 Job: 8 |v:t_job| |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11231 Channel: 9 |v:t_channel| |
|
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11232 Blob: 10 |v:t_blob| |
|
9626
172131507c85
commit https://github.com/vim/vim/commit/df48fb456fb6bf63d94cad9b302ff01d8ee8d311
Christian Brabandt <cb@256bit.org>
parents:
9587
diff
changeset
|
11233 For backward compatibility, this method can be used: > |
| 87 | 11234 :if type(myvar) == type(0) |
| 11235 :if type(myvar) == type("") | |
| 11236 :if type(myvar) == type(function("tr")) | |
| 11237 :if type(myvar) == type([]) | |
| 153 | 11238 :if type(myvar) == type({}) |
| 1621 | 11239 :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
|
11240 :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
|
11241 :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
|
11242 < 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
|
11243 :if exists('v:t_number') |
| 7 | 11244 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11245 < Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11246 mylist->type() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11247 |
|
23594
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11248 |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11249 typename({expr}) *typename()* |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11250 Return a string representation of the type of {expr}. |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11251 Example: > |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11252 echo typename([1, 2, 3]) |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11253 list<number> |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11254 |
|
d3e064f54890
patch 8.2.2339: cannot get the type of a value as a string
Bram Moolenaar <Bram@vim.org>
parents:
23588
diff
changeset
|
11255 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
11256 undofile({name}) *undofile()* |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
11257 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
|
11258 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
|
11259 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
|
11260 the undo file exists. |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
11261 {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
|
11262 is used internally. |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
11263 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
|
11264 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
|
11265 Useful in combination with |:wundo| and |:rundo|. |
|
15378
0d76dd701e49
patch 8.1.0697: ":sign place" requires the buffer argument
Bram Moolenaar <Bram@vim.org>
parents:
15335
diff
changeset
|
11266 When compiled without the |+persistent_undo| option this always |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
11267 returns an empty string. |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2226
diff
changeset
|
11268 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11269 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11270 GetFilename()->undofile() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11271 |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11272 undotree() *undotree()* |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11273 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
|
11274 the following items: |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11275 "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
|
11276 "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
|
11277 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
|
11278 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
|
11279 "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
|
11280 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
|
11281 something readable. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11282 "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
|
11283 write yet. |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
11284 "save_cur" Number of the current position in the undo |
| 12785 | 11285 tree. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11286 "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
|
11287 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
|
11288 user. See |undo-blocks|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11289 "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
|
11290 undo blocks. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11291 |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11292 The first item in the "entries" list is the oldest undo item. |
| 21093 | 11293 Each List item is a |Dictionary| with these items: |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11294 "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
|
11295 |:undolist|. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11296 "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
|
11297 |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
|
11298 "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
|
11299 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
|
11300 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
|
11301 "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
|
11302 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
|
11303 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
|
11304 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
|
11305 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
|
11306 not appear anywhere. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11307 "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
|
11308 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
|
11309 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
|
11310 "save_last" mentioned above. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11311 "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
|
11312 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
|
11313 item. |
|
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2252
diff
changeset
|
11314 |
| 5747 | 11315 uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* |
| 11316 Remove second and succeeding copies of repeated adjacent | |
| 11317 {list} items in-place. Returns {list}. If you want a list | |
| 11318 to remain unmodified make a copy first: > | |
| 11319 :let newlist = uniq(copy(mylist)) | |
| 11320 < The default compare function uses the string representation of | |
| 11321 each item. For the use of {func} and {dict} see |sort()|. | |
| 11322 | |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11323 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11324 mylist->uniq() |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11325 |
| 140 | 11326 values({dict}) *values()* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
11327 Return a |List| with all the values of {dict}. The |List| is |
|
15571
4af72c724093
patch 8.1.0793: incorrect error messages for functions that take a Blob
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
11328 in arbitrary order. Also see |items()| and |keys()|. |
| 140 | 11329 |
|
17612
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11330 Can also be used as a |method|: > |
|
e259d11e2900
patch 8.1.1803: all builtin functions are global
Bram Moolenaar <Bram@vim.org>
parents:
17571
diff
changeset
|
11331 mydict->values() |
| 140 | 11332 |
| 7 | 11333 virtcol({expr}) *virtcol()* |
| 11334 The result is a Number, which is the screen column of the file | |
| 11335 position given with {expr}. That is, the last screen position | |
| 11336 occupied by the character at that position, when the screen | |
| 11337 would be of unlimited width. When there is a <Tab> at the | |
| 11338 position, the returned Number will be the column at the end of | |
| 11339 the <Tab>. For example, for a <Tab> in column 1, with 'ts' | |
| 3445 | 11340 set to 8, it returns 8. |conceal| is ignored. |
| 1317 | 11341 For the byte position use |col()|. |
| 11342 For the use of {expr} see |col()|. | |
| 11343 When 'virtualedit' is used {expr} can be [lnum, col, off], where | |
| 703 | 11344 "off" is the offset in screen columns from the start of the |
| 1266 | 11345 character. E.g., a position within a <Tab> or after the last |
| 2965 | 11346 character. When "off" is omitted zero is used. |
| 7 | 11347 When Virtual editing is active in the current mode, a position |
| 11348 beyond the end of the line can be returned. |'virtualedit'| | |
| 11349 The accepted positions are: | |
| 11350 . the cursor position | |
| 11351 $ the end of the cursor line (the result is the | |
| 11352 number of displayed characters in the cursor line | |
| 11353 plus one) | |
| 11354 'x position of mark x (if the mark is not set, 0 is | |
| 11355 returned) | |
| 6447 | 11356 v In Visual mode: the start of the Visual area (the |
| 11357 cursor is the end). When not in Visual mode | |
| 11358 returns the cursor position. Differs from |'<| in | |
| 11359 that it's updated right away. | |
| 7 | 11360 Note that only marks in the current file can be used. |
| 11361 Examples: > | |
| 11362 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5 | |
| 11363 virtcol("$") with text "foo^Lbar", returns 9 | |
| 1621 | 11364 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
|
11365 < The first column is 1. 0 is returned for an error. |
| 1156 | 11366 A more advanced example that echoes the maximum length of |
| 11367 all lines: > | |
| 11368 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) | |
| 11369 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11370 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11371 GetPos()->virtcol() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11372 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11373 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11374 visualmode([{expr}]) *visualmode()* |
| 7 | 11375 The result is a String, which describes the last Visual mode |
| 856 | 11376 used in the current buffer. Initially it returns an empty |
| 11377 string, but once Visual mode has been used, it returns "v", | |
| 11378 "V", or "<CTRL-V>" (a single CTRL-V character) for | |
| 11379 character-wise, line-wise, or block-wise Visual mode | |
| 11380 respectively. | |
| 7 | 11381 Example: > |
| 11382 :exe "normal " . visualmode() | |
| 11383 < This enters the same Visual mode as before. It is also useful | |
| 11384 in scripts if you wish to act differently depending on the | |
| 11385 Visual mode that was used. | |
| 1621 | 11386 If Visual mode is active, use |mode()| to get the Visual mode |
| 11387 (e.g., in a |:vmap|). | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11388 If {expr} is supplied and it evaluates to a non-zero Number or |
| 1661 | 11389 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
|
11390 the old value is returned. See |non-zero-arg|. |
| 7 | 11391 |
| 4151 | 11392 wildmenumode() *wildmenumode()* |
|
9422
f93704b11e43
commit https://github.com/vim/vim/commit/e381d3d5e098546854b008e01ca1d28ba1a4a057
Christian Brabandt <cb@256bit.org>
parents:
9416
diff
changeset
|
11393 Returns |TRUE| when the wildmenu is active and |FALSE| |
| 4151 | 11394 otherwise. See 'wildmenu' and 'wildmode'. |
| 11395 This can be used in mappings to handle the 'wildcharm' option | |
| 11396 gracefully. (Makes only sense with |mapmode-c| mappings). | |
| 11397 | |
| 11398 For example to make <c-j> work like <down> in wildmode, use: > | |
| 11399 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" | |
| 11400 < | |
| 11401 (Note, this needs the 'wildcharm' option set appropriately). | |
| 11402 | |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
11403 win_execute({id}, {command} [, {silent}]) *win_execute()* |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
11404 Like `execute()` but in the context of window {id}. |
|
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
11405 The window will temporarily be made the current window, |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
11406 without triggering autocommands. When executing {command} |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
11407 autocommands will be triggered, this may have unexpected side |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
11408 effects. Use |:noautocmd| if needed. |
|
16833
6699c03347d2
patch 8.1.1418: win_execute() is not implemented yet
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
11409 Example: > |
|
16849
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
11410 call win_execute(winid, 'set syntax=python') |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
11411 < Doing the same with `setwinvar()` would not trigger |
|
629f3d3b6886
patch 8.1.1426: no test for syntax highlight in popup window
Bram Moolenaar <Bram@vim.org>
parents:
16833
diff
changeset
|
11412 autocommands and not actually show syntax highlighting. |
|
23602
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
11413 |
| 16944 | 11414 *E994* |
| 11415 Not all commands are allowed in popup windows. | |
|
23602
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
11416 When window {id} does not exist then no error is given and |
|
7b3317e959e3
patch 8.2.2343: Vim9: return type of readfile() is any
Bram Moolenaar <Bram@vim.org>
parents:
23594
diff
changeset
|
11417 an empty string is returned. |
| 4151 | 11418 |
| 18343 | 11419 Can also be used as a |method|, the base is passed as the |
| 11420 second argument: > | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11421 GetCommand()->win_execute(winid) |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11422 |
|
8536
09041d2fd7d0
commit https://github.com/vim/vim/commit/9cdf86b86f5fdb5a45b682f336846f9d9a9c6f1f
Christian Brabandt <cb@256bit.org>
parents:
8534
diff
changeset
|
11423 win_findbuf({bufnr}) *win_findbuf()* |
| 23164 | 11424 Returns a |List| with |window-ID|s for windows that contain |
|
9908
2b6654519a7c
commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234
Christian Brabandt <cb@256bit.org>
parents:
9904
diff
changeset
|
11425 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
|
11426 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11427 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11428 GetBufnr()->win_findbuf() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11429 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11430 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
|
11431 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
|
11432 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
|
11433 With {win} this is the window number. The top window has |
| 14999 | 11434 number 1. |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11435 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
|
11436 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
|
11437 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
|
11438 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11439 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11440 GetWinnr()->win_getid() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11441 |
|
19398
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11442 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11443 win_gettype([{nr}]) *win_gettype()* |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11444 Return the type of the window: |
|
20889
27401f09fe9b
patch 8.2.0996: using "aucmdwin" in win_gettype() is not ideal
Bram Moolenaar <Bram@vim.org>
parents:
20879
diff
changeset
|
11445 "autocmd" autocommand window. Temporary window |
|
20879
0ab45b558621
patch 8.2.0991: cannot get window type for autocmd and preview window
Bram Moolenaar <Bram@vim.org>
parents:
20873
diff
changeset
|
11446 used to execute autocommands. |
|
19398
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11447 "popup" popup window |popup| |
|
20879
0ab45b558621
patch 8.2.0991: cannot get window type for autocmd and preview window
Bram Moolenaar <Bram@vim.org>
parents:
20873
diff
changeset
|
11448 "preview" preview window |preview-window| |
|
19398
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11449 "command" command-line window |cmdwin| |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11450 (empty) normal window |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11451 "unknown" window {nr} not found |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11452 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11453 When {nr} is omitted return the type of the current window. |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11454 When {nr} is given return the type of this window by number or |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11455 |window-ID|. |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11456 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11457 Also see the 'buftype' option. When running a terminal in a |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11458 popup window then 'buftype' is "terminal" and win_gettype() |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11459 returns "popup". |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11460 |
|
f0033a10b613
patch 8.2.0257: cannot recognize a terminal in a popup window
Bram Moolenaar <Bram@vim.org>
parents:
19384
diff
changeset
|
11461 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11462 win_gotoid({expr}) *win_gotoid()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11463 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
|
11464 tabpage. |
| 23666 | 11465 Return TRUE if successful, FALSE if the window cannot be found. |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11466 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11467 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11468 GetWinid()->win_gotoid() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11469 |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8831
diff
changeset
|
11470 win_id2tabwin({expr}) *win_id2tabwin()* |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11471 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
|
11472 with ID {expr}: [tabnr, winnr]. |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11473 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
|
11474 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11475 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11476 GetWinid()->win_id2tabwin() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11477 |
|
8534
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11478 win_id2win({expr}) *win_id2win()* |
|
485d4d8a97f6
commit https://github.com/vim/vim/commit/86edef664efccbfe685906c854b9cdd04e56f2d5
Christian Brabandt <cb@256bit.org>
parents:
8512
diff
changeset
|
11479 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
|
11480 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
|
11481 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11482 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11483 GetWinid()->win_id2win() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11484 |
|
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
|
11485 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
|
11486 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
|
11487 numbers: [row, col]. The first window always has position |
|
14343
7589f103ec11
patch 8.1.0187: getwininfo() and win_screenpos() return different numbers
Christian Brabandt <cb@256bit.org>
parents:
14337
diff
changeset
|
11488 [1, 1], unless there is a tabline, then it is [2, 1]. |
| 22171 | 11489 {nr} can be the window number or the |window-ID|. Use zero |
| 11490 for the current window. | |
|
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
|
11491 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
|
11492 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
|
11493 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11494 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11495 GetWinid()->win_screenpos() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11496 < |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11497 win_splitmove({nr}, {target} [, {options}]) *win_splitmove()* |
| 20965 | 11498 Move the window {nr} to a new split of the window {target}. |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11499 This is similar to moving to {target}, creating a new window |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11500 using |:split| but having the same contents as window {nr}, and |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11501 then closing {nr}. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11502 |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11503 Both {nr} and {target} can be window numbers or |window-ID|s. |
| 19099 | 11504 Both must be in the current tab page. |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11505 |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11506 Returns zero for success, non-zero for failure. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11507 |
| 21093 | 11508 {options} is a |Dictionary| with the following optional entries: |
|
18049
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11509 "vertical" When TRUE, the split is created vertically, |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11510 like with |:vsplit|. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11511 "rightbelow" When TRUE, the split is made below or to the |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11512 right (if vertical). When FALSE, it is done |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11513 above or to the left (if vertical). When not |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11514 present, the values of 'splitbelow' and |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11515 'splitright' are used. |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11516 |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11517 Can also be used as a |method|: > |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11518 GetWinid()->win_splitmove(target) |
|
a9f1656f13c9
patch 8.1.2020: it is not easy to change the window layout
Bram Moolenaar <Bram@vim.org>
parents:
18035
diff
changeset
|
11519 < |
|
19400
bd9069d21c5d
patch 8.2.0258: modifyOtherKeys cannot be temporarily disabled
Bram Moolenaar <Bram@vim.org>
parents:
19398
diff
changeset
|
11520 |
| 7 | 11521 *winbufnr()* |
| 11522 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
|
11523 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
|
11524 the |window-ID|. |
|
9223
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
11525 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
|
11526 window is returned. |
|
6c4d610fce0a
commit https://github.com/vim/vim/commit/888ccac8902cee186fbd47e971881f6d9b19c068
Christian Brabandt <cb@256bit.org>
parents:
9221
diff
changeset
|
11527 When window {nr} doesn't exist, -1 is returned. |
| 7 | 11528 Example: > |
| 11529 :echo "The file in the current window is " . bufname(winbufnr(0)) | |
| 11530 < | |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
11531 Can also be used as a |method|: > |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
11532 FindWindow()->winbufnr()->bufname() |
|
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
11533 < |
| 7 | 11534 *wincol()* |
| 11535 wincol() The result is a Number, which is the virtual column of the | |
| 11536 cursor in the window. This is counting screen cells from the | |
| 11537 left side of the window. The leftmost column is one. | |
| 11538 | |
|
18973
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
11539 *windowsversion()* |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
11540 windowsversion() |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
11541 The result is a String. For MS-Windows it indicates the OS |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
11542 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2", |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
11543 Windows XP is "5.1". For non-MS-Windows systems the result is |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
11544 an empty string. |
|
bf8eb950df61
patch 8.2.0047: cannot skip tests for specific MS-Windows platform
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
11545 |
| 7 | 11546 winheight({nr}) *winheight()* |
| 11547 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
|
11548 {nr} can be the window number or the |window-ID|. |
| 7 | 11549 When {nr} is zero, the height of the current window is |
| 11550 returned. When window {nr} doesn't exist, -1 is returned. | |
| 11551 An existing window always has a height of zero or more. | |
| 12499 | 11552 This excludes any window toolbar line. |
| 7 | 11553 Examples: > |
| 11554 :echo "The current window has " . winheight(0) . " lines." | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11555 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11556 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11557 GetWinid()->winheight() |
| 7 | 11558 < |
|
14587
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11559 winlayout([{tabnr}]) *winlayout()* |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11560 The result is a nested List containing the layout of windows |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11561 in a tabpage. |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11562 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11563 Without {tabnr} use the current tabpage, otherwise the tabpage |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11564 with number {tabnr}. If the tabpage {tabnr} is not found, |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11565 returns an empty list. |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11566 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11567 For a leaf window, it returns: |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11568 ['leaf', {winid}] |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11569 For horizontally split windows, which form a column, it |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11570 returns: |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11571 ['col', [{nested list of windows}]] |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11572 For vertically split windows, which form a row, it returns: |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11573 ['row', [{nested list of windows}]] |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11574 |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11575 Example: > |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11576 " Only one window in the tab page |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11577 :echo winlayout() |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11578 ['leaf', 1000] |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11579 " Two horizontally split windows |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11580 :echo winlayout() |
|
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11581 ['col', [['leaf', 1000], ['leaf', 1001]]] |
| 19646 | 11582 " The second tab page, with three horizontally split |
| 11583 " windows, with two vertically split windows in the | |
| 11584 " middle window | |
|
14587
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11585 :echo winlayout(2) |
| 19646 | 11586 ['col', [['leaf', 1002], ['row', [['leaf', 1003], |
| 11587 ['leaf', 1001]]], ['leaf', 1000]]] | |
|
14587
d33220d3bc27
patch 8.1.0307: there is no good way to get the window layout
Christian Brabandt <cb@256bit.org>
parents:
14519
diff
changeset
|
11588 < |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11589 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11590 GetTabnr()->winlayout() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11591 < |
| 7 | 11592 *winline()* |
| 11593 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
|
11594 in the window. This is counting screen lines from the top of |
| 7 | 11595 the window. The first line is one. |
| 531 | 11596 If the cursor was moved the view on the file will be updated |
| 11597 first, this may cause a scroll. | |
| 7 | 11598 |
| 11599 *winnr()* | |
| 20 | 11600 winnr([{arg}]) The result is a Number, which is the number of the current |
| 11601 window. The top window has number 1. | |
| 19303 | 11602 Returns zero for a popup window. |
|
16271
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11603 |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11604 The optional argument {arg} supports the following values: |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11605 $ the number of the last window (the window |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11606 count). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11607 # the number of the last accessed window (where |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11608 |CTRL-W_p| goes to). If there is no previous |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11609 window or it is in another tab page 0 is |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11610 returned. |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11611 {N}j the number of the Nth window below the |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11612 current window (where |CTRL-W_j| goes to). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11613 {N}k the number of the Nth window above the current |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11614 window (where |CTRL-W_k| goes to). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11615 {N}h the number of the Nth window left of the |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11616 current window (where |CTRL-W_h| goes to). |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11617 {N}l the number of the Nth window right of the |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11618 current window (where |CTRL-W_l| goes to). |
| 20 | 11619 The number can be used with |CTRL-W_w| and ":wincmd w" |
| 11620 |:wincmd|. | |
| 10734 | 11621 Also see |tabpagewinnr()| and |win_getid()|. |
|
16271
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11622 Examples: > |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11623 let window_count = winnr('$') |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11624 let prev_window = winnr('#') |
|
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11625 let wnum = winnr('3k') |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11626 |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11627 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11628 GetWinval()->winnr() |
|
16271
243cdc183ec9
patch 8.1.1140: not easy to find out what neighbors a window has
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
11629 < |
| 7 | 11630 *winrestcmd()* |
| 11631 winrestcmd() Returns a sequence of |:resize| commands that should restore | |
| 11632 the current window sizes. Only works properly when no windows | |
| 712 | 11633 are opened or closed and the current window and tab page is |
| 11634 unchanged. | |
| 7 | 11635 Example: > |
| 11636 :let cmd = winrestcmd() | |
| 11637 :call MessWithWindowSizes() | |
| 11638 :exe cmd | |
| 712 | 11639 < |
| 11640 *winrestview()* | |
| 11641 winrestview({dict}) | |
| 11642 Uses the |Dictionary| returned by |winsaveview()| to restore | |
| 11643 the view of the current window. | |
| 5940 | 11644 Note: The {dict} does not have to contain all values, that are |
| 11645 returned by |winsaveview()|. If values are missing, those | |
| 11646 settings won't be restored. So you can use: > | |
| 11647 :call winrestview({'curswant': 4}) | |
| 11648 < | |
| 11649 This will only set the curswant value (the column the cursor | |
| 11650 wants to move on vertical movements) of the cursor to column 5 | |
| 11651 (yes, that is 5), while all other settings will remain the | |
| 11652 same. This is useful, if you set the cursor position manually. | |
| 11653 | |
| 712 | 11654 If you have changed the values the result is unpredictable. |
| 11655 If the window size changed the result won't be the same. | |
| 11656 | |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11657 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11658 GetView()->winrestview() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11659 < |
| 712 | 11660 *winsaveview()* |
| 11661 winsaveview() Returns a |Dictionary| that contains information to restore | |
| 11662 the view of the current window. Use |winrestview()| to | |
| 11663 restore the view. | |
| 11664 This is useful if you have a mapping that jumps around in the | |
| 11665 buffer and you want to go back to the original view. | |
| 11666 This does not save fold information. Use the 'foldenable' | |
| 798 | 11667 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
|
11668 not opened when moving around. This may have side effects. |
| 712 | 11669 The return value includes: |
| 11670 lnum cursor line number | |
| 5940 | 11671 col cursor column (Note: the first column |
| 11672 zero, as opposed to what getpos() | |
| 11673 returns) | |
| 712 | 11674 coladd cursor column offset for 'virtualedit' |
| 11675 curswant column for vertical movement | |
| 11676 topline first line in the window | |
| 11677 topfill filler lines, only in diff mode | |
| 22723 | 11678 leftcol first column displayed; only used when |
| 11679 'wrap' is off | |
| 712 | 11680 skipcol columns skipped |
| 11681 Note that no option values are saved. | |
| 11682 | |
| 7 | 11683 |
| 11684 winwidth({nr}) *winwidth()* | |
| 11685 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
|
11686 {nr} can be the window number or the |window-ID|. |
| 7 | 11687 When {nr} is zero, the width of the current window is |
| 11688 returned. When window {nr} doesn't exist, -1 is returned. | |
| 11689 An existing window always has a width of zero or more. | |
| 11690 Examples: > | |
| 11691 :echo "The current window has " . winwidth(0) . " columns." | |
| 11692 :if winwidth(0) <= 50 | |
|
12857
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11693 : 50 wincmd | |
| 7 | 11694 :endif |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
11695 < 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
|
11696 option. |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
11697 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11698 Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11699 GetWinid()->winwidth() |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11700 |
|
9389
32e34e574716
commit https://github.com/vim/vim/commit/22fcfad29276bd5f317faf516637dcd491b96a12
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
11701 |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11702 wordcount() *wordcount()* |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11703 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
|
11704 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
|
11705 |g_CTRL-G| |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11706 The return value includes: |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11707 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
|
11708 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
|
11709 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
|
11710 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
|
11711 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11712 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
|
11713 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11714 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
|
11715 (not in Visual mode) |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11716 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
|
11717 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11718 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
|
11719 (only in Visual mode) |
| 12254 | 11720 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
|
11721 (only in Visual mode) |
|
7480
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11722 |
|
a49163681559
commit https://github.com/vim/vim/commit/ed767a2073ef150971b0439a58e7ee582af6984e
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
11723 |
| 158 | 11724 *writefile()* |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11725 writefile({object}, {fname} [, {flags}]) |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11726 When {object} is a |List| write it to file {fname}. Each list |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11727 item is separated with a NL. Each list item must be a String |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11728 or Number. |
| 6341 | 11729 When {flags} contains "b" then binary mode is used: There will |
| 158 | 11730 not be a NL after the last list item. An empty item at the |
| 11731 end does cause the last line in the file to end in a NL. | |
| 6341 | 11732 |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11733 When {object} is a |Blob| write the bytes to file {fname} |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11734 unmodified. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
11735 |
| 6341 | 11736 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
|
11737 appended to the file: > |
| 6341 | 11738 :call writefile(["foo"], "event.log", "a") |
| 11739 :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
|
11740 < |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11741 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
|
11742 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
|
11743 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
|
11744 crashes. |
|
13016
e47e70300f30
patch 8.0.1384: not enough quickfix help; confusing winid
Christian Brabandt <cb@256bit.org>
parents:
12977
diff
changeset
|
11745 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
|
11746 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
|
11747 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
|
11748 when 'fsync' is set. |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11749 |
|
ffdf2e4b5d9a
patch 8.0.1305: writefile() never calls fsync()
Christian Brabandt <cb@256bit.org>
parents:
12837
diff
changeset
|
11750 All NL characters are replaced with a NUL character. |
| 158 | 11751 Inserting CR characters needs to be done before passing {list} |
| 11752 to writefile(). | |
| 11753 An existing file is overwritten, if possible. | |
| 11754 When the write fails -1 is returned, otherwise 0. There is an | |
| 11755 error message if the file can't be created or when writing | |
| 11756 fails. | |
| 11757 Also see |readfile()|. | |
| 11758 To copy a file byte for byte: > | |
| 11759 :let fl = readfile("foo", "b") | |
| 11760 :call writefile(fl, "foocopy", "b") | |
| 3214 | 11761 |
|
18035
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11762 < Can also be used as a |method|: > |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11763 GetText()->writefile("thefile") |
|
11dca9732a48
patch 8.1.2013: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
18031
diff
changeset
|
11764 |
| 3214 | 11765 |
| 11766 xor({expr}, {expr}) *xor()* | |
| 11767 Bitwise XOR on the two arguments. The arguments are converted | |
| 11768 to a number. A List, Dict or Float argument causes an error. | |
| 11769 Example: > | |
| 11770 :let bits = xor(bits, 0x80) | |
| 18343 | 11771 < |
| 11772 Can also be used as a |method|: > | |
|
17783
45eca7143d7c
patch 8.1.1888: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17765
diff
changeset
|
11773 :let bits = bits->xor(0x80) |
| 3256 | 11774 < |
| 3214 | 11775 |
| 7 | 11776 *feature-list* |
| 19163 | 11777 There are three types of features: |
| 7 | 11778 1. Features that are only supported when they have been enabled when Vim |
| 11779 was compiled |+feature-list|. Example: > | |
| 11780 :if has("cindent") | |
| 11781 2. Features that are only supported when certain conditions have been met. | |
| 11782 Example: > | |
| 11783 :if has("gui_running") | |
| 11784 < *has-patch* | |
|
13967
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11785 3. Beyond a certain version or at a certain version and including a specific |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11786 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11787 later, or it is version 7.4 and patch 248 was included. Example: > |
| 5862 | 11788 :if has("patch-7.4.248") |
|
13967
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11789 < Note that it's possible for patch 248 to be omitted even though 249 is |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11790 included. Only happens when cherry-picking patches. |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11791 Note that this form only works for patch 7.4.237 and later, before that |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11792 you need to check for the patch and the v:version. Example (checking |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11793 version 6.2.148 or later): > |
|
acc62d455f90
Runtime file and translation updates.
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
11794 :if v:version > 602 || (v:version == 602 && has("patch148")) |
| 7 | 11795 |
|
9850
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
11796 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
|
11797 use: `if exists('+shellslash')` |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
11798 |
|
67781bb0a61a
commit https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
Christian Brabandt <cb@256bit.org>
parents:
9810
diff
changeset
|
11799 |
| 5340 | 11800 acl Compiled with |ACL| support. |
| 7 | 11801 all_builtin_terms Compiled with all builtin terminals enabled. |
| 11802 amiga Amiga version of Vim. | |
| 11803 arabic Compiled with Arabic support |Arabic|. | |
| 11804 arp Compiled with ARP support (Amiga). | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11805 autocmd Compiled with autocommand support. (always true) |
| 14421 | 11806 autochdir Compiled with support for 'autochdir' |
|
12837
963cdeb42c41
patch 8.0.1295: cannot automatically get a server name in a terminal
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
11807 autoservername Automatically enable |clientserver| |
| 7 | 11808 balloon_eval Compiled with |balloon-eval| support. |
| 435 | 11809 balloon_multiline GUI supports multiline balloons. |
| 7 | 11810 beos BeOS version of Vim. |
| 11811 browse Compiled with |:browse| support, and browse() will | |
| 11812 work. | |
| 3682 | 11813 browsefilter Compiled with support for |browsefilter|. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11814 bsd Compiled on an OS in the BSD family (excluding macOS). |
| 7 | 11815 builtin_terms Compiled with some builtin terminals. |
| 11816 byte_offset Compiled with support for 'o' in 'statusline' | |
| 19523 | 11817 channel Compiled with support for |channel| and |job| |
| 7 | 11818 cindent Compiled with 'cindent' support. |
| 11819 clientserver Compiled with remote invocation support |clientserver|. | |
| 11820 clipboard Compiled with 'clipboard' support. | |
|
17680
55704f587945
patch 8.1.1837: popup test fails if clipboard is supported but not working
Bram Moolenaar <Bram@vim.org>
parents:
17676
diff
changeset
|
11821 clipboard_working Compiled with 'clipboard' support and it can be used. |
| 7 | 11822 cmdline_compl Compiled with |cmdline-completion| support. |
| 11823 cmdline_hist Compiled with |cmdline-history| support. | |
| 11824 cmdline_info Compiled with 'showcmd' and 'ruler' support. | |
| 11825 comments Compiled with |'comments'| support. | |
| 2681 | 11826 compatible Compiled to be very Vi compatible. |
|
15725
a3e2e7948ee4
patch 8.1.0870: Vim doesn't use the new ConPTY support in Windows 10
Bram Moolenaar <Bram@vim.org>
parents:
15711
diff
changeset
|
11827 conpty Platform where |ConPTY| can be used. |
| 7 | 11828 cryptv Compiled with encryption support |encryption|. |
| 11829 cscope Compiled with |cscope| support. | |
| 15729 | 11830 cursorbind Compiled with |'cursorbind'| (always true) |
| 7 | 11831 debug Compiled with "DEBUG" defined. |
| 11832 dialog_con Compiled with console dialog support. | |
| 11833 dialog_gui Compiled with GUI dialog support. | |
| 11834 diff Compiled with |vimdiff| and 'diff' support. | |
| 11835 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
|
11836 directx Compiled with support for DirectX and 'renderoptions'. |
| 7 | 11837 dnd Compiled with support for the "~ register |quote_~|. |
| 11838 ebcdic Compiled on a machine with ebcdic character set. | |
| 11839 emacs_tags Compiled with support for Emacs tags. | |
| 11840 eval Compiled with expression evaluation support. Always | |
| 11841 true, of course! | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11842 ex_extra |+ex_extra| (always true) |
| 7 | 11843 extra_search Compiled with support for |'incsearch'| and |
| 11844 |'hlsearch'| | |
| 18790 | 11845 farsi Support for Farsi was removed |farsi|. |
| 7 | 11846 file_in_path Compiled with support for |gf| and |<cfile>| |
| 168 | 11847 filterpipe When 'shelltemp' is off pipes are used for shell |
| 11848 read/write/filter commands | |
| 7 | 11849 find_in_path Compiled with support for include file searches |
| 11850 |+find_in_path|. | |
| 1621 | 11851 float Compiled with support for |Float|. |
| 18972 | 11852 fname_case Case in file names matters (for Amiga and MS-Windows |
| 11853 this is not present). | |
| 7 | 11854 folding Compiled with |folding| support. |
| 11855 footer Compiled with GUI footer support. |gui-footer| | |
| 11856 fork Compiled to use fork()/exec() instead of system(). | |
| 11857 gettext Compiled with message translation |multi-lang| | |
| 11858 gui Compiled with GUI enabled. | |
| 11859 gui_athena Compiled with Athena GUI. | |
| 2681 | 11860 gui_gnome Compiled with Gnome support (gui_gtk is also defined). |
| 7 | 11861 gui_gtk Compiled with GTK+ GUI (any version). |
| 11862 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
|
11863 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined). |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
11864 gui_haiku Compiled with Haiku GUI. |
| 7 | 11865 gui_mac Compiled with Macintosh GUI. |
| 11866 gui_motif Compiled with Motif GUI. | |
| 11867 gui_photon Compiled with Photon GUI. | |
| 2681 | 11868 gui_running Vim is running in the GUI, or it will start soon. |
| 7 | 11869 gui_win32 Compiled with MS Windows Win32 GUI. |
| 11870 gui_win32s idem, and Win32s system being used (Windows 3.1) | |
|
19526
22f0dda71638
patch 8.2.0320: no Haiku support
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
11871 haiku Haiku version of Vim. |
| 7 | 11872 hangul_input Compiled with Hangul input support. |hangul| |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11873 hpux HP-UX version of Vim. |
| 7 | 11874 iconv Can use iconv() for conversion. |
| 11875 insert_expand Compiled with support for CTRL-X expansion commands in | |
|
17825
ce993ba17adb
patch 8.1.1909: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17783
diff
changeset
|
11876 Insert mode. (always true) |
| 19968 | 11877 job Compiled with support for |channel| and |job| |
|
20037
f36f10d90378
patch 8.2.0574: ipv6 feature not shown in :version output
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
11878 ipv6 Compiled with support for IPv6 networking in |channel|. |
| 7 | 11879 jumplist Compiled with |jumplist| support. |
| 11880 keymap Compiled with 'keymap' support. | |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
11881 lambda Compiled with |lambda| support. |
| 7 | 11882 langmap Compiled with 'langmap' support. |
| 11883 libcall Compiled with |libcall()| support. | |
| 5995 | 11884 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and |
| 11885 'breakindent' support. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11886 linux Linux version of Vim. |
| 7 | 11887 lispindent Compiled with support for lisp indenting. |
| 11888 listcmds Compiled with commands for the buffer list |:files| | |
| 11889 and the argument list |arglist|. | |
| 11890 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
|
11891 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
|
11892 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
|
11893 macunix Synonym for osxdarwin |
| 7 | 11894 menu Compiled with support for |:menu|. |
| 11895 mksession Compiled with support for |:mksession|. | |
| 11896 modify_fname Compiled with file name modifiers. |filename-modifiers| | |
|
17982
2029737e6a22
patch 8.1.1987: more functions can be used as methods
Bram Moolenaar <Bram@vim.org>
parents:
17976
diff
changeset
|
11897 (always true) |
| 22824 | 11898 mouse Compiled with support for mouse. |
| 7 | 11899 mouse_dec Compiled with support for Dec terminal mouse. |
| 11900 mouse_gpm Compiled with support for gpm (Linux console mouse) | |
|
16527
5412fcd03ecb
patch 8.1.1267: cannot check if GPM mouse support is working
Bram Moolenaar <Bram@vim.org>
parents:
16517
diff
changeset
|
11901 mouse_gpm_enabled GPM mouse is working |
| 7 | 11902 mouse_netterm Compiled with support for netterm mouse. |
| 11903 mouse_pterm Compiled with support for qnx pterm mouse. | |
| 1621 | 11904 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse) |
| 3750 | 11905 mouse_sgr Compiled with support for sgr mouse. |
| 3224 | 11906 mouse_urxvt Compiled with support for urxvt mouse. |
| 7 | 11907 mouse_xterm Compiled with support for xterm mouse. |
| 2681 | 11908 mouseshape Compiled with support for 'mouseshape'. |
| 15878 | 11909 multi_byte Compiled with support for 'encoding' (always true) |
| 21991 | 11910 multi_byte_encoding 'encoding' is set to a multibyte encoding. |
| 7 | 11911 multi_byte_ime Compiled with support for IME input method. |
| 11912 multi_lang Compiled with support for multiple languages. | |
| 14 | 11913 mzscheme Compiled with MzScheme interface |mzscheme|. |
| 2681 | 11914 netbeans_enabled Compiled with support for |netbeans| and connected. |
| 7 | 11915 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
|
11916 num64 Compiled with 64-bit |Number| support. |
| 7 | 11917 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
|
11918 osx Compiled for macOS cf. mac |
|
351cf7c67bbe
patch 8.0.1236: Mac features are confusing
Christian Brabandt <cb@256bit.org>
parents:
12632
diff
changeset
|
11919 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
|
11920 packages Compiled with |packages| support. |
| 7 | 11921 path_extra Compiled with up/downwards search in 'path' and 'tags' |
| 11922 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
|
11923 persistent_undo Compiled with support for persistent undo history. |
| 7 | 11924 postscript Compiled with PostScript file printing. |
| 11925 printer Compiled with |:hardcopy| support. | |
| 170 | 11926 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
|
11927 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
|
11928 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
|
11929 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
|
11930 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
|
11931 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
|
11932 python3_dynamic Python 3.x interface is dynamically loaded. |has-python| |
| 19523 | 11933 pythonx Python 2.x and/or 3.x interface available. |python_x| |
| 7 | 11934 qnx QNX version of Vim. |
| 11935 quickfix Compiled with |quickfix| support. | |
| 857 | 11936 reltime Compiled with |reltime()| support. |
| 7 | 11937 rightleft Compiled with 'rightleft' support. |
| 11938 ruby Compiled with Ruby interface |ruby|. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11939 scrollbind Compiled with 'scrollbind' support. (always true) |
| 7 | 11940 showcmd Compiled with 'showcmd' support. |
| 11941 signs Compiled with |:sign| support. | |
| 11942 smartindent Compiled with 'smartindent' support. | |
|
17004
353ed7ef78df
patch 8.1.1502: cannot play any sound
Bram Moolenaar <Bram@vim.org>
parents:
16996
diff
changeset
|
11943 sound Compiled with sound support, e.g. `sound_playevent()` |
| 2681 | 11944 spell Compiled with spell checking support |spell|. |
| 1989 | 11945 startuptime Compiled with |--startuptime| support. |
| 7 | 11946 statusline Compiled with support for 'statusline', 'rulerformat' |
| 11947 and special formats of 'titlestring' and 'iconstring'. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11948 sun SunOS version of Vim. |
| 15512 | 11949 sun_workshop Support for Sun |workshop| has been removed. |
| 314 | 11950 syntax Compiled with syntax highlighting support |syntax|. |
| 7 | 11951 syntax_items There are active syntax highlighting items for the |
| 11952 current buffer. | |
| 11953 system Compiled to use system() instead of fork()/exec(). | |
| 11954 tag_binary Compiled with binary searching in tags files | |
| 11955 |tag-binary-search|. | |
| 16208 | 11956 tag_old_static Support for old static tags was removed, see |
| 7 | 11957 |tag-old-static|. |
| 11958 tcl Compiled with Tcl interface. | |
|
9076
9305a1251e51
commit https://github.com/vim/vim/commit/91c4937be15b0b743b6bc495df602c1abbff6b87
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
11959 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
|
11960 terminal Compiled with |terminal| support. |
| 7 | 11961 terminfo Compiled with terminfo instead of termcap. |
| 11962 termresponse Compiled with support for |t_RV| and |v:termresponse|. | |
| 11963 textobjects Compiled with support for |text-objects|. | |
|
15138
9df130fd5e0d
patch 8.1.0579: cannot attach properties to text
Bram Moolenaar <Bram@vim.org>
parents:
15131
diff
changeset
|
11964 textprop Compiled with support for |text-properties|. |
| 7 | 11965 tgetent Compiled with tgetent support, able to use a termcap |
| 11966 or terminfo file. | |
|
8577
63dc856bd13d
commit https://github.com/vim/vim/commit/975b5271eed4fa0500c24a8f37be0b1797cb9db7
Christian Brabandt <cb@256bit.org>
parents:
8538
diff
changeset
|
11967 timers Compiled with |timer_start()| support. |
| 7 | 11968 title Compiled with window title support |'title'|. |
| 11969 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
|
11970 ttyin input is a terminal (tty) |
|
65e0537a4560
commit https://github.com/vim/vim/commit/2cab0e191055a8145ccd46cd52869fbb9798b971
Christian Brabandt <cb@256bit.org>
parents:
10348
diff
changeset
|
11971 ttyout output is a terminal (tty) |
| 12499 | 11972 unix Unix version of Vim. *+unix* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
11973 unnamedplus Compiled with support for "unnamedplus" in 'clipboard' |
|
16411
5b5c5daf57de
patch 8.1.1210: support for user commands is spread out
Bram Moolenaar <Bram@vim.org>
parents:
16380
diff
changeset
|
11974 user_commands User-defined commands. (always true) |
| 18790 | 11975 vartabs Compiled with variable tabstop support |'vartabstop'|. |
|
13341
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
11976 vcon Win32: Virtual console support is working, can use |
|
acd7eaa13d2b
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
13329
diff
changeset
|
11977 'termguicolors'. Also see |+vtp|. |
| 2681 | 11978 vertsplit Compiled with vertically split windows |:vsplit|. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11979 (always true) |
| 2581 | 11980 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
|
11981 *vim_starting* |
| 2681 | 11982 viminfo Compiled with viminfo support. |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11983 vimscript-1 Compiled Vim script version 1 support |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
11984 vimscript-2 Compiled Vim script version 2 support |
| 16380 | 11985 vimscript-3 Compiled Vim script version 3 support |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11986 virtualedit Compiled with 'virtualedit' option. (always true) |
|
15424
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
11987 visual Compiled with Visual mode. (always true) |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
11988 visualextra Compiled with extra Visual mode commands. (always |
|
90c8ff9c19ee
patch 8.1.0720: cannot easily change the current quickfx list index
Bram Moolenaar <Bram@vim.org>
parents:
15418
diff
changeset
|
11989 true) |blockwise-operators|. |
| 7 | 11990 vms VMS version of Vim. |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11991 vreplace Compiled with |gR| and |gr| commands. (always true) |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
11992 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
|
11993 out if it works in the current console). |
| 7 | 11994 wildignore Compiled with 'wildignore' option. |
| 11995 wildmenu Compiled with 'wildmenu' option. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
11996 win16 old version for MS-Windows 3.1 (always false) |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
11997 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
|
11998 64 bits) |
| 2681 | 11999 win32unix Win32 version of Vim, using Unix files (Cygwin) |
| 7 | 12000 win64 Win64 version of Vim (MS-Windows 64 bit). |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
12001 win95 Win32 version for MS-Windows 95/98/ME (always false) |
| 2681 | 12002 winaltkeys Compiled with 'winaltkeys' option. |
| 12003 windows Compiled with support for more than one window. | |
|
15677
772e72b046a3
patch 8.1.0846: not easy to recognize the system Vim runs on
Bram Moolenaar <Bram@vim.org>
parents:
15615
diff
changeset
|
12004 (always true) |
| 7 | 12005 writebackup Compiled with 'writebackup' default on. |
| 12006 xfontset Compiled with X fontset support |xfontset|. | |
| 12007 xim Compiled with X input method support |xim|. | |
| 5340 | 12008 xpm Compiled with pixmap support. |
| 12009 xpm_w32 Compiled with pixmap support for Win32. (Only for | |
| 12010 backward compatibility. Use "xpm" instead.) | |
| 7 | 12011 xsmp Compiled with X session management support. |
| 12012 xsmp_interact Compiled with interactive X session management support. | |
| 12013 xterm_clipboard Compiled with support for xterm clipboard. | |
| 12014 xterm_save Compiled with support for saving and restoring the | |
| 12015 xterm screen. | |
| 12016 x11 Compiled with X11 support. | |
| 12017 | |
| 12018 *string-match* | |
| 12019 Matching a pattern in a String | |
| 12020 | |
| 12021 A regexp pattern as explained at |pattern| is normally used to find a match in | |
| 12022 the buffer lines. When a pattern is used to find a match in a String, almost | |
| 12023 everything works in the same way. The difference is that a String is handled | |
| 12024 like it is one line. When it contains a "\n" character, this is not seen as a | |
| 12025 line break for the pattern. It can be matched with a "\n" in the pattern, or | |
| 12026 with ".". Example: > | |
| 12027 :let a = "aaaa\nxxxx" | |
| 12028 :echo matchstr(a, "..\n..") | |
| 12029 aa | |
| 12030 xx | |
| 12031 :echo matchstr(a, "a.x") | |
| 12032 a | |
| 12033 x | |
| 12034 | |
| 12035 Don't forget that "^" will only match at the first character of the String and | |
| 12036 "$" at the last character of the string. They don't match after or before a | |
| 12037 "\n". | |
| 12038 | |
| 12039 ============================================================================== | |
| 12040 5. Defining functions *user-functions* | |
| 12041 | |
| 12042 New functions can be defined. These can be called just like builtin | |
| 12043 functions. The function executes a sequence of Ex commands. Normal mode | |
| 12044 commands can be executed with the |:normal| command. | |
| 12045 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
12046 This section is about the legacy functions. For the Vim9 functions, which |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
12047 execute much faster, support type checking and more, see |vim9.txt|. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19163
diff
changeset
|
12048 |
| 7 | 12049 The function name must start with an uppercase letter, to avoid confusion with |
| 12050 builtin functions. To prevent from using the same name in different scripts | |
| 12051 avoid obvious, short names. A good habit is to start the function name with | |
| 12052 the name of the script, e.g., "HTMLcolor()". | |
| 12053 | |
| 504 | 12054 It's also possible to use curly braces, see |curly-braces-names|. And the |
| 12055 |autoload| facility is useful to define a function only when it's called. | |
| 7 | 12056 |
| 12057 *local-function* | |
| 12058 A function local to a script must start with "s:". A local script function | |
| 12059 can only be called from within the script and from functions, user commands | |
| 12060 and autocommands defined in the script. It is also possible to call the | |
| 1698 | 12061 function from a mapping defined in the script, but then |<SID>| must be used |
| 7 | 12062 instead of "s:" when the mapping is expanded outside of the script. |
| 5862 | 12063 There are only script-local functions, no buffer-local or window-local |
| 12064 functions. | |
| 7 | 12065 |
| 12066 *:fu* *:function* *E128* *E129* *E123* | |
| 12067 :fu[nction] List all functions and their arguments. | |
| 12068 | |
| 12069 :fu[nction] {name} List function {name}. | |
| 685 | 12070 {name} can also be a |Dictionary| entry that is a |
| 12071 |Funcref|: > | |
| 114 | 12072 :function dict.init |
| 504 | 12073 |
| 12074 :fu[nction] /{pattern} List functions with a name matching {pattern}. | |
| 12075 Example that lists all functions ending with "File": > | |
| 12076 :function /File$ | |
| 482 | 12077 < |
| 12078 *:function-verbose* | |
| 12079 When 'verbose' is non-zero, listing a function will also display where it was | |
| 12080 last defined. Example: > | |
| 12081 | |
| 12082 :verbose function SetFileTypeSH | |
| 12083 function SetFileTypeSH(name) | |
| 12084 Last set from /usr/share/vim/vim-7.0/filetype.vim | |
| 12085 < | |
| 484 | 12086 See |:verbose-cmd| for more information. |
| 482 | 12087 |
| 5862 | 12088 *E124* *E125* *E853* *E884* |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12089 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
12090 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
|
12091 the function follows in the next lines, until the |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
12092 matching |:endfunction|. |
| 12785 | 12093 |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
12094 The name must be made of alphanumeric characters and |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
12095 '_', and must start with a capital or "s:" (see |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
12096 above). Note that using "b:" or "g:" is not allowed. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
12097 (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
|
12098 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
|
12099 Before that patch no error was given). |
| 114 | 12100 |
| 685 | 12101 {name} can also be a |Dictionary| entry that is a |
| 12102 |Funcref|: > | |
| 114 | 12103 :function dict.init(arg) |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12104 < "dict" must be an existing dictionary. The entry |
| 114 | 12105 "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
|
12106 is required to overwrite an existing function. The |
| 114 | 12107 result is a |Funcref| to a numbered function. The |
| 12108 function can only be used with a |Funcref| and will be | |
| 12109 deleted if there are no more references to it. | |
| 7 | 12110 *E127* *E122* |
| 12111 When a function by this name already exists and [!] is | |
|
15008
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
12112 not used an error message is given. There is one |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
12113 exception: When sourcing a script again, a function |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
12114 that was previously defined in that script will be |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
12115 silently replaced. |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
12116 When [!] is used, an existing function is silently |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
12117 replaced. Unless it is currently being executed, that |
|
67e3103d6e18
patch 8.1.0515: reloading a script gives errors for existing functions
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
12118 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
|
12119 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
|
12120 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
|
12121 which is hard to debug. |
| 20552 | 12122 NOTE: In Vim9 script script-local functions cannot be |
| 12123 deleted or redefined. | |
| 133 | 12124 |
| 12125 For the {arguments} see |function-argument|. | |
| 12126 | |
| 5618 | 12127 *:func-range* *a:firstline* *a:lastline* |
| 7 | 12128 When the [range] argument is added, the function is |
| 12129 expected to take care of a range itself. The range is | |
| 12130 passed as "a:firstline" and "a:lastline". If [range] | |
| 12131 is excluded, ":{range}call" will call the function for | |
| 12132 each line in the range, with the cursor on the start | |
| 12133 of each line. See |function-range-example|. | |
| 3967 | 12134 The cursor is still moved to the first line of the |
| 12135 range, as is the case with all Ex commands. | |
| 5618 | 12136 *:func-abort* |
| 7 | 12137 When the [abort] argument is added, the function will |
| 12138 abort as soon as an error is detected. | |
| 5618 | 12139 *:func-dict* |
| 102 | 12140 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
|
12141 be invoked through an entry in a |Dictionary|. The |
| 102 | 12142 local variable "self" will then be set to the |
| 12143 dictionary. See |Dictionary-function|. | |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12144 *:func-closure* *E932* |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12145 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
|
12146 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
|
12147 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
|
12148 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
|
12149 remains referenced even after Foo() returns: > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12150 :function! Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12151 : let x = 0 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12152 : function! Bar() closure |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12153 : let x += 1 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12154 : return x |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12155 : endfunction |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9723
diff
changeset
|
12156 : return funcref('Bar') |
|
9688
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12157 :endfunction |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12158 |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12159 :let F = Foo() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12160 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12161 < 1 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12162 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12163 < 2 > |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12164 :echo F() |
|
2ea935bdd1a1
commit https://github.com/vim/vim/commit/10ce39a0d52272a3dfff2feb8c631529f29e6740
Christian Brabandt <cb@256bit.org>
parents:
9686
diff
changeset
|
12165 < 3 |
| 7 | 12166 |
| 1621 | 12167 *function-search-undo* |
| 653 | 12168 The last used search pattern and the redo command "." |
| 1621 | 12169 will not be changed by the function. This also |
| 12170 implies that the effect of |:nohlsearch| is undone | |
| 12171 when the function returns. | |
| 653 | 12172 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
12173 *: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
|
12174 :endf[unction] [argument] |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
12175 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
|
12176 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
|
12177 |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
12178 [argument] can be: |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
12179 | 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
|
12180 \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
|
12181 " 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
|
12182 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
|
12183 '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
|
12184 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
|
12185 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
|
12186 ignored. |
| 7 | 12187 |
|
11561
7ad79766365a
patch 8.0.0663: unexpected error message only when 'verbose' is set
Christian Brabandt <cb@256bit.org>
parents:
11553
diff
changeset
|
12188 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
|
12189 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
|
12190 :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
|
12191 < |
|
9723
80ac9cf77c9b
commit https://github.com/vim/vim/commit/437bafe4c8a83ed71ee006eda7f54b65a90f0d4c
Christian Brabandt <cb@256bit.org>
parents:
9688
diff
changeset
|
12192 *: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
|
12193 :delf[unction][!] {name} |
|
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
12194 Delete function {name}. |
| 685 | 12195 {name} can also be a |Dictionary| entry that is a |
| 12196 |Funcref|: > | |
| 114 | 12197 :delfunc dict.init |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12198 < This will remove the "init" entry from "dict". The |
| 114 | 12199 function is deleted if there are no more references to |
| 12200 it. | |
|
11543
57c452316da1
patch 8.0.0654: no warning for text after :endfunction
Christian Brabandt <cb@256bit.org>
parents:
11518
diff
changeset
|
12201 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
|
12202 exist. |
| 7 | 12203 *:retu* *:return* *E133* |
| 12204 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is | |
| 12205 evaluated and returned as the result of the function. | |
| 12206 If "[expr]" is not given, the number 0 is returned. | |
| 12207 When a function ends without an explicit ":return", | |
| 12208 the number 0 is returned. | |
| 12209 Note that there is no check for unreachable lines, | |
| 12210 thus there is no warning if commands follow ":return". | |
| 12211 | |
| 12212 If the ":return" is used after a |:try| but before the | |
| 12213 matching |:finally| (if present), the commands | |
| 12214 following the ":finally" up to the matching |:endtry| | |
| 12215 are executed first. This process applies to all | |
| 12216 nested ":try"s inside the function. The function | |
| 12217 returns at the outermost ":endtry". | |
| 12218 | |
| 133 | 12219 *function-argument* *a:var* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12220 An argument can be defined by giving its name. In the function this can then |
| 133 | 12221 be used as "a:name" ("a:" for argument). |
| 1156 | 12222 *a:0* *a:1* *a:000* *E740* *...* |
| 133 | 12223 Up to 20 arguments can be given, separated by commas. After the named |
| 12224 arguments an argument "..." can be specified, which means that more arguments | |
| 12225 may optionally be following. In the function the extra arguments can be used | |
| 12226 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which | |
| 685 | 12227 can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 12228 that "a:1" is the same as "a:000[0]". | |
| 148 | 12229 *E742* |
| 12230 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
|
12231 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
|
12232 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
|
12233 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
|
12234 change a |List| or |Dictionary| use |:lockvar|. |
| 133 | 12235 |
| 12236 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
|
12237 still supply the () then. |
|
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12722
diff
changeset
|
12238 |
|
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13438
diff
changeset
|
12239 It is allowed to define another function inside a function body. |
| 133 | 12240 |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12241 *optional-function-argument* |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12242 You can provide default values for positional named arguments. This makes |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12243 them optional for function calls. When a positional argument is not |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12244 specified at a call, the default expression is used to initialize it. |
| 19968 | 12245 This only works for functions declared with `:function` or `:def`, not for |
| 12246 lambda expressions |expr-lambda|. | |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12247 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12248 Example: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12249 function Something(key, value = 10) |
|
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
12250 echo a:key .. ": " .. a:value |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12251 endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12252 call Something('empty') "empty: 10" |
|
16648
a7f06505ad39
patch 8.1.1326: no test for listener with partial
Bram Moolenaar <Bram@vim.org>
parents:
16638
diff
changeset
|
12253 call Something('key', 20) "key: 20" |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12254 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12255 The argument default expressions are evaluated at the time of the function |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12256 call, not definition. Thus it is possible to use an expression which is |
| 16808 | 12257 invalid the moment the function is defined. The expressions are also only |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12258 evaluated when arguments are not specified during a call. |
| 21499 | 12259 *none-function_argument* |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12260 You can pass |v:none| to use the default expression. Note that this means you |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12261 cannot pass v:none as an ordinary value when an argument has a default |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12262 expression. |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12263 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12264 Example: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12265 function Something(a = 10, b = 20, c = 30) |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12266 endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12267 call Something(1, v:none, 3) " b = 20 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12268 < |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12269 *E989* |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12270 Optional arguments with default expressions must occur after any mandatory |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12271 arguments. You can use "..." after all optional named arguments. |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12272 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12273 It is possible for later argument defaults to refer to prior arguments, |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12274 but not the other way around. They must be prefixed with "a:", as with all |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12275 arguments. |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12276 |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12277 Example that works: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12278 :function Okay(mandatory, optional = a:mandatory) |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12279 :endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12280 Example that does NOT work: > |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12281 :function NoGood(first = a:second, second = 10) |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12282 :endfunction |
|
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12283 < |
| 19968 | 12284 When not using "...", the number of arguments in a function call must be at |
| 12285 least equal to the number of mandatory named arguments. When using "...", the | |
| 12286 number of arguments may be larger than the total of mandatory and optional | |
| 12287 arguments. | |
|
16615
1a911bd57f11
patch 8.1.1310: named function arguments are never optional
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
12288 |
| 133 | 12289 *local-variables* |
|
9527
e8b3db8e2d30
commit https://github.com/vim/vim/commit/069c1e7fa9f45a665064f7f2c17da84d6a48f544
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
12290 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
|
12291 function returns. Global variables need to be accessed with "g:". |
| 7 | 12292 |
| 12293 Example: > | |
| 12294 :function Table(title, ...) | |
| 12295 : echohl Title | |
| 12296 : echo a:title | |
| 12297 : echohl None | |
| 140 | 12298 : echo a:0 . " items:" |
| 12299 : for s in a:000 | |
| 12300 : echon ' ' . s | |
| 12301 : endfor | |
| 7 | 12302 :endfunction |
| 12303 | |
| 12304 This function can then be called with: > | |
| 140 | 12305 call Table("Table", "line1", "line2") |
| 12306 call Table("Empty Table") | |
| 7 | 12307 |
| 1156 | 12308 To return more than one value, return a |List|: > |
| 12309 :function Compute(n1, n2) | |
| 7 | 12310 : if a:n2 == 0 |
| 1156 | 12311 : return ["fail", 0] |
| 7 | 12312 : endif |
| 1156 | 12313 : return ["ok", a:n1 / a:n2] |
| 7 | 12314 :endfunction |
| 12315 | |
| 12316 This function can then be called with: > | |
| 1156 | 12317 :let [success, div] = Compute(102, 6) |
| 7 | 12318 :if success == "ok" |
| 12319 : echo div | |
| 12320 :endif | |
| 1156 | 12321 < |
| 786 | 12322 *:cal* *:call* *E107* *E117* |
| 7 | 12323 :[range]cal[l] {name}([arguments]) |
| 12324 Call a function. The name of the function and its arguments | |
| 16808 | 12325 are as specified with `:function`. Up to 20 arguments can be |
| 1156 | 12326 used. The returned value is discarded. |
| 7 | 12327 Without a range and for functions that accept a range, the |
| 12328 function is called once. When a range is given the cursor is | |
| 12329 positioned at the start of the first line before executing the | |
| 12330 function. | |
| 12331 When a range is given and the function doesn't handle it | |
| 12332 itself, the function is executed for each line in the range, | |
| 12333 with the cursor in the first column of that line. The cursor | |
| 12334 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
|
12335 call). The arguments are re-evaluated for each line. Thus |
| 7 | 12336 this works: |
| 12337 *function-range-example* > | |
| 12338 :function Mynumber(arg) | |
| 12339 : echo line(".") . " " . a:arg | |
| 12340 :endfunction | |
| 12341 :1,5call Mynumber(getline(".")) | |
| 12342 < | |
| 12343 The "a:firstline" and "a:lastline" are defined anyway, they | |
| 12344 can be used to do something different at the start or end of | |
| 12345 the range. | |
| 12346 | |
| 12347 Example of a function that handles the range itself: > | |
| 12348 | |
| 12349 :function Cont() range | |
| 12350 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ ' | |
| 12351 :endfunction | |
| 12352 :4,8call Cont() | |
| 12353 < | |
| 12354 This function inserts the continuation character "\" in front | |
| 12355 of all the lines in the range, except the first one. | |
| 12356 | |
| 1156 | 12357 When the function returns a composite value it can be further |
| 12358 dereferenced, but the range will not be used then. Example: > | |
| 12359 :4,8call GetDict().method() | |
| 12360 < Here GetDict() gets the range but method() does not. | |
| 12361 | |
| 7 | 12362 *E132* |
| 12363 The recursiveness of user functions is restricted with the |'maxfuncdepth'| | |
| 12364 option. | |
| 12365 | |
|
17620
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
12366 It is also possible to use `:eval`. It does not support a range, but does |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
12367 allow for method chaining, e.g.: > |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
12368 eval GetList()->Filter()->append('$') |
|
072efa9ca875
patch 8.1.1807: more functions can be used as a method
Bram Moolenaar <Bram@vim.org>
parents:
17612
diff
changeset
|
12369 |
| 17667 | 12370 A function can also be called as part of evaluating an expression or when it |
| 12371 is used as a method: > | |
| 12372 let x = GetList() | |
| 12373 let y = GetList()->Filter() | |
| 12374 | |
| 161 | 12375 |
| 12376 AUTOMATICALLY LOADING FUNCTIONS ~ | |
| 7 | 12377 *autoload-functions* |
| 12378 When using many or large functions, it's possible to automatically define them | |
| 161 | 12379 only when they are used. There are two methods: with an autocommand and with |
| 12380 the "autoload" directory in 'runtimepath'. | |
| 12381 | |
| 12382 | |
| 12383 Using an autocommand ~ | |
| 12384 | |
| 170 | 12385 This is introduced in the user manual, section |41.14|. |
| 12386 | |
| 161 | 12387 The autocommand is useful if you have a plugin that is a long Vim script file. |
| 16808 | 12388 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
|
12389 That makes Vim startup faster. The autocommand should then load the same file |
| 16808 | 12390 again, setting a variable to skip the `:finish` command. |
| 161 | 12391 |
| 12392 Use the FuncUndefined autocommand event with a pattern that matches the | |
| 12393 function(s) to be defined. Example: > | |
| 7 | 12394 |
| 12395 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim | |
| 12396 | |
| 12397 The file "~/vim/bufnetfuncs.vim" should then define functions that start with | |
| 12398 "BufNet". Also see |FuncUndefined|. | |
| 12399 | |
| 161 | 12400 |
| 12401 Using an autoload script ~ | |
| 168 | 12402 *autoload* *E746* |
| 170 | 12403 This is introduced in the user manual, section |41.15|. |
| 12404 | |
| 161 | 12405 Using a script in the "autoload" directory is simpler, but requires using |
| 12406 exactly the right file name. A function that can be autoloaded has a name | |
| 12407 like this: > | |
| 12408 | |
| 270 | 12409 :call filename#funcname() |
| 161 | 12410 |
| 20856 | 12411 These functions are always global, in Vim9 script "g:" needs to be used: > |
| 12412 :call g:filename#funcname() | |
| 12413 | |
| 161 | 12414 When such a function is called, and it is not defined yet, Vim will search the |
| 12415 "autoload" directories in 'runtimepath' for a script file called | |
| 12416 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should | |
| 12417 then define the function like this: > | |
| 12418 | |
| 270 | 12419 function filename#funcname() |
| 161 | 12420 echo "Done!" |
| 12421 endfunction | |
| 12422 | |
| 530 | 12423 The file name and the name used before the # in the function must match |
| 161 | 12424 exactly, and the defined function must have the name exactly as it will be |
| 20856 | 12425 called. In Vim9 script the "g:" prefix must be used: > |
| 12426 function g:filename#funcname() | |
| 12427 | |
| 12428 or for a compiled function: > | |
| 12429 def g:filename#funcname() | |
| 161 | 12430 |
| 270 | 12431 It is possible to use subdirectories. Every # in the function name works like |
| 12432 a path separator. Thus when calling a function: > | |
| 12433 | |
| 12434 :call foo#bar#func() | |
| 161 | 12435 |
| 12436 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. | |
| 12437 | |
| 168 | 12438 This also works when reading a variable that has not been set yet: > |
| 12439 | |
| 270 | 12440 :let l = foo#bar#lvar |
| 168 | 12441 |
| 557 | 12442 However, when the autoload script was already loaded it won't be loaded again |
| 12443 for an unknown variable. | |
| 12444 | |
| 168 | 12445 When assigning a value to such a variable nothing special happens. This can |
| 12446 be used to pass settings to the autoload script before it's loaded: > | |
| 12447 | |
| 270 | 12448 :let foo#bar#toggle = 1 |
| 12449 :call foo#bar#func() | |
| 168 | 12450 |
| 164 | 12451 Note that when you make a mistake and call a function that is supposed to be |
| 12452 defined in an autoload script, but the script doesn't actually define the | |
| 22723 | 12453 function, you will get an error message for the missing function. If you fix |
| 12454 the autoload script it won't be automatically loaded again. Either restart | |
| 12455 Vim or manually source the script. | |
| 168 | 12456 |
| 12457 Also note that if you have two script files, and one calls a function in the | |
| 1621 | 12458 other and vice versa, before the used function is defined, it won't work. |
| 168 | 12459 Avoid using the autoload functionality at the toplevel. |
| 161 | 12460 |
| 794 | 12461 Hint: If you distribute a bunch of scripts you can pack them together with the |
| 12462 |vimball| utility. Also read the user manual |distribute-script|. | |
| 12463 | |
| 7 | 12464 ============================================================================== |
| 12465 6. Curly braces names *curly-braces-names* | |
| 12466 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
12467 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
|
12468 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
|
12469 wrapped in braces {} like this: > |
| 7 | 12470 my_{adjective}_variable |
| 12471 | |
| 12472 When Vim encounters this, it evaluates the expression inside the braces, puts | |
| 12473 that in place of the expression, and re-interprets the whole as a variable | |
| 12474 name. So in the above example, if the variable "adjective" was set to | |
| 12475 "noisy", then the reference would be to "my_noisy_variable", whereas if | |
| 12476 "adjective" was set to "quiet", then it would be to "my_quiet_variable". | |
| 12477 | |
| 12478 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
|
12479 value. For example, the statement > |
| 7 | 12480 echo my_{&background}_message |
| 12481 | |
| 12482 would output the contents of "my_dark_message" or "my_light_message" depending | |
| 12483 on the current value of 'background'. | |
| 12484 | |
| 12485 You can use multiple brace pairs: > | |
| 12486 echo my_{adverb}_{adjective}_message | |
| 12487 ..or even nest them: > | |
| 12488 echo my_{ad{end_of_word}}_message | |
| 12489 where "end_of_word" is either "verb" or "jective". | |
| 12490 | |
| 12491 However, the expression inside the braces must evaluate to a valid single | |
| 236 | 12492 variable name, e.g. this is invalid: > |
| 7 | 12493 :let foo='a + b' |
| 12494 :echo c{foo}d | |
| 12495 .. since the result of expansion is "ca + bd", which is not a variable name. | |
| 12496 | |
| 12497 *curly-braces-function-names* | |
| 12498 You can call and define functions by an evaluated name in a similar way. | |
| 12499 Example: > | |
| 12500 :let func_end='whizz' | |
| 12501 :call my_func_{func_end}(parameter) | |
| 12502 | |
| 12503 This would call the function "my_func_whizz(parameter)". | |
| 12504 | |
|
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
12505 This does NOT work: > |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
12506 :let i = 3 |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
12507 :let @{i} = '' " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
12508 :echo @{i} " error |
|
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3398
diff
changeset
|
12509 |
| 7 | 12510 ============================================================================== |
| 12511 7. Commands *expression-commands* | |
| 12512 | |
| 20856 | 12513 Note: in Vim9 script `:let` is used for variable declaration, not assignment. |
| 12514 An assignment leaves out the `:let` command. |vim9-declaration| | |
| 12515 | |
| 7 | 12516 :let {var-name} = {expr1} *:let* *E18* |
| 12517 Set internal variable {var-name} to the result of the | |
| 12518 expression {expr1}. The variable will get the type | |
| 12519 from the {expr}. If {var-name} didn't exist yet, it | |
| 12520 is created. | |
| 12521 | |
| 85 | 12522 :let {var-name}[{idx}] = {expr1} *E689* |
| 12523 Set a list item to the result of the expression | |
| 12524 {expr1}. {var-name} must refer to a list and {idx} | |
| 12525 must be a valid index in that list. For nested list | |
| 12526 the index can be repeated. | |
| 1621 | 12527 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
|
12528 This cannot be used to set a byte in a String. You |
| 1621 | 12529 can do that like this: > |
| 12530 :let var = var[0:2] . 'X' . var[4:] | |
|
15454
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
12531 < When {var-name} is a |Blob| then {idx} can be the |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
12532 length of the blob, in which case one byte is |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
12533 appended. |
|
1d2b5c016f17
patch 8.1.0735: cannot handle binary data
Bram Moolenaar <Bram@vim.org>
parents:
15446
diff
changeset
|
12534 |
| 114 | 12535 *E711* *E719* |
| 12536 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* | |
| 685 | 12537 Set a sequence of items in a |List| to the result of |
| 12538 the expression {expr1}, which must be a list with the | |
| 87 | 12539 correct number of items. |
| 12540 {idx1} can be omitted, zero is used instead. | |
| 12541 {idx2} can be omitted, meaning the end of the list. | |
| 12542 When the selected range of items is partly past the | |
| 12543 end of the list, items will be added. | |
| 12544 | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12545 *:let+=* *:let-=* *:letstar=* |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12546 *:let/=* *:let%=* *:let.=* *:let..=* *E734* *E985* |
| 114 | 12547 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 12548 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". | |
|
15790
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
12549 :let {var} *= {expr1} Like ":let {var} = {var} * {expr1}". |
|
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
12550 :let {var} /= {expr1} Like ":let {var} = {var} / {expr1}". |
|
05d836c8f1c4
patch 8.1.0902: incomplete set of assignment operators
Bram Moolenaar <Bram@vim.org>
parents:
15774
diff
changeset
|
12551 :let {var} %= {expr1} Like ":let {var} = {var} % {expr1}". |
| 114 | 12552 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12553 :let {var} ..= {expr1} Like ":let {var} = {var} .. {expr1}". |
| 114 | 12554 These fail if {var} was not set yet and when the type |
| 12555 of {var} and {expr1} don't fit the operator. | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12556 `.=` is not supported with Vim script version 2 and |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
12557 later, see |vimscript-version|. |
| 114 | 12558 |
| 12559 | |
| 7 | 12560 :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 12561 Set environment variable {env-name} to the result of | |
| 12562 the expression {expr1}. The type is always String. | |
| 17758 | 12563 |
| 12564 On some systems making an environment variable empty | |
| 12565 causes it to be deleted. Many systems do not make a | |
| 12566 difference between an environment variable that is not | |
| 12567 set and an environment variable that is empty. | |
| 12568 | |
| 114 | 12569 :let ${env-name} .= {expr1} |
| 12570 Append {expr1} to the environment variable {env-name}. | |
| 12571 If the environment variable didn't exist yet this | |
| 12572 works like "=". | |
| 7 | 12573 |
| 12574 :let @{reg-name} = {expr1} *:let-register* *:let-@* | |
| 12575 Write the result of the expression {expr1} in register | |
| 12576 {reg-name}. {reg-name} must be a single letter, and | |
| 12577 must be the name of a writable register (see | |
| 12578 |registers|). "@@" can be used for the unnamed | |
| 12579 register, "@/" for the search pattern. | |
| 12580 If the result of {expr1} ends in a <CR> or <NL>, the | |
| 12581 register will be linewise, otherwise it will be set to | |
| 12582 characterwise. | |
| 12583 This can be used to clear the last search pattern: > | |
| 12584 :let @/ = "" | |
| 12585 < This is different from searching for an empty string, | |
| 12586 that would match everywhere. | |
| 12587 | |
| 114 | 12588 :let @{reg-name} .= {expr1} |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12589 Append {expr1} to register {reg-name}. If the |
| 114 | 12590 register was empty it's like setting it to {expr1}. |
| 12591 | |
| 1156 | 12592 :let &{option-name} = {expr1} *:let-option* *:let-&* |
| 7 | 12593 Set option {option-name} to the result of the |
| 68 | 12594 expression {expr1}. A String or Number value is |
| 12595 always converted to the type of the option. | |
| 7 | 12596 For an option local to a window or buffer the effect |
| 12597 is just like using the |:set| command: both the local | |
| 555 | 12598 value and the global value are changed. |
| 68 | 12599 Example: > |
| 12600 :let &path = &path . ',/usr/local/include' | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
12601 < This also works for terminal codes in the form t_xx. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
12602 But only for alphanumerical names. Example: > |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
12603 :let &t_k1 = "\<Esc>[234;" |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10787
diff
changeset
|
12604 < 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
|
12605 a terminal key code, there is no error. |
| 7 | 12606 |
| 114 | 12607 :let &{option-name} .= {expr1} |
| 12608 For a string option: Append {expr1} to the value. | |
| 12609 Does not insert a comma like |:set+=|. | |
| 12610 | |
| 12611 :let &{option-name} += {expr1} | |
| 12612 :let &{option-name} -= {expr1} | |
| 12613 For a number or boolean option: Add or subtract | |
| 12614 {expr1}. | |
| 12615 | |
| 7 | 12616 :let &l:{option-name} = {expr1} |
| 114 | 12617 :let &l:{option-name} .= {expr1} |
| 12618 :let &l:{option-name} += {expr1} | |
| 12619 :let &l:{option-name} -= {expr1} | |
| 7 | 12620 Like above, but only set the local value of an option |
| 12621 (if there is one). Works like |:setlocal|. | |
| 12622 | |
| 12623 :let &g:{option-name} = {expr1} | |
| 114 | 12624 :let &g:{option-name} .= {expr1} |
| 12625 :let &g:{option-name} += {expr1} | |
| 12626 :let &g:{option-name} -= {expr1} | |
| 7 | 12627 Like above, but only set the global value of an option |
| 12628 (if there is one). Works like |:setglobal|. | |
| 12629 | |
| 85 | 12630 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
| 685 | 12631 {expr1} must evaluate to a |List|. The first item in |
| 68 | 12632 the list is assigned to {name1}, the second item to |
| 12633 {name2}, etc. | |
| 12634 The number of names must match the number of items in | |
| 685 | 12635 the |List|. |
| 68 | 12636 Each name can be one of the items of the ":let" |
| 12637 command as mentioned above. | |
| 12638 Example: > | |
| 12639 :let [s, item] = GetItem(s) | |
| 114 | 12640 < Detail: {expr1} is evaluated first, then the |
| 12641 assignments are done in sequence. This matters if | |
| 12642 {name2} depends on {name1}. Example: > | |
| 12643 :let x = [0, 1] | |
| 12644 :let i = 0 | |
| 12645 :let [i, x[i]] = [1, 2] | |
| 12646 :echo x | |
| 12647 < The result is [0, 2]. | |
| 12648 | |
| 12649 :let [{name1}, {name2}, ...] .= {expr1} | |
| 12650 :let [{name1}, {name2}, ...] += {expr1} | |
| 12651 :let [{name1}, {name2}, ...] -= {expr1} | |
| 12652 Like above, but append/add/subtract the value for each | |
| 685 | 12653 |List| item. |
| 68 | 12654 |
| 19968 | 12655 :let [{name}, ..., ; {lastname}] = {expr1} *E452* |
| 685 | 12656 Like |:let-unpack| above, but the |List| may have more |
| 114 | 12657 items than there are names. A list of the remaining |
| 12658 items is assigned to {lastname}. If there are no | |
| 12659 remaining items {lastname} is set to an empty list. | |
| 68 | 12660 Example: > |
| 12661 :let [a, b; rest] = ["aval", "bval", 3, 4] | |
| 12662 < | |
| 114 | 12663 :let [{name}, ..., ; {lastname}] .= {expr1} |
| 12664 :let [{name}, ..., ; {lastname}] += {expr1} | |
| 12665 :let [{name}, ..., ; {lastname}] -= {expr1} | |
| 12666 Like above, but append/add/subtract the value for each | |
| 685 | 12667 |List| item. |
| 2596 | 12668 |
|
17450
509542f1fffb
patch 8.1.1723: heredoc assignment has no room for new features
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
12669 *:let=<<* *:let-heredoc* |
|
509542f1fffb
patch 8.1.1723: heredoc assignment has no room for new features
Bram Moolenaar <Bram@vim.org>
parents:
17433
diff
changeset
|
12670 *E990* *E991* *E172* *E221* |
| 18343 | 12671 :let {var-name} =<< [trim] {endmarker} |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12672 text... |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12673 text... |
| 18343 | 12674 {endmarker} |
| 21093 | 12675 Set internal variable {var-name} to a |List| |
| 12676 containing the lines of text bounded by the string | |
|
21608
24cb89db078d
patch 8.2.1354: test 59 is old style
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
12677 {endmarker}. The lines of text is used as a |
|
24cb89db078d
patch 8.2.1354: test 59 is old style
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
12678 |literal-string|. |
| 18343 | 12679 {endmarker} must not contain white space. |
| 12680 {endmarker} cannot start with a lower case character. | |
| 12681 The last line should end only with the {endmarker} | |
| 12682 string without any other character. Watch out for | |
| 12683 white space after {endmarker}! | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12684 |
|
17172
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12685 Without "trim" any white space characters in the lines |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12686 of text are preserved. If "trim" is specified before |
| 18343 | 12687 {endmarker}, then indentation is stripped so you can |
| 12688 do: > | |
|
17172
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12689 let text =<< trim END |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12690 if ok |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12691 echo 'done' |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12692 endif |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12693 END |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12694 < Results in: ["if ok", " echo 'done'", "endif"] |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12695 The marker must line up with "let" and the indentation |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12696 of the first line is removed from all the text lines. |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12697 Specifically: all the leading indentation exactly |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12698 matching the leading indentation of the first |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12699 non-empty text line is stripped from the input lines. |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12700 All leading indentation exactly matching the leading |
|
6990c1160ea5
patch 8.1.1585: :let-heredoc does not trim enough
Bram Moolenaar <Bram@vim.org>
parents:
17161
diff
changeset
|
12701 indentation before `let` is stripped from the line |
| 18343 | 12702 containing {endmarker}. Note that the difference |
| 12703 between space and tab matters here. | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12704 |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12705 If {var-name} didn't exist yet, it is created. |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12706 Cannot be followed by another command, but can be |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12707 followed by a comment. |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12708 |
| 18343 | 12709 To avoid line continuation to be applied, consider |
| 12710 adding 'C' to 'cpoptions': > | |
| 12711 set cpo+=C | |
| 12712 let var =<< END | |
| 12713 \ leading backslash | |
| 12714 END | |
| 12715 set cpo-=C | |
| 12716 < | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12717 Examples: > |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12718 let var1 =<< END |
| 18343 | 12719 Sample text 1 |
| 12720 Sample text 2 | |
| 12721 Sample text 3 | |
| 12722 END | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12723 |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12724 let data =<< trim DATA |
| 18343 | 12725 1 2 3 4 |
| 12726 5 6 7 8 | |
|
16704
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12727 DATA |
|
a927fdf9a4b0
patch 8.1.1354: getting a list of text lines is clumsy
Bram Moolenaar <Bram@vim.org>
parents:
16664
diff
changeset
|
12728 < |
| 2596 | 12729 *E121* |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9861
diff
changeset
|
12730 :let {var-name} .. List the value of variable {var-name}. Multiple |
| 123 | 12731 variable names may be given. Special names recognized |
| 12732 here: *E738* | |
| 777 | 12733 g: global variables |
| 12734 b: local buffer variables | |
| 12735 w: local window variables | |
| 819 | 12736 t: local tab page variables |
| 777 | 12737 s: script-local variables |
| 12738 l: local function variables | |
| 123 | 12739 v: Vim variables. |
| 20856 | 12740 This does not work in Vim9 script. |vim9-declaration| |
| 7 | 12741 |
| 55 | 12742 :let List the values of all variables. The type of the |
| 12743 variable is indicated before the value: | |
| 12744 <nothing> String | |
| 12745 # Number | |
| 856 | 12746 * Funcref |
| 20856 | 12747 This does not work in Vim9 script. |vim9-declaration| |
| 7 | 12748 |
| 1156 | 12749 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* |
| 148 | 12750 Remove the internal variable {name}. Several variable |
| 12751 names can be given, they are all removed. The name | |
| 685 | 12752 may also be a |List| or |Dictionary| item. |
| 7 | 12753 With [!] no error message is given for non-existing |
| 12754 variables. | |
| 685 | 12755 One or more items from a |List| can be removed: > |
| 108 | 12756 :unlet list[3] " remove fourth item |
| 12757 :unlet list[3:] " remove fourth item to last | |
| 685 | 12758 < One item from a |Dictionary| can be removed at a time: > |
| 108 | 12759 :unlet dict['two'] |
| 12760 :unlet dict.two | |
| 1668 | 12761 < This is especially useful to clean up used global |
| 12762 variables and script-local variables (these are not | |
| 12763 deleted when the script ends). Function-local | |
| 12764 variables are automatically deleted when the function | |
| 12765 ends. | |
| 7 | 12766 |
|
13923
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12767 :unl[et] ${env-name} ... *:unlet-environment* *:unlet-$* |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12768 Remove environment variable {env-name}. |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12769 Can mix {name} and ${env-name} in one :unlet command. |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12770 No error message is given for a non-existing |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12771 variable, also without !. |
|
e4d5726e1678
patch 8.0.1832: cannot use :unlet for an environment variable
Christian Brabandt <cb@256bit.org>
parents:
13821
diff
changeset
|
12772 If the system does not support deleting an environment |
|
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12773 variable, it is made empty. |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12774 |
|
17109
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12775 *:cons* *:const* |
|
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12776 :cons[t] {var-name} = {expr1} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12777 :cons[t] [{name1}, {name2}, ...] = {expr1} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12778 :cons[t] [{name}, ..., ; {lastname}] = {expr1} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12779 :cons[t] {var-name} =<< [trim] {marker} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12780 text... |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12781 text... |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12782 {marker} |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12783 Similar to |:let|, but additionally lock the variable |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12784 after setting the value. This is the same as locking |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12785 the variable with |:lockvar| just after |:let|, thus: > |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12786 :const x = 1 |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12787 < is equivalent to: > |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12788 :let x = 1 |
|
21847
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12789 :lockvar! x |
|
22298
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12790 < NOTE: in Vim9 script `:const` works differently, see |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12791 |vim9-const| |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12792 This is useful if you want to make sure the variable |
|
21847
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12793 is not modified. If the value is a List or Dictionary |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12794 literal then the items also cannot be changed: > |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12795 const ll = [1, 2, 3] |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12796 let ll[1] = 5 " Error! |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12797 < Nested references are not locked: > |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12798 let lvar = ['a'] |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12799 const lconst = [0, lvar] |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12800 let lconst[0] = 2 " Error! |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12801 let lconst[1][0] = 'b' " OK |
|
fb74a3387694
patch 8.2.1473: items in a list given to :const can still be modified
Bram Moolenaar <Bram@vim.org>
parents:
21825
diff
changeset
|
12802 < *E995* |
|
17131
be5a5cfc991a
patch 8.1.1565: MS-Windows: no sound support
Bram Moolenaar <Bram@vim.org>
parents:
17109
diff
changeset
|
12803 |:const| does not allow to for changing a variable: > |
|
17079
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12804 :let x = 1 |
|
00ffed9bbb65
patch 8.1.1539: not easy to define a variable and lock it
Bram Moolenaar <Bram@vim.org>
parents:
17053
diff
changeset
|
12805 :const x = 2 " Error! |
|
17109
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12806 < *E996* |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12807 Note that environment variables, option values and |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12808 register values cannot be used here, since they cannot |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12809 be locked. |
|
cc5d4b4bae83
patch 8.1.1554: docs and tests for :const can be improved
Bram Moolenaar <Bram@vim.org>
parents:
17085
diff
changeset
|
12810 |
| 17433 | 12811 :cons[t] |
| 12812 :cons[t] {var-name} | |
| 12813 If no argument is given or only {var-name} is given, | |
| 12814 the behavior is the same as |:let|. | |
| 12815 | |
| 148 | 12816 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 12817 Lock the internal variable {name}. Locking means that | |
| 12818 it can no longer be changed (until it is unlocked). | |
| 12819 A locked variable can be deleted: > | |
| 12820 :lockvar v | |
| 24278 | 12821 :let v = 'asdf' " fails! |
| 12822 :unlet v " works | |
|
10908
6b6abffbdf59
patch 8.0.0343: b:changedtick can be unlocked
Christian Brabandt <cb@256bit.org>
parents:
10895
diff
changeset
|
12823 < *E741* *E940* |
| 148 | 12824 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
|
12825 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
|
12826 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
|
12827 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
|
12828 variable {name}". |
| 148 | 12829 |
| 685 | 12830 [depth] is relevant when locking a |List| or |
| 12831 |Dictionary|. It specifies how deep the locking goes: | |
|
22298
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12832 0 Lock the variable {name} but not its |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12833 value. |
| 685 | 12834 1 Lock the |List| or |Dictionary| itself, |
| 148 | 12835 cannot add or remove items, but can |
| 12836 still change their values. | |
| 12837 2 Also lock the values, cannot change | |
| 685 | 12838 the items. If an item is a |List| or |
| 12839 |Dictionary|, cannot add or remove | |
| 148 | 12840 items, but can still change the |
| 12841 values. | |
| 685 | 12842 3 Like 2 but for the |List| / |
| 12843 |Dictionary| in the |List| / | |
| 12844 |Dictionary|, one level deeper. | |
| 12845 The default [depth] is 2, thus when {name} is a |List| | |
| 12846 or |Dictionary| the values cannot be changed. | |
|
22298
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12847 |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12848 Example with [depth] 0: > |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12849 let mylist = [1, 2, 3] |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12850 lockvar 0 mylist |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12851 let mylist[0] = 77 " OK |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12852 call add(mylist, 4] " OK |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12853 let mylist = [7, 8, 9] " Error! |
|
07e48ee8c3bb
patch 8.2.1698: cannot lock a variable in legacy Vim script like in Vim9
Bram Moolenaar <Bram@vim.org>
parents:
22232
diff
changeset
|
12854 < *E743* |
| 148 | 12855 For unlimited depth use [!] and omit [depth]. |
| 12856 However, there is a maximum depth of 100 to catch | |
| 12857 loops. | |
| 12858 | |
| 685 | 12859 Note that when two variables refer to the same |List| |
| 12860 and you lock one of them, the |List| will also be | |
| 819 | 12861 locked when used through the other variable. |
| 12862 Example: > | |
| 148 | 12863 :let l = [0, 1, 2, 3] |
| 12864 :let cl = l | |
| 12865 :lockvar l | |
| 12866 :let cl[1] = 99 " won't work! | |
| 12867 < You may want to make a copy of a list to avoid this. | |
| 12868 See |deepcopy()|. | |
| 12869 | |
| 12870 | |
| 12871 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* | |
| 12872 Unlock the internal variable {name}. Does the | |
| 12873 opposite of |:lockvar|. | |
| 12874 | |
| 16944 | 12875 :if {expr1} *:if* *:end* *:endif* *:en* *E171* *E579* *E580* |
| 7 | 12876 :en[dif] Execute the commands until the next matching ":else" |
| 12877 or ":endif" if {expr1} evaluates to non-zero. | |
| 12878 | |
| 12879 From Vim version 4.5 until 5.0, every Ex command in | |
| 12880 between the ":if" and ":endif" is ignored. These two | |
| 12881 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
|
12882 backward compatible way. Nesting was allowed. Note |
| 7 | 12883 that any ":else" or ":elseif" was ignored, the "else" |
| 12884 part was not executed either. | |
| 12885 | |
| 12886 You can use this to remain compatible with older | |
| 12887 versions: > | |
| 12888 :if version >= 500 | |
| 12889 : version-5-specific-commands | |
| 12890 :endif | |
| 12891 < The commands still need to be parsed to find the | |
| 12892 "endif". Sometimes an older Vim has a problem with a | |
| 12893 new command. For example, ":silent" is recognized as | |
| 12894 a ":substitute" command. In that case ":execute" can | |
| 12895 avoid problems: > | |
| 12896 :if version >= 600 | |
| 12897 : execute "silent 1,$delete" | |
| 12898 :endif | |
| 12899 < | |
| 12900 NOTE: The ":append" and ":insert" commands don't work | |
| 12901 properly in between ":if" and ":endif". | |
| 12902 | |
| 12903 *:else* *:el* *E581* *E583* | |
| 12904 :el[se] Execute the commands until the next matching ":else" | |
| 12905 or ":endif" if they previously were not being | |
| 12906 executed. | |
| 12907 | |
| 12908 *:elseif* *:elsei* *E582* *E584* | |
| 12909 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there | |
| 12910 is no extra ":endif". | |
| 12911 | |
| 12912 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* | |
| 114 | 12913 *E170* *E585* *E588* *E733* |
| 7 | 12914 :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 12915 as long as {expr1} evaluates to non-zero. | |
| 12916 When an error is detected from a command inside the | |
| 12917 loop, execution continues after the "endwhile". | |
| 75 | 12918 Example: > |
| 12919 :let lnum = 1 | |
| 12920 :while lnum <= line("$") | |
| 12921 :call FixLine(lnum) | |
| 12922 :let lnum = lnum + 1 | |
| 12923 :endwhile | |
| 12924 < | |
| 7 | 12925 NOTE: The ":append" and ":insert" commands don't work |
| 99 | 12926 properly inside a ":while" and ":for" loop. |
| 75 | 12927 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12928 :for {var} in {object} *:for* *E690* *E732* |
| 75 | 12929 :endfo[r] *:endfo* *:endfor* |
| 12930 Repeat the commands between ":for" and ":endfor" for | |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12931 each item in {object}. {object} can be a |List| or |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12932 a |Blob|. Variable {var} is set to the value of each |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12933 item. When an error is detected for a command inside |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12934 the loop, execution continues after the "endfor". |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12935 Changing {object} inside the loop affects what items |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12936 are used. Make a copy if this is unwanted: > |
| 79 | 12937 :for item in copy(mylist) |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12938 < |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12939 When {object} is a |List| and not making a copy, Vim |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12940 stores a reference to the next item in the |List| |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12941 before executing the commands with the current item. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12942 Thus the current item can be removed without effect. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12943 Removing any later item means it will not be found. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12944 Thus the following example works (an inefficient way |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12945 to make a |List| empty): > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12946 for item in mylist |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12947 call remove(mylist, 0) |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
12948 endfor |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12949 < Note that reordering the |List| (e.g., with sort() or |
| 87 | 12950 reverse()) may have unexpected effects. |
| 75 | 12951 |
|
15615
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12952 When {object} is a |Blob|, Vim always makes a copy to |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12953 iterate over. Unlike with |List|, modifying the |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12954 |Blob| does not affect the iteration. |
|
536fca2cee19
patch 8.1.0815: dialog for file changed outside of Vim not tested
Bram Moolenaar <Bram@vim.org>
parents:
15579
diff
changeset
|
12955 |
| 75 | 12956 :for [{var1}, {var2}, ...] in {listlist} |
| 12957 :endfo[r] | |
| 12958 Like ":for" above, but each item in {listlist} must be | |
| 12959 a list, of which each item is assigned to {var1}, | |
| 12960 {var2}, etc. Example: > | |
| 12961 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] | |
| 12962 :echo getline(lnum)[col] | |
| 12963 :endfor | |
| 12964 < | |
| 7 | 12965 *:continue* *:con* *E586* |
| 75 | 12966 :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 12967 to the start of the loop. | |
| 12968 If it is used after a |:try| inside the loop but | |
| 12969 before the matching |:finally| (if present), the | |
| 12970 commands following the ":finally" up to the matching | |
| 12971 |:endtry| are executed first. This process applies to | |
| 12972 all nested ":try"s inside the loop. The outermost | |
| 12973 ":endtry" then jumps back to the start of the loop. | |
| 7 | 12974 |
| 12975 *:break* *:brea* *E587* | |
| 75 | 12976 :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 12977 the command after the matching ":endwhile" or | |
| 12978 ":endfor". | |
| 12979 If it is used after a |:try| inside the loop but | |
| 12980 before the matching |:finally| (if present), the | |
| 12981 commands following the ":finally" up to the matching | |
| 12982 |:endtry| are executed first. This process applies to | |
| 12983 all nested ":try"s inside the loop. The outermost | |
| 12984 ":endtry" then jumps to the command after the loop. | |
| 7 | 12985 |
| 12986 :try *:try* *:endt* *:endtry* *E600* *E601* *E602* | |
| 12987 :endt[ry] Change the error handling for the commands between | |
| 12988 ":try" and ":endtry" including everything being | |
| 12989 executed across ":source" commands, function calls, | |
| 12990 or autocommand invocations. | |
| 12991 | |
| 12992 When an error or interrupt is detected and there is | |
| 12993 a |:finally| command following, execution continues | |
| 12994 after the ":finally". Otherwise, or when the | |
| 12995 ":endtry" is reached thereafter, the next | |
| 12996 (dynamically) surrounding ":try" is checked for | |
| 12997 a corresponding ":finally" etc. Then the script | |
| 19523 | 12998 processing is terminated. Whether a function |
| 12999 definition has an "abort" argument does not matter. | |
| 7 | 13000 Example: > |
| 19523 | 13001 try | call Unknown() | finally | echomsg "cleanup" | endtry |
| 13002 echomsg "not reached" | |
| 7 | 13003 < |
| 13004 Moreover, an error or interrupt (dynamically) inside | |
| 13005 ":try" and ":endtry" is converted to an exception. It | |
| 13006 can be caught as if it were thrown by a |:throw| | |
| 13007 command (see |:catch|). In this case, the script | |
| 13008 processing is not terminated. | |
| 13009 | |
| 13010 The value "Vim:Interrupt" is used for an interrupt | |
| 13011 exception. An error in a Vim command is converted | |
| 13012 to a value of the form "Vim({command}):{errmsg}", | |
| 13013 other errors are converted to a value of the form | |
| 13014 "Vim:{errmsg}". {command} is the full command name, | |
| 13015 and {errmsg} is the message that is displayed if the | |
| 13016 error exception is not caught, always beginning with | |
| 13017 the error number. | |
| 13018 Examples: > | |
| 19523 | 13019 try | sleep 100 | catch /^Vim:Interrupt$/ | endtry |
| 13020 try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry | |
| 7 | 13021 < |
| 13022 *:cat* *:catch* *E603* *E604* *E605* | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
13023 :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
| 7 | 13024 |:finally|, or |:endtry| that belongs to the same |
| 13025 |:try| as the ":catch" are executed when an exception | |
| 13026 matching {pattern} is being thrown and has not yet | |
| 13027 been caught by a previous ":catch". Otherwise, these | |
| 13028 commands are skipped. | |
| 13029 When {pattern} is omitted all errors are caught. | |
| 13030 Examples: > | |
|
16019
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13031 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13032 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13033 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13034 :catch /^Vim(write):/ " catch all errors in :write |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13035 :catch /^Vim\%((\a\+)\)\=:E123:/ " catch error E123 |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13036 :catch /my-exception/ " catch user exception |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13037 :catch /.*/ " catch everything |
|
096b8ccd855e
patch 8.1.1015: quickfix buffer shows up in list, can't get buffer number
Bram Moolenaar <Bram@vim.org>
parents:
15977
diff
changeset
|
13038 :catch " same as /.*/ |
| 7 | 13039 < |
| 13040 Another character can be used instead of / around the | |
| 13041 {pattern}, so long as it does not have a special | |
| 13042 meaning (e.g., '|' or '"') and doesn't occur inside | |
| 13043 {pattern}. | |
| 5814 | 13044 Information about the exception is available in |
| 13045 |v:exception|. Also see |throw-variables|. | |
| 7 | 13046 NOTE: It is not reliable to ":catch" the TEXT of |
| 13047 an error message because it may vary in different | |
| 13048 locales. | |
| 13049 | |
| 13050 *:fina* *:finally* *E606* *E607* | |
| 13051 :fina[lly] The following commands until the matching |:endtry| | |
| 13052 are executed whenever the part between the matching | |
| 13053 |:try| and the ":finally" is left: either by falling | |
| 13054 through to the ":finally" or by a |:continue|, | |
| 13055 |:break|, |:finish|, or |:return|, or by an error or | |
| 13056 interrupt or exception (see |:throw|). | |
| 13057 | |
| 13058 *:th* *:throw* *E608* | |
| 13059 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. | |
| 13060 If the ":throw" is used after a |:try| but before the | |
| 13061 first corresponding |:catch|, commands are skipped | |
| 13062 until the first ":catch" matching {expr1} is reached. | |
| 13063 If there is no such ":catch" or if the ":throw" is | |
| 13064 used after a ":catch" but before the |:finally|, the | |
| 13065 commands following the ":finally" (if present) up to | |
| 13066 the matching |:endtry| are executed. If the ":throw" | |
| 13067 is after the ":finally", commands up to the ":endtry" | |
| 13068 are skipped. At the ":endtry", this process applies | |
| 13069 again for the next dynamically surrounding ":try" | |
| 13070 (which may be found in a calling function or sourcing | |
| 13071 script), until a matching ":catch" has been found. | |
| 13072 If the exception is not caught, the command processing | |
| 13073 is terminated. | |
| 13074 Example: > | |
| 13075 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry | |
| 2725 | 13076 < Note that "catch" may need to be on a separate line |
| 13077 for when an error causes the parsing to skip the whole | |
| 13078 line and not see the "|" that separates the commands. | |
| 7 | 13079 |
| 13080 *:ec* *:echo* | |
| 13081 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The | |
| 13082 first {expr1} starts on a new line. | |
| 13083 Also see |:comment|. | |
| 13084 Use "\n" to start a new line. Use "\r" to move the | |
| 13085 cursor to the first column. | |
| 13086 Uses the highlighting set by the |:echohl| command. | |
| 13087 Cannot be followed by a comment. | |
| 13088 Example: > | |
| 13089 :echo "the value of 'shell' is" &shell | |
| 1156 | 13090 < *:echo-redraw* |
| 13091 A later redraw may make the message disappear again. | |
| 13092 And since Vim mostly postpones redrawing until it's | |
| 13093 finished with a sequence of commands this happens | |
| 13094 quite often. To avoid that a command from before the | |
| 13095 ":echo" causes a redraw afterwards (redraws are often | |
| 13096 postponed until you type something), force a redraw | |
| 13097 with the |:redraw| command. Example: > | |
| 7 | 13098 :new | redraw | echo "there is a new window" |
| 13099 < | |
| 13100 *:echon* | |
| 13101 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see | |
| 13102 |:comment|. | |
| 13103 Uses the highlighting set by the |:echohl| command. | |
| 13104 Cannot be followed by a comment. | |
| 13105 Example: > | |
| 13106 :echon "the value of 'shell' is " &shell | |
| 13107 < | |
| 13108 Note the difference between using ":echo", which is a | |
| 13109 Vim command, and ":!echo", which is an external shell | |
| 13110 command: > | |
| 13111 :!echo % --> filename | |
| 13112 < The arguments of ":!" are expanded, see |:_%|. > | |
| 13113 :!echo "%" --> filename or "filename" | |
| 13114 < Like the previous example. Whether you see the double | |
| 13115 quotes or not depends on your 'shell'. > | |
| 13116 :echo % --> nothing | |
| 13117 < The '%' is an illegal character in an expression. > | |
| 13118 :echo "%" --> % | |
| 13119 < This just echoes the '%' character. > | |
| 13120 :echo expand("%") --> filename | |
| 13121 < This calls the expand() function to expand the '%'. | |
| 13122 | |
| 13123 *:echoh* *:echohl* | |
| 13124 :echoh[l] {name} Use the highlight group {name} for the following | |
| 13125 |:echo|, |:echon| and |:echomsg| commands. Also used | |
| 13126 for the |input()| prompt. Example: > | |
| 13127 :echohl WarningMsg | echo "Don't panic!" | echohl None | |
| 13128 < Don't forget to set the group back to "None", | |
| 13129 otherwise all following echo's will be highlighted. | |
| 13130 | |
| 13131 *:echom* *:echomsg* | |
| 13132 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the | |
| 13133 message in the |message-history|. | |
| 13134 Spaces are placed between the arguments as with the | |
| 13135 |:echo| command. But unprintable characters are | |
| 13136 displayed, not interpreted. | |
| 1156 | 13137 The parsing works slightly different from |:echo|, |
| 13138 more like |:execute|. All the expressions are first | |
| 13139 evaluated and concatenated before echoing anything. | |
|
15219
dada0b389d4f
patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents:
15209
diff
changeset
|
13140 If expressions does not evaluate to a Number or |
|
dada0b389d4f
patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents:
15209
diff
changeset
|
13141 String, string() is used to turn it into a string. |
| 7 | 13142 Uses the highlighting set by the |:echohl| command. |
| 13143 Example: > | |
| 13144 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." | |
| 1156 | 13145 < See |:echo-redraw| to avoid the message disappearing |
| 13146 when the screen is redrawn. | |
| 7 | 13147 *:echoe* *:echoerr* |
| 13148 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the | |
| 13149 message in the |message-history|. When used in a | |
| 13150 script or function the line number will be added. | |
| 13151 Spaces are placed between the arguments as with the | |
|
15219
dada0b389d4f
patch 8.1.0619: :echomsg and :echoerr do not handle List and Dict
Bram Moolenaar <Bram@vim.org>
parents:
15209
diff
changeset
|
13152 |:echomsg| command. When used inside a try conditional, |
| 7 | 13153 the message is raised as an error exception instead |
| 13154 (see |try-echoerr|). | |
| 13155 Example: > | |
| 13156 :echoerr "This script just failed!" | |
| 13157 < If you just want a highlighted message use |:echohl|. | |
| 13158 And to get a beep: > | |
| 13159 :exe "normal \<Esc>" | |
|
24194
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
13160 |
|
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
13161 :echoc[onsole] {expr1} .. *:echoc* *:echoconsole* |
|
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
13162 Intended for testing: works like `:echomsg` but when |
|
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
13163 running in the GUI and started from a terminal write |
|
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
13164 the text to stdout. |
|
9f64c420f280
patch 8.2.2638: cannot write a message to the terminal from the GUI
Bram Moolenaar <Bram@vim.org>
parents:
24132
diff
changeset
|
13165 |
| 18639 | 13166 *:eval* |
| 13167 :eval {expr} Evaluate {expr} and discard the result. Example: > | |
| 13168 :eval Getlist()->Filter()->append('$') | |
| 13169 | |
| 13170 < The expression is supposed to have a side effect, | |
| 13171 since the resulting value is not used. In the example | |
| 13172 the `append()` call appends the List with text to the | |
| 13173 buffer. This is similar to `:call` but works with any | |
| 13174 expression. | |
| 13175 | |
| 13176 The command can be shortened to `:ev` or `:eva`, but | |
| 13177 these are hard to recognize and therefore not to be | |
| 13178 used. | |
| 13179 | |
| 19523 | 13180 The command cannot be followed by "|" and another |
| 13181 command, since "|" is seen as part of the expression. | |
| 13182 | |
| 18639 | 13183 |
| 7 | 13184 *:exe* *:execute* |
| 13185 :exe[cute] {expr1} .. Executes the string that results from the evaluation | |
| 2152 | 13186 of {expr1} as an Ex command. |
| 13187 Multiple arguments are concatenated, with a space in | |
| 23466 | 13188 between. To avoid the extra space use the ".." |
| 2152 | 13189 operator to concatenate strings into one argument. |
| 13190 {expr1} is used as the processed command, command line | |
| 13191 editing keys are not recognized. | |
| 7 | 13192 Cannot be followed by a comment. |
| 13193 Examples: > | |
| 2152 | 13194 :execute "buffer" nextbuf |
| 24103 | 13195 :execute "normal" count .. "w" |
| 7 | 13196 < |
| 13197 ":execute" can be used to append a command to commands | |
| 13198 that don't accept a '|'. Example: > | |
| 13199 :execute '!ls' | echo "theend" | |
| 13200 | |
| 13201 < ":execute" is also a nice way to avoid having to type | |
| 13202 control characters in a Vim script for a ":normal" | |
| 13203 command: > | |
| 13204 :execute "normal ixxx\<Esc>" | |
| 13205 < This has an <Esc> character, see |expr-string|. | |
| 13206 | |
| 1621 | 13207 Be careful to correctly escape special characters in |
| 13208 file names. The |fnameescape()| function can be used | |
| 1661 | 13209 for Vim commands, |shellescape()| for |:!| commands. |
| 13210 Examples: > | |
| 24103 | 13211 :execute "e " .. fnameescape(filename) |
| 13212 :execute "!ls " .. shellescape(filename, 1) | |
| 1621 | 13213 < |
| 7 | 13214 Note: The executed string may be any command-line, but |
| 5763 | 13215 starting or ending "if", "while" and "for" does not |
| 13216 always work, because when commands are skipped the | |
| 13217 ":execute" is not evaluated and Vim loses track of | |
| 13218 where blocks start and end. Also "break" and | |
| 13219 "continue" should not be inside ":execute". | |
| 13220 This example does not work, because the ":execute" is | |
| 13221 not evaluated and Vim does not see the "while", and | |
| 13222 gives an error for finding an ":endwhile": > | |
| 13223 :if 0 | |
| 13224 : execute 'while i > 5' | |
| 13225 : echo "test" | |
| 13226 : endwhile | |
| 13227 :endif | |
| 7 | 13228 < |
| 13229 It is allowed to have a "while" or "if" command | |
| 13230 completely in the executed string: > | |
| 13231 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' | |
| 13232 < | |
| 13233 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
13234 *:exe-comment* |
| 7 | 13235 ":execute", ":echo" and ":echon" cannot be followed by |
| 13236 a comment directly, because they see the '"' as the | |
| 13237 start of a string. But, you can use '|' followed by a | |
| 13238 comment. Example: > | |
| 13239 :echo "foo" | "this is a comment | |
| 13240 | |
| 13241 ============================================================================== | |
| 13242 8. Exception handling *exception-handling* | |
| 13243 | |
| 13244 The Vim script language comprises an exception handling feature. This section | |
| 13245 explains how it can be used in a Vim script. | |
| 13246 | |
| 13247 Exceptions may be raised by Vim on an error or on interrupt, see | |
| 13248 |catch-errors| and |catch-interrupt|. You can also explicitly throw an | |
| 13249 exception by using the ":throw" command, see |throw-catch|. | |
| 13250 | |
| 13251 | |
| 13252 TRY CONDITIONALS *try-conditionals* | |
| 13253 | |
| 13254 Exceptions can be caught or can cause cleanup code to be executed. You can | |
| 13255 use a try conditional to specify catch clauses (that catch exceptions) and/or | |
| 13256 a finally clause (to be executed for cleanup). | |
| 13257 A try conditional begins with a |:try| command and ends at the matching | |
| 13258 |:endtry| command. In between, you can use a |:catch| command to start | |
| 13259 a catch clause, or a |:finally| command to start a finally clause. There may | |
| 13260 be none or multiple catch clauses, but there is at most one finally clause, | |
| 13261 which must not be followed by any catch clauses. The lines before the catch | |
| 13262 clauses and the finally clause is called a try block. > | |
| 13263 | |
| 13264 :try | |
| 1621 | 13265 : ... |
| 13266 : ... TRY BLOCK | |
| 13267 : ... | |
| 7 | 13268 :catch /{pattern}/ |
| 1621 | 13269 : ... |
| 13270 : ... CATCH CLAUSE | |
| 13271 : ... | |
| 7 | 13272 :catch /{pattern}/ |
| 1621 | 13273 : ... |
| 13274 : ... CATCH CLAUSE | |
| 13275 : ... | |
| 7 | 13276 :finally |
| 1621 | 13277 : ... |
| 13278 : ... FINALLY CLAUSE | |
| 13279 : ... | |
| 7 | 13280 :endtry |
| 13281 | |
| 13282 The try conditional allows to watch code for exceptions and to take the | |
| 13283 appropriate actions. Exceptions from the try block may be caught. Exceptions | |
| 13284 from the try block and also the catch clauses may cause cleanup actions. | |
| 13285 When no exception is thrown during execution of the try block, the control | |
| 13286 is transferred to the finally clause, if present. After its execution, the | |
| 13287 script continues with the line following the ":endtry". | |
| 13288 When an exception occurs during execution of the try block, the remaining | |
| 13289 lines in the try block are skipped. The exception is matched against the | |
| 13290 patterns specified as arguments to the ":catch" commands. The catch clause | |
| 13291 after the first matching ":catch" is taken, other catch clauses are not | |
| 13292 executed. The catch clause ends when the next ":catch", ":finally", or | |
| 13293 ":endtry" command is reached - whatever is first. Then, the finally clause | |
| 13294 (if present) is executed. When the ":endtry" is reached, the script execution | |
| 13295 continues in the following line as usual. | |
| 13296 When an exception that does not match any of the patterns specified by the | |
| 13297 ":catch" commands is thrown in the try block, the exception is not caught by | |
| 13298 that try conditional and none of the catch clauses is executed. Only the | |
| 13299 finally clause, if present, is taken. The exception pends during execution of | |
| 13300 the finally clause. It is resumed at the ":endtry", so that commands after | |
| 13301 the ":endtry" are not executed and the exception might be caught elsewhere, | |
| 13302 see |try-nesting|. | |
| 13303 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
|
13304 remaining lines in that catch clause are not executed. The new exception is |
| 7 | 13305 not matched against the patterns in any of the ":catch" commands of the same |
| 13306 try conditional and none of its catch clauses is taken. If there is, however, | |
| 13307 a finally clause, it is executed, and the exception pends during its | |
| 13308 execution. The commands following the ":endtry" are not executed. The new | |
| 13309 exception might, however, be caught elsewhere, see |try-nesting|. | |
| 13310 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
|
13311 thrown, the remaining lines in the finally clause are skipped. If the finally |
| 7 | 13312 clause has been taken because of an exception from the try block or one of the |
| 13313 catch clauses, the original (pending) exception is discarded. The commands | |
| 13314 following the ":endtry" are not executed, and the exception from the finally | |
| 13315 clause is propagated and can be caught elsewhere, see |try-nesting|. | |
| 13316 | |
| 13317 The finally clause is also executed, when a ":break" or ":continue" for | |
| 13318 a ":while" loop enclosing the complete try conditional is executed from the | |
| 13319 try block or a catch clause. Or when a ":return" or ":finish" is executed | |
| 13320 from the try block or a catch clause of a try conditional in a function or | |
| 13321 sourced script, respectively. The ":break", ":continue", ":return", or | |
| 13322 ":finish" pends during execution of the finally clause and is resumed when the | |
| 13323 ":endtry" is reached. It is, however, discarded when an exception is thrown | |
| 13324 from the finally clause. | |
| 13325 When a ":break" or ":continue" for a ":while" loop enclosing the complete | |
| 13326 try conditional or when a ":return" or ":finish" is encountered in the finally | |
| 13327 clause, the rest of the finally clause is skipped, and the ":break", | |
| 13328 ":continue", ":return" or ":finish" is executed as usual. If the finally | |
| 13329 clause has been taken because of an exception or an earlier ":break", | |
| 13330 ":continue", ":return", or ":finish" from the try block or a catch clause, | |
| 13331 this pending exception or command is discarded. | |
| 13332 | |
| 13333 For examples see |throw-catch| and |try-finally|. | |
| 13334 | |
| 13335 | |
| 13336 NESTING OF TRY CONDITIONALS *try-nesting* | |
| 13337 | |
| 13338 Try conditionals can be nested arbitrarily. That is, a complete try | |
| 13339 conditional can be put into the try block, a catch clause, or the finally | |
| 13340 clause of another try conditional. If the inner try conditional does not | |
| 13341 catch an exception thrown in its try block or throws a new exception from one | |
| 13342 of its catch clauses or its finally clause, the outer try conditional is | |
| 13343 checked according to the rules above. If the inner try conditional is in the | |
| 13344 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
|
13345 otherwise only the finally clause is executed. It does not matter for |
| 7 | 13346 nesting, whether the inner try conditional is directly contained in the outer |
| 13347 one, or whether the outer one sources a script or calls a function containing | |
| 13348 the inner try conditional. | |
| 13349 | |
| 13350 When none of the active try conditionals catches an exception, just their | |
| 13351 finally clauses are executed. Thereafter, the script processing terminates. | |
| 13352 An error message is displayed in case of an uncaught exception explicitly | |
| 13353 thrown by a ":throw" command. For uncaught error and interrupt exceptions | |
| 13354 implicitly raised by Vim, the error message(s) or interrupt message are shown | |
| 13355 as usual. | |
| 13356 | |
| 13357 For examples see |throw-catch|. | |
| 13358 | |
| 13359 | |
| 13360 EXAMINING EXCEPTION HANDLING CODE *except-examine* | |
| 13361 | |
| 13362 Exception handling code can get tricky. If you are in doubt what happens, set | |
| 13363 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your | |
| 13364 script file. Then you see when an exception is thrown, discarded, caught, or | |
| 13365 finished. When using a verbosity level of at least 14, things pending in | |
| 13366 a finally clause are also shown. This information is also given in debug mode | |
| 13367 (see |debug-scripts|). | |
| 13368 | |
| 13369 | |
| 13370 THROWING AND CATCHING EXCEPTIONS *throw-catch* | |
| 13371 | |
| 13372 You can throw any number or string as an exception. Use the |:throw| command | |
| 13373 and pass the value to be thrown as argument: > | |
| 13374 :throw 4711 | |
| 13375 :throw "string" | |
| 13376 < *throw-expression* | |
| 13377 You can also specify an expression argument. The expression is then evaluated | |
| 13378 first, and the result is thrown: > | |
| 13379 :throw 4705 + strlen("string") | |
| 13380 :throw strpart("strings", 0, 6) | |
| 13381 | |
| 13382 An exception might be thrown during evaluation of the argument of the ":throw" | |
| 13383 command. Unless it is caught there, the expression evaluation is abandoned. | |
| 13384 The ":throw" command then does not throw a new exception. | |
| 13385 Example: > | |
| 13386 | |
| 13387 :function! Foo(arg) | |
| 13388 : try | |
| 13389 : throw a:arg | |
| 13390 : catch /foo/ | |
| 13391 : endtry | |
| 13392 : return 1 | |
| 13393 :endfunction | |
| 13394 : | |
| 13395 :function! Bar() | |
| 13396 : echo "in Bar" | |
| 13397 : return 4710 | |
| 13398 :endfunction | |
| 13399 : | |
| 13400 :throw Foo("arrgh") + Bar() | |
| 13401 | |
| 13402 This throws "arrgh", and "in Bar" is not displayed since Bar() is not | |
| 13403 executed. > | |
| 13404 :throw Foo("foo") + Bar() | |
| 13405 however displays "in Bar" and throws 4711. | |
| 13406 | |
| 13407 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
|
13408 abandoned by an (uncaught) exception during the expression evaluation. The |
| 7 | 13409 exception is then propagated to the caller of the command. |
| 13410 Example: > | |
| 13411 | |
| 13412 :if Foo("arrgh") | |
| 13413 : echo "then" | |
| 13414 :else | |
| 13415 : echo "else" | |
| 13416 :endif | |
| 13417 | |
| 13418 Here neither of "then" or "else" is displayed. | |
| 13419 | |
| 13420 *catch-order* | |
| 13421 Exceptions can be caught by a try conditional with one or more |:catch| | |
| 13422 commands, see |try-conditionals|. The values to be caught by each ":catch" | |
| 13423 command can be specified as a pattern argument. The subsequent catch clause | |
| 13424 gets executed when a matching exception is caught. | |
| 13425 Example: > | |
| 13426 | |
| 13427 :function! Foo(value) | |
| 13428 : try | |
| 13429 : throw a:value | |
| 13430 : catch /^\d\+$/ | |
| 13431 : echo "Number thrown" | |
| 13432 : catch /.*/ | |
| 13433 : echo "String thrown" | |
| 13434 : endtry | |
| 13435 :endfunction | |
| 13436 : | |
| 13437 :call Foo(0x1267) | |
| 13438 :call Foo('string') | |
| 13439 | |
| 13440 The first call to Foo() displays "Number thrown", the second "String thrown". | |
| 13441 An exception is matched against the ":catch" commands in the order they are | |
| 13442 specified. Only the first match counts. So you should place the more | |
| 13443 specific ":catch" first. The following order does not make sense: > | |
| 13444 | |
| 13445 : catch /.*/ | |
| 13446 : echo "String thrown" | |
| 13447 : catch /^\d\+$/ | |
| 13448 : echo "Number thrown" | |
| 13449 | |
| 13450 The first ":catch" here matches always, so that the second catch clause is | |
| 13451 never taken. | |
| 13452 | |
| 13453 *throw-variables* | |
| 13454 If you catch an exception by a general pattern, you may access the exact value | |
| 13455 in the variable |v:exception|: > | |
| 13456 | |
| 13457 : catch /^\d\+$/ | |
| 13458 : echo "Number thrown. Value is" v:exception | |
| 13459 | |
| 13460 You may also be interested where an exception was thrown. This is stored in | |
| 13461 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the | |
| 13462 exception most recently caught as long it is not finished. | |
| 13463 Example: > | |
| 13464 | |
| 13465 :function! Caught() | |
| 13466 : if v:exception != "" | |
| 13467 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint | |
| 13468 : else | |
| 13469 : echo 'Nothing caught' | |
| 13470 : endif | |
| 13471 :endfunction | |
| 13472 : | |
| 13473 :function! Foo() | |
| 13474 : try | |
| 13475 : try | |
| 13476 : try | |
| 13477 : throw 4711 | |
| 13478 : finally | |
| 13479 : call Caught() | |
| 13480 : endtry | |
| 13481 : catch /.*/ | |
| 13482 : call Caught() | |
| 13483 : throw "oops" | |
| 13484 : endtry | |
| 13485 : catch /.*/ | |
| 13486 : call Caught() | |
| 13487 : finally | |
| 13488 : call Caught() | |
| 13489 : endtry | |
| 13490 :endfunction | |
| 13491 : | |
| 13492 :call Foo() | |
| 13493 | |
| 13494 This displays > | |
| 13495 | |
| 13496 Nothing caught | |
| 13497 Caught "4711" in function Foo, line 4 | |
| 13498 Caught "oops" in function Foo, line 10 | |
| 13499 Nothing caught | |
| 13500 | |
| 13501 A practical example: The following command ":LineNumber" displays the line | |
| 13502 number in the script or function where it has been used: > | |
| 13503 | |
| 13504 :function! LineNumber() | |
| 13505 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") | |
| 13506 :endfunction | |
| 13507 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry | |
| 13508 < | |
| 13509 *try-nested* | |
| 13510 An exception that is not caught by a try conditional can be caught by | |
| 13511 a surrounding try conditional: > | |
| 13512 | |
| 13513 :try | |
| 13514 : try | |
| 13515 : throw "foo" | |
| 13516 : catch /foobar/ | |
| 13517 : echo "foobar" | |
| 13518 : finally | |
| 13519 : echo "inner finally" | |
| 13520 : endtry | |
| 13521 :catch /foo/ | |
| 13522 : echo "foo" | |
| 13523 :endtry | |
| 13524 | |
| 13525 The inner try conditional does not catch the exception, just its finally | |
| 13526 clause is executed. The exception is then caught by the outer try | |
| 13527 conditional. The example displays "inner finally" and then "foo". | |
| 13528 | |
| 13529 *throw-from-catch* | |
| 13530 You can catch an exception and throw a new one to be caught elsewhere from the | |
| 13531 catch clause: > | |
| 13532 | |
| 13533 :function! Foo() | |
| 13534 : throw "foo" | |
| 13535 :endfunction | |
| 13536 : | |
| 13537 :function! Bar() | |
| 13538 : try | |
| 13539 : call Foo() | |
| 13540 : catch /foo/ | |
| 13541 : echo "Caught foo, throw bar" | |
| 13542 : throw "bar" | |
| 13543 : endtry | |
| 13544 :endfunction | |
| 13545 : | |
| 13546 :try | |
| 13547 : call Bar() | |
| 13548 :catch /.*/ | |
| 13549 : echo "Caught" v:exception | |
| 13550 :endtry | |
| 13551 | |
| 13552 This displays "Caught foo, throw bar" and then "Caught bar". | |
| 13553 | |
| 13554 *rethrow* | |
| 13555 There is no real rethrow in the Vim script language, but you may throw | |
| 13556 "v:exception" instead: > | |
| 13557 | |
| 13558 :function! Bar() | |
| 13559 : try | |
| 13560 : call Foo() | |
| 13561 : catch /.*/ | |
| 13562 : echo "Rethrow" v:exception | |
| 13563 : throw v:exception | |
| 13564 : endtry | |
| 13565 :endfunction | |
| 13566 < *try-echoerr* | |
| 13567 Note that this method cannot be used to "rethrow" Vim error or interrupt | |
| 13568 exceptions, because it is not possible to fake Vim internal exceptions. | |
| 13569 Trying so causes an error exception. You should throw your own exception | |
| 13570 denoting the situation. If you want to cause a Vim error exception containing | |
| 13571 the original error exception value, you can use the |:echoerr| command: > | |
| 13572 | |
| 13573 :try | |
| 13574 : try | |
| 13575 : asdf | |
| 13576 : catch /.*/ | |
| 13577 : echoerr v:exception | |
| 13578 : endtry | |
| 13579 :catch /.*/ | |
| 13580 : echo v:exception | |
| 13581 :endtry | |
| 13582 | |
| 13583 This code displays | |
| 13584 | |
| 1621 | 13585 Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
| 7 | 13586 |
| 13587 | |
| 13588 CLEANUP CODE *try-finally* | |
| 13589 | |
| 13590 Scripts often change global settings and restore them at their end. If the | |
| 13591 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
|
13592 an inconsistent state. The same may happen to you in the development phase of |
| 7 | 13593 a script when an error occurs or you explicitly throw an exception without |
| 13594 catching it. You can solve these problems by using a try conditional with | |
| 13595 a finally clause for restoring the settings. Its execution is guaranteed on | |
| 13596 normal control flow, on error, on an explicit ":throw", and on interrupt. | |
| 13597 (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
|
13598 to exceptions. When not caught, they terminate the script after the finally |
| 7 | 13599 clause has been executed.) |
| 13600 Example: > | |
| 13601 | |
| 13602 :try | |
| 13603 : let s:saved_ts = &ts | |
| 13604 : set ts=17 | |
| 13605 : | |
| 13606 : " Do the hard work here. | |
| 13607 : | |
| 13608 :finally | |
| 13609 : let &ts = s:saved_ts | |
| 13610 : unlet s:saved_ts | |
| 13611 :endtry | |
| 13612 | |
| 13613 This method should be used locally whenever a function or part of a script | |
| 13614 changes global settings which need to be restored on failure or normal exit of | |
| 13615 that function or script part. | |
| 13616 | |
| 13617 *break-finally* | |
| 13618 Cleanup code works also when the try block or a catch clause is left by | |
| 13619 a ":continue", ":break", ":return", or ":finish". | |
| 13620 Example: > | |
| 13621 | |
| 13622 :let first = 1 | |
| 13623 :while 1 | |
| 13624 : try | |
| 13625 : if first | |
| 13626 : echo "first" | |
| 13627 : let first = 0 | |
| 13628 : continue | |
| 13629 : else | |
| 13630 : throw "second" | |
| 13631 : endif | |
| 13632 : catch /.*/ | |
| 13633 : echo v:exception | |
| 13634 : break | |
| 13635 : finally | |
| 13636 : echo "cleanup" | |
| 13637 : endtry | |
| 13638 : echo "still in while" | |
| 13639 :endwhile | |
| 13640 :echo "end" | |
| 13641 | |
| 13642 This displays "first", "cleanup", "second", "cleanup", and "end". > | |
| 13643 | |
| 13644 :function! Foo() | |
| 13645 : try | |
| 13646 : return 4711 | |
| 13647 : finally | |
| 13648 : echo "cleanup\n" | |
| 13649 : endtry | |
| 13650 : echo "Foo still active" | |
| 13651 :endfunction | |
| 13652 : | |
| 13653 :echo Foo() "returned by Foo" | |
| 13654 | |
| 13655 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
|
13656 extra ":return" in the finally clause. (Above all, this would override the |
| 7 | 13657 return value.) |
| 13658 | |
| 13659 *except-from-finally* | |
| 13660 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in | |
| 13661 a finally clause is possible, but not recommended since it abandons the | |
| 13662 cleanup actions for the try conditional. But, of course, interrupt and error | |
| 13663 exceptions might get raised from a finally clause. | |
| 13664 Example where an error in the finally clause stops an interrupt from | |
| 13665 working correctly: > | |
| 13666 | |
| 13667 :try | |
| 13668 : try | |
| 13669 : echo "Press CTRL-C for interrupt" | |
| 13670 : while 1 | |
| 13671 : endwhile | |
| 13672 : finally | |
| 13673 : unlet novar | |
| 13674 : endtry | |
| 13675 :catch /novar/ | |
| 13676 :endtry | |
| 13677 :echo "Script still running" | |
| 13678 :sleep 1 | |
| 13679 | |
| 13680 If you need to put commands that could fail into a finally clause, you should | |
| 13681 think about catching or ignoring the errors in these commands, see | |
| 13682 |catch-errors| and |ignore-errors|. | |
| 13683 | |
| 13684 | |
| 13685 CATCHING ERRORS *catch-errors* | |
| 13686 | |
| 13687 If you want to catch specific errors, you just have to put the code to be | |
| 13688 watched in a try block and add a catch clause for the error message. The | |
| 13689 presence of the try conditional causes all errors to be converted to an | |
| 13690 exception. No message is displayed and |v:errmsg| is not set then. To find | |
| 13691 the right pattern for the ":catch" command, you have to know how the format of | |
| 13692 the error exception is. | |
| 13693 Error exceptions have the following format: > | |
| 13694 | |
| 13695 Vim({cmdname}):{errmsg} | |
| 13696 or > | |
| 13697 Vim:{errmsg} | |
| 13698 | |
| 13699 {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
|
13700 the command name is not known. {errmsg} is the error message usually produced |
| 7 | 13701 when the error occurs outside try conditionals. It always begins with |
| 13702 a capital "E", followed by a two or three-digit error number, a colon, and | |
| 13703 a space. | |
| 13704 | |
| 13705 Examples: | |
| 13706 | |
| 13707 The command > | |
| 13708 :unlet novar | |
| 13709 normally produces the error message > | |
| 13710 E108: No such variable: "novar" | |
| 13711 which is converted inside try conditionals to an exception > | |
| 13712 Vim(unlet):E108: No such variable: "novar" | |
| 13713 | |
| 13714 The command > | |
| 13715 :dwim | |
| 13716 normally produces the error message > | |
| 13717 E492: Not an editor command: dwim | |
| 13718 which is converted inside try conditionals to an exception > | |
| 13719 Vim:E492: Not an editor command: dwim | |
| 13720 | |
| 13721 You can catch all ":unlet" errors by a > | |
| 13722 :catch /^Vim(unlet):/ | |
| 13723 or all errors for misspelled command names by a > | |
| 13724 :catch /^Vim:E492:/ | |
| 13725 | |
| 13726 Some error messages may be produced by different commands: > | |
| 13727 :function nofunc | |
| 13728 and > | |
| 13729 :delfunction nofunc | |
| 13730 both produce the error message > | |
| 13731 E128: Function name must start with a capital: nofunc | |
| 13732 which is converted inside try conditionals to an exception > | |
| 13733 Vim(function):E128: Function name must start with a capital: nofunc | |
| 13734 or > | |
| 13735 Vim(delfunction):E128: Function name must start with a capital: nofunc | |
| 13736 respectively. You can catch the error by its number independently on the | |
| 13737 command that caused it if you use the following pattern: > | |
| 13738 :catch /^Vim(\a\+):E128:/ | |
| 13739 | |
| 13740 Some commands like > | |
| 13741 :let x = novar | |
| 13742 produce multiple error messages, here: > | |
| 13743 E121: Undefined variable: novar | |
| 13744 E15: Invalid expression: novar | |
| 13745 Only the first is used for the exception value, since it is the most specific | |
| 13746 one (see |except-several-errors|). So you can catch it by > | |
| 13747 :catch /^Vim(\a\+):E121:/ | |
| 13748 | |
| 13749 You can catch all errors related to the name "nofunc" by > | |
| 13750 :catch /\<nofunc\>/ | |
| 13751 | |
| 13752 You can catch all Vim errors in the ":write" and ":read" commands by > | |
| 13753 :catch /^Vim(\(write\|read\)):E\d\+:/ | |
| 13754 | |
| 13755 You can catch all Vim errors by the pattern > | |
| 13756 :catch /^Vim\((\a\+)\)\=:E\d\+:/ | |
| 13757 < | |
| 13758 *catch-text* | |
| 13759 NOTE: You should never catch the error message text itself: > | |
| 13760 :catch /No such variable/ | |
| 6647 | 13761 only works in the English locale, but not when the user has selected |
| 7 | 13762 a different language by the |:language| command. It is however helpful to |
| 13763 cite the message text in a comment: > | |
| 13764 :catch /^Vim(\a\+):E108:/ " No such variable | |
| 13765 | |
| 13766 | |
| 13767 IGNORING ERRORS *ignore-errors* | |
| 13768 | |
| 13769 You can ignore errors in a specific Vim command by catching them locally: > | |
| 13770 | |
| 13771 :try | |
| 13772 : write | |
| 13773 :catch | |
| 13774 :endtry | |
| 13775 | |
| 13776 But you are strongly recommended NOT to use this simple form, since it could | |
| 13777 catch more than you want. With the ":write" command, some autocommands could | |
| 13778 be executed and cause errors not related to writing, for instance: > | |
| 13779 | |
| 13780 :au BufWritePre * unlet novar | |
| 13781 | |
| 13782 There could even be such errors you are not responsible for as a script | |
| 13783 writer: a user of your script might have defined such autocommands. You would | |
| 13784 then hide the error from the user. | |
| 13785 It is much better to use > | |
| 13786 | |
| 13787 :try | |
| 13788 : write | |
| 13789 :catch /^Vim(write):/ | |
| 13790 :endtry | |
| 13791 | |
| 13792 which only catches real write errors. So catch only what you'd like to ignore | |
| 13793 intentionally. | |
| 13794 | |
| 13795 For a single command that does not cause execution of autocommands, you could | |
| 13796 even suppress the conversion of errors to exceptions by the ":silent!" | |
| 13797 command: > | |
| 13798 :silent! nunmap k | |
| 13799 This works also when a try conditional is active. | |
| 13800 | |
| 13801 | |
| 13802 CATCHING INTERRUPTS *catch-interrupt* | |
| 13803 | |
| 13804 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
|
13805 the exception "Vim:Interrupt". You can catch it like every exception. The |
| 7 | 13806 script is not terminated, then. |
| 13807 Example: > | |
| 13808 | |
| 13809 :function! TASK1() | |
| 13810 : sleep 10 | |
| 13811 :endfunction | |
| 13812 | |
| 13813 :function! TASK2() | |
| 13814 : sleep 20 | |
| 13815 :endfunction | |
| 13816 | |
| 13817 :while 1 | |
| 13818 : let command = input("Type a command: ") | |
| 13819 : try | |
| 13820 : if command == "" | |
| 13821 : continue | |
| 13822 : elseif command == "END" | |
| 13823 : break | |
| 13824 : elseif command == "TASK1" | |
| 13825 : call TASK1() | |
| 13826 : elseif command == "TASK2" | |
| 13827 : call TASK2() | |
| 13828 : else | |
| 13829 : echo "\nIllegal command:" command | |
| 13830 : continue | |
| 13831 : endif | |
| 13832 : catch /^Vim:Interrupt$/ | |
| 13833 : echo "\nCommand interrupted" | |
| 13834 : " Caught the interrupt. Continue with next prompt. | |
| 13835 : endtry | |
| 13836 :endwhile | |
| 13837 | |
| 13838 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
|
13839 a new command. If you press CTRL-C at the prompt, the script is terminated. |
| 7 | 13840 |
| 13841 For testing what happens when CTRL-C would be pressed on a specific line in | |
| 13842 your script, use the debug mode and execute the |>quit| or |>interrupt| | |
| 13843 command on that line. See |debug-scripts|. | |
| 13844 | |
| 13845 | |
| 13846 CATCHING ALL *catch-all* | |
| 13847 | |
| 13848 The commands > | |
| 13849 | |
| 13850 :catch /.*/ | |
| 13851 :catch // | |
| 13852 :catch | |
| 13853 | |
| 13854 catch everything, error exceptions, interrupt exceptions and exceptions | |
| 13855 explicitly thrown by the |:throw| command. This is useful at the top level of | |
| 13856 a script in order to catch unexpected things. | |
| 13857 Example: > | |
| 13858 | |
| 13859 :try | |
| 13860 : | |
| 13861 : " do the hard work here | |
| 13862 : | |
| 13863 :catch /MyException/ | |
| 13864 : | |
| 13865 : " handle known problem | |
| 13866 : | |
| 13867 :catch /^Vim:Interrupt$/ | |
| 13868 : echo "Script interrupted" | |
| 13869 :catch /.*/ | |
| 13870 : echo "Internal error (" . v:exception . ")" | |
| 13871 : echo " - occurred at " . v:throwpoint | |
| 13872 :endtry | |
| 13873 :" end of script | |
| 13874 | |
| 13875 Note: Catching all might catch more things than you want. Thus, you are | |
| 13876 strongly encouraged to catch only for problems that you can really handle by | |
| 13877 specifying a pattern argument to the ":catch". | |
| 13878 Example: Catching all could make it nearly impossible to interrupt a script | |
| 13879 by pressing CTRL-C: > | |
| 13880 | |
| 13881 :while 1 | |
| 13882 : try | |
| 13883 : sleep 1 | |
| 13884 : catch | |
| 13885 : endtry | |
| 13886 :endwhile | |
| 13887 | |
| 13888 | |
| 13889 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* | |
| 13890 | |
| 13891 Exceptions may be used during execution of autocommands. Example: > | |
| 13892 | |
| 13893 :autocmd User x try | |
| 13894 :autocmd User x throw "Oops!" | |
| 13895 :autocmd User x catch | |
| 13896 :autocmd User x echo v:exception | |
| 13897 :autocmd User x endtry | |
| 13898 :autocmd User x throw "Arrgh!" | |
| 13899 :autocmd User x echo "Should not be displayed" | |
| 13900 : | |
| 13901 :try | |
| 13902 : doautocmd User x | |
| 13903 :catch | |
| 13904 : echo v:exception | |
| 13905 :endtry | |
| 13906 | |
| 13907 This displays "Oops!" and "Arrgh!". | |
| 13908 | |
| 13909 *except-autocmd-Pre* | |
| 13910 For some commands, autocommands get executed before the main action of the | |
| 13911 command takes place. If an exception is thrown and not caught in the sequence | |
| 13912 of autocommands, the sequence and the command that caused its execution are | |
| 13913 abandoned and the exception is propagated to the caller of the command. | |
| 13914 Example: > | |
| 13915 | |
| 13916 :autocmd BufWritePre * throw "FAIL" | |
| 13917 :autocmd BufWritePre * echo "Should not be displayed" | |
| 13918 : | |
| 13919 :try | |
| 13920 : write | |
| 13921 :catch | |
| 13922 : echo "Caught:" v:exception "from" v:throwpoint | |
| 13923 :endtry | |
| 13924 | |
| 13925 Here, the ":write" command does not write the file currently being edited (as | |
| 13926 you can see by checking 'modified'), since the exception from the BufWritePre | |
| 13927 autocommand abandons the ":write". The exception is then caught and the | |
| 13928 script displays: > | |
| 13929 | |
| 13930 Caught: FAIL from BufWrite Auto commands for "*" | |
| 13931 < | |
| 13932 *except-autocmd-Post* | |
| 13933 For some commands, autocommands get executed after the main action of the | |
| 13934 command has taken place. If this main action fails and the command is inside | |
| 13935 an active try conditional, the autocommands are skipped and an error exception | |
| 13936 is thrown that can be caught by the caller of the command. | |
| 13937 Example: > | |
| 13938 | |
| 13939 :autocmd BufWritePost * echo "File successfully written!" | |
| 13940 : | |
| 13941 :try | |
| 13942 : write /i/m/p/o/s/s/i/b/l/e | |
| 13943 :catch | |
| 13944 : echo v:exception | |
| 13945 :endtry | |
| 13946 | |
| 13947 This just displays: > | |
| 13948 | |
| 13949 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) | |
| 13950 | |
| 13951 If you really need to execute the autocommands even when the main action | |
| 13952 fails, trigger the event from the catch clause. | |
| 13953 Example: > | |
| 13954 | |
| 13955 :autocmd BufWritePre * set noreadonly | |
| 13956 :autocmd BufWritePost * set readonly | |
| 13957 : | |
| 13958 :try | |
| 13959 : write /i/m/p/o/s/s/i/b/l/e | |
| 13960 :catch | |
| 13961 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e | |
| 13962 :endtry | |
| 13963 < | |
| 13964 You can also use ":silent!": > | |
| 13965 | |
| 13966 :let x = "ok" | |
| 13967 :let v:errmsg = "" | |
| 13968 :autocmd BufWritePost * if v:errmsg != "" | |
| 13969 :autocmd BufWritePost * let x = "after fail" | |
| 13970 :autocmd BufWritePost * endif | |
| 13971 :try | |
| 13972 : silent! write /i/m/p/o/s/s/i/b/l/e | |
| 13973 :catch | |
| 13974 :endtry | |
| 13975 :echo x | |
| 13976 | |
| 13977 This displays "after fail". | |
| 13978 | |
| 13979 If the main action of the command does not fail, exceptions from the | |
| 13980 autocommands will be catchable by the caller of the command: > | |
| 13981 | |
| 13982 :autocmd BufWritePost * throw ":-(" | |
| 13983 :autocmd BufWritePost * echo "Should not be displayed" | |
| 13984 : | |
| 13985 :try | |
| 13986 : write | |
| 13987 :catch | |
| 13988 : echo v:exception | |
| 13989 :endtry | |
| 13990 < | |
| 13991 *except-autocmd-Cmd* | |
| 13992 For some commands, the normal action can be replaced by a sequence of | |
| 13993 autocommands. Exceptions from that sequence will be catchable by the caller | |
| 13994 of the command. | |
| 13995 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
|
13996 had actually been written when the exception occurred. You need to tell it in |
| 7 | 13997 some way. > |
| 13998 | |
| 13999 :if !exists("cnt") | |
| 14000 : let cnt = 0 | |
| 14001 : | |
| 14002 : autocmd BufWriteCmd * if &modified | |
| 14003 : autocmd BufWriteCmd * let cnt = cnt + 1 | |
| 14004 : autocmd BufWriteCmd * if cnt % 3 == 2 | |
| 14005 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 14006 : autocmd BufWriteCmd * endif | |
| 14007 : autocmd BufWriteCmd * write | set nomodified | |
| 14008 : autocmd BufWriteCmd * if cnt % 3 == 0 | |
| 14009 : autocmd BufWriteCmd * throw "BufWriteCmdError" | |
| 14010 : autocmd BufWriteCmd * endif | |
| 14011 : autocmd BufWriteCmd * echo "File successfully written!" | |
| 14012 : autocmd BufWriteCmd * endif | |
| 14013 :endif | |
| 14014 : | |
| 14015 :try | |
| 14016 : write | |
| 14017 :catch /^BufWriteCmdError$/ | |
| 14018 : if &modified | |
| 14019 : echo "Error on writing (file contents not changed)" | |
| 14020 : else | |
| 14021 : echo "Error after writing" | |
| 14022 : endif | |
| 14023 :catch /^Vim(write):/ | |
| 14024 : echo "Error on writing" | |
| 14025 :endtry | |
| 14026 | |
| 14027 When this script is sourced several times after making changes, it displays | |
| 14028 first > | |
| 14029 File successfully written! | |
| 14030 then > | |
| 14031 Error on writing (file contents not changed) | |
| 14032 then > | |
| 14033 Error after writing | |
| 14034 etc. | |
| 14035 | |
| 14036 *except-autocmd-ill* | |
| 14037 You cannot spread a try conditional over autocommands for different events. | |
| 14038 The following code is ill-formed: > | |
| 14039 | |
| 14040 :autocmd BufWritePre * try | |
| 14041 : | |
| 14042 :autocmd BufWritePost * catch | |
| 14043 :autocmd BufWritePost * echo v:exception | |
| 14044 :autocmd BufWritePost * endtry | |
| 14045 : | |
| 14046 :write | |
| 14047 | |
| 14048 | |
| 14049 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* | |
| 14050 | |
| 14051 Some programming languages allow to use hierarchies of exception classes or to | |
| 14052 pass additional information with the object of an exception class. You can do | |
| 14053 similar things in Vim. | |
| 14054 In order to throw an exception from a hierarchy, just throw the complete | |
| 14055 class name with the components separated by a colon, for instance throw the | |
| 14056 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. | |
| 14057 When you want to pass additional information with your exception class, add | |
| 14058 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" | |
| 14059 for an error when writing "myfile". | |
| 14060 With the appropriate patterns in the ":catch" command, you can catch for | |
| 14061 base classes or derived classes of your hierarchy. Additional information in | |
| 14062 parentheses can be cut out from |v:exception| with the ":substitute" command. | |
| 14063 Example: > | |
| 14064 | |
| 14065 :function! CheckRange(a, func) | |
| 14066 : if a:a < 0 | |
| 14067 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")" | |
| 14068 : endif | |
| 14069 :endfunction | |
| 14070 : | |
| 14071 :function! Add(a, b) | |
| 14072 : call CheckRange(a:a, "Add") | |
| 14073 : call CheckRange(a:b, "Add") | |
| 14074 : let c = a:a + a:b | |
| 14075 : if c < 0 | |
| 14076 : throw "EXCEPT:MATHERR:OVERFLOW" | |
| 14077 : endif | |
| 14078 : return c | |
| 14079 :endfunction | |
| 14080 : | |
| 14081 :function! Div(a, b) | |
| 14082 : call CheckRange(a:a, "Div") | |
| 14083 : call CheckRange(a:b, "Div") | |
| 14084 : if (a:b == 0) | |
| 14085 : throw "EXCEPT:MATHERR:ZERODIV" | |
| 14086 : endif | |
| 14087 : return a:a / a:b | |
| 14088 :endfunction | |
| 14089 : | |
| 14090 :function! Write(file) | |
| 14091 : try | |
| 1621 | 14092 : execute "write" fnameescape(a:file) |
| 7 | 14093 : catch /^Vim(write):/ |
| 14094 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR" | |
| 14095 : endtry | |
| 14096 :endfunction | |
| 14097 : | |
| 14098 :try | |
| 14099 : | |
| 14100 : " something with arithmetics and I/O | |
| 14101 : | |
| 14102 :catch /^EXCEPT:MATHERR:RANGE/ | |
| 14103 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") | |
| 14104 : echo "Range error in" function | |
| 14105 : | |
| 14106 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV | |
| 14107 : echo "Math error" | |
| 14108 : | |
| 14109 :catch /^EXCEPT:IO/ | |
| 14110 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") | |
| 14111 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") | |
| 14112 : if file !~ '^/' | |
| 14113 : let file = dir . "/" . file | |
| 14114 : endif | |
| 14115 : echo 'I/O error for "' . file . '"' | |
| 14116 : | |
| 14117 :catch /^EXCEPT/ | |
| 14118 : echo "Unspecified error" | |
| 14119 : | |
| 14120 :endtry | |
| 14121 | |
| 14122 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use | |
| 14123 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself | |
| 14124 exceptions with the "Vim" prefix; they are reserved for Vim. | |
| 14125 Vim error exceptions are parameterized with the name of the command that | |
| 14126 failed, if known. See |catch-errors|. | |
| 14127 | |
| 14128 | |
| 14129 PECULIARITIES | |
| 14130 *except-compat* | |
| 14131 The exception handling concept requires that the command sequence causing the | |
| 14132 exception is aborted immediately and control is transferred to finally clauses | |
| 14133 and/or a catch clause. | |
| 14134 | |
| 14135 In the Vim script language there are cases where scripts and functions | |
| 14136 continue after an error: in functions without the "abort" flag or in a command | |
| 14137 after ":silent!", control flow goes to the following line, and outside | |
| 14138 functions, control flow goes to the line following the outermost ":endwhile" | |
| 14139 or ":endif". On the other hand, errors should be catchable as exceptions | |
| 14140 (thus, requiring the immediate abortion). | |
| 14141 | |
| 14142 This problem has been solved by converting errors to exceptions and using | |
| 14143 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
|
14144 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
|
14145 be caught only from an active try conditional. If you want an immediate |
| 7 | 14146 termination without catching the error, just use a try conditional without |
| 14147 catch clause. (You can cause cleanup code being executed before termination | |
| 14148 by specifying a finally clause.) | |
| 14149 | |
| 14150 When no try conditional is active, the usual abortion and continuation | |
| 14151 behavior is used instead of immediate abortion. This ensures compatibility of | |
| 14152 scripts written for Vim 6.1 and earlier. | |
| 14153 | |
| 14154 However, when sourcing an existing script that does not use exception handling | |
| 14155 commands (or when calling one of its functions) from inside an active try | |
| 14156 conditional of a new script, you might change the control flow of the existing | |
| 14157 script on error. You get the immediate abortion on error and can catch the | |
| 14158 error in the new script. If however the sourced script suppresses error | |
| 14159 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
|
14160 |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
|
14161 not converted to an exception. (See |:silent|.) So the only remaining cause |
| 7 | 14162 where this happens is for scripts that don't care about errors and produce |
| 14163 error messages. You probably won't want to use such code from your new | |
| 14164 scripts. | |
| 14165 | |
| 14166 *except-syntax-err* | |
| 14167 Syntax errors in the exception handling commands are never caught by any of | |
| 14168 the ":catch" commands of the try conditional they belong to. Its finally | |
| 14169 clauses, however, is executed. | |
| 14170 Example: > | |
| 14171 | |
| 14172 :try | |
| 14173 : try | |
| 14174 : throw 4711 | |
| 14175 : catch /\(/ | |
| 14176 : echo "in catch with syntax error" | |
| 14177 : catch | |
| 14178 : echo "inner catch-all" | |
| 14179 : finally | |
| 14180 : echo "inner finally" | |
| 14181 : endtry | |
| 14182 :catch | |
| 14183 : echo 'outer catch-all caught "' . v:exception . '"' | |
| 14184 : finally | |
| 14185 : echo "outer finally" | |
| 14186 :endtry | |
| 14187 | |
| 14188 This displays: > | |
| 14189 inner finally | |
| 14190 outer catch-all caught "Vim(catch):E54: Unmatched \(" | |
| 14191 outer finally | |
| 14192 The original exception is discarded and an error exception is raised, instead. | |
| 14193 | |
| 14194 *except-single-line* | |
| 14195 The ":try", ":catch", ":finally", and ":endtry" commands can be put on | |
| 14196 a single line, but then syntax errors may make it difficult to recognize the | |
| 14197 "catch" line, thus you better avoid this. | |
| 14198 Example: > | |
| 14199 :try | unlet! foo # | catch | endtry | |
| 14200 raises an error exception for the trailing characters after the ":unlet!" | |
| 14201 argument, but does not see the ":catch" and ":endtry" commands, so that the | |
| 14202 error exception is discarded and the "E488: Trailing characters" message gets | |
| 14203 displayed. | |
| 14204 | |
| 14205 *except-several-errors* | |
| 14206 When several errors appear in a single command, the first error message is | |
| 14207 usually the most specific one and therefor converted to the error exception. | |
| 14208 Example: > | |
| 14209 echo novar | |
| 14210 causes > | |
| 14211 E121: Undefined variable: novar | |
| 14212 E15: Invalid expression: novar | |
| 14213 The value of the error exception inside try conditionals is: > | |
| 14214 Vim(echo):E121: Undefined variable: novar | |
| 14215 < *except-syntax-error* | |
| 14216 But when a syntax error is detected after a normal error in the same command, | |
| 14217 the syntax error is used for the exception being thrown. | |
| 14218 Example: > | |
| 14219 unlet novar # | |
| 14220 causes > | |
| 14221 E108: No such variable: "novar" | |
| 14222 E488: Trailing characters | |
| 14223 The value of the error exception inside try conditionals is: > | |
| 14224 Vim(unlet):E488: Trailing characters | |
| 14225 This is done because the syntax error might change the execution path in a way | |
| 14226 not intended by the user. Example: > | |
| 14227 try | |
| 14228 try | unlet novar # | catch | echo v:exception | endtry | |
| 14229 catch /.*/ | |
| 14230 echo "outer catch:" v:exception | |
| 14231 endtry | |
| 14232 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then | |
| 14233 a "E600: Missing :endtry" error message is given, see |except-single-line|. | |
| 14234 | |
| 14235 ============================================================================== | |
| 14236 9. Examples *eval-examples* | |
| 14237 | |
| 1156 | 14238 Printing in Binary ~ |
| 7 | 14239 > |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1998
diff
changeset
|
14240 :" The function Nr2Bin() returns the binary string representation of a number. |
| 1156 | 14241 :func Nr2Bin(nr) |
| 7 | 14242 : let n = a:nr |
| 14243 : let r = "" | |
| 14244 : while n | |
| 1156 | 14245 : let r = '01'[n % 2] . r |
| 14246 : let n = n / 2 | |
| 7 | 14247 : endwhile |
| 14248 : return r | |
| 14249 :endfunc | |
| 14250 | |
| 1156 | 14251 :" The function String2Bin() converts each character in a string to a |
| 14252 :" binary string, separated with dashes. | |
| 14253 :func String2Bin(str) | |
| 7 | 14254 : let out = '' |
| 1156 | 14255 : for ix in range(strlen(a:str)) |
| 14256 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix])) | |
| 14257 : endfor | |
| 14258 : return out[1:] | |
| 7 | 14259 :endfunc |
| 14260 | |
| 14261 Example of its use: > | |
| 1156 | 14262 :echo Nr2Bin(32) |
| 14263 result: "100000" > | |
| 14264 :echo String2Bin("32") | |
| 14265 result: "110011-110010" | |
| 14266 | |
| 14267 | |
| 14268 Sorting lines ~ | |
| 14269 | |
| 14270 This example sorts lines with a specific compare function. > | |
| 14271 | |
| 14272 :func SortBuffer() | |
| 14273 : let lines = getline(1, '$') | |
| 14274 : call sort(lines, function("Strcmp")) | |
| 14275 : call setline(1, lines) | |
| 7 | 14276 :endfunction |
| 14277 | |
| 1156 | 14278 As a one-liner: > |
| 14279 :call setline(1, sort(getline(1, '$'), function("Strcmp"))) | |
| 14280 | |
| 14281 | |
| 14282 scanf() replacement ~ | |
| 7 | 14283 *sscanf* |
| 14284 There is no sscanf() function in Vim. If you need to extract parts from a | |
| 14285 line, you can use matchstr() and substitute() to do it. This example shows | |
| 14286 how to get the file name, line number and column number out of a line like | |
| 14287 "foobar.txt, 123, 45". > | |
| 14288 :" Set up the match bit | |
| 14289 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' | |
| 14290 :"get the part matching the whole expression | |
| 14291 :let l = matchstr(line, mx) | |
| 14292 :"get each item out of the match | |
| 14293 :let file = substitute(l, mx, '\1', '') | |
| 14294 :let lnum = substitute(l, mx, '\2', '') | |
| 14295 :let col = substitute(l, mx, '\3', '') | |
| 14296 | |
| 14297 The input is in the variable "line", the results in the variables "file", | |
| 14298 "lnum" and "col". (idea from Michael Geddes) | |
| 14299 | |
| 1156 | 14300 |
| 14301 getting the scriptnames in a Dictionary ~ | |
| 14302 *scriptnames-dictionary* | |
| 14303 The |:scriptnames| command can be used to get a list of all script files that | |
| 14304 have been sourced. There is no equivalent function or variable for this | |
| 14305 (because it's rarely needed). In case you need to manipulate the list this | |
| 14306 code can be used: > | |
| 14307 " Get the output of ":scriptnames" in the scriptnames_output variable. | |
| 14308 let scriptnames_output = '' | |
| 14309 redir => scriptnames_output | |
| 14310 silent scriptnames | |
| 14311 redir END | |
| 12785 | 14312 |
| 1621 | 14313 " Split the output into lines and parse each line. Add an entry to the |
| 1156 | 14314 " "scripts" dictionary. |
| 14315 let scripts = {} | |
| 14316 for line in split(scriptnames_output, "\n") | |
| 14317 " Only do non-blank lines. | |
| 14318 if line =~ '\S' | |
| 14319 " Get the first number in the line. | |
| 1621 | 14320 let nr = matchstr(line, '\d\+') |
| 1156 | 14321 " Get the file name, remove the script number " 123: ". |
| 1621 | 14322 let name = substitute(line, '.\+:\s*', '', '') |
| 1156 | 14323 " Add an item to the Dictionary |
| 1621 | 14324 let scripts[nr] = name |
| 1156 | 14325 endif |
| 14326 endfor | |
| 14327 unlet scriptnames_output | |
| 14328 | |
| 7 | 14329 ============================================================================== |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14330 10. Vim script versions *vimscript-version* *vimscript-versions* |
| 16380 | 14331 *scriptversion* |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14332 Over time many features have been added to Vim script. This includes Ex |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14333 commands, functions, variable types, etc. Each individual feature can be |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14334 checked with the |has()| and |exists()| functions. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14335 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14336 Sometimes old syntax of functionality gets in the way of making Vim better. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14337 When support is taken away this will break older Vim scripts. To make this |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14338 explicit the |:scriptversion| command can be used. When a Vim script is not |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14339 compatible with older versions of Vim this will give an explicit error, |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
14340 instead of failing in mysterious ways. |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
14341 |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
14342 *scriptversion-1* > |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14343 :scriptversion 1 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14344 < This is the original Vim script, same as not using a |:scriptversion| |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14345 command. Can be used to go back to old syntax for a range of lines. |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14346 Test for support with: > |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14347 has('vimscript-1') |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14348 |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
14349 < *scriptversion-2* > |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14350 :scriptversion 2 |
| 16808 | 14351 < String concatenation with "." is not supported, use ".." instead. |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14352 This avoids the ambiguity using "." for Dict member access and |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14353 floating point numbers. Now ".5" means the number 0.5. |
|
17026
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
14354 |
|
905e1b154058
patch 8.1.1513: all popup functionality is in functions, except :popupclear
Bram Moolenaar <Bram@vim.org>
parents:
17020
diff
changeset
|
14355 *scriptversion-3* > |
| 16380 | 14356 :scriptversion 3 |
| 14357 < All |vim-variable|s must be prefixed by "v:". E.g. "version" doesn't | |
| 14358 work as |v:version| anymore, it can be used as a normal variable. | |
| 14359 Same for some obvious names as "count" and others. | |
| 14360 | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14361 Test for support with: > |
| 16380 | 14362 has('vimscript-3') |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14363 < |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14364 *scriptversion-4* > |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14365 :scriptversion 4 |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14366 < Numbers with a leading zero are not recognized as octal. "0o" or "0O" |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14367 is still recognized as octal. With the |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14368 previous version you get: > |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14369 echo 017 " displays 15 (octal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14370 echo 0o17 " displays 15 (octal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14371 echo 018 " displays 18 (decimal) |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14372 < with script version 4: > |
|
20665
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14373 echo 017 " displays 17 (decimal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14374 echo 0o17 " displays 15 (octal) |
|
6ff992bf4c82
patch 8.2.0886: cannot use octal numbers in scriptversion 4
Bram Moolenaar <Bram@vim.org>
parents:
20649
diff
changeset
|
14375 echo 018 " displays 18 (decimal) |
|
18080
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14376 < Also, it is possible to use single quotes inside numbers to make them |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14377 easier to read: > |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14378 echo 1'000'000 |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14379 < The quotes must be surrounded by digits. |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14380 |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14381 Test for support with: > |
|
a6d218f99ff7
patch 8.1.2035: recognizing octal numbers is confusing
Bram Moolenaar <Bram@vim.org>
parents:
18053
diff
changeset
|
14382 has('vimscript-4') |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14383 |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14384 ============================================================================== |
|
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14385 11. No +eval feature *no-eval-feature* |
| 7 | 14386 |
| 14387 When the |+eval| feature was disabled at compile time, none of the expression | |
| 14388 evaluation commands are available. To prevent this from causing Vim scripts | |
| 14389 to generate all kinds of errors, the ":if" and ":endif" commands are still | |
| 14390 recognized, though the argument of the ":if" and everything between the ":if" | |
| 14391 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but | |
| 14392 only if the commands are at the start of the line. The ":else" command is not | |
| 14393 recognized. | |
| 14394 | |
| 14395 Example of how to avoid executing commands when the |+eval| feature is | |
| 14396 missing: > | |
| 14397 | |
| 14398 :if 1 | |
| 14399 : echo "Expression evaluation is compiled in" | |
| 14400 :else | |
| 14401 : echo "You will _never_ see this message" | |
| 14402 :endif | |
| 14403 | |
|
16971
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14404 To execute a command only when the |+eval| feature is disabled can be done in |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14405 two ways. The simplest is to exit the script (or Vim) prematurely: > |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14406 if 1 |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14407 echo "commands executed with +eval" |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14408 finish |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14409 endif |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14410 args " command executed without +eval |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14411 |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14412 If you do not want to abort loading the script you can use a trick, as this |
|
e18b1c654d09
Update runtime files - Add typescript syntax and indent.
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
14413 example shows: > |
|
11414
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
14414 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
14415 silent! while 0 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
14416 set history=111 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
14417 silent! endwhile |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
14418 |
|
c95c5ddc3b0d
patch 8.0.0591: changes to eval functionality not documented
Christian Brabandt <cb@256bit.org>
parents:
11407
diff
changeset
|
14419 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
|
14420 "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
|
14421 silently ignored, and the command is executed. |
| 11347 | 14422 |
| 7 | 14423 ============================================================================== |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14424 12. The sandbox *eval-sandbox* *sandbox* *E48* |
| 7 | 14425 |
|
2350
06feaf4fe36a
Rename some "python3" symbols to "py3", as the command name.
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
14426 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
|
14427 '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
|
14428 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
|
14429 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
|
14430 the command from a tags file is executed and for CTRL-R = in the command line. |
| 29 | 14431 The sandbox is also used for the |:sandbox| command. |
| 7 | 14432 |
| 14433 These items are not allowed in the sandbox: | |
| 14434 - changing the buffer text | |
| 14347 | 14435 - defining or changing mapping, autocommands, user commands |
| 7 | 14436 - setting certain options (see |option-summary|) |
| 1156 | 14437 - setting certain v: variables (see |v:var|) *E794* |
| 7 | 14438 - executing a shell command |
| 14439 - reading or writing a file | |
| 14440 - jumping to another buffer or editing a file | |
| 625 | 14441 - executing Python, Perl, etc. commands |
| 29 | 14442 This is not guaranteed 100% secure, but it should block most attacks. |
| 14443 | |
| 14444 *:san* *:sandbox* | |
| 401 | 14445 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
| 29 | 14446 option that may have been set from a modeline, e.g. |
| 14447 'foldexpr'. | |
| 14448 | |
| 634 | 14449 *sandbox-option* |
| 14450 A few options contain an expression. When this expression is evaluated it may | |
| 790 | 14451 have to be done in the sandbox to avoid a security risk. But the sandbox is |
| 634 | 14452 restrictive, thus this only happens when the option was set from an insecure |
| 14453 location. Insecure in this context are: | |
| 843 | 14454 - sourcing a .vimrc or .exrc in the current directory |
| 634 | 14455 - while executing in the sandbox |
| 14456 - value coming from a modeline | |
| 14347 | 14457 - executing a function that was defined in the sandbox |
| 634 | 14458 |
| 14459 Note that when in the sandbox and saving an option value and restoring it, the | |
| 14460 option will still be marked as it was set in the sandbox. | |
| 14461 | |
| 14462 ============================================================================== | |
|
16223
abb67309c1ca
patch 8.1.1116: cannot enforce a Vim script style
Bram Moolenaar <Bram@vim.org>
parents:
16219
diff
changeset
|
14463 13. Textlock *textlock* |
| 634 | 14464 |
| 14465 In a few situations it is not allowed to change the text in the buffer, jump | |
| 14466 to another window and some other things that might confuse or break what Vim | |
| 14467 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
|
14468 actually doing something else. For example, evaluating the 'balloonexpr' may |
| 634 | 14469 happen any moment the mouse cursor is resting at some position. |
| 14470 | |
| 14471 This is not allowed when the textlock is active: | |
| 14472 - changing the buffer text | |
| 14473 - jumping to another buffer or window | |
| 14474 - editing another file | |
| 14475 - closing a window or quitting Vim | |
| 14476 - etc. | |
| 14477 | |
| 7 | 14478 |
| 14421 | 14479 vim:tw=78:ts=8:noet:ft=help:norl: |