Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 1 | *eval.txt* For Vim version 8.2. Last change: 2022 Feb 21 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2 | |
| 3 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4 | VIM REFERENCE MANUAL by Bram Moolenaar |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5 | |
| 6 | |
| 7 | Expression evaluation *expression* *expr* *E15* *eval* |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 8 | *E1002* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 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 |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 12 | done, the features in this document are not available. See |+eval| and |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 13 | |no-eval-feature|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 14 | |
Bram Moolenaar | 1cae5a0 | 2021-12-27 21:28:34 +0000 | [diff] [blame] | 15 | This file is mainly about the backwards compatible (legacy) Vim script. For |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 16 | specifics of Vim9 script, which can execute much faster, supports type |
| 17 | checking and much more, see |vim9.txt|. Where the syntax or semantics differ |
| 18 | a remark is given. |
Bram Moolenaar | 8a7d654 | 2020-01-26 15:56:19 +0100 | [diff] [blame] | 19 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 20 | 1. Variables |variables| |
| 21 | 1.1 Variable types |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 22 | 1.2 Function references |Funcref| |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 23 | 1.3 Lists |Lists| |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 24 | 1.4 Dictionaries |Dictionaries| |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 25 | 1.5 Blobs |Blobs| |
| 26 | 1.6 More about variables |more-variables| |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 27 | 2. Expression syntax |expression-syntax| |
| 28 | 3. Internal variable |internal-variables| |
| 29 | 4. Builtin Functions |functions| |
| 30 | 5. Defining functions |user-functions| |
| 31 | 6. Curly braces names |curly-braces-names| |
| 32 | 7. Commands |expression-commands| |
| 33 | 8. Exception handling |exception-handling| |
| 34 | 9. Examples |eval-examples| |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 35 | 10. Vim script version |vimscript-version| |
| 36 | 11. No +eval feature |no-eval-feature| |
| 37 | 12. The sandbox |eval-sandbox| |
| 38 | 13. Textlock |textlock| |
Bram Moolenaar | ed997ad | 2019-07-21 16:42:00 +0200 | [diff] [blame] | 39 | |
| 40 | Testing support is documented in |testing.txt|. |
| 41 | Profiling is documented at |profiling|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 42 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 43 | ============================================================================== |
| 44 | 1. Variables *variables* |
| 45 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 46 | 1.1 Variable types ~ |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 47 | *E712* *E896* *E897* *E899* *E1098* |
| 48 | *E1107* *E1135* *E1138* |
Bram Moolenaar | 06fe74a | 2019-08-31 16:20:32 +0200 | [diff] [blame] | 49 | There are ten types of variables: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 50 | |
Bram Moolenaar | 664f3cf | 2019-12-07 16:03:51 +0100 | [diff] [blame] | 51 | *Number* *Integer* |
| 52 | Number A 32 or 64 bit signed number. |expr-number| |
Bram Moolenaar | f9706e9 | 2020-02-22 14:27:04 +0100 | [diff] [blame] | 53 | The number of bits is available in |v:numbersize|. |
Bram Moolenaar | 6f02b00 | 2021-01-10 20:22:54 +0100 | [diff] [blame] | 54 | Examples: -123 0x10 0177 0o177 0b1011 |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 55 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 56 | Float A floating point number. |floating-point-format| *Float* |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 57 | {only when compiled with the |+float| feature} *E1076* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 58 | Examples: 123.456 1.15e-6 -1.1e3 |
| 59 | |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 60 | String A NUL terminated string of 8-bit unsigned characters (bytes). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 61 | |expr-string| Examples: "ab\txx\"--" 'x-z''a,c' |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 62 | |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 63 | List An ordered sequence of items, see |List| for details. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 64 | Example: [1, 2, ['a', 'b']] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 65 | |
Bram Moolenaar | 39a58ca | 2005-06-27 22:42:44 +0000 | [diff] [blame] | 66 | Dictionary An associative, unordered array: Each entry has a key and a |
| 67 | value. |Dictionary| |
Bram Moolenaar | d5abb4c | 2019-07-13 22:46:10 +0200 | [diff] [blame] | 68 | Examples: |
| 69 | {'blue': "#0000ff", 'red': "#ff0000"} |
Bram Moolenaar | 4c6d904 | 2019-07-16 22:04:02 +0200 | [diff] [blame] | 70 | #{blue: "#0000ff", red: "#ff0000"} |
Bram Moolenaar | 39a58ca | 2005-06-27 22:42:44 +0000 | [diff] [blame] | 71 | |
Bram Moolenaar | 835dc63 | 2016-02-07 14:27:38 +0100 | [diff] [blame] | 72 | Funcref A reference to a function |Funcref|. |
| 73 | Example: function("strlen") |
Bram Moolenaar | 1d42961 | 2016-05-24 15:44:17 +0200 | [diff] [blame] | 74 | It can be bound to a dictionary and arguments, it then works |
| 75 | like a Partial. |
| 76 | Example: function("Callback", [arg], myDict) |
Bram Moolenaar | 835dc63 | 2016-02-07 14:27:38 +0100 | [diff] [blame] | 77 | |
Bram Moolenaar | 02e83b4 | 2016-02-21 20:10:26 +0100 | [diff] [blame] | 78 | Special |v:false|, |v:true|, |v:none| and |v:null|. *Special* |
Bram Moolenaar | 835dc63 | 2016-02-07 14:27:38 +0100 | [diff] [blame] | 79 | |
Bram Moolenaar | ebf7dfa | 2016-04-14 12:46:51 +0200 | [diff] [blame] | 80 | Job Used for a job, see |job_start()|. *Job* *Jobs* |
Bram Moolenaar | 38a5563 | 2016-02-15 22:07:32 +0100 | [diff] [blame] | 81 | |
Bram Moolenaar | ebf7dfa | 2016-04-14 12:46:51 +0200 | [diff] [blame] | 82 | Channel Used for a channel, see |ch_open()|. *Channel* *Channels* |
Bram Moolenaar | 835dc63 | 2016-02-07 14:27:38 +0100 | [diff] [blame] | 83 | |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 84 | Blob Binary Large Object. Stores any sequence of bytes. See |Blob| |
| 85 | for details |
Bram Moolenaar | 6e5ea8d | 2019-01-12 22:47:31 +0100 | [diff] [blame] | 86 | Example: 0zFF00ED015DAF |
| 87 | 0z is an empty Blob. |
| 88 | |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 89 | The Number and String types are converted automatically, depending on how they |
| 90 | are used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 91 | |
| 92 | Conversion from a Number to a String is by making the ASCII representation of |
Bram Moolenaar | 24ea3ba | 2010-09-19 19:01:21 +0200 | [diff] [blame] | 93 | the Number. Examples: |
| 94 | Number 123 --> String "123" ~ |
| 95 | Number 0 --> String "0" ~ |
| 96 | Number -1 --> String "-1" ~ |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 97 | *octal* |
Bram Moolenaar | d43906d | 2020-07-20 21:31:32 +0200 | [diff] [blame] | 98 | Conversion from a String to a Number only happens in legacy Vim script, not in |
| 99 | Vim9 script. It is done by converting the first digits to a number. |
| 100 | Hexadecimal "0xf9", Octal "017" or "0o17", and Binary "0b10" |
Bram Moolenaar | 6f02b00 | 2021-01-10 20:22:54 +0100 | [diff] [blame] | 101 | numbers are recognized |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 102 | NOTE: when using |Vim9| script or |scriptversion-4| octal with a leading "0" |
| 103 | is not recognized. The 0o notation requires patch 8.2.0886. |
Bram Moolenaar | 6f02b00 | 2021-01-10 20:22:54 +0100 | [diff] [blame] | 104 | If the String doesn't start with digits, the result is zero. |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 105 | Examples: |
Bram Moolenaar | 24ea3ba | 2010-09-19 19:01:21 +0200 | [diff] [blame] | 106 | String "456" --> Number 456 ~ |
| 107 | String "6bar" --> Number 6 ~ |
| 108 | String "foo" --> Number 0 ~ |
| 109 | String "0xf1" --> Number 241 ~ |
| 110 | String "0100" --> Number 64 ~ |
Bram Moolenaar | c17e66c | 2020-06-02 21:38:22 +0200 | [diff] [blame] | 111 | String "0o100" --> Number 64 ~ |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 112 | String "0b101" --> Number 5 ~ |
Bram Moolenaar | 24ea3ba | 2010-09-19 19:01:21 +0200 | [diff] [blame] | 113 | String "-8" --> Number -8 ~ |
| 114 | String "+8" --> Number 0 ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 115 | |
| 116 | To force conversion from String to Number, add zero to it: > |
| 117 | :echo "0100" + 0 |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 118 | < 64 ~ |
| 119 | |
| 120 | To avoid a leading zero to cause octal conversion, or for using a different |
| 121 | base, use |str2nr()|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 122 | |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 123 | *TRUE* *FALSE* *Boolean* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 124 | For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. |
Bram Moolenaar | 6aa5729 | 2021-08-14 21:25:52 +0200 | [diff] [blame] | 125 | You can also use |v:false| and |v:true|, in Vim9 script |false| and |true|. |
Bram Moolenaar | 1c6737b | 2020-09-07 22:18:52 +0200 | [diff] [blame] | 126 | When TRUE is returned from a function it is the Number one, FALSE is the |
| 127 | number zero. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 128 | |
Bram Moolenaar | e381d3d | 2016-07-07 14:50:41 +0200 | [diff] [blame] | 129 | Note that in the command: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 130 | :if "foo" |
Bram Moolenaar | e381d3d | 2016-07-07 14:50:41 +0200 | [diff] [blame] | 131 | :" NOT executed |
| 132 | "foo" is converted to 0, which means FALSE. If the string starts with a |
| 133 | non-zero number it means TRUE: > |
| 134 | :if "8foo" |
| 135 | :" executed |
| 136 | To test for a non-empty string, use empty(): > |
Bram Moolenaar | 3a0d809 | 2012-10-21 03:02:54 +0200 | [diff] [blame] | 137 | :if !empty("foo") |
Bram Moolenaar | 92f26c2 | 2020-10-03 20:17:30 +0200 | [diff] [blame] | 138 | |
| 139 | < *falsy* *truthy* |
| 140 | An expression can be used as a condition, ignoring the type and only using |
| 141 | whether the value is "sort of true" or "sort of false". Falsy is: |
| 142 | the number zero |
| 143 | empty string, blob, list or dictionary |
| 144 | Other values are truthy. Examples: |
| 145 | 0 falsy |
| 146 | 1 truthy |
| 147 | -1 truthy |
| 148 | 0.0 falsy |
| 149 | 0.1 truthy |
| 150 | '' falsy |
| 151 | 'x' truthy |
| 152 | [] falsy |
| 153 | [0] truthy |
| 154 | {} falsy |
| 155 | #{x: 1} truthy |
| 156 | 0z falsy |
| 157 | 0z00 truthy |
| 158 | |
Bram Moolenaar | e381d3d | 2016-07-07 14:50:41 +0200 | [diff] [blame] | 159 | *non-zero-arg* |
| 160 | Function arguments often behave slightly different from |TRUE|: If the |
| 161 | argument is present and it evaluates to a non-zero Number, |v:true| or a |
Bram Moolenaar | 64d8e25 | 2016-09-06 22:12:34 +0200 | [diff] [blame] | 162 | non-empty String, then the value is considered to be TRUE. |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 163 | Note that " " and "0" are also non-empty strings, thus considered to be TRUE. |
| 164 | A List, Dictionary or Float is not a Number or String, thus evaluate to FALSE. |
Bram Moolenaar | e381d3d | 2016-07-07 14:50:41 +0200 | [diff] [blame] | 165 | |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 166 | *E611* *E745* *E728* *E703* *E729* *E730* *E731* *E908* *E910* |
| 167 | *E913* *E974* *E975* *E976* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 168 | |List|, |Dictionary|, |Funcref|, |Job|, |Channel| and |Blob| types are not |
| 169 | automatically converted. |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 170 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 171 | *E805* *E806* *E808* |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 172 | When mixing Number and Float the Number is converted to Float. Otherwise |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 173 | there is no automatic conversion of Float. You can use str2float() for String |
| 174 | to Float, printf() for Float to String and float2nr() for Float to Number. |
| 175 | |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 176 | *E362* *E891* *E892* *E893* *E894* *E907* *E911* *E914* |
Bram Moolenaar | 13d5aee | 2016-01-21 23:36:05 +0100 | [diff] [blame] | 177 | When expecting a Float a Number can also be used, but nothing else. |
| 178 | |
Bram Moolenaar | f6f32c3 | 2016-03-12 19:03:59 +0100 | [diff] [blame] | 179 | *no-type-checking* |
| 180 | You will not get an error if you try to change the type of a variable. |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 181 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 182 | |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 183 | 1.2 Function references ~ |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 184 | *Funcref* *E695* *E718* *E1086* *E1192* |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 185 | A Funcref variable is obtained with the |function()| function, the |funcref()| |
| 186 | function or created with the lambda expression |expr-lambda|. It can be used |
| 187 | in an expression in the place of a function name, before the parenthesis |
| 188 | around the arguments, to invoke the function it refers to. Example: > |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 189 | |
| 190 | :let Fn = function("MyFunc") |
| 191 | :echo Fn() |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 192 | < *E704* *E705* *E707* |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 193 | A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You |
Bram Moolenaar | 7cba6c0 | 2013-09-05 22:13:31 +0200 | [diff] [blame] | 194 | can use "g:" but the following name must still start with a capital. You |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 195 | cannot have both a Funcref variable and a function with the same name. |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 196 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 197 | A special case is defining a function and directly assigning its Funcref to a |
| 198 | Dictionary entry. Example: > |
| 199 | :function dict.init() dict |
| 200 | : let self.val = 0 |
| 201 | :endfunction |
| 202 | |
| 203 | The key of the Dictionary can start with a lower case letter. The actual |
| 204 | function name is not used here. Also see |numbered-function|. |
| 205 | |
| 206 | A Funcref can also be used with the |:call| command: > |
| 207 | :call Fn() |
| 208 | :call dict.init() |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 209 | |
| 210 | The name of the referenced function can be obtained with |string()|. > |
Bram Moolenaar | 383f9bc | 2005-01-19 22:18:32 +0000 | [diff] [blame] | 211 | :let func = string(Fn) |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 212 | |
| 213 | You can use |call()| to invoke a Funcref and use a list variable for the |
| 214 | arguments: > |
Bram Moolenaar | 383f9bc | 2005-01-19 22:18:32 +0000 | [diff] [blame] | 215 | :let r = call(Fn, mylist) |
Bram Moolenaar | 1d42961 | 2016-05-24 15:44:17 +0200 | [diff] [blame] | 216 | < |
| 217 | *Partial* |
| 218 | A Funcref optionally binds a Dictionary and/or arguments. This is also called |
| 219 | a Partial. This is created by passing the Dictionary and/or arguments to |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 220 | function() or funcref(). When calling the function the Dictionary and/or |
| 221 | arguments will be passed to the function. Example: > |
Bram Moolenaar | 1d42961 | 2016-05-24 15:44:17 +0200 | [diff] [blame] | 222 | |
| 223 | let Cb = function('Callback', ['foo'], myDict) |
Bram Moolenaar | ba3ff53 | 2018-11-04 14:45:49 +0100 | [diff] [blame] | 224 | call Cb('bar') |
Bram Moolenaar | 1d42961 | 2016-05-24 15:44:17 +0200 | [diff] [blame] | 225 | |
| 226 | This will invoke the function as if using: > |
Bram Moolenaar | ba3ff53 | 2018-11-04 14:45:49 +0100 | [diff] [blame] | 227 | call myDict.Callback('foo', 'bar') |
Bram Moolenaar | 1d42961 | 2016-05-24 15:44:17 +0200 | [diff] [blame] | 228 | |
| 229 | This is very useful when passing a function around, e.g. in the arguments of |
| 230 | |ch_open()|. |
| 231 | |
| 232 | Note that binding a function to a Dictionary also happens when the function is |
| 233 | a member of the Dictionary: > |
| 234 | |
| 235 | let myDict.myFunction = MyFunction |
| 236 | call myDict.myFunction() |
| 237 | |
| 238 | Here MyFunction() will get myDict passed as "self". This happens when the |
| 239 | "myFunction" member is accessed. When making assigning "myFunction" to |
| 240 | otherDict and calling it, it will be bound to otherDict: > |
| 241 | |
| 242 | let otherDict.myFunction = myDict.myFunction |
| 243 | call otherDict.myFunction() |
| 244 | |
| 245 | Now "self" will be "otherDict". But when the dictionary was bound explicitly |
| 246 | this won't happen: > |
| 247 | |
| 248 | let myDict.myFunction = function(MyFunction, myDict) |
| 249 | let otherDict.myFunction = myDict.myFunction |
| 250 | call otherDict.myFunction() |
| 251 | |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 252 | Here "self" will be "myDict", because it was bound explicitly. |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 253 | |
| 254 | |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 255 | 1.3 Lists ~ |
Bram Moolenaar | 7e38ea2 | 2014-04-05 22:55:53 +0200 | [diff] [blame] | 256 | *list* *List* *Lists* *E686* |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 257 | A List is an ordered sequence of items. An item can be of any type. Items |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 258 | can be accessed by their index number. Items can be added and removed at any |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 259 | position in the sequence. |
| 260 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 261 | |
| 262 | List creation ~ |
| 263 | *E696* *E697* |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 264 | A List is created with a comma separated list of items in square brackets. |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 265 | Examples: > |
| 266 | :let mylist = [1, two, 3, "four"] |
| 267 | :let emptylist = [] |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 268 | |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 269 | An item can be any expression. Using a List for an item creates a |
Bram Moolenaar | f9393ef | 2006-04-24 19:47:27 +0000 | [diff] [blame] | 270 | List of Lists: > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 271 | :let nestlist = [[11, 12], [21, 22], [31, 32]] |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 272 | |
| 273 | An extra comma after the last item is ignored. |
| 274 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 275 | |
| 276 | List index ~ |
| 277 | *list-index* *E684* |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 278 | An item in the List can be accessed by putting the index in square brackets |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 279 | after the List. Indexes are zero-based, thus the first item has index zero. > |
| 280 | :let item = mylist[0] " get the first item: 1 |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 281 | :let item = mylist[2] " get the third item: 3 |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 282 | |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 283 | When the resulting item is a list this can be repeated: > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 284 | :let item = nestlist[0][1] " get the first list, second item: 12 |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 285 | < |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 286 | A negative index is counted from the end. Index -1 refers to the last item in |
| 287 | the List, -2 to the last but one item, etc. > |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 288 | :let last = mylist[-1] " get the last item: "four" |
| 289 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 290 | To avoid an error for an invalid index use the |get()| function. When an item |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 291 | is not available it returns zero or the default value you specify: > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 292 | :echo get(mylist, idx) |
| 293 | :echo get(mylist, idx, "NONE") |
| 294 | |
| 295 | |
| 296 | List concatenation ~ |
Bram Moolenaar | 3445320 | 2021-01-31 13:08:38 +0100 | [diff] [blame] | 297 | *list-concatenation* |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 298 | Two lists can be concatenated with the "+" operator: > |
| 299 | :let longlist = mylist + [5, 6] |
Bram Moolenaar | 383f9bc | 2005-01-19 22:18:32 +0000 | [diff] [blame] | 300 | :let mylist += [7, 8] |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 301 | |
Bram Moolenaar | 3445320 | 2021-01-31 13:08:38 +0100 | [diff] [blame] | 302 | To prepend or append an item, turn the item into a list by putting [] around |
| 303 | it. To change a list in-place, refer to |list-modification| below. |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 304 | |
| 305 | |
| 306 | Sublist ~ |
Bram Moolenaar | bc8801c | 2016-08-02 21:04:33 +0200 | [diff] [blame] | 307 | *sublist* |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 308 | A part of the List can be obtained by specifying the first and last index, |
| 309 | separated by a colon in square brackets: > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 310 | :let shortlist = mylist[2:-1] " get List [3, "four"] |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 311 | |
| 312 | Omitting the first index is similar to zero. Omitting the last index is |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 313 | similar to -1. > |
Bram Moolenaar | 540d6e3 | 2005-01-09 21:20:18 +0000 | [diff] [blame] | 314 | :let endlist = mylist[2:] " from item 2 to the end: [3, "four"] |
| 315 | :let shortlist = mylist[2:2] " List with one item: [3] |
| 316 | :let otherlist = mylist[:] " make a copy of the List |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 317 | |
Bram Moolenaar | 6601b62 | 2021-01-13 21:47:15 +0100 | [diff] [blame] | 318 | Notice that the last index is inclusive. If you prefer using an exclusive |
| 319 | index use the |slice()| method. |
| 320 | |
Bram Moolenaar | f9393ef | 2006-04-24 19:47:27 +0000 | [diff] [blame] | 321 | If the first index is beyond the last item of the List or the second item is |
| 322 | before the first item, the result is an empty list. There is no error |
| 323 | message. |
| 324 | |
| 325 | If the second index is equal to or greater than the length of the list the |
| 326 | length minus one is used: > |
Bram Moolenaar | 9e54a0e | 2006-04-14 20:42:25 +0000 | [diff] [blame] | 327 | :let mylist = [0, 1, 2, 3] |
| 328 | :echo mylist[2:8] " result: [2, 3] |
| 329 | |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 330 | NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 331 | using a single letter variable before the ":". Insert a space when needed: |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 332 | mylist[s : e]. |
| 333 | |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 334 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 335 | List identity ~ |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 336 | *list-identity* |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 337 | When variable "aa" is a list and you assign it to another variable "bb", both |
| 338 | variables refer to the same list. Thus changing the list "aa" will also |
| 339 | change "bb": > |
| 340 | :let aa = [1, 2, 3] |
| 341 | :let bb = aa |
| 342 | :call add(aa, 4) |
| 343 | :echo bb |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 344 | < [1, 2, 3, 4] |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 345 | |
| 346 | Making a copy of a list is done with the |copy()| function. Using [:] also |
| 347 | works, as explained above. This creates a shallow copy of the list: Changing |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 348 | a list item in the list will also change the item in the copied list: > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 349 | :let aa = [[1, 'a'], 2, 3] |
| 350 | :let bb = copy(aa) |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 351 | :call add(aa, 4) |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 352 | :let aa[0][1] = 'aaa' |
| 353 | :echo aa |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 354 | < [[1, aaa], 2, 3, 4] > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 355 | :echo bb |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 356 | < [[1, aaa], 2, 3] |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 357 | |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 358 | To make a completely independent list use |deepcopy()|. This also makes a |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 359 | copy of the values in the list, recursively. Up to a hundred levels deep. |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 360 | |
| 361 | The operator "is" can be used to check if two variables refer to the same |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 362 | List. "isnot" does the opposite. In contrast "==" compares if two lists have |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 363 | the same value. > |
| 364 | :let alist = [1, 2, 3] |
| 365 | :let blist = [1, 2, 3] |
| 366 | :echo alist is blist |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 367 | < 0 > |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 368 | :echo alist == blist |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 369 | < 1 |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 370 | |
Bram Moolenaar | 9ba0eb8 | 2005-06-13 22:28:56 +0000 | [diff] [blame] | 371 | Note about comparing lists: Two lists are considered equal if they have the |
| 372 | same length and all items compare equal, as with using "==". There is one |
Bram Moolenaar | 7d1f5db | 2005-07-03 21:39:27 +0000 | [diff] [blame] | 373 | exception: When comparing a number with a string they are considered |
| 374 | different. There is no automatic type conversion, as with using "==" on |
| 375 | variables. Example: > |
| 376 | echo 4 == "4" |
Bram Moolenaar | 9ba0eb8 | 2005-06-13 22:28:56 +0000 | [diff] [blame] | 377 | < 1 > |
Bram Moolenaar | 7d1f5db | 2005-07-03 21:39:27 +0000 | [diff] [blame] | 378 | echo [4] == ["4"] |
Bram Moolenaar | 9ba0eb8 | 2005-06-13 22:28:56 +0000 | [diff] [blame] | 379 | < 0 |
| 380 | |
Bram Moolenaar | 7d1f5db | 2005-07-03 21:39:27 +0000 | [diff] [blame] | 381 | Thus comparing Lists is more strict than comparing numbers and strings. You |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 382 | can compare simple values this way too by putting them in a list: > |
Bram Moolenaar | 7d1f5db | 2005-07-03 21:39:27 +0000 | [diff] [blame] | 383 | |
| 384 | :let a = 5 |
| 385 | :let b = "5" |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 386 | :echo a == b |
Bram Moolenaar | 7d1f5db | 2005-07-03 21:39:27 +0000 | [diff] [blame] | 387 | < 1 > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 388 | :echo [a] == [b] |
Bram Moolenaar | 7d1f5db | 2005-07-03 21:39:27 +0000 | [diff] [blame] | 389 | < 0 |
Bram Moolenaar | 9ba0eb8 | 2005-06-13 22:28:56 +0000 | [diff] [blame] | 390 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 391 | |
| 392 | List unpack ~ |
| 393 | |
| 394 | To unpack the items in a list to individual variables, put the variables in |
| 395 | square brackets, like list items: > |
| 396 | :let [var1, var2] = mylist |
| 397 | |
| 398 | When the number of variables does not match the number of items in the list |
| 399 | this produces an error. To handle any extra items from the list append ";" |
| 400 | and a variable name: > |
| 401 | :let [var1, var2; rest] = mylist |
| 402 | |
| 403 | This works like: > |
| 404 | :let var1 = mylist[0] |
| 405 | :let var2 = mylist[1] |
Bram Moolenaar | 5f2bb9f | 2005-01-11 21:29:04 +0000 | [diff] [blame] | 406 | :let rest = mylist[2:] |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 407 | |
| 408 | Except that there is no error if there are only two items. "rest" will be an |
| 409 | empty list then. |
| 410 | |
| 411 | |
| 412 | List modification ~ |
| 413 | *list-modification* |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 414 | To change a specific item of a list use |:let| this way: > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 415 | :let list[4] = "four" |
| 416 | :let listlist[0][3] = item |
| 417 | |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 418 | To change part of a list you can specify the first and last item to be |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 419 | modified. The value must at least have the number of items in the range: > |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 420 | :let list[3:5] = [3, 4, 5] |
| 421 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 422 | Adding and removing items from a list is done with functions. Here are a few |
| 423 | examples: > |
| 424 | :call insert(list, 'a') " prepend item 'a' |
| 425 | :call insert(list, 'a', 3) " insert item 'a' before list[3] |
| 426 | :call add(list, "new") " append String item |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 427 | :call add(list, [1, 2]) " append a List as one new item |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 428 | :call extend(list, [1, 2]) " extend the list with two more items |
| 429 | :let i = remove(list, 3) " remove item 3 |
Bram Moolenaar | 9cd1516 | 2005-01-16 22:02:49 +0000 | [diff] [blame] | 430 | :unlet list[3] " idem |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 431 | :let l = remove(list, 3, -1) " remove items 3 to last item |
Bram Moolenaar | 9cd1516 | 2005-01-16 22:02:49 +0000 | [diff] [blame] | 432 | :unlet list[3 : ] " idem |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 433 | :call filter(list, 'v:val !~ "x"') " remove items with an 'x' |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 434 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 435 | Changing the order of items in a list: > |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 436 | :call sort(list) " sort a list alphabetically |
| 437 | :call reverse(list) " reverse the order of items |
Bram Moolenaar | 327aa02 | 2014-03-25 18:24:23 +0100 | [diff] [blame] | 438 | :call uniq(sort(list)) " sort and remove duplicates |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 439 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 440 | |
| 441 | For loop ~ |
| 442 | |
Bram Moolenaar | 74e54fc | 2021-03-26 20:41:29 +0100 | [diff] [blame] | 443 | The |:for| loop executes commands for each item in a List, String or Blob. |
| 444 | A variable is set to each item in sequence. Example with a List: > |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 445 | :for item in mylist |
| 446 | : call Doit(item) |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 447 | :endfor |
| 448 | |
| 449 | This works like: > |
| 450 | :let index = 0 |
| 451 | :while index < len(mylist) |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 452 | : let item = mylist[index] |
| 453 | : :call Doit(item) |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 454 | : let index = index + 1 |
| 455 | :endwhile |
| 456 | |
Bram Moolenaar | 5f2bb9f | 2005-01-11 21:29:04 +0000 | [diff] [blame] | 457 | If all you want to do is modify each item in the list then the |map()| |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 458 | function will be a simpler method than a for loop. |
Bram Moolenaar | 5f2bb9f | 2005-01-11 21:29:04 +0000 | [diff] [blame] | 459 | |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 460 | Just like the |:let| command, |:for| also accepts a list of variables. This |
Bram Moolenaar | 74e54fc | 2021-03-26 20:41:29 +0100 | [diff] [blame] | 461 | requires the argument to be a List of Lists. > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 462 | :for [lnum, col] in [[1, 3], [2, 8], [3, 0]] |
| 463 | : call Doit(lnum, col) |
| 464 | :endfor |
| 465 | |
| 466 | This works like a |:let| command is done for each list item. Again, the types |
| 467 | must remain the same to avoid an error. |
| 468 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 469 | It is also possible to put remaining items in a List variable: > |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 470 | :for [i, j; rest] in listlist |
| 471 | : call Doit(i, j) |
| 472 | : if !empty(rest) |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 473 | : echo "remainder: " .. string(rest) |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 474 | : endif |
| 475 | :endfor |
| 476 | |
Bram Moolenaar | 74e54fc | 2021-03-26 20:41:29 +0100 | [diff] [blame] | 477 | For a Blob one byte at a time is used. |
| 478 | |
| 479 | For a String one character, including any composing characters, is used as a |
| 480 | String. Example: > |
| 481 | for c in text |
| 482 | echo 'This character is ' .. c |
| 483 | endfor |
| 484 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 485 | |
| 486 | List functions ~ |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 487 | *E714* |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 488 | Functions that are useful with a List: > |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 489 | :let r = call(funcname, list) " call a function with an argument list |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 490 | :if empty(list) " check if list is empty |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 491 | :let l = len(list) " number of items in list |
| 492 | :let big = max(list) " maximum value in list |
| 493 | :let small = min(list) " minimum value in list |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 494 | :let xs = count(list, 'x') " count nr of times 'x' appears in list |
| 495 | :let i = index(list, 'x') " index of first 'x' in list |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 496 | :let lines = getline(1, 10) " get ten text lines from buffer |
| 497 | :call append('$', lines) " append text lines in buffer |
Bram Moolenaar | 5f2bb9f | 2005-01-11 21:29:04 +0000 | [diff] [blame] | 498 | :let list = split("a b c") " create list from items in a string |
| 499 | :let string = join(list, ', ') " create string from list items |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 500 | :let s = string(list) " String representation of list |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 501 | :call map(list, '">> " .. v:val') " prepend ">> " to each item |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 502 | |
Bram Moolenaar | 0cb032e | 2005-04-23 20:52:00 +0000 | [diff] [blame] | 503 | Don't forget that a combination of features can make things simple. For |
| 504 | example, to add up all the numbers in a list: > |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 505 | :exe 'let sum = ' .. join(nrlist, '+') |
Bram Moolenaar | 0cb032e | 2005-04-23 20:52:00 +0000 | [diff] [blame] | 506 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 507 | |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 508 | 1.4 Dictionaries ~ |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 509 | *dict* *Dict* *Dictionaries* *Dictionary* |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 510 | A Dictionary is an associative array: Each entry has a key and a value. The |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 511 | entry can be located with the key. The entries are stored without a specific |
| 512 | ordering. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 513 | |
| 514 | |
| 515 | Dictionary creation ~ |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 516 | *E720* *E721* *E722* *E723* |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 517 | A Dictionary is created with a comma separated list of entries in curly |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 518 | braces. Each entry has a key and a value, separated by a colon. Each key can |
| 519 | only appear once. Examples: > |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 520 | :let mydict = {1: 'one', 2: 'two', 3: 'three'} |
| 521 | :let emptydict = {} |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 522 | < *E713* *E716* *E717* |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 523 | A key is always a String. You can use a Number, it will be converted to a |
| 524 | String automatically. Thus the String '4' and the number 4 will find the same |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 525 | entry. Note that the String '04' and the Number 04 are different, since the |
Bram Moolenaar | d5abb4c | 2019-07-13 22:46:10 +0200 | [diff] [blame] | 526 | Number will be converted to the String '4'. The empty string can also be used |
| 527 | as a key. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 528 | |
| 529 | In |Vim9| script literaly keys can be used if the key consists of alphanumeric |
| 530 | characters, underscore and dash, see |vim9-literal-dict|. |
Bram Moolenaar | 56c860c | 2019-08-17 20:09:31 +0200 | [diff] [blame] | 531 | *literal-Dict* *#{}* |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 532 | To avoid having to put quotes around every key the #{} form can be used in |
| 533 | legacy script. This does require the key to consist only of ASCII letters, |
| 534 | digits, '-' and '_'. Example: > |
Bram Moolenaar | 10455d4 | 2019-11-21 15:36:18 +0100 | [diff] [blame] | 535 | :let mydict = #{zero: 0, one_key: 1, two-key: 2, 333: 3} |
Bram Moolenaar | 4c6d904 | 2019-07-16 22:04:02 +0200 | [diff] [blame] | 536 | Note that 333 here is the string "333". Empty keys are not possible with #{}. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 537 | In |Vim9| script the #{} form cannot be used. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 538 | |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 539 | A value can be any expression. Using a Dictionary for a value creates a |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 540 | nested Dictionary: > |
| 541 | :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}} |
| 542 | |
| 543 | An extra comma after the last entry is ignored. |
| 544 | |
| 545 | |
| 546 | Accessing entries ~ |
| 547 | |
| 548 | The normal way to access an entry is by putting the key in square brackets: > |
| 549 | :let val = mydict["one"] |
| 550 | :let mydict["four"] = 4 |
| 551 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 552 | You can add new entries to an existing Dictionary this way, unlike Lists. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 553 | |
| 554 | For keys that consist entirely of letters, digits and underscore the following |
| 555 | form can be used |expr-entry|: > |
| 556 | :let val = mydict.one |
| 557 | :let mydict.four = 4 |
| 558 | |
| 559 | Since an entry can be any type, also a List and a Dictionary, the indexing and |
| 560 | key lookup can be repeated: > |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 561 | :echo dict.key[idx].key |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 562 | |
| 563 | |
| 564 | Dictionary to List conversion ~ |
| 565 | |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 566 | You may want to loop over the entries in a dictionary. For this you need to |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 567 | turn the Dictionary into a List and pass it to |:for|. |
| 568 | |
| 569 | Most often you want to loop over the keys, using the |keys()| function: > |
| 570 | :for key in keys(mydict) |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 571 | : echo key .. ': ' .. mydict[key] |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 572 | :endfor |
| 573 | |
| 574 | The List of keys is unsorted. You may want to sort them first: > |
| 575 | :for key in sort(keys(mydict)) |
| 576 | |
| 577 | To loop over the values use the |values()| function: > |
| 578 | :for v in values(mydict) |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 579 | : echo "value: " .. v |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 580 | :endfor |
| 581 | |
| 582 | If you want both the key and the value use the |items()| function. It returns |
Bram Moolenaar | d47d522 | 2018-12-09 20:43:55 +0100 | [diff] [blame] | 583 | a List in which each item is a List with two items, the key and the value: > |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 584 | :for [key, value] in items(mydict) |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 585 | : echo key .. ': ' .. value |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 586 | :endfor |
| 587 | |
| 588 | |
| 589 | Dictionary identity ~ |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 590 | *dict-identity* |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 591 | Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a |
| 592 | Dictionary. Otherwise, assignment results in referring to the same |
| 593 | Dictionary: > |
| 594 | :let onedict = {'a': 1, 'b': 2} |
| 595 | :let adict = onedict |
| 596 | :let adict['a'] = 11 |
| 597 | :echo onedict['a'] |
| 598 | 11 |
| 599 | |
Bram Moolenaar | f3bd51a | 2005-06-14 22:11:18 +0000 | [diff] [blame] | 600 | Two Dictionaries compare equal if all the key-value pairs compare equal. For |
| 601 | more info see |list-identity|. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 602 | |
| 603 | |
| 604 | Dictionary modification ~ |
| 605 | *dict-modification* |
| 606 | To change an already existing entry of a Dictionary, or to add a new entry, |
| 607 | use |:let| this way: > |
| 608 | :let dict[4] = "four" |
| 609 | :let dict['one'] = item |
| 610 | |
Bram Moolenaar | 9cd1516 | 2005-01-16 22:02:49 +0000 | [diff] [blame] | 611 | Removing an entry from a Dictionary is done with |remove()| or |:unlet|. |
| 612 | Three ways to remove the entry with key "aaa" from dict: > |
| 613 | :let i = remove(dict, 'aaa') |
| 614 | :unlet dict.aaa |
| 615 | :unlet dict['aaa'] |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 616 | |
| 617 | Merging a Dictionary with another is done with |extend()|: > |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 618 | :call extend(adict, bdict) |
| 619 | This extends adict with all entries from bdict. Duplicate keys cause entries |
| 620 | in adict to be overwritten. An optional third argument can change this. |
Bram Moolenaar | 383f9bc | 2005-01-19 22:18:32 +0000 | [diff] [blame] | 621 | Note that the order of entries in a Dictionary is irrelevant, thus don't |
| 622 | expect ":echo adict" to show the items from bdict after the older entries in |
| 623 | adict. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 624 | |
| 625 | Weeding out entries from a Dictionary can be done with |filter()|: > |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 626 | :call filter(dict, 'v:val =~ "x"') |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 627 | This removes all entries from "dict" with a value not matching 'x'. |
Bram Moolenaar | 388a5d4 | 2020-05-26 21:20:45 +0200 | [diff] [blame] | 628 | This can also be used to remove all entries: > |
| 629 | call filter(dict, 0) |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 630 | |
| 631 | |
| 632 | Dictionary function ~ |
Bram Moolenaar | 26402cb | 2013-02-20 21:26:00 +0100 | [diff] [blame] | 633 | *Dictionary-function* *self* *E725* *E862* |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 634 | When a function is defined with the "dict" attribute it can be used in a |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 635 | special way with a dictionary. Example: > |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 636 | :function Mylen() dict |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 637 | : return len(self.data) |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 638 | :endfunction |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 639 | :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")} |
| 640 | :echo mydict.len() |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 641 | |
| 642 | This is like a method in object oriented programming. The entry in the |
| 643 | Dictionary is a |Funcref|. The local variable "self" refers to the dictionary |
| 644 | the function was invoked from. |
| 645 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 646 | It is also possible to add a function without the "dict" attribute as a |
| 647 | Funcref to a Dictionary, but the "self" variable is not available then. |
| 648 | |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 649 | *numbered-function* *anonymous-function* |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 650 | To avoid the extra name for the function it can be defined and directly |
| 651 | assigned to a Dictionary in this way: > |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 652 | :let mydict = {'data': [0, 1, 2, 3]} |
Bram Moolenaar | 5a5f459 | 2015-04-13 12:43:06 +0200 | [diff] [blame] | 653 | :function mydict.len() |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 654 | : return len(self.data) |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 655 | :endfunction |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 656 | :echo mydict.len() |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 657 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 658 | The function will then get a number and the value of dict.len is a |Funcref| |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 659 | that references this function. The function can only be used through a |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 660 | |Funcref|. It will automatically be deleted when there is no |Funcref| |
| 661 | remaining that refers to it. |
| 662 | |
| 663 | It is not necessary to use the "dict" attribute for a numbered function. |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 664 | |
Bram Moolenaar | 1affd72 | 2010-08-04 17:49:30 +0200 | [diff] [blame] | 665 | If you get an error for a numbered function, you can find out what it is with |
| 666 | a trick. Assuming the function is 42, the command is: > |
Bram Moolenaar | 34cc7d8 | 2021-09-21 20:09:51 +0200 | [diff] [blame] | 667 | :function g:42 |
Bram Moolenaar | 1affd72 | 2010-08-04 17:49:30 +0200 | [diff] [blame] | 668 | |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 669 | |
| 670 | Functions for Dictionaries ~ |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 671 | *E715* |
| 672 | Functions that can be used with a Dictionary: > |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 673 | :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo" |
| 674 | :if empty(dict) " TRUE if dict is empty |
| 675 | :let l = len(dict) " number of items in dict |
| 676 | :let big = max(dict) " maximum value in dict |
| 677 | :let small = min(dict) " minimum value in dict |
| 678 | :let xs = count(dict, 'x') " count nr of times 'x' appears in dict |
| 679 | :let s = string(dict) " String representation of dict |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 680 | :call map(dict, '">> " .. v:val') " prepend ">> " to each item |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 681 | |
| 682 | |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 683 | 1.5 Blobs ~ |
| 684 | *blob* *Blob* *Blobs* *E978* |
Bram Moolenaar | aff7491 | 2019-03-30 18:11:49 +0100 | [diff] [blame] | 685 | A Blob is a binary object. It can be used to read an image from a file and |
| 686 | send it over a channel, for example. |
| 687 | |
| 688 | A Blob mostly behaves like a |List| of numbers, where each number has the |
| 689 | value of an 8-bit byte, from 0 to 255. |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 690 | |
| 691 | |
| 692 | Blob creation ~ |
| 693 | |
| 694 | A Blob can be created with a |blob-literal|: > |
| 695 | :let b = 0zFF00ED015DAF |
Bram Moolenaar | 0d17f0d | 2019-01-22 22:20:38 +0100 | [diff] [blame] | 696 | Dots can be inserted between bytes (pair of hex characters) for readability, |
| 697 | they don't change the value: > |
| 698 | :let b = 0zFF00.ED01.5DAF |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 699 | |
| 700 | A blob can be read from a file with |readfile()| passing the {type} argument |
| 701 | set to "B", for example: > |
| 702 | :let b = readfile('image.png', 'B') |
| 703 | |
| 704 | A blob can be read from a channel with the |ch_readblob()| function. |
| 705 | |
| 706 | |
| 707 | Blob index ~ |
| 708 | *blob-index* *E979* |
| 709 | A byte in the Blob can be accessed by putting the index in square brackets |
| 710 | after the Blob. Indexes are zero-based, thus the first byte has index zero. > |
| 711 | :let myblob = 0z00112233 |
| 712 | :let byte = myblob[0] " get the first byte: 0x00 |
| 713 | :let byte = myblob[2] " get the third byte: 0x22 |
| 714 | |
| 715 | A negative index is counted from the end. Index -1 refers to the last byte in |
| 716 | the Blob, -2 to the last but one byte, etc. > |
| 717 | :let last = myblob[-1] " get the last byte: 0x33 |
| 718 | |
| 719 | To avoid an error for an invalid index use the |get()| function. When an item |
| 720 | is not available it returns -1 or the default value you specify: > |
| 721 | :echo get(myblob, idx) |
| 722 | :echo get(myblob, idx, 999) |
| 723 | |
| 724 | |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 725 | Blob iteration ~ |
| 726 | |
| 727 | The |:for| loop executes commands for each byte of a Blob. The loop variable is |
| 728 | set to each byte in the Blob. Example: > |
| 729 | :for byte in 0z112233 |
| 730 | : call Doit(byte) |
| 731 | :endfor |
| 732 | This calls Doit() with 0x11, 0x22 and 0x33. |
| 733 | |
| 734 | |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 735 | Blob concatenation ~ |
| 736 | |
| 737 | Two blobs can be concatenated with the "+" operator: > |
| 738 | :let longblob = myblob + 0z4455 |
| 739 | :let myblob += 0z6677 |
| 740 | |
| 741 | To change a blob in-place see |blob-modification| below. |
| 742 | |
| 743 | |
| 744 | Part of a blob ~ |
| 745 | |
| 746 | A part of the Blob can be obtained by specifying the first and last index, |
| 747 | separated by a colon in square brackets: > |
| 748 | :let myblob = 0z00112233 |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 749 | :let shortblob = myblob[1:2] " get 0z1122 |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 750 | :let shortblob = myblob[2:-1] " get 0z2233 |
| 751 | |
| 752 | Omitting the first index is similar to zero. Omitting the last index is |
| 753 | similar to -1. > |
| 754 | :let endblob = myblob[2:] " from item 2 to the end: 0z2233 |
| 755 | :let shortblob = myblob[2:2] " Blob with one byte: 0z22 |
| 756 | :let otherblob = myblob[:] " make a copy of the Blob |
| 757 | |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 758 | If the first index is beyond the last byte of the Blob or the second index is |
Bram Moolenaar | aa5df7e | 2019-02-03 14:53:10 +0100 | [diff] [blame] | 759 | before the first index, the result is an empty Blob. There is no error |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 760 | message. |
| 761 | |
| 762 | If the second index is equal to or greater than the length of the list the |
| 763 | length minus one is used: > |
| 764 | :echo myblob[2:8] " result: 0z2233 |
| 765 | |
| 766 | |
| 767 | Blob modification ~ |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 768 | *blob-modification* *E1182* *E1184* |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 769 | To change a specific byte of a blob use |:let| this way: > |
| 770 | :let blob[4] = 0x44 |
| 771 | |
| 772 | When the index is just one beyond the end of the Blob, it is appended. Any |
| 773 | higher index is an error. |
| 774 | |
| 775 | To change a sequence of bytes the [:] notation can be used: > |
| 776 | let blob[1:3] = 0z445566 |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 777 | The length of the replaced bytes must be exactly the same as the value |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 778 | provided. *E972* |
| 779 | |
| 780 | To change part of a blob you can specify the first and last byte to be |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 781 | modified. The value must have the same number of bytes in the range: > |
| 782 | :let blob[3:5] = 0z334455 |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 783 | |
| 784 | You can also use the functions |add()|, |remove()| and |insert()|. |
| 785 | |
| 786 | |
| 787 | Blob identity ~ |
| 788 | |
| 789 | Blobs can be compared for equality: > |
| 790 | if blob == 0z001122 |
| 791 | And for equal identity: > |
| 792 | if blob is otherblob |
| 793 | < *blob-identity* *E977* |
| 794 | When variable "aa" is a Blob and you assign it to another variable "bb", both |
| 795 | variables refer to the same Blob. Then the "is" operator returns true. |
| 796 | |
| 797 | When making a copy using [:] or |copy()| the values are the same, but the |
| 798 | identity is different: > |
| 799 | :let blob = 0z112233 |
| 800 | :let blob2 = blob |
| 801 | :echo blob == blob2 |
| 802 | < 1 > |
| 803 | :echo blob is blob2 |
| 804 | < 1 > |
| 805 | :let blob3 = blob[:] |
| 806 | :echo blob == blob3 |
| 807 | < 1 > |
| 808 | :echo blob is blob3 |
| 809 | < 0 |
| 810 | |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 811 | Making a copy of a Blob is done with the |copy()| function. Using [:] also |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 812 | works, as explained above. |
| 813 | |
| 814 | |
| 815 | 1.6 More about variables ~ |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 816 | *more-variables* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 817 | If you need to know the type of a variable or expression, use the |type()| |
| 818 | function. |
| 819 | |
| 820 | When the '!' flag is included in the 'viminfo' option, global variables that |
| 821 | start with an uppercase letter, and don't contain a lowercase letter, are |
| 822 | stored in the viminfo file |viminfo-file|. |
| 823 | |
| 824 | When the 'sessionoptions' option contains "global", global variables that |
| 825 | start with an uppercase letter and contain at least one lowercase letter are |
| 826 | stored in the session file |session-file|. |
| 827 | |
| 828 | variable name can be stored where ~ |
| 829 | my_var_6 not |
| 830 | My_Var_6 session file |
| 831 | MY_VAR_6 viminfo file |
| 832 | |
| 833 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 834 | In legacy script it is possible to form a variable name with curly braces, see |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 835 | |curly-braces-names|. |
| 836 | |
| 837 | ============================================================================== |
| 838 | 2. Expression syntax *expression-syntax* |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 839 | *E1143* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 840 | Expression syntax summary, from least to most significant: |
| 841 | |
Bram Moolenaar | 50ba526 | 2016-09-22 22:33:02 +0200 | [diff] [blame] | 842 | |expr1| expr2 |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 843 | expr2 ? expr1 : expr1 if-then-else |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 844 | |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 845 | |expr2| expr3 |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 846 | expr3 || expr3 ... logical OR |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 847 | |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 848 | |expr3| expr4 |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 849 | expr4 && expr4 ... logical AND |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 850 | |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 851 | |expr4| expr5 |
| 852 | expr5 == expr5 equal |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 853 | expr5 != expr5 not equal |
| 854 | expr5 > expr5 greater than |
| 855 | expr5 >= expr5 greater than or equal |
| 856 | expr5 < expr5 smaller than |
| 857 | expr5 <= expr5 smaller than or equal |
| 858 | expr5 =~ expr5 regexp matches |
| 859 | expr5 !~ expr5 regexp doesn't match |
| 860 | |
| 861 | expr5 ==? expr5 equal, ignoring case |
| 862 | expr5 ==# expr5 equal, match case |
| 863 | etc. As above, append ? for ignoring case, # for |
| 864 | matching case |
| 865 | |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 866 | expr5 is expr5 same |List|, |Dictionary| or |Blob| instance |
| 867 | expr5 isnot expr5 different |List|, |Dictionary| or |Blob| |
| 868 | instance |
Bram Moolenaar | de8866b | 2005-01-06 23:24:37 +0000 | [diff] [blame] | 869 | |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 870 | |expr5| expr6 |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 871 | expr6 + expr6 ... number addition, list or blob concatenation |
| 872 | expr6 - expr6 ... number subtraction |
| 873 | expr6 . expr6 ... string concatenation |
| 874 | expr6 .. expr6 ... string concatenation |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 875 | |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 876 | |expr6| expr7 |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 877 | expr7 * expr7 ... number multiplication |
| 878 | expr7 / expr7 ... number division |
| 879 | expr7 % expr7 ... number modulo |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 880 | |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 881 | |expr7| expr8 |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 882 | <type>expr8 type check and conversion (|Vim9| only) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 883 | |
Bram Moolenaar | 89bcfda | 2016-08-30 23:26:57 +0200 | [diff] [blame] | 884 | |expr8| expr9 |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 885 | ! expr8 logical NOT |
| 886 | - expr8 unary minus |
| 887 | + expr8 unary plus |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 888 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 889 | |expr9| expr10 |
| 890 | expr9[expr1] byte of a String or item of a |List| |
| 891 | expr9[expr1 : expr1] substring of a String or sublist of a |List| |
| 892 | expr9.name entry in a |Dictionary| |
| 893 | expr9(expr1, ...) function call with |Funcref| variable |
| 894 | expr9->name(expr1, ...) |method| call |
| 895 | |
| 896 | |expr10| number number constant |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 897 | "string" string constant, backslash is special |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 898 | 'string' string constant, ' is doubled |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 899 | [expr1, ...] |List| |
| 900 | {expr1: expr1, ...} |Dictionary| |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 901 | #{key: expr1, ...} legacy |Dictionary| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 902 | &option option value |
| 903 | (expr1) nested expression |
| 904 | variable internal variable |
| 905 | va{ria}ble internal variable with curly braces |
| 906 | $VAR environment variable |
| 907 | @r contents of register 'r' |
| 908 | function(expr1, ...) function call |
| 909 | func{ti}on(expr1, ...) function call with curly braces |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 910 | {args -> expr1} legacy lambda expression |
| 911 | (args) => expr1 Vim9 lambda expression |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 912 | |
| 913 | |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 914 | "..." indicates that the operations in this level can be concatenated. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 915 | Example: > |
| 916 | &nu || &list && &shell == "csh" |
| 917 | |
| 918 | All expressions within one level are parsed from left to right. |
| 919 | |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 920 | Expression nesting is limited to 1000 levels deep (300 when build with MSVC) |
| 921 | to avoid running out of stack and crashing. *E1169* |
| 922 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 923 | |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 924 | expr1 *expr1* *ternary* *falsy-operator* *??* *E109* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 925 | ----- |
| 926 | |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 927 | The ternary operator: expr2 ? expr1 : expr1 |
Bram Moolenaar | 92f26c2 | 2020-10-03 20:17:30 +0200 | [diff] [blame] | 928 | The falsy operator: expr2 ?? expr1 |
| 929 | |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 930 | Ternary operator ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 931 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 932 | In legacy script the expression before the '?' is evaluated to a number. If |
| 933 | it evaluates to |TRUE|, the result is the value of the expression between the |
| 934 | '?' and ':', otherwise the result is the value of the expression after the |
| 935 | ':'. |
| 936 | |
| 937 | In |Vim9| script the first expression must evaluate to a boolean, see |
| 938 | |vim9-boolean|. |
| 939 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 940 | Example: > |
| 941 | :echo lnum == 1 ? "top" : lnum |
| 942 | |
| 943 | Since the first expression is an "expr2", it cannot contain another ?:. The |
| 944 | other two expressions can, thus allow for recursive use of ?:. |
| 945 | Example: > |
| 946 | :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum |
| 947 | |
| 948 | To keep this readable, using |line-continuation| is suggested: > |
| 949 | :echo lnum == 1 |
| 950 | :\ ? "top" |
| 951 | :\ : lnum == 1000 |
| 952 | :\ ? "last" |
| 953 | :\ : lnum |
| 954 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 955 | You should always put a space before the ':', otherwise it can be mistaken for |
| 956 | use in a variable such as "a:1". |
| 957 | |
Bram Moolenaar | 92f26c2 | 2020-10-03 20:17:30 +0200 | [diff] [blame] | 958 | Falsy operator ~ |
| 959 | |
| 960 | This is also known as the "null coalescing operator", but that's too |
| 961 | complicated, thus we just call it the falsy operator. |
| 962 | |
| 963 | The expression before the '??' is evaluated. If it evaluates to |
| 964 | |truthy|, this is used as the result. Otherwise the expression after the '??' |
| 965 | is evaluated and used as the result. This is most useful to have a default |
| 966 | value for an expression that may result in zero or empty: > |
| 967 | echo theList ?? 'list is empty' |
| 968 | echo GetName() ?? 'unknown' |
| 969 | |
| 970 | These are similar, but not equal: > |
| 971 | expr2 ?? expr1 |
| 972 | expr2 ? expr2 : expr1 |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 973 | In the second line "expr2" is evaluated twice. And in |Vim9| script the type |
| 974 | of expr2 before "?" must be a boolean. |
Bram Moolenaar | 92f26c2 | 2020-10-03 20:17:30 +0200 | [diff] [blame] | 975 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 976 | |
| 977 | expr2 and expr3 *expr2* *expr3* |
| 978 | --------------- |
| 979 | |
Bram Moolenaar | 0418609 | 2016-08-29 21:55:35 +0200 | [diff] [blame] | 980 | expr3 || expr3 .. logical OR *expr-barbar* |
| 981 | expr4 && expr4 .. logical AND *expr-&&* |
| 982 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 983 | The "||" and "&&" operators take one argument on each side. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 984 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 985 | In legacy script the arguments are (converted to) Numbers. |
| 986 | |
| 987 | In |Vim9| script the values must be boolean, see |vim9-boolean|. Use "!!" to |
| 988 | convert any type to a boolean. |
| 989 | |
| 990 | The result is: |
Bram Moolenaar | e381d3d | 2016-07-07 14:50:41 +0200 | [diff] [blame] | 991 | input output ~ |
| 992 | n1 n2 n1 || n2 n1 && n2 ~ |
| 993 | |FALSE| |FALSE| |FALSE| |FALSE| |
| 994 | |FALSE| |TRUE| |TRUE| |FALSE| |
| 995 | |TRUE| |FALSE| |TRUE| |FALSE| |
| 996 | |TRUE| |TRUE| |TRUE| |TRUE| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 997 | |
| 998 | The operators can be concatenated, for example: > |
| 999 | |
| 1000 | &nu || &list && &shell == "csh" |
| 1001 | |
| 1002 | Note that "&&" takes precedence over "||", so this has the meaning of: > |
| 1003 | |
| 1004 | &nu || (&list && &shell == "csh") |
| 1005 | |
| 1006 | Once the result is known, the expression "short-circuits", that is, further |
| 1007 | arguments are not evaluated. This is like what happens in C. For example: > |
| 1008 | |
| 1009 | let a = 1 |
| 1010 | echo a || b |
| 1011 | |
Bram Moolenaar | e381d3d | 2016-07-07 14:50:41 +0200 | [diff] [blame] | 1012 | This is valid even if there is no variable called "b" because "a" is |TRUE|, |
| 1013 | so the result must be |TRUE|. Similarly below: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1014 | |
| 1015 | echo exists("b") && b == "yes" |
| 1016 | |
| 1017 | This is valid whether "b" has been defined or not. The second clause will |
| 1018 | only be evaluated if "b" has been defined. |
| 1019 | |
| 1020 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 1021 | expr4 *expr4* *E1153* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1022 | ----- |
| 1023 | |
| 1024 | expr5 {cmp} expr5 |
| 1025 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1026 | Compare two expr5 expressions. In legacy script the result is a 0 if it |
| 1027 | evaluates to false, or 1 if it evaluates to true. In |Vim9| script the result |
| 1028 | is |true| or |false|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1029 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1030 | *expr-==* *expr-!=* *expr->* *expr->=* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1031 | *expr-<* *expr-<=* *expr-=~* *expr-!~* |
| 1032 | *expr-==#* *expr-!=#* *expr->#* *expr->=#* |
| 1033 | *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#* |
| 1034 | *expr-==?* *expr-!=?* *expr->?* *expr->=?* |
| 1035 | *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?* |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 1036 | *expr-is* *expr-isnot* *expr-is#* *expr-isnot#* |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1037 | *expr-is?* *expr-isnot?* *E1072* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1038 | use 'ignorecase' match case ignore case ~ |
| 1039 | equal == ==# ==? |
| 1040 | not equal != !=# !=? |
| 1041 | greater than > ># >? |
| 1042 | greater than or equal >= >=# >=? |
| 1043 | smaller than < <# <? |
| 1044 | smaller than or equal <= <=# <=? |
| 1045 | regexp matches =~ =~# =~? |
| 1046 | regexp doesn't match !~ !~# !~? |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 1047 | same instance is is# is? |
| 1048 | different instance isnot isnot# isnot? |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1049 | |
| 1050 | Examples: |
| 1051 | "abc" ==# "Abc" evaluates to 0 |
| 1052 | "abc" ==? "Abc" evaluates to 1 |
| 1053 | "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1054 | NOTE: In |Vim9| script 'ignorecase' is not used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1055 | |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 1056 | *E691* *E692* |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 1057 | A |List| can only be compared with a |List| and only "equal", "not equal", |
| 1058 | "is" and "isnot" can be used. This compares the values of the list, |
| 1059 | recursively. Ignoring case means case is ignored when comparing item values. |
Bram Moolenaar | de8866b | 2005-01-06 23:24:37 +0000 | [diff] [blame] | 1060 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 1061 | *E735* *E736* |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 1062 | A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 1063 | equal", "is" and "isnot" can be used. This compares the key/values of the |
| 1064 | |Dictionary| recursively. Ignoring case means case is ignored when comparing |
| 1065 | item values. |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 1066 | |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 1067 | *E694* |
Bram Moolenaar | e18dbe8 | 2016-07-02 21:42:23 +0200 | [diff] [blame] | 1068 | A |Funcref| can only be compared with a |Funcref| and only "equal", "not |
| 1069 | equal", "is" and "isnot" can be used. Case is never ignored. Whether |
| 1070 | arguments or a Dictionary are bound (with a partial) matters. The |
| 1071 | Dictionaries must also be equal (or the same, in case of "is") and the |
| 1072 | arguments must be equal (or the same). |
| 1073 | |
| 1074 | To compare Funcrefs to see if they refer to the same function, ignoring bound |
| 1075 | Dictionary and arguments, use |get()| to get the function name: > |
| 1076 | if get(Part1, 'name') == get(Part2, 'name') |
| 1077 | " Part1 and Part2 refer to the same function |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1078 | < *E1037* |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 1079 | Using "is" or "isnot" with a |List|, |Dictionary| or |Blob| checks whether |
| 1080 | the expressions are referring to the same |List|, |Dictionary| or |Blob| |
| 1081 | instance. A copy of a |List| is different from the original |List|. When |
| 1082 | using "is" without a |List|, |Dictionary| or |Blob|, it is equivalent to |
| 1083 | using "equal", using "isnot" equivalent to using "not equal". Except that |
| 1084 | a different type means the values are different: > |
Bram Moolenaar | 86edef6 | 2016-03-13 18:07:30 +0100 | [diff] [blame] | 1085 | echo 4 == '4' |
| 1086 | 1 |
| 1087 | echo 4 is '4' |
| 1088 | 0 |
| 1089 | echo 0 is [] |
| 1090 | 0 |
| 1091 | "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. |
Bram Moolenaar | de8866b | 2005-01-06 23:24:37 +0000 | [diff] [blame] | 1092 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1093 | In legacy script, when comparing a String with a Number, the String is |
| 1094 | converted to a Number, and the comparison is done on Numbers. This means |
| 1095 | that: > |
Bram Moolenaar | 86edef6 | 2016-03-13 18:07:30 +0100 | [diff] [blame] | 1096 | echo 0 == 'x' |
| 1097 | 1 |
| 1098 | because 'x' converted to a Number is zero. However: > |
| 1099 | echo [0] == ['x'] |
| 1100 | 0 |
| 1101 | Inside a List or Dictionary this conversion is not used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1102 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1103 | In |Vim9| script the types must match. |
| 1104 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1105 | When comparing two Strings, this is done with strcmp() or stricmp(). This |
| 1106 | results in the mathematical difference (comparing byte values), not |
| 1107 | necessarily the alphabetical difference in the local language. |
| 1108 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1109 | When using the operators with a trailing '#', or the short version and |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 1110 | 'ignorecase' is off, the comparing is done with strcmp(): case matters. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1111 | |
| 1112 | When using the operators with a trailing '?', or the short version and |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 1113 | 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. |
| 1114 | |
| 1115 | 'smartcase' is not used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1116 | |
| 1117 | The "=~" and "!~" operators match the lefthand argument with the righthand |
| 1118 | argument, which is used as a pattern. See |pattern| for what a pattern is. |
| 1119 | This matching is always done like 'magic' was set and 'cpoptions' is empty, no |
| 1120 | matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts |
| 1121 | portable. To avoid backslashes in the regexp pattern to be doubled, use a |
| 1122 | single-quote string, see |literal-string|. |
| 1123 | Since a string is considered to be a single line, a multi-line pattern |
| 1124 | (containing \n, backslash-n) will not match. However, a literal NL character |
| 1125 | can be matched like an ordinary character. Examples: |
| 1126 | "foo\nbar" =~ "\n" evaluates to 1 |
| 1127 | "foo\nbar" =~ "\\n" evaluates to 0 |
| 1128 | |
| 1129 | |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1130 | expr5 and expr6 *expr5* *expr6* *E1036* *E1051* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1131 | --------------- |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 1132 | expr6 + expr6 Number addition, |List| or |Blob| concatenation *expr-+* |
| 1133 | expr6 - expr6 Number subtraction *expr--* |
| 1134 | expr6 . expr6 String concatenation *expr-.* |
| 1135 | expr6 .. expr6 String concatenation *expr-..* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1136 | |
Bram Moolenaar | a23ccb8 | 2006-02-27 00:08:02 +0000 | [diff] [blame] | 1137 | For |Lists| only "+" is possible and then both expr6 must be a list. The |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 1138 | result is a new list with the two lists Concatenated. |
Bram Moolenaar | de8866b | 2005-01-06 23:24:37 +0000 | [diff] [blame] | 1139 | |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 1140 | For String concatenation ".." is preferred, since "." is ambiguous, it is also |
| 1141 | used for |Dict| member access and floating point numbers. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1142 | In |Vim9| script and when |vimscript-version| is 2 or higher, using "." is not |
| 1143 | allowed. |
| 1144 | |
| 1145 | In |Vim9| script the arguments of ".." are converted to String for simple |
| 1146 | types: Number, Float, Special and Bool. For other types |string()| should be |
| 1147 | used. |
Bram Moolenaar | 0f248b0 | 2019-04-04 15:36:05 +0200 | [diff] [blame] | 1148 | |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 1149 | expr7 * expr7 Number multiplication *expr-star* |
| 1150 | expr7 / expr7 Number division *expr-/* |
| 1151 | expr7 % expr7 Number modulo *expr-%* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1152 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1153 | In legacy script, for all operators except "." and "..", Strings are converted |
| 1154 | to Numbers. |
| 1155 | |
Bram Moolenaar | d6e256c | 2011-12-14 15:32:50 +0100 | [diff] [blame] | 1156 | For bitwise operators see |and()|, |or()| and |xor()|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1157 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1158 | Note the difference between "+" and ".." in legacy script: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1159 | "123" + "456" = 579 |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1160 | "123" .. "456" = "123456" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1161 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1162 | Since '..' has the same precedence as '+' and '-', you need to read: > |
| 1163 | 1 .. 90 + 90.0 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1164 | As: > |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1165 | (1 .. 90) + 90.0 |
| 1166 | That works in legacy script, since the String "190" is automatically converted |
| 1167 | to the Number 190, which can be added to the Float 90.0. However: > |
| 1168 | 1 .. 90 * 90.0 |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1169 | Should be read as: > |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1170 | 1 .. (90 * 90.0) |
| 1171 | Since '..' has lower precedence than '*'. This does NOT work, since this |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1172 | attempts to concatenate a Float and a String. |
| 1173 | |
| 1174 | When dividing a Number by zero the result depends on the value: |
| 1175 | 0 / 0 = -0x80000000 (like NaN for Float) |
| 1176 | >0 / 0 = 0x7fffffff (like positive infinity) |
| 1177 | <0 / 0 = -0x7fffffff (like negative infinity) |
| 1178 | (before Vim 7.2 it was always 0x7fffffff) |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 1179 | In |Vim9| script dividing a number by zero is an error. *E1154* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1180 | |
Bram Moolenaar | 22fcfad | 2016-07-01 18:17:26 +0200 | [diff] [blame] | 1181 | When 64-bit Number support is enabled: |
| 1182 | 0 / 0 = -0x8000000000000000 (like NaN for Float) |
| 1183 | >0 / 0 = 0x7fffffffffffffff (like positive infinity) |
| 1184 | <0 / 0 = -0x7fffffffffffffff (like negative infinity) |
| 1185 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1186 | When the righthand side of '%' is zero, the result is 0. |
| 1187 | |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 1188 | None of these work for |Funcref|s. |
Bram Moolenaar | de8866b | 2005-01-06 23:24:37 +0000 | [diff] [blame] | 1189 | |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1190 | ".", ".." and "%" do not work for Float. *E804* *E1035* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1191 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1192 | |
| 1193 | expr7 *expr7* |
| 1194 | ----- |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1195 | <type>expr8 |
| 1196 | |
| 1197 | This is only available in |Vim9| script, see |type-casting|. |
| 1198 | |
| 1199 | |
| 1200 | expr8 *expr8* |
| 1201 | ----- |
| 1202 | ! expr8 logical NOT *expr-!* |
| 1203 | - expr8 unary minus *expr-unary--* |
| 1204 | + expr8 unary plus *expr-unary-+* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1205 | |
Bram Moolenaar | e381d3d | 2016-07-07 14:50:41 +0200 | [diff] [blame] | 1206 | For '!' |TRUE| becomes |FALSE|, |FALSE| becomes |TRUE| (one). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1207 | For '-' the sign of the number is changed. |
Bram Moolenaar | 6f02b00 | 2021-01-10 20:22:54 +0100 | [diff] [blame] | 1208 | For '+' the number is unchanged. Note: "++" has no effect. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1209 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1210 | In legacy script a String will be converted to a Number first. Note that if |
| 1211 | the string does not start with a digit you likely don't get what you expect. |
| 1212 | |
| 1213 | In |Vim9| script an error is given when "-" or "+" is used and the type is not |
| 1214 | a number. |
| 1215 | |
| 1216 | In |Vim9| script "!" can be used for any type and the result is always a |
| 1217 | boolean. Use "!!" to convert any type to a boolean, according to whether the |
| 1218 | value is |falsy|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1219 | |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1220 | These three can be repeated and mixed. Examples: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1221 | !-1 == 0 |
| 1222 | !!8 == 1 |
| 1223 | --9 == 9 |
| 1224 | |
| 1225 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1226 | expr9 *expr9* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1227 | ----- |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1228 | This expression is either |expr10| or a sequence of the alternatives below, |
Bram Moolenaar | fc65cab | 2018-08-28 22:58:02 +0200 | [diff] [blame] | 1229 | in any order. E.g., these are all possible: |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1230 | expr9[expr1].name |
| 1231 | expr9.name[expr1] |
| 1232 | expr9(expr1, ...)[expr1].name |
| 1233 | expr9->(expr1, ...)[expr1] |
Bram Moolenaar | ac92e25 | 2019-08-03 21:58:38 +0200 | [diff] [blame] | 1234 | Evaluation is always from left to right. |
Bram Moolenaar | fc65cab | 2018-08-28 22:58:02 +0200 | [diff] [blame] | 1235 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1236 | expr9[expr1] item of String or |List| *expr-[]* *E111* |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1237 | *E909* *subscript* *E1062* |
Bram Moolenaar | e3c37d8 | 2020-08-15 18:39:05 +0200 | [diff] [blame] | 1238 | In legacy Vim script: |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1239 | If expr9 is a Number or String this results in a String that contains the |
| 1240 | expr1'th single byte from expr9. expr9 is used as a String (a number is |
Bram Moolenaar | e3c37d8 | 2020-08-15 18:39:05 +0200 | [diff] [blame] | 1241 | automatically converted to a String), expr1 as a Number. This doesn't |
Bram Moolenaar | 207f009 | 2020-08-30 17:20:20 +0200 | [diff] [blame] | 1242 | recognize multibyte encodings, see `byteidx()` for an alternative, or use |
Bram Moolenaar | e3c37d8 | 2020-08-15 18:39:05 +0200 | [diff] [blame] | 1243 | `split()` to turn the string into a list of characters. Example, to get the |
| 1244 | byte under the cursor: > |
Bram Moolenaar | 61660ea | 2006-04-07 21:40:07 +0000 | [diff] [blame] | 1245 | :let c = getline(".")[col(".") - 1] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1246 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 1247 | In |Vim9| script: *E1147* *E1148* |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1248 | If expr9 is a String this results in a String that contains the expr1'th |
| 1249 | single character (including any composing characters) from expr9. To use byte |
Bram Moolenaar | 02b4d9b | 2021-03-14 19:46:45 +0100 | [diff] [blame] | 1250 | indexes use |strpart()|. |
Bram Moolenaar | e3c37d8 | 2020-08-15 18:39:05 +0200 | [diff] [blame] | 1251 | |
| 1252 | Index zero gives the first byte or character. Careful: text column numbers |
| 1253 | start with one! |
| 1254 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1255 | If the length of the String is less than the index, the result is an empty |
Bram Moolenaar | 85084ef | 2016-01-17 22:26:33 +0100 | [diff] [blame] | 1256 | String. A negative index always results in an empty string (reason: backward |
Bram Moolenaar | e3c37d8 | 2020-08-15 18:39:05 +0200 | [diff] [blame] | 1257 | compatibility). Use [-1:] to get the last byte or character. |
Bram Moolenaar | 6f02b00 | 2021-01-10 20:22:54 +0100 | [diff] [blame] | 1258 | In Vim9 script a negative index is used like with a list: count from the end. |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1259 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1260 | If expr9 is a |List| then it results the item at index expr1. See |list-index| |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1261 | for possible index values. If the index is out of range this results in an |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1262 | error. Example: > |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1263 | :let item = mylist[-1] " get last item |
| 1264 | |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 1265 | Generally, if a |List| index is equal to or higher than the length of the |
| 1266 | |List|, or more negative than the length of the |List|, this results in an |
| 1267 | error. |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1268 | |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 1269 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1270 | expr9[expr1a : expr1b] substring or sublist *expr-[:]* |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1271 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1272 | If expr9 is a String this results in the substring with the bytes or |
| 1273 | characters from expr1a to and including expr1b. expr9 is used as a String, |
Bram Moolenaar | 207f009 | 2020-08-30 17:20:20 +0200 | [diff] [blame] | 1274 | expr1a and expr1b are used as a Number. |
Bram Moolenaar | e3c37d8 | 2020-08-15 18:39:05 +0200 | [diff] [blame] | 1275 | |
| 1276 | In legacy Vim script the indexes are byte indexes. This doesn't recognize |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1277 | multibyte encodings, see |byteidx()| for computing the indexes. If expr9 is |
Bram Moolenaar | e3c37d8 | 2020-08-15 18:39:05 +0200 | [diff] [blame] | 1278 | a Number it is first converted to a String. |
| 1279 | |
Bram Moolenaar | 02b4d9b | 2021-03-14 19:46:45 +0100 | [diff] [blame] | 1280 | In Vim9 script the indexes are character indexes and include composing |
| 1281 | characters. To use byte indexes use |strpart()|. To use character indexes |
| 1282 | without including composing characters use |strcharpart()|. |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1283 | |
Bram Moolenaar | 6601b62 | 2021-01-13 21:47:15 +0100 | [diff] [blame] | 1284 | The item at index expr1b is included, it is inclusive. For an exclusive index |
| 1285 | use the |slice()| function. |
| 1286 | |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1287 | If expr1a is omitted zero is used. If expr1b is omitted the length of the |
| 1288 | string minus one is used. |
| 1289 | |
| 1290 | A negative number can be used to measure from the end of the string. -1 is |
| 1291 | the last character, -2 the last but one, etc. |
| 1292 | |
| 1293 | If an index goes out of range for the string characters are omitted. If |
| 1294 | expr1b is smaller than expr1a the result is an empty string. |
| 1295 | |
| 1296 | Examples: > |
| 1297 | :let c = name[-1:] " last byte of a string |
Bram Moolenaar | 207f009 | 2020-08-30 17:20:20 +0200 | [diff] [blame] | 1298 | :let c = name[0:-1] " the whole string |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1299 | :let c = name[-2:-2] " last but one byte of a string |
| 1300 | :let s = line(".")[4:] " from the fifth byte to the end |
| 1301 | :let s = s[:-3] " remove last two bytes |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1302 | < |
Bram Moolenaar | bc8801c | 2016-08-02 21:04:33 +0200 | [diff] [blame] | 1303 | *slice* |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1304 | If expr9 is a |List| this results in a new |List| with the items indicated by |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1305 | the indexes expr1a and expr1b. This works like with a String, as explained |
Bram Moolenaar | bc8801c | 2016-08-02 21:04:33 +0200 | [diff] [blame] | 1306 | just above. Also see |sublist| below. Examples: > |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 1307 | :let l = mylist[:3] " first four items |
| 1308 | :let l = mylist[4:4] " List with one item |
| 1309 | :let l = mylist[:] " shallow copy of a List |
| 1310 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1311 | If expr9 is a |Blob| this results in a new |Blob| with the bytes in the |
Bram Moolenaar | 6e5ea8d | 2019-01-12 22:47:31 +0100 | [diff] [blame] | 1312 | indexes expr1a and expr1b, inclusive. Examples: > |
| 1313 | :let b = 0zDEADBEEF |
| 1314 | :let bs = b[1:2] " 0zADBE |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 1315 | :let bs = b[:] " copy of 0zDEADBEEF |
Bram Moolenaar | 6e5ea8d | 2019-01-12 22:47:31 +0100 | [diff] [blame] | 1316 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1317 | Using expr9[expr1] or expr9[expr1a : expr1b] on a |Funcref| results in an |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 1318 | error. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1319 | |
Bram Moolenaar | da440d2 | 2016-01-16 21:27:23 +0100 | [diff] [blame] | 1320 | Watch out for confusion between a namespace and a variable followed by a colon |
| 1321 | for a sublist: > |
| 1322 | mylist[n:] " uses variable n |
| 1323 | mylist[s:] " uses namespace s:, error! |
| 1324 | |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 1325 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1326 | expr9.name entry in a |Dictionary| *expr-entry* |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 1327 | *E1203* *E1229* |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1328 | If expr9 is a |Dictionary| and it is followed by a dot, then the following |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 1329 | name will be used as a key in the |Dictionary|. This is just like: |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1330 | expr9[name]. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 1331 | |
| 1332 | The name must consist of alphanumeric characters, just like a variable name, |
| 1333 | but it may start with a number. Curly braces cannot be used. |
| 1334 | |
| 1335 | There must not be white space before or after the dot. |
| 1336 | |
| 1337 | Examples: > |
| 1338 | :let dict = {"one": 1, 2: "two"} |
Bram Moolenaar | 68e6560 | 2019-05-26 21:33:31 +0200 | [diff] [blame] | 1339 | :echo dict.one " shows "1" |
| 1340 | :echo dict.2 " shows "two" |
| 1341 | :echo dict .2 " error because of space before the dot |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 1342 | |
| 1343 | Note that the dot is also used for String concatenation. To avoid confusion |
| 1344 | always put spaces around the dot for String concatenation. |
| 1345 | |
| 1346 | |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 1347 | expr9(expr1, ...) |Funcref| function call *E1085* |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 1348 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1349 | When expr9 is a |Funcref| type variable, invoke the function it refers to. |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 1350 | |
| 1351 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1352 | expr9->name([args]) method call *method* *->* |
| 1353 | expr9->{lambda}([args]) |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 1354 | *E260* *E276* *E1265* |
Bram Moolenaar | 25e4223 | 2019-08-04 15:04:10 +0200 | [diff] [blame] | 1355 | For methods that are also available as global functions this is the same as: > |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1356 | name(expr9 [, args]) |
| 1357 | There can also be methods specifically for the type of "expr9". |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 1358 | |
Bram Moolenaar | 5184132 | 2019-08-08 21:10:01 +0200 | [diff] [blame] | 1359 | This allows for chaining, passing the value that one method returns to the |
| 1360 | next method: > |
Bram Moolenaar | 25e4223 | 2019-08-04 15:04:10 +0200 | [diff] [blame] | 1361 | mylist->filter(filterexpr)->map(mapexpr)->sort()->join() |
| 1362 | < |
Bram Moolenaar | 22a0c0c | 2019-08-09 23:25:08 +0200 | [diff] [blame] | 1363 | Example of using a lambda: > |
Bram Moolenaar | 02b3111 | 2019-08-31 22:16:38 +0200 | [diff] [blame] | 1364 | GetPercentage()->{x -> x * 100}()->printf('%d%%') |
Bram Moolenaar | 56c860c | 2019-08-17 20:09:31 +0200 | [diff] [blame] | 1365 | < |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1366 | When using -> the |expr8| operators will be applied first, thus: > |
Bram Moolenaar | 93cf85f | 2019-08-17 21:36:28 +0200 | [diff] [blame] | 1367 | -1.234->string() |
| 1368 | Is equivalent to: > |
| 1369 | (-1.234)->string() |
| 1370 | And NOT: > |
| 1371 | -(1.234->string()) |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1372 | |
| 1373 | What comes after "->" can be a name, a simple expression (not containing any |
Bram Moolenaar | 944697a | 2022-02-20 19:48:20 +0000 | [diff] [blame] | 1374 | parenthesis), or any expression in parentheses: > |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1375 | base->name(args) |
| 1376 | base->some.name(args) |
| 1377 | base->alist[idx](args) |
| 1378 | base->(getFuncRef())(args) |
| 1379 | Note that in the last call the base is passed to the function resulting from |
| 1380 | "(getFuncRef())", inserted before "args". |
| 1381 | |
Bram Moolenaar | 5184132 | 2019-08-08 21:10:01 +0200 | [diff] [blame] | 1382 | *E274* |
| 1383 | "->name(" must not contain white space. There can be white space before the |
| 1384 | "->" and after the "(", thus you can split the lines like this: > |
| 1385 | mylist |
| 1386 | \ ->filter(filterexpr) |
| 1387 | \ ->map(mapexpr) |
| 1388 | \ ->sort() |
| 1389 | \ ->join() |
Bram Moolenaar | 56c860c | 2019-08-17 20:09:31 +0200 | [diff] [blame] | 1390 | |
| 1391 | When using the lambda form there must be no white space between the } and the |
| 1392 | (. |
| 1393 | |
Bram Moolenaar | 25e4223 | 2019-08-04 15:04:10 +0200 | [diff] [blame] | 1394 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1395 | *expr10* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1396 | number |
| 1397 | ------ |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 1398 | number number constant *expr-number* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1399 | |
Bram Moolenaar | 6f02b00 | 2021-01-10 20:22:54 +0100 | [diff] [blame] | 1400 | *0x* *hex-number* *0o* *octal-number* *binary-number* |
Bram Moolenaar | 7571d55 | 2016-08-18 22:54:46 +0200 | [diff] [blame] | 1401 | Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B) |
Bram Moolenaar | c17e66c | 2020-06-02 21:38:22 +0200 | [diff] [blame] | 1402 | and Octal (starting with 0, 0o or 0O). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1403 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1404 | *floating-point-format* |
| 1405 | Floating point numbers can be written in two forms: |
| 1406 | |
| 1407 | [-+]{N}.{M} |
Bram Moolenaar | 8a94d87 | 2015-01-25 13:02:57 +0100 | [diff] [blame] | 1408 | [-+]{N}.{M}[eE][-+]{exp} |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1409 | |
| 1410 | {N} and {M} are numbers. Both {N} and {M} must be present and can only |
Bram Moolenaar | 6aa5729 | 2021-08-14 21:25:52 +0200 | [diff] [blame] | 1411 | contain digits, except that in |Vim9| script in {N} single quotes between |
| 1412 | digits are ignored. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1413 | [-+] means there is an optional plus or minus sign. |
| 1414 | {exp} is the exponent, power of 10. |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1415 | Only a decimal point is accepted, not a comma. No matter what the current |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1416 | locale is. |
| 1417 | {only when compiled with the |+float| feature} |
| 1418 | |
| 1419 | Examples: |
| 1420 | 123.456 |
| 1421 | +0.0001 |
| 1422 | 55.0 |
| 1423 | -0.123 |
| 1424 | 1.234e03 |
| 1425 | 1.0E-6 |
| 1426 | -3.1416e+88 |
| 1427 | |
| 1428 | These are INVALID: |
| 1429 | 3. empty {M} |
| 1430 | 1e40 missing .{M} |
| 1431 | |
| 1432 | Rationale: |
| 1433 | Before floating point was introduced, the text "123.456" was interpreted as |
| 1434 | the two numbers "123" and "456", both converted to a string and concatenated, |
| 1435 | resulting in the string "123456". Since this was considered pointless, and we |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 1436 | could not find it intentionally being used in Vim scripts, this backwards |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1437 | incompatibility was accepted in favor of being able to use the normal notation |
| 1438 | for floating point numbers. |
| 1439 | |
Bram Moolenaar | d47d522 | 2018-12-09 20:43:55 +0100 | [diff] [blame] | 1440 | *float-pi* *float-e* |
| 1441 | A few useful values to copy&paste: > |
| 1442 | :let pi = 3.14159265359 |
| 1443 | :let e = 2.71828182846 |
| 1444 | Or, if you don't want to write them in as floating-point literals, you can |
| 1445 | also use functions, like the following: > |
| 1446 | :let pi = acos(-1.0) |
| 1447 | :let e = exp(1.0) |
Bram Moolenaar | 98aefe7 | 2018-12-13 22:20:09 +0100 | [diff] [blame] | 1448 | < |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1449 | *floating-point-precision* |
| 1450 | The precision and range of floating points numbers depends on what "double" |
| 1451 | means in the library Vim was compiled with. There is no way to change this at |
| 1452 | runtime. |
| 1453 | |
| 1454 | The default for displaying a |Float| is to use 6 decimal places, like using |
| 1455 | printf("%g", f). You can select something else when using the |printf()| |
| 1456 | function. Example: > |
| 1457 | :echo printf('%.15e', atan(1)) |
| 1458 | < 7.853981633974483e-01 |
| 1459 | |
| 1460 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1461 | |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 1462 | string *string* *String* *expr-string* *E114* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1463 | ------ |
| 1464 | "string" string constant *expr-quote* |
| 1465 | |
| 1466 | Note that double quotes are used. |
| 1467 | |
| 1468 | A string constant accepts these special characters: |
| 1469 | \... three-digit octal number (e.g., "\316") |
| 1470 | \.. two-digit octal number (must be followed by non-digit) |
| 1471 | \. one-digit octal number (must be followed by non-digit) |
| 1472 | \x.. byte specified with two hex numbers (e.g., "\x1f") |
| 1473 | \x. byte specified with one hex number (must be followed by non-hex char) |
| 1474 | \X.. same as \x.. |
| 1475 | \X. same as \x. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1476 | \u.... character specified with up to 4 hex numbers, stored according to the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1477 | current value of 'encoding' (e.g., "\u02a4") |
Bram Moolenaar | 541f92d | 2015-06-19 13:27:23 +0200 | [diff] [blame] | 1478 | \U.... same as \u but allows up to 8 hex numbers. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1479 | \b backspace <BS> |
| 1480 | \e escape <Esc> |
Bram Moolenaar | 6e64922 | 2021-10-04 21:32:54 +0100 | [diff] [blame] | 1481 | \f formfeed 0x0C |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1482 | \n newline <NL> |
| 1483 | \r return <CR> |
| 1484 | \t tab <Tab> |
| 1485 | \\ backslash |
| 1486 | \" double quote |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 1487 | \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1488 | in mappings, the 0x80 byte is escaped. |
| 1489 | To use the double quote character it must be escaped: "<M-\">". |
Bram Moolenaar | 6e64922 | 2021-10-04 21:32:54 +0100 | [diff] [blame] | 1490 | Don't use <Char-xxxx> to get a UTF-8 character, use \uxxxx as |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1491 | mentioned above. |
Bram Moolenaar | fccd93f | 2020-05-31 22:06:51 +0200 | [diff] [blame] | 1492 | \<*xxx> Like \<xxx> but prepends a modifier instead of including it in the |
| 1493 | character. E.g. "\<C-w>" is one character 0x17 while "\<*C-w>" is four |
Bram Moolenaar | ebe9d34 | 2020-05-30 21:52:54 +0200 | [diff] [blame] | 1494 | bytes: 3 for the CTRL modifier and then character "W". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1495 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 1496 | Note that "\xff" is stored as the byte 255, which may be invalid in some |
| 1497 | encodings. Use "\u00ff" to store character 255 according to the current value |
| 1498 | of 'encoding'. |
| 1499 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1500 | Note that "\000" and "\x00" force the end of the string. |
| 1501 | |
| 1502 | |
Bram Moolenaar | d896824 | 2019-01-15 22:51:57 +0100 | [diff] [blame] | 1503 | blob-literal *blob-literal* *E973* |
Bram Moolenaar | 6e5ea8d | 2019-01-12 22:47:31 +0100 | [diff] [blame] | 1504 | ------------ |
| 1505 | |
| 1506 | Hexadecimal starting with 0z or 0Z, with an arbitrary number of bytes. |
| 1507 | The sequence must be an even number of hex characters. Example: > |
| 1508 | :let b = 0zFF00ED015DAF |
| 1509 | |
| 1510 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1511 | literal-string *literal-string* *E115* |
| 1512 | --------------- |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 1513 | 'string' string constant *expr-'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1514 | |
| 1515 | Note that single quotes are used. |
| 1516 | |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1517 | This string is taken as it is. No backslashes are removed or have a special |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 1518 | meaning. The only exception is that two quotes stand for one quote. |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 1519 | |
| 1520 | Single quoted strings are useful for patterns, so that backslashes do not need |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1521 | to be doubled. These two commands are equivalent: > |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 1522 | if a =~ "\\s*" |
| 1523 | if a =~ '\s*' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1524 | |
| 1525 | |
| 1526 | option *expr-option* *E112* *E113* |
| 1527 | ------ |
| 1528 | &option option value, local value if possible |
| 1529 | &g:option global option value |
| 1530 | &l:option local option value |
| 1531 | |
| 1532 | Examples: > |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 1533 | echo "tabstop is " .. &tabstop |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1534 | if &insertmode |
| 1535 | |
| 1536 | Any option name can be used here. See |options|. When using the local value |
| 1537 | and there is no buffer-local or window-local value, the global value is used |
| 1538 | anyway. |
| 1539 | |
| 1540 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 1541 | register *expr-register* *@r* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1542 | -------- |
| 1543 | @r contents of register 'r' |
| 1544 | |
| 1545 | The result is the contents of the named register, as a single string. |
| 1546 | Newlines are inserted where required. To get the contents of the unnamed |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1547 | register use @" or @@. See |registers| for an explanation of the available |
Bram Moolenaar | e756604 | 2005-06-17 22:00:15 +0000 | [diff] [blame] | 1548 | registers. |
| 1549 | |
| 1550 | When using the '=' register you get the expression itself, not what it |
| 1551 | evaluates to. Use |eval()| to evaluate it. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1552 | |
| 1553 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 1554 | nesting *expr-nesting* *E110* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1555 | ------- |
| 1556 | (expr1) nested expression |
| 1557 | |
| 1558 | |
| 1559 | environment variable *expr-env* |
| 1560 | -------------------- |
| 1561 | $VAR environment variable |
| 1562 | |
| 1563 | The String value of any environment variable. When it is not defined, the |
| 1564 | result is an empty string. |
Bram Moolenaar | 691ddee | 2019-05-09 14:52:41 +0200 | [diff] [blame] | 1565 | |
| 1566 | The functions `getenv()` and `setenv()` can also be used and work for |
| 1567 | environment variables with non-alphanumeric names. |
| 1568 | The function `environ()` can be used to get a Dict with all environment |
| 1569 | variables. |
| 1570 | |
| 1571 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1572 | *expr-env-expand* |
| 1573 | Note that there is a difference between using $VAR directly and using |
| 1574 | expand("$VAR"). Using it directly will only expand environment variables that |
| 1575 | are known inside the current Vim session. Using expand() will first try using |
| 1576 | the environment variables known inside the current Vim session. If that |
| 1577 | fails, a shell will be used to expand the variable. This can be slow, but it |
| 1578 | does expand all variables that the shell knows about. Example: > |
Bram Moolenaar | 34401cc | 2014-08-29 15:12:19 +0200 | [diff] [blame] | 1579 | :echo $shell |
| 1580 | :echo expand("$shell") |
| 1581 | The first one probably doesn't echo anything, the second echoes the $shell |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1582 | variable (if your shell supports it). |
| 1583 | |
| 1584 | |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 1585 | internal variable *expr-variable* *E1015* *E1089* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1586 | ----------------- |
| 1587 | variable internal variable |
| 1588 | See below |internal-variables|. |
| 1589 | |
| 1590 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 1591 | function call *expr-function* *E116* *E118* *E119* *E120* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1592 | ------------- |
| 1593 | function(expr1, ...) function call |
| 1594 | See below |functions|. |
| 1595 | |
| 1596 | |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 1597 | lambda expression *expr-lambda* *lambda* |
| 1598 | ----------------- |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 1599 | {args -> expr1} legacy lambda expression *E451* |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1600 | (args) => expr1 |Vim9| lambda expression |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 1601 | |
| 1602 | A lambda expression creates a new unnamed function which returns the result of |
Bram Moolenaar | 42ebd06 | 2016-07-17 13:35:14 +0200 | [diff] [blame] | 1603 | evaluating |expr1|. Lambda expressions differ from |user-functions| in |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 1604 | the following ways: |
| 1605 | |
| 1606 | 1. The body of the lambda expression is an |expr1| and not a sequence of |Ex| |
| 1607 | commands. |
Bram Moolenaar | 1e96d9b | 2016-07-29 22:15:09 +0200 | [diff] [blame] | 1608 | 2. The prefix "a:" should not be used for arguments. E.g.: > |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 1609 | :let F = {arg1, arg2 -> arg1 - arg2} |
| 1610 | :echo F(5, 2) |
| 1611 | < 3 |
| 1612 | |
| 1613 | The arguments are optional. Example: > |
| 1614 | :let F = {-> 'error function'} |
Bram Moolenaar | 130cbfc | 2021-04-07 21:07:20 +0200 | [diff] [blame] | 1615 | :echo F('ignored') |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 1616 | < error function |
Bram Moolenaar | 130cbfc | 2021-04-07 21:07:20 +0200 | [diff] [blame] | 1617 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1618 | The |Vim9| lambda does not only use a different syntax, it also adds type |
| 1619 | checking and can be split over multiple lines, see |vim9-lambda|. |
Bram Moolenaar | 130cbfc | 2021-04-07 21:07:20 +0200 | [diff] [blame] | 1620 | |
Bram Moolenaar | 1e96d9b | 2016-07-29 22:15:09 +0200 | [diff] [blame] | 1621 | *closure* |
| 1622 | Lambda expressions can access outer scope variables and arguments. This is |
Bram Moolenaar | 50ba526 | 2016-09-22 22:33:02 +0200 | [diff] [blame] | 1623 | often called a closure. Example where "i" and "a:arg" are used in a lambda |
Bram Moolenaar | 6bb2cdf | 2018-02-24 19:53:53 +0100 | [diff] [blame] | 1624 | while they already exist in the function scope. They remain valid even after |
| 1625 | the function returns: > |
Bram Moolenaar | 1e96d9b | 2016-07-29 22:15:09 +0200 | [diff] [blame] | 1626 | :function Foo(arg) |
| 1627 | : let i = 3 |
| 1628 | : return {x -> x + i - a:arg} |
| 1629 | :endfunction |
| 1630 | :let Bar = Foo(4) |
| 1631 | :echo Bar(6) |
| 1632 | < 5 |
Bram Moolenaar | 437bafe | 2016-08-01 15:40:54 +0200 | [diff] [blame] | 1633 | |
Bram Moolenaar | 388a5d4 | 2020-05-26 21:20:45 +0200 | [diff] [blame] | 1634 | Note that the variables must exist in the outer scope before the lambda is |
Bram Moolenaar | 6bb2cdf | 2018-02-24 19:53:53 +0100 | [diff] [blame] | 1635 | defined for this to work. See also |:func-closure|. |
| 1636 | |
| 1637 | Lambda and closure support can be checked with: > |
Bram Moolenaar | 437bafe | 2016-08-01 15:40:54 +0200 | [diff] [blame] | 1638 | if has('lambda') |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 1639 | |
| 1640 | Examples for using a lambda expression with |sort()|, |map()| and |filter()|: > |
| 1641 | :echo map([1, 2, 3], {idx, val -> val + 1}) |
| 1642 | < [2, 3, 4] > |
| 1643 | :echo sort([3,7,2,1,4], {a, b -> a - b}) |
| 1644 | < [1, 2, 3, 4, 7] |
| 1645 | |
| 1646 | The lambda expression is also useful for Channel, Job and timer: > |
| 1647 | :let timer = timer_start(500, |
| 1648 | \ {-> execute("echo 'Handler called'", "")}, |
| 1649 | \ {'repeat': 3}) |
| 1650 | < Handler called |
| 1651 | Handler called |
| 1652 | Handler called |
| 1653 | |
Bram Moolenaar | 90df4b9 | 2021-07-07 20:26:08 +0200 | [diff] [blame] | 1654 | Note that it is possible to cause memory to be used and not freed if the |
| 1655 | closure is referenced by the context it depends on: > |
| 1656 | function Function() |
| 1657 | let x = 0 |
| 1658 | let F = {-> x} |
| 1659 | endfunction |
| 1660 | The closure uses "x" from the function scope, and "F" in that same scope |
| 1661 | refers to the closure. This cycle results in the memory not being freed. |
| 1662 | Recommendation: don't do this. |
| 1663 | |
| 1664 | Notice how execute() is used to execute an Ex command. That's ugly though. |
Bram Moolenaar | 130cbfc | 2021-04-07 21:07:20 +0200 | [diff] [blame] | 1665 | In Vim9 script you can use a command block, see |inline-function|. |
Bram Moolenaar | 1e96d9b | 2016-07-29 22:15:09 +0200 | [diff] [blame] | 1666 | |
| 1667 | Lambda expressions have internal names like '<lambda>42'. If you get an error |
| 1668 | for a lambda expression, you can find what it is with the following command: > |
Bram Moolenaar | 6f02b00 | 2021-01-10 20:22:54 +0100 | [diff] [blame] | 1669 | :function <lambda>42 |
Bram Moolenaar | 1e96d9b | 2016-07-29 22:15:09 +0200 | [diff] [blame] | 1670 | See also: |numbered-function| |
| 1671 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1672 | ============================================================================== |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1673 | 3. Internal variable *internal-variables* *E461* *E1001* |
Bram Moolenaar | 4a74803 | 2010-09-30 21:47:56 +0200 | [diff] [blame] | 1674 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1675 | An internal variable name can be made up of letters, digits and '_'. But it |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 1676 | cannot start with a digit. In legacy script it is also possible to use curly |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1677 | braces, see |curly-braces-names|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1678 | |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 1679 | In legacy script an internal variable is created with the ":let" command |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1680 | |:let|. An internal variable is explicitly destroyed with the ":unlet" |
| 1681 | command |:unlet|. |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 1682 | Using a name that is not an internal variable or refers to a variable that has |
| 1683 | been destroyed results in an error. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1684 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1685 | In |Vim9| script `:let` is not used and variables work differently, see |:var|. |
| 1686 | |
Bram Moolenaar | 65e0d77 | 2020-06-14 17:29:55 +0200 | [diff] [blame] | 1687 | *variable-scope* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1688 | There are several name spaces for variables. Which one is to be used is |
| 1689 | specified by what is prepended: |
| 1690 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1691 | (nothing) In a function: local to the function; |
| 1692 | in a legacy script: global; |
| 1693 | in a |Vim9| script: local to the script |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1694 | |buffer-variable| b: Local to the current buffer. |
| 1695 | |window-variable| w: Local to the current window. |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 1696 | |tabpage-variable| t: Local to the current tab page. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1697 | |global-variable| g: Global. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1698 | |local-variable| l: Local to a function (only in a legacy function) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1699 | |script-variable| s: Local to a |:source|'ed Vim script. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1700 | |function-argument| a: Function argument (only in a legacy function). |
Bram Moolenaar | 75b8156 | 2014-04-06 14:09:13 +0200 | [diff] [blame] | 1701 | |vim-variable| v: Global, predefined by Vim. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1702 | |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 1703 | The scope name by itself can be used as a |Dictionary|. For example, to |
| 1704 | delete all script-local variables: > |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 1705 | :for k in keys(s:) |
| 1706 | : unlet s:[k] |
| 1707 | :endfor |
Bram Moolenaar | 65e0d77 | 2020-06-14 17:29:55 +0200 | [diff] [blame] | 1708 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 1709 | Note: in Vim9 script variables can also be local to a block of commands, see |
| 1710 | |vim9-scopes|. |
Bram Moolenaar | 531da59 | 2013-05-06 05:58:55 +0200 | [diff] [blame] | 1711 | *buffer-variable* *b:var* *b:* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1712 | A variable name that is preceded with "b:" is local to the current buffer. |
| 1713 | Thus you can have several "b:foo" variables, one for each buffer. |
| 1714 | This kind of variable is deleted when the buffer is wiped out or deleted with |
| 1715 | |:bdelete|. |
| 1716 | |
| 1717 | One local buffer variable is predefined: |
Bram Moolenaar | bf88493 | 2013-04-05 22:26:15 +0200 | [diff] [blame] | 1718 | *b:changedtick* *changetick* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1719 | b:changedtick The total number of changes to the current buffer. It is |
| 1720 | incremented for each change. An undo command is also a change |
Bram Moolenaar | c024b46 | 2019-06-08 18:07:21 +0200 | [diff] [blame] | 1721 | in this case. Resetting 'modified' when writing the buffer is |
| 1722 | also counted. |
| 1723 | This can be used to perform an action only when the buffer has |
| 1724 | changed. Example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1725 | :if my_changedtick != b:changedtick |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1726 | : let my_changedtick = b:changedtick |
| 1727 | : call My_Update() |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1728 | :endif |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 1729 | < You cannot change or delete the b:changedtick variable. |
| 1730 | |
Bram Moolenaar | 531da59 | 2013-05-06 05:58:55 +0200 | [diff] [blame] | 1731 | *window-variable* *w:var* *w:* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1732 | A variable name that is preceded with "w:" is local to the current window. It |
| 1733 | is deleted when the window is closed. |
| 1734 | |
Bram Moolenaar | ad3b366 | 2013-05-17 18:14:19 +0200 | [diff] [blame] | 1735 | *tabpage-variable* *t:var* *t:* |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 1736 | A variable name that is preceded with "t:" is local to the current tab page, |
| 1737 | It is deleted when the tab page is closed. {not available when compiled |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 1738 | without the |+windows| feature} |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 1739 | |
Bram Moolenaar | 531da59 | 2013-05-06 05:58:55 +0200 | [diff] [blame] | 1740 | *global-variable* *g:var* *g:* |
Bram Moolenaar | 04fb916 | 2021-12-30 20:24:12 +0000 | [diff] [blame] | 1741 | Inside functions and in |Vim9| script global variables are accessed with "g:". |
| 1742 | Omitting this will access a variable local to a function or script. "g:" |
| 1743 | can also be used in any other place if you like. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1744 | |
Bram Moolenaar | 531da59 | 2013-05-06 05:58:55 +0200 | [diff] [blame] | 1745 | *local-variable* *l:var* *l:* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1746 | Inside functions local variables are accessed without prepending anything. |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 1747 | But you can also prepend "l:" if you like. However, without prepending "l:" |
| 1748 | you may run into reserved variable names. For example "count". By itself it |
| 1749 | refers to "v:count". Using "l:count" you can have a local variable with the |
| 1750 | same name. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1751 | |
| 1752 | *script-variable* *s:var* |
Bram Moolenaar | 04fb916 | 2021-12-30 20:24:12 +0000 | [diff] [blame] | 1753 | In a legacy Vim script variables starting with "s:" can be used. They cannot |
| 1754 | be accessed from outside of the scripts, thus are local to the script. |
| 1755 | In |Vim9| script the "s:" prefix can be omitted, variables are script-local by |
| 1756 | default. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1757 | |
| 1758 | They can be used in: |
| 1759 | - commands executed while the script is sourced |
| 1760 | - functions defined in the script |
| 1761 | - autocommands defined in the script |
| 1762 | - functions and autocommands defined in functions and autocommands which were |
| 1763 | defined in the script (recursively) |
| 1764 | - user defined commands defined in the script |
| 1765 | Thus not in: |
| 1766 | - other scripts sourced from this one |
| 1767 | - mappings |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1768 | - menus |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1769 | - etc. |
| 1770 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 1771 | Script variables can be used to avoid conflicts with global variable names. |
| 1772 | Take this example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1773 | |
| 1774 | let s:counter = 0 |
| 1775 | function MyCounter() |
| 1776 | let s:counter = s:counter + 1 |
| 1777 | echo s:counter |
| 1778 | endfunction |
| 1779 | command Tick call MyCounter() |
| 1780 | |
| 1781 | You can now invoke "Tick" from any script, and the "s:counter" variable in |
| 1782 | that script will not be changed, only the "s:counter" in the script where |
| 1783 | "Tick" was defined is used. |
| 1784 | |
| 1785 | Another example that does the same: > |
| 1786 | |
| 1787 | let s:counter = 0 |
| 1788 | command Tick let s:counter = s:counter + 1 | echo s:counter |
| 1789 | |
| 1790 | When calling a function and invoking a user-defined command, the context for |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 1791 | script variables is set to the script where the function or command was |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1792 | defined. |
| 1793 | |
| 1794 | The script variables are also available when a function is defined inside a |
| 1795 | function that is defined in a script. Example: > |
| 1796 | |
| 1797 | let s:counter = 0 |
| 1798 | function StartCounting(incr) |
| 1799 | if a:incr |
| 1800 | function MyCounter() |
| 1801 | let s:counter = s:counter + 1 |
| 1802 | endfunction |
| 1803 | else |
| 1804 | function MyCounter() |
| 1805 | let s:counter = s:counter - 1 |
| 1806 | endfunction |
| 1807 | endif |
| 1808 | endfunction |
| 1809 | |
| 1810 | This defines the MyCounter() function either for counting up or counting down |
| 1811 | when calling StartCounting(). It doesn't matter from where StartCounting() is |
| 1812 | called, the s:counter variable will be accessible in MyCounter(). |
| 1813 | |
| 1814 | When the same script is sourced again it will use the same script variables. |
| 1815 | They will remain valid as long as Vim is running. This can be used to |
| 1816 | maintain a counter: > |
| 1817 | |
| 1818 | if !exists("s:counter") |
| 1819 | let s:counter = 1 |
| 1820 | echo "script executed for the first time" |
| 1821 | else |
| 1822 | let s:counter = s:counter + 1 |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 1823 | echo "script executed " .. s:counter .. " times now" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1824 | endif |
| 1825 | |
| 1826 | Note that this means that filetype plugins don't get a different set of script |
| 1827 | variables for each buffer. Use local buffer variables instead |b:var|. |
| 1828 | |
| 1829 | |
Bram Moolenaar | d47d522 | 2018-12-09 20:43:55 +0100 | [diff] [blame] | 1830 | PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:* |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 1831 | *E963* *E1063* |
Bram Moolenaar | d47d522 | 2018-12-09 20:43:55 +0100 | [diff] [blame] | 1832 | Some variables can be set by the user, but the type cannot be changed. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1833 | |
Bram Moolenaar | 69bf634 | 2019-10-29 04:16:57 +0100 | [diff] [blame] | 1834 | *v:argv* *argv-variable* |
| 1835 | v:argv The command line arguments Vim was invoked with. This is a |
| 1836 | list of strings. The first item is the Vim command. |
| 1837 | |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1838 | *v:beval_col* *beval_col-variable* |
| 1839 | v:beval_col The number of the column, over which the mouse pointer is. |
| 1840 | This is the byte index in the |v:beval_lnum| line. |
| 1841 | Only valid while evaluating the 'balloonexpr' option. |
| 1842 | |
| 1843 | *v:beval_bufnr* *beval_bufnr-variable* |
| 1844 | v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only |
| 1845 | valid while evaluating the 'balloonexpr' option. |
| 1846 | |
| 1847 | *v:beval_lnum* *beval_lnum-variable* |
| 1848 | v:beval_lnum The number of the line, over which the mouse pointer is. Only |
| 1849 | valid while evaluating the 'balloonexpr' option. |
| 1850 | |
| 1851 | *v:beval_text* *beval_text-variable* |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 1852 | v:beval_text The text under or after the mouse pointer. Usually a word as |
| 1853 | it is useful for debugging a C program. 'iskeyword' applies, |
| 1854 | but a dot and "->" before the position is included. When on a |
| 1855 | ']' the text before it is used, including the matching '[' and |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1856 | word before it. When on a Visual area within one line the |
Bram Moolenaar | b4d5fba | 2017-09-11 19:31:28 +0200 | [diff] [blame] | 1857 | highlighted text is used. Also see |<cexpr>|. |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1858 | Only valid while evaluating the 'balloonexpr' option. |
| 1859 | |
| 1860 | *v:beval_winnr* *beval_winnr-variable* |
| 1861 | v:beval_winnr The number of the window, over which the mouse pointer is. Only |
Bram Moolenaar | 0065402 | 2011-02-25 14:42:19 +0100 | [diff] [blame] | 1862 | valid while evaluating the 'balloonexpr' option. The first |
| 1863 | window has number zero (unlike most other places where a |
| 1864 | window gets a number). |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1865 | |
Bram Moolenaar | 511972d | 2016-06-04 18:09:59 +0200 | [diff] [blame] | 1866 | *v:beval_winid* *beval_winid-variable* |
Bram Moolenaar | 7571d55 | 2016-08-18 22:54:46 +0200 | [diff] [blame] | 1867 | v:beval_winid The |window-ID| of the window, over which the mouse pointer |
| 1868 | is. Otherwise like v:beval_winnr. |
Bram Moolenaar | 511972d | 2016-06-04 18:09:59 +0200 | [diff] [blame] | 1869 | |
Bram Moolenaar | f193fff | 2006-04-27 00:02:13 +0000 | [diff] [blame] | 1870 | *v:char* *char-variable* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1871 | v:char Argument for evaluating 'formatexpr' and used for the typed |
Bram Moolenaar | 945e2db | 2010-06-05 17:43:32 +0200 | [diff] [blame] | 1872 | character when using <expr> in an abbreviation |:map-<expr>|. |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 1873 | It is also used by the |InsertCharPre| and |InsertEnter| events. |
Bram Moolenaar | f193fff | 2006-04-27 00:02:13 +0000 | [diff] [blame] | 1874 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1875 | *v:charconvert_from* *charconvert_from-variable* |
| 1876 | v:charconvert_from |
| 1877 | The name of the character encoding of a file to be converted. |
| 1878 | Only valid while evaluating the 'charconvert' option. |
| 1879 | |
| 1880 | *v:charconvert_to* *charconvert_to-variable* |
| 1881 | v:charconvert_to |
| 1882 | The name of the character encoding of a file after conversion. |
| 1883 | Only valid while evaluating the 'charconvert' option. |
| 1884 | |
| 1885 | *v:cmdarg* *cmdarg-variable* |
| 1886 | v:cmdarg This variable is used for two purposes: |
| 1887 | 1. The extra arguments given to a file read/write command. |
| 1888 | Currently these are "++enc=" and "++ff=". This variable is |
| 1889 | set before an autocommand event for a file read/write |
| 1890 | command is triggered. There is a leading space to make it |
| 1891 | possible to append this variable directly after the |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1892 | read/write command. Note: The "+cmd" argument isn't |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1893 | included here, because it will be executed anyway. |
| 1894 | 2. When printing a PostScript file with ":hardcopy" this is |
| 1895 | the argument for the ":hardcopy" command. This can be used |
| 1896 | in 'printexpr'. |
| 1897 | |
| 1898 | *v:cmdbang* *cmdbang-variable* |
| 1899 | v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" |
| 1900 | was used the value is 1, otherwise it is 0. Note that this |
| 1901 | can only be used in autocommands. For user commands |<bang>| |
| 1902 | can be used. |
Bram Moolenaar | 84cf6bd | 2020-06-16 20:03:43 +0200 | [diff] [blame] | 1903 | *v:collate* *collate-variable* |
| 1904 | v:collate The current locale setting for collation order of the runtime |
| 1905 | environment. This allows Vim scripts to be aware of the |
| 1906 | current locale encoding. Technical: it's the value of |
| 1907 | LC_COLLATE. When not using a locale the value is "C". |
| 1908 | This variable can not be set directly, use the |:language| |
| 1909 | command. |
| 1910 | See |multi-lang|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1911 | |
Drew Vogel | e30d102 | 2021-10-24 20:35:07 +0100 | [diff] [blame] | 1912 | *v:colornames* |
| 1913 | v:colornames A dictionary that maps color names to hex color strings. These |
| 1914 | color names can be used with the |highlight-guifg|, |
| 1915 | |highlight-guibg|, and |highlight-guisp| parameters. Updating |
| 1916 | an entry in v:colornames has no immediate effect on the syntax |
| 1917 | highlighting. The highlight commands (probably in a |
| 1918 | colorscheme script) need to be re-evaluated in order to use |
| 1919 | the updated color values. For example: > |
| 1920 | |
| 1921 | :let v:colornames['fuscia'] = '#cf3ab4' |
| 1922 | :let v:colornames['mauve'] = '#915f6d' |
| 1923 | :highlight Normal guifg=fuscia guibg=mauve |
| 1924 | < |
| 1925 | This cannot be used to override the |cterm-colors| but it can |
| 1926 | be used to override other colors. For example, the X11 colors |
| 1927 | defined in the `colors/lists/default.vim` (previously defined |
| 1928 | in |rgb.txt|). When defining new color names in a plugin, the |
| 1929 | recommended practice is to set a color entry only when it does |
| 1930 | not already exist. For example: > |
| 1931 | |
| 1932 | :call extend(v:colornames, { |
| 1933 | \ 'fuscia': '#cf3ab4', |
| 1934 | \ 'mauve': '#915f6d, |
| 1935 | \ }, 'keep') |
| 1936 | < |
Bram Moolenaar | 113cb51 | 2021-11-07 20:27:04 +0000 | [diff] [blame] | 1937 | Using |extend()| with the 'keep' option updates each color only |
Drew Vogel | e30d102 | 2021-10-24 20:35:07 +0100 | [diff] [blame] | 1938 | if it did not exist in |v:colornames|. Doing so allows the |
| 1939 | user to choose the precise color value for a common name |
| 1940 | by setting it in their |.vimrc|. |
| 1941 | |
| 1942 | It is possible to remove entries from this dictionary but |
Drew Vogel | a0fca17 | 2021-11-13 10:50:01 +0000 | [diff] [blame] | 1943 | doing so is NOT recommended, because it is disruptive to |
Drew Vogel | e30d102 | 2021-10-24 20:35:07 +0100 | [diff] [blame] | 1944 | other scripts. It is also unlikely to achieve the desired |
Bram Moolenaar | 113cb51 | 2021-11-07 20:27:04 +0000 | [diff] [blame] | 1945 | result because the |:colorscheme| and |:highlight| commands will |
Drew Vogel | e30d102 | 2021-10-24 20:35:07 +0100 | [diff] [blame] | 1946 | both automatically load all `colors/lists/default.vim` color |
| 1947 | scripts. |
| 1948 | |
Bram Moolenaar | 42a4512 | 2015-07-10 17:56:23 +0200 | [diff] [blame] | 1949 | *v:completed_item* *completed_item-variable* |
| 1950 | v:completed_item |
| 1951 | |Dictionary| containing the |complete-items| for the most |
| 1952 | recently completed word after |CompleteDone|. The |
| 1953 | |Dictionary| is empty if the completion failed. |
| 1954 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1955 | *v:count* *count-variable* |
| 1956 | v:count The count given for the last Normal mode command. Can be used |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1957 | to get the count before a mapping. Read-only. Example: > |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 1958 | :map _x :<C-U>echo "the count is " .. v:count<CR> |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1959 | < Note: The <C-U> is required to remove the line range that you |
| 1960 | get when typing ':' after a count. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1961 | When there are two counts, as in "3d2w", they are multiplied, |
| 1962 | just like what happens in the command, "d6w" for the example. |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 1963 | Also used for evaluating the 'formatexpr' option. |
Bram Moolenaar | d2e716e | 2019-04-20 14:39:52 +0200 | [diff] [blame] | 1964 | "count" also works, for backwards compatibility, unless |
| 1965 | |scriptversion| is 3 or higher. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1966 | |
| 1967 | *v:count1* *count1-variable* |
| 1968 | v:count1 Just like "v:count", but defaults to one when no count is |
| 1969 | used. |
| 1970 | |
| 1971 | *v:ctype* *ctype-variable* |
| 1972 | v:ctype The current locale setting for characters of the runtime |
| 1973 | environment. This allows Vim scripts to be aware of the |
| 1974 | current locale encoding. Technical: it's the value of |
| 1975 | LC_CTYPE. When not using a locale the value is "C". |
| 1976 | This variable can not be set directly, use the |:language| |
| 1977 | command. |
| 1978 | See |multi-lang|. |
| 1979 | |
| 1980 | *v:dying* *dying-variable* |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 1981 | v:dying Normally zero. When a deadly signal is caught it's set to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1982 | one. When multiple signals are caught the number increases. |
| 1983 | Can be used in an autocommand to check if Vim didn't |
| 1984 | terminate normally. {only works on Unix} |
| 1985 | Example: > |
| 1986 | :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif |
Bram Moolenaar | 0e1e25f | 2010-05-28 21:07:08 +0200 | [diff] [blame] | 1987 | < Note: if another deadly signal is caught when v:dying is one, |
| 1988 | VimLeave autocommands will not be executed. |
| 1989 | |
Bram Moolenaar | f0068c5 | 2020-11-30 17:42:10 +0100 | [diff] [blame] | 1990 | *v:exiting* *exiting-variable* |
| 1991 | v:exiting Vim exit code. Normally zero, non-zero when something went |
| 1992 | wrong. The value is v:null before invoking the |VimLeavePre| |
| 1993 | and |VimLeave| autocmds. See |:q|, |:x| and |:cquit|. |
| 1994 | Example: > |
| 1995 | :au VimLeave * echo "Exit value is " .. v:exiting |
| 1996 | < |
Bram Moolenaar | 37f4cbd | 2019-08-23 20:58:45 +0200 | [diff] [blame] | 1997 | *v:echospace* *echospace-variable* |
| 1998 | v:echospace Number of screen cells that can be used for an `:echo` message |
| 1999 | in the last screen line before causing the |hit-enter-prompt|. |
| 2000 | Depends on 'showcmd', 'ruler' and 'columns'. You need to |
| 2001 | check 'cmdheight' for whether there are full-width lines |
| 2002 | available above the last line. |
| 2003 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2004 | *v:errmsg* *errmsg-variable* |
| 2005 | v:errmsg Last given error message. It's allowed to set this variable. |
| 2006 | Example: > |
| 2007 | :let v:errmsg = "" |
| 2008 | :silent! next |
| 2009 | :if v:errmsg != "" |
| 2010 | : ... handle error |
Bram Moolenaar | d2e716e | 2019-04-20 14:39:52 +0200 | [diff] [blame] | 2011 | < "errmsg" also works, for backwards compatibility, unless |
| 2012 | |scriptversion| is 3 or higher. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2013 | |
Bram Moolenaar | 65a5464 | 2018-04-28 16:56:53 +0200 | [diff] [blame] | 2014 | *v:errors* *errors-variable* *assert-return* |
Bram Moolenaar | 683fa18 | 2015-11-30 21:38:24 +0100 | [diff] [blame] | 2015 | v:errors Errors found by assert functions, such as |assert_true()|. |
Bram Moolenaar | 4334554 | 2015-11-29 17:35:35 +0100 | [diff] [blame] | 2016 | This is a list of strings. |
| 2017 | The assert functions append an item when an assert fails. |
Bram Moolenaar | 65a5464 | 2018-04-28 16:56:53 +0200 | [diff] [blame] | 2018 | The return value indicates this: a one is returned if an item |
| 2019 | was added to v:errors, otherwise zero is returned. |
Bram Moolenaar | 4334554 | 2015-11-29 17:35:35 +0100 | [diff] [blame] | 2020 | To remove old results make it empty: > |
| 2021 | :let v:errors = [] |
| 2022 | < If v:errors is set to anything but a list it is made an empty |
| 2023 | list by the assert function. |
| 2024 | |
Bram Moolenaar | 7e1652c | 2017-12-16 18:27:02 +0100 | [diff] [blame] | 2025 | *v:event* *event-variable* |
| 2026 | v:event Dictionary containing information about the current |
Bram Moolenaar | 560979e | 2020-02-04 22:53:05 +0100 | [diff] [blame] | 2027 | |autocommand|. See the specific event for what it puts in |
| 2028 | this dictionary. |
Bram Moolenaar | 2c7f8c5 | 2020-04-20 19:52:53 +0200 | [diff] [blame] | 2029 | The dictionary is emptied when the |autocommand| finishes, |
| 2030 | please refer to |dict-identity| for how to get an independent |
| 2031 | copy of it. Use |deepcopy()| if you want to keep the |
| 2032 | information after the event triggers. Example: > |
| 2033 | au TextYankPost * let g:foo = deepcopy(v:event) |
| 2034 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2035 | *v:exception* *exception-variable* |
| 2036 | v:exception The value of the exception most recently caught and not |
| 2037 | finished. See also |v:throwpoint| and |throw-variables|. |
| 2038 | Example: > |
| 2039 | :try |
| 2040 | : throw "oops" |
| 2041 | :catch /.*/ |
Bram Moolenaar | 5477506 | 2019-07-31 21:07:14 +0200 | [diff] [blame] | 2042 | : echo "caught " .. v:exception |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2043 | :endtry |
| 2044 | < Output: "caught oops". |
| 2045 | |
Bram Moolenaar | 520e1e4 | 2016-01-23 19:46:28 +0100 | [diff] [blame] | 2046 | *v:false* *false-variable* |
| 2047 | v:false A Number with value zero. Used to put "false" in JSON. See |
Bram Moolenaar | 6463ca2 | 2016-02-13 17:04:46 +0100 | [diff] [blame] | 2048 | |json_encode()|. |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2049 | When used as a string this evaluates to "v:false". > |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 2050 | echo v:false |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2051 | < v:false ~ |
| 2052 | That is so that eval() can parse the string back to the same |
Bram Moolenaar | df48fb4 | 2016-07-22 21:50:18 +0200 | [diff] [blame] | 2053 | value. Read-only. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 2054 | In |Vim9| script "false" can be used which has a boolean type. |
Bram Moolenaar | 520e1e4 | 2016-01-23 19:46:28 +0100 | [diff] [blame] | 2055 | |
Bram Moolenaar | 19a09a1 | 2005-03-04 23:39:37 +0000 | [diff] [blame] | 2056 | *v:fcs_reason* *fcs_reason-variable* |
| 2057 | v:fcs_reason The reason why the |FileChangedShell| event was triggered. |
| 2058 | Can be used in an autocommand to decide what to do and/or what |
| 2059 | to set v:fcs_choice to. Possible values: |
| 2060 | deleted file no longer exists |
| 2061 | conflict file contents, mode or timestamp was |
| 2062 | changed and buffer is modified |
| 2063 | changed file contents has changed |
| 2064 | mode mode of file changed |
| 2065 | time only file timestamp changed |
| 2066 | |
| 2067 | *v:fcs_choice* *fcs_choice-variable* |
| 2068 | v:fcs_choice What should happen after a |FileChangedShell| event was |
| 2069 | triggered. Can be used in an autocommand to tell Vim what to |
| 2070 | do with the affected buffer: |
| 2071 | reload Reload the buffer (does not work if |
| 2072 | the file was deleted). |
Rob Pilling | 8196e94 | 2022-02-11 15:12:10 +0000 | [diff] [blame] | 2073 | edit Reload the buffer and detect the |
| 2074 | values for options such as |
| 2075 | 'fileformat', 'fileencoding', 'binary' |
| 2076 | (does not work if the file was |
| 2077 | deleted). |
Bram Moolenaar | 19a09a1 | 2005-03-04 23:39:37 +0000 | [diff] [blame] | 2078 | ask Ask the user what to do, as if there |
| 2079 | was no autocommand. Except that when |
| 2080 | only the timestamp changed nothing |
| 2081 | will happen. |
| 2082 | <empty> Nothing, the autocommand should do |
| 2083 | everything that needs to be done. |
| 2084 | The default is empty. If another (invalid) value is used then |
| 2085 | Vim behaves like it is empty, there is no warning message. |
| 2086 | |
Bram Moolenaar | 4c29502 | 2021-05-02 17:19:11 +0200 | [diff] [blame] | 2087 | *v:fname* *fname-variable* |
Bram Moolenaar | 90df4b9 | 2021-07-07 20:26:08 +0200 | [diff] [blame] | 2088 | v:fname When evaluating 'includeexpr': the file name that was |
| 2089 | detected. Empty otherwise. |
Bram Moolenaar | 4c29502 | 2021-05-02 17:19:11 +0200 | [diff] [blame] | 2090 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2091 | *v:fname_in* *fname_in-variable* |
Bram Moolenaar | 4e330bb | 2005-12-07 21:04:31 +0000 | [diff] [blame] | 2092 | v:fname_in The name of the input file. Valid while evaluating: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2093 | option used for ~ |
| 2094 | 'charconvert' file to be converted |
| 2095 | 'diffexpr' original file |
| 2096 | 'patchexpr' original file |
| 2097 | 'printexpr' file to be printed |
Bram Moolenaar | 2c7a29c | 2005-12-12 22:02:31 +0000 | [diff] [blame] | 2098 | And set to the swap file name for |SwapExists|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2099 | |
| 2100 | *v:fname_out* *fname_out-variable* |
| 2101 | v:fname_out The name of the output file. Only valid while |
| 2102 | evaluating: |
| 2103 | option used for ~ |
| 2104 | 'charconvert' resulting converted file (*) |
| 2105 | 'diffexpr' output of diff |
| 2106 | 'patchexpr' resulting patched file |
| 2107 | (*) When doing conversion for a write command (e.g., ":w |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2108 | file") it will be equal to v:fname_in. When doing conversion |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2109 | for a read command (e.g., ":e file") it will be a temporary |
| 2110 | file and different from v:fname_in. |
| 2111 | |
| 2112 | *v:fname_new* *fname_new-variable* |
| 2113 | v:fname_new The name of the new version of the file. Only valid while |
| 2114 | evaluating 'diffexpr'. |
| 2115 | |
| 2116 | *v:fname_diff* *fname_diff-variable* |
| 2117 | v:fname_diff The name of the diff (patch) file. Only valid while |
| 2118 | evaluating 'patchexpr'. |
| 2119 | |
| 2120 | *v:folddashes* *folddashes-variable* |
| 2121 | v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed |
| 2122 | fold. |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 2123 | Read-only in the |sandbox|. |fold-foldtext| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2124 | |
| 2125 | *v:foldlevel* *foldlevel-variable* |
| 2126 | v:foldlevel Used for 'foldtext': foldlevel of closed fold. |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 2127 | Read-only in the |sandbox|. |fold-foldtext| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2128 | |
| 2129 | *v:foldend* *foldend-variable* |
| 2130 | v:foldend Used for 'foldtext': last line of closed fold. |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 2131 | Read-only in the |sandbox|. |fold-foldtext| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2132 | |
| 2133 | *v:foldstart* *foldstart-variable* |
| 2134 | v:foldstart Used for 'foldtext': first line of closed fold. |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 2135 | Read-only in the |sandbox|. |fold-foldtext| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2136 | |
Bram Moolenaar | 817a880 | 2013-11-09 01:44:43 +0100 | [diff] [blame] | 2137 | *v:hlsearch* *hlsearch-variable* |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 2138 | v:hlsearch Variable that indicates whether search highlighting is on. |
Bram Moolenaar | 76440e2 | 2014-11-27 19:14:49 +0100 | [diff] [blame] | 2139 | Setting it makes sense only if 'hlsearch' is enabled which |
| 2140 | requires |+extra_search|. Setting this variable to zero acts |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 2141 | like the |:nohlsearch| command, setting it to one acts like > |
Bram Moolenaar | 817a880 | 2013-11-09 01:44:43 +0100 | [diff] [blame] | 2142 | let &hlsearch = &hlsearch |
Bram Moolenaar | 86ae720 | 2015-07-10 19:31:35 +0200 | [diff] [blame] | 2143 | < Note that the value is restored when returning from a |
| 2144 | function. |function-search-undo|. |
| 2145 | |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 2146 | *v:insertmode* *insertmode-variable* |
| 2147 | v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand |
| 2148 | events. Values: |
| 2149 | i Insert mode |
| 2150 | r Replace mode |
| 2151 | v Virtual Replace mode |
| 2152 | |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 2153 | *v:key* *key-variable* |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 2154 | v:key Key of the current item of a |Dictionary|. Only valid while |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 2155 | evaluating the expression used with |map()| and |filter()|. |
| 2156 | Read-only. |
| 2157 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2158 | *v:lang* *lang-variable* |
| 2159 | v:lang The current locale setting for messages of the runtime |
| 2160 | environment. This allows Vim scripts to be aware of the |
| 2161 | current language. Technical: it's the value of LC_MESSAGES. |
| 2162 | The value is system dependent. |
| 2163 | This variable can not be set directly, use the |:language| |
| 2164 | command. |
| 2165 | It can be different from |v:ctype| when messages are desired |
| 2166 | in a different language than what is used for character |
| 2167 | encoding. See |multi-lang|. |
| 2168 | |
| 2169 | *v:lc_time* *lc_time-variable* |
| 2170 | v:lc_time The current locale setting for time messages of the runtime |
| 2171 | environment. This allows Vim scripts to be aware of the |
| 2172 | current language. Technical: it's the value of LC_TIME. |
| 2173 | This variable can not be set directly, use the |:language| |
| 2174 | command. See |multi-lang|. |
| 2175 | |
| 2176 | *v:lnum* *lnum-variable* |
Bram Moolenaar | 368373e | 2010-07-19 20:46:22 +0200 | [diff] [blame] | 2177 | v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr' and |
| 2178 | 'indentexpr' expressions, tab page number for 'guitablabel' |
| 2179 | and 'guitabtooltip'. Only valid while one of these |
| 2180 | expressions is being evaluated. Read-only when in the |
| 2181 | |sandbox|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2182 | |
naohiro ono | 56200ee | 2022-01-01 14:59:44 +0000 | [diff] [blame] | 2183 | *v:maxcol* *maxcol-variable* |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 2184 | v:maxcol Maximum line length. Depending on where it is used it can be |
Bram Moolenaar | 944697a | 2022-02-20 19:48:20 +0000 | [diff] [blame] | 2185 | screen columns, characters or bytes. The value currently is |
| 2186 | 2147483647 on all systems. |
naohiro ono | 56200ee | 2022-01-01 14:59:44 +0000 | [diff] [blame] | 2187 | |
Bram Moolenaar | 219b870 | 2006-11-01 14:32:36 +0000 | [diff] [blame] | 2188 | *v:mouse_win* *mouse_win-variable* |
| 2189 | v:mouse_win Window number for a mouse click obtained with |getchar()|. |
| 2190 | First window has number 1, like with |winnr()|. The value is |
| 2191 | zero when there was no mouse button click. |
| 2192 | |
Bram Moolenaar | 511972d | 2016-06-04 18:09:59 +0200 | [diff] [blame] | 2193 | *v:mouse_winid* *mouse_winid-variable* |
| 2194 | v:mouse_winid Window ID for a mouse click obtained with |getchar()|. |
| 2195 | The value is zero when there was no mouse button click. |
| 2196 | |
Bram Moolenaar | 219b870 | 2006-11-01 14:32:36 +0000 | [diff] [blame] | 2197 | *v:mouse_lnum* *mouse_lnum-variable* |
| 2198 | v:mouse_lnum Line number for a mouse click obtained with |getchar()|. |
| 2199 | This is the text line number, not the screen line number. The |
| 2200 | value is zero when there was no mouse button click. |
| 2201 | |
| 2202 | *v:mouse_col* *mouse_col-variable* |
| 2203 | v:mouse_col Column number for a mouse click obtained with |getchar()|. |
| 2204 | This is the screen column number, like with |virtcol()|. The |
| 2205 | value is zero when there was no mouse button click. |
| 2206 | |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2207 | *v:none* *none-variable* *None* |
Bram Moolenaar | 520e1e4 | 2016-01-23 19:46:28 +0100 | [diff] [blame] | 2208 | v:none An empty String. Used to put an empty item in JSON. See |
Bram Moolenaar | 6463ca2 | 2016-02-13 17:04:46 +0100 | [diff] [blame] | 2209 | |json_encode()|. |
Bram Moolenaar | 2547aa9 | 2020-07-26 17:00:44 +0200 | [diff] [blame] | 2210 | This can also be used as a function argument to use the |
| 2211 | default value, see |none-function_argument|. |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 2212 | When used as a number this evaluates to zero. |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2213 | When used as a string this evaluates to "v:none". > |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 2214 | echo v:none |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2215 | < v:none ~ |
| 2216 | That is so that eval() can parse the string back to the same |
Bram Moolenaar | df48fb4 | 2016-07-22 21:50:18 +0200 | [diff] [blame] | 2217 | value. Read-only. |
Bram Moolenaar | 520e1e4 | 2016-01-23 19:46:28 +0100 | [diff] [blame] | 2218 | |
| 2219 | *v:null* *null-variable* |
| 2220 | v:null An empty String. Used to put "null" in JSON. See |
Bram Moolenaar | 6463ca2 | 2016-02-13 17:04:46 +0100 | [diff] [blame] | 2221 | |json_encode()|. |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 2222 | When used as a number this evaluates to zero. |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2223 | When used as a string this evaluates to "v:null". > |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 2224 | echo v:null |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2225 | < v:null ~ |
| 2226 | That is so that eval() can parse the string back to the same |
Bram Moolenaar | df48fb4 | 2016-07-22 21:50:18 +0200 | [diff] [blame] | 2227 | value. Read-only. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 2228 | In |Vim9| script "null" can be used without "v:". |
Bram Moolenaar | 520e1e4 | 2016-01-23 19:46:28 +0100 | [diff] [blame] | 2229 | |
Bram Moolenaar | 57d5a01 | 2021-01-21 21:42:31 +0100 | [diff] [blame] | 2230 | *v:numbermax* *numbermax-variable* |
| 2231 | v:numbermax Maximum value of a number. |
| 2232 | |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 2233 | *v:numbermin* *numbermin-variable* |
Bram Moolenaar | 2346a63 | 2021-06-13 19:02:49 +0200 | [diff] [blame] | 2234 | v:numbermin Minimum value of a number (negative). |
Bram Moolenaar | 57d5a01 | 2021-01-21 21:42:31 +0100 | [diff] [blame] | 2235 | |
Bram Moolenaar | f9706e9 | 2020-02-22 14:27:04 +0100 | [diff] [blame] | 2236 | *v:numbersize* *numbersize-variable* |
| 2237 | v:numbersize Number of bits in a Number. This is normally 64, but on some |
Bram Moolenaar | bc93ceb | 2020-02-26 13:36:21 +0100 | [diff] [blame] | 2238 | systems it may be 32. |
Bram Moolenaar | f9706e9 | 2020-02-22 14:27:04 +0100 | [diff] [blame] | 2239 | |
Bram Moolenaar | d812df6 | 2008-11-09 12:46:09 +0000 | [diff] [blame] | 2240 | *v:oldfiles* *oldfiles-variable* |
| 2241 | v:oldfiles List of file names that is loaded from the |viminfo| file on |
| 2242 | startup. These are the files that Vim remembers marks for. |
| 2243 | The length of the List is limited by the ' argument of the |
| 2244 | 'viminfo' option (default is 100). |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2245 | When the |viminfo| file is not used the List is empty. |
Bram Moolenaar | d812df6 | 2008-11-09 12:46:09 +0000 | [diff] [blame] | 2246 | Also see |:oldfiles| and |c_#<|. |
| 2247 | The List can be modified, but this has no effect on what is |
| 2248 | stored in the |viminfo| file later. If you use values other |
| 2249 | than String this will cause trouble. |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 2250 | {only when compiled with the |+viminfo| feature} |
Bram Moolenaar | d812df6 | 2008-11-09 12:46:09 +0000 | [diff] [blame] | 2251 | |
Bram Moolenaar | 5374430 | 2015-07-17 17:38:22 +0200 | [diff] [blame] | 2252 | *v:option_new* |
| 2253 | v:option_new New value of the option. Valid while executing an |OptionSet| |
| 2254 | autocommand. |
| 2255 | *v:option_old* |
| 2256 | v:option_old Old value of the option. Valid while executing an |OptionSet| |
Bram Moolenaar | d7c9687 | 2019-06-15 17:12:48 +0200 | [diff] [blame] | 2257 | autocommand. Depending on the command used for setting and the |
| 2258 | kind of option this is either the local old value or the |
| 2259 | global old value. |
| 2260 | *v:option_oldlocal* |
| 2261 | v:option_oldlocal |
| 2262 | Old local value of the option. Valid while executing an |
| 2263 | |OptionSet| autocommand. |
| 2264 | *v:option_oldglobal* |
| 2265 | v:option_oldglobal |
| 2266 | Old global value of the option. Valid while executing an |
| 2267 | |OptionSet| autocommand. |
Bram Moolenaar | 5374430 | 2015-07-17 17:38:22 +0200 | [diff] [blame] | 2268 | *v:option_type* |
| 2269 | v:option_type Scope of the set command. Valid while executing an |
| 2270 | |OptionSet| autocommand. Can be either "global" or "local" |
Bram Moolenaar | d7c9687 | 2019-06-15 17:12:48 +0200 | [diff] [blame] | 2271 | *v:option_command* |
| 2272 | v:option_command |
| 2273 | Command used to set the option. Valid while executing an |
| 2274 | |OptionSet| autocommand. |
| 2275 | value option was set via ~ |
| 2276 | "setlocal" |:setlocal| or ":let l:xxx" |
| 2277 | "setglobal" |:setglobal| or ":let g:xxx" |
| 2278 | "set" |:set| or |:let| |
| 2279 | "modeline" |modeline| |
Bram Moolenaar | 8af1fbf | 2008-01-05 12:35:21 +0000 | [diff] [blame] | 2280 | *v:operator* *operator-variable* |
| 2281 | v:operator The last operator given in Normal mode. This is a single |
| 2282 | character except for commands starting with <g> or <z>, |
| 2283 | in which case it is two characters. Best used alongside |
| 2284 | |v:prevcount| and |v:register|. Useful if you want to cancel |
| 2285 | Operator-pending mode and then use the operator, e.g.: > |
| 2286 | :omap O <Esc>:call MyMotion(v:operator)<CR> |
| 2287 | < The value remains set until another operator is entered, thus |
| 2288 | don't expect it to be empty. |
| 2289 | v:operator is not set for |:delete|, |:yank| or other Ex |
| 2290 | commands. |
| 2291 | Read-only. |
| 2292 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2293 | *v:prevcount* *prevcount-variable* |
| 2294 | v:prevcount The count given for the last but one Normal mode command. |
| 2295 | This is the v:count value of the previous command. Useful if |
Bram Moolenaar | 8af1fbf | 2008-01-05 12:35:21 +0000 | [diff] [blame] | 2296 | you want to cancel Visual or Operator-pending mode and then |
| 2297 | use the count, e.g.: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2298 | :vmap % <Esc>:call MyFilter(v:prevcount)<CR> |
| 2299 | < Read-only. |
| 2300 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 2301 | *v:profiling* *profiling-variable* |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2302 | v:profiling Normally zero. Set to one after using ":profile start". |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 2303 | See |profiling|. |
| 2304 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2305 | *v:progname* *progname-variable* |
| 2306 | v:progname Contains the name (with path removed) with which Vim was |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 2307 | invoked. Allows you to do special initialisations for |view|, |
| 2308 | |evim| etc., or any other name you might symlink to Vim. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2309 | Read-only. |
| 2310 | |
Bram Moolenaar | a1706c9 | 2014-04-01 19:55:49 +0200 | [diff] [blame] | 2311 | *v:progpath* *progpath-variable* |
Bram Moolenaar | 56c860c | 2019-08-17 20:09:31 +0200 | [diff] [blame] | 2312 | v:progpath Contains the command with which Vim was invoked, in a form |
| 2313 | that when passed to the shell will run the same Vim executable |
| 2314 | as the current one (if $PATH remains unchanged). |
| 2315 | Useful if you want to message a Vim server using a |
Bram Moolenaar | a1706c9 | 2014-04-01 19:55:49 +0200 | [diff] [blame] | 2316 | |--remote-expr|. |
Bram Moolenaar | c7f0255 | 2014-04-01 21:00:59 +0200 | [diff] [blame] | 2317 | To get the full path use: > |
| 2318 | echo exepath(v:progpath) |
Bram Moolenaar | 56c860c | 2019-08-17 20:09:31 +0200 | [diff] [blame] | 2319 | < If the command has a relative path it will be expanded to the |
| 2320 | full path, so that it still works after `:cd`. Thus starting |
| 2321 | "./vim" results in "/home/user/path/to/vim/src/vim". |
| 2322 | On Linux and other systems it will always be the full path. |
| 2323 | On Mac it may just be "vim" and using exepath() as mentioned |
| 2324 | above should be used to get the full path. |
Bram Moolenaar | 08cab96 | 2017-03-04 14:37:18 +0100 | [diff] [blame] | 2325 | On MS-Windows the executable may be called "vim.exe", but the |
| 2326 | ".exe" is not added to v:progpath. |
Bram Moolenaar | a1706c9 | 2014-04-01 19:55:49 +0200 | [diff] [blame] | 2327 | Read-only. |
| 2328 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2329 | *v:register* *register-variable* |
Bram Moolenaar | d58e929 | 2011-02-09 17:07:58 +0100 | [diff] [blame] | 2330 | v:register The name of the register in effect for the current normal mode |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 2331 | command (regardless of whether that command actually used a |
| 2332 | register). Or for the currently executing normal mode mapping |
| 2333 | (use this in custom commands that take a register). |
| 2334 | If none is supplied it is the default register '"', unless |
| 2335 | 'clipboard' contains "unnamed" or "unnamedplus", then it is |
| 2336 | '*' or '+'. |
Bram Moolenaar | d58e929 | 2011-02-09 17:07:58 +0100 | [diff] [blame] | 2337 | Also see |getreg()| and |setreg()| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2338 | |
Bram Moolenaar | 1c7715d | 2005-10-03 22:02:18 +0000 | [diff] [blame] | 2339 | *v:scrollstart* *scrollstart-variable* |
| 2340 | v:scrollstart String describing the script or function that caused the |
| 2341 | screen to scroll up. It's only set when it is empty, thus the |
| 2342 | first reason is remembered. It is set to "Unknown" for a |
| 2343 | typed command. |
| 2344 | This can be used to find out why your script causes the |
| 2345 | hit-enter prompt. |
| 2346 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2347 | *v:servername* *servername-variable* |
Bram Moolenaar | c2ce52c | 2017-08-01 18:35:38 +0200 | [diff] [blame] | 2348 | v:servername The resulting registered |client-server-name| if any. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2349 | Read-only. |
| 2350 | |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 2351 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2352 | v:searchforward *v:searchforward* *searchforward-variable* |
| 2353 | Search direction: 1 after a forward search, 0 after a |
| 2354 | backward search. It is reset to forward when directly setting |
| 2355 | the last search pattern, see |quote/|. |
| 2356 | Note that the value is restored when returning from a |
| 2357 | function. |function-search-undo|. |
| 2358 | Read-write. |
| 2359 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2360 | *v:shell_error* *shell_error-variable* |
| 2361 | v:shell_error Result of the last shell command. When non-zero, the last |
| 2362 | shell command had an error. When zero, there was no problem. |
| 2363 | This only works when the shell returns the error code to Vim. |
| 2364 | The value -1 is often used when the command could not be |
| 2365 | executed. Read-only. |
| 2366 | Example: > |
| 2367 | :!mv foo bar |
| 2368 | :if v:shell_error |
| 2369 | : echo 'could not rename "foo" to "bar"!' |
| 2370 | :endif |
Bram Moolenaar | d2e716e | 2019-04-20 14:39:52 +0200 | [diff] [blame] | 2371 | < "shell_error" also works, for backwards compatibility, unless |
| 2372 | |scriptversion| is 3 or higher. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2373 | |
Bram Moolenaar | 113cb51 | 2021-11-07 20:27:04 +0000 | [diff] [blame] | 2374 | *v:sizeofint* *sizeofint-variable* |
| 2375 | v:sizeofint Number of bytes in an int. Depends on how Vim was compiled. |
| 2376 | This is only useful for deciding whether a test will give the |
| 2377 | expected result. |
| 2378 | |
| 2379 | *v:sizeoflong* *sizeoflong-variable* |
| 2380 | v:sizeoflong Number of bytes in a long. Depends on how Vim was compiled. |
| 2381 | This is only useful for deciding whether a test will give the |
| 2382 | expected result. |
| 2383 | |
| 2384 | *v:sizeofpointer* *sizeofpointer-variable* |
| 2385 | v:sizeofpointer Number of bytes in a pointer. Depends on how Vim was compiled. |
| 2386 | This is only useful for deciding whether a test will give the |
| 2387 | expected result. |
| 2388 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2389 | *v:statusmsg* *statusmsg-variable* |
| 2390 | v:statusmsg Last given status message. It's allowed to set this variable. |
| 2391 | |
Bram Moolenaar | 4e330bb | 2005-12-07 21:04:31 +0000 | [diff] [blame] | 2392 | *v:swapname* *swapname-variable* |
| 2393 | v:swapname Only valid when executing |SwapExists| autocommands: Name of |
| 2394 | the swap file found. Read-only. |
| 2395 | |
| 2396 | *v:swapchoice* *swapchoice-variable* |
| 2397 | v:swapchoice |SwapExists| autocommands can set this to the selected choice |
| 2398 | for handling an existing swap file: |
| 2399 | 'o' Open read-only |
| 2400 | 'e' Edit anyway |
| 2401 | 'r' Recover |
| 2402 | 'd' Delete swapfile |
| 2403 | 'q' Quit |
| 2404 | 'a' Abort |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2405 | The value should be a single-character string. An empty value |
Bram Moolenaar | 4e330bb | 2005-12-07 21:04:31 +0000 | [diff] [blame] | 2406 | results in the user being asked, as would happen when there is |
| 2407 | no SwapExists autocommand. The default is empty. |
| 2408 | |
Bram Moolenaar | b348038 | 2005-12-11 21:33:32 +0000 | [diff] [blame] | 2409 | *v:swapcommand* *swapcommand-variable* |
Bram Moolenaar | 4770d09 | 2006-01-12 23:22:24 +0000 | [diff] [blame] | 2410 | v:swapcommand Normal mode command to be executed after a file has been |
Bram Moolenaar | b348038 | 2005-12-11 21:33:32 +0000 | [diff] [blame] | 2411 | opened. Can be used for a |SwapExists| autocommand to have |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2412 | another Vim open the file and jump to the right place. For |
Bram Moolenaar | b348038 | 2005-12-11 21:33:32 +0000 | [diff] [blame] | 2413 | example, when jumping to a tag the value is ":tag tagname\r". |
Bram Moolenaar | 1f35bf9 | 2006-03-07 22:38:47 +0000 | [diff] [blame] | 2414 | For ":edit +cmd file" the value is ":cmd\r". |
Bram Moolenaar | b348038 | 2005-12-11 21:33:32 +0000 | [diff] [blame] | 2415 | |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2416 | *v:t_TYPE* *v:t_bool* *t_bool-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2417 | v:t_bool Value of |Boolean| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2418 | *v:t_channel* *t_channel-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2419 | v:t_channel Value of |Channel| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2420 | *v:t_dict* *t_dict-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2421 | v:t_dict Value of |Dictionary| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2422 | *v:t_float* *t_float-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2423 | v:t_float Value of |Float| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2424 | *v:t_func* *t_func-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2425 | v:t_func Value of |Funcref| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2426 | *v:t_job* *t_job-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2427 | v:t_job Value of |Job| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2428 | *v:t_list* *t_list-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2429 | v:t_list Value of |List| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2430 | *v:t_none* *t_none-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2431 | v:t_none Value of |None| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2432 | *v:t_number* *t_number-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2433 | v:t_number Value of |Number| type. Read-only. See: |type()| |
Bram Moolenaar | d823fa9 | 2016-08-12 16:29:27 +0200 | [diff] [blame] | 2434 | *v:t_string* *t_string-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2435 | v:t_string Value of |String| type. Read-only. See: |type()| |
Bram Moolenaar | 6e5ea8d | 2019-01-12 22:47:31 +0100 | [diff] [blame] | 2436 | *v:t_blob* *t_blob-variable* |
Bram Moolenaar | d09091d | 2019-01-17 16:07:22 +0100 | [diff] [blame] | 2437 | v:t_blob Value of |Blob| type. Read-only. See: |type()| |
Bram Moolenaar | f562e72 | 2016-07-19 17:25:25 +0200 | [diff] [blame] | 2438 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2439 | *v:termresponse* *termresponse-variable* |
| 2440 | v:termresponse The escape sequence returned by the terminal for the |t_RV| |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2441 | termcap entry. It is set when Vim receives an escape sequence |
Bram Moolenaar | b423012 | 2019-05-30 18:40:53 +0200 | [diff] [blame] | 2442 | that starts with ESC [ or CSI, then '>' or '?' and ends in a |
| 2443 | 'c', with only digits and ';' in between. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2444 | When this option is set, the TermResponse autocommand event is |
| 2445 | fired, so that you can react to the response from the |
Bram Moolenaar | 0c0eddd | 2020-06-13 15:47:25 +0200 | [diff] [blame] | 2446 | terminal. You can use |terminalprops()| to see what Vim |
| 2447 | figured out about the terminal. |
Bram Moolenaar | b423012 | 2019-05-30 18:40:53 +0200 | [diff] [blame] | 2448 | The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2449 | is the terminal type: 0 for vt100 and 1 for vt220. Pv is the |
| 2450 | patch level (since this was introduced in patch 95, it's |
Bram Moolenaar | fa3b723 | 2021-12-24 13:18:38 +0000 | [diff] [blame] | 2451 | always 95 or higher). Pc is always zero. |
| 2452 | If Pv is 141 or higher then Vim will try to request terminal |
| 2453 | codes. This only works with xterm |xterm-codes|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2454 | {only when compiled with |+termresponse| feature} |
| 2455 | |
Bram Moolenaar | f3af54e | 2017-08-30 14:53:06 +0200 | [diff] [blame] | 2456 | *v:termblinkresp* |
| 2457 | v:termblinkresp The escape sequence returned by the terminal for the |t_RC| |
| 2458 | termcap entry. This is used to find out whether the terminal |
| 2459 | cursor is blinking. This is used by |term_getcursor()|. |
| 2460 | |
| 2461 | *v:termstyleresp* |
| 2462 | v:termstyleresp The escape sequence returned by the terminal for the |t_RS| |
| 2463 | termcap entry. This is used to find out what the shape of the |
| 2464 | cursor is. This is used by |term_getcursor()|. |
| 2465 | |
Bram Moolenaar | 65e4c4f | 2017-10-14 23:24:25 +0200 | [diff] [blame] | 2466 | *v:termrbgresp* |
| 2467 | v:termrbgresp The escape sequence returned by the terminal for the |t_RB| |
Bram Moolenaar | f3af54e | 2017-08-30 14:53:06 +0200 | [diff] [blame] | 2468 | termcap entry. This is used to find out what the terminal |
| 2469 | background color is, see 'background'. |
| 2470 | |
Bram Moolenaar | 65e4c4f | 2017-10-14 23:24:25 +0200 | [diff] [blame] | 2471 | *v:termrfgresp* |
| 2472 | v:termrfgresp The escape sequence returned by the terminal for the |t_RF| |
| 2473 | termcap entry. This is used to find out what the terminal |
| 2474 | foreground color is. |
| 2475 | |
Bram Moolenaar | f3af54e | 2017-08-30 14:53:06 +0200 | [diff] [blame] | 2476 | *v:termu7resp* |
| 2477 | v:termu7resp The escape sequence returned by the terminal for the |t_u7| |
| 2478 | termcap entry. This is used to find out what the terminal |
| 2479 | does with ambiguous width characters, see 'ambiwidth'. |
| 2480 | |
Bram Moolenaar | ebf7dfa | 2016-04-14 12:46:51 +0200 | [diff] [blame] | 2481 | *v:testing* *testing-variable* |
Bram Moolenaar | 8e8df25 | 2016-05-25 21:23:21 +0200 | [diff] [blame] | 2482 | v:testing Must be set before using `test_garbagecollect_now()`. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 2483 | Also, when set certain error messages won't be shown for 2 |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 2484 | seconds. (e.g. "'dictionary' option is empty") |
Bram Moolenaar | ebf7dfa | 2016-04-14 12:46:51 +0200 | [diff] [blame] | 2485 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2486 | *v:this_session* *this_session-variable* |
| 2487 | v:this_session Full filename of the last loaded or saved session file. See |
| 2488 | |:mksession|. It is allowed to set this variable. When no |
| 2489 | session file has been saved, this variable is empty. |
Bram Moolenaar | d2e716e | 2019-04-20 14:39:52 +0200 | [diff] [blame] | 2490 | "this_session" also works, for backwards compatibility, unless |
| 2491 | |scriptversion| is 3 or higher |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2492 | |
| 2493 | *v:throwpoint* *throwpoint-variable* |
| 2494 | v:throwpoint The point where the exception most recently caught and not |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2495 | finished was thrown. Not set when commands are typed. See |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2496 | also |v:exception| and |throw-variables|. |
| 2497 | Example: > |
| 2498 | :try |
| 2499 | : throw "oops" |
| 2500 | :catch /.*/ |
| 2501 | : echo "Exception from" v:throwpoint |
| 2502 | :endtry |
| 2503 | < Output: "Exception from test.vim, line 2" |
| 2504 | |
Bram Moolenaar | 520e1e4 | 2016-01-23 19:46:28 +0100 | [diff] [blame] | 2505 | *v:true* *true-variable* |
| 2506 | v:true A Number with value one. Used to put "true" in JSON. See |
Bram Moolenaar | 6463ca2 | 2016-02-13 17:04:46 +0100 | [diff] [blame] | 2507 | |json_encode()|. |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2508 | When used as a string this evaluates to "v:true". > |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 2509 | echo v:true |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 2510 | < v:true ~ |
| 2511 | That is so that eval() can parse the string back to the same |
Bram Moolenaar | df48fb4 | 2016-07-22 21:50:18 +0200 | [diff] [blame] | 2512 | value. Read-only. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 2513 | In |Vim9| script "true" can be used which has a boolean type. |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 2514 | *v:val* *val-variable* |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2515 | v:val Value of the current item of a |List| or |Dictionary|. Only |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 2516 | valid while evaluating the expression used with |map()| and |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 2517 | |filter()|. Read-only. |
| 2518 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2519 | *v:version* *version-variable* |
| 2520 | v:version Version number of Vim: Major version number times 100 plus |
Bram Moolenaar | 9b28352 | 2019-06-17 22:19:33 +0200 | [diff] [blame] | 2521 | minor version number. Version 5.0 is 500. Version 5.1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2522 | is 501. Read-only. "version" also works, for backwards |
Bram Moolenaar | d2e716e | 2019-04-20 14:39:52 +0200 | [diff] [blame] | 2523 | compatibility, unless |scriptversion| is 3 or higher. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2524 | Use |has()| to check if a certain patch was included, e.g.: > |
Bram Moolenaar | 6716d9a | 2014-04-02 12:12:08 +0200 | [diff] [blame] | 2525 | if has("patch-7.4.123") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2526 | < Note that patch numbers are specific to the version, thus both |
| 2527 | version 5.0 and 5.1 may have a patch 123, but these are |
| 2528 | completely different. |
| 2529 | |
Bram Moolenaar | 37df9a4 | 2019-06-14 14:39:51 +0200 | [diff] [blame] | 2530 | *v:versionlong* *versionlong-variable* |
Bram Moolenaar | 9b28352 | 2019-06-17 22:19:33 +0200 | [diff] [blame] | 2531 | v:versionlong Like v:version, but also including the patchlevel in the last |
| 2532 | four digits. Version 8.1 with patch 123 has value 8010123. |
| 2533 | This can be used like this: > |
| 2534 | if v:versionlong >= 8010123 |
Bram Moolenaar | 37df9a4 | 2019-06-14 14:39:51 +0200 | [diff] [blame] | 2535 | < However, if there are gaps in the list of patches included |
| 2536 | this will not work well. This can happen if a recent patch |
| 2537 | was included into an older version, e.g. for a security fix. |
| 2538 | Use the has() function to make sure the patch is actually |
| 2539 | included. |
| 2540 | |
Bram Moolenaar | 1473551 | 2016-03-26 21:00:08 +0100 | [diff] [blame] | 2541 | *v:vim_did_enter* *vim_did_enter-variable* |
| 2542 | v:vim_did_enter Zero until most of startup is done. It is set to one just |
| 2543 | before |VimEnter| autocommands are triggered. |
| 2544 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2545 | *v:warningmsg* *warningmsg-variable* |
| 2546 | v:warningmsg Last given warning message. It's allowed to set this variable. |
| 2547 | |
Bram Moolenaar | 727c876 | 2010-10-20 19:17:48 +0200 | [diff] [blame] | 2548 | *v:windowid* *windowid-variable* |
| 2549 | v:windowid When any X11 based GUI is running or when running in a |
| 2550 | terminal and Vim connects to the X server (|-X|) this will be |
Bram Moolenaar | 264e9fd | 2010-10-27 12:33:17 +0200 | [diff] [blame] | 2551 | set to the window ID. |
| 2552 | When an MS-Windows GUI is running this will be set to the |
| 2553 | window handle. |
| 2554 | Otherwise the value is zero. |
Bram Moolenaar | 7571d55 | 2016-08-18 22:54:46 +0200 | [diff] [blame] | 2555 | Note: for windows inside Vim use |winnr()| or |win_getid()|, |
| 2556 | see |window-ID|. |
Bram Moolenaar | 727c876 | 2010-10-20 19:17:48 +0200 | [diff] [blame] | 2557 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2558 | ============================================================================== |
| 2559 | 4. Builtin Functions *functions* |
| 2560 | |
| 2561 | See |function-list| for a list grouped by what the function is used for. |
| 2562 | |
Bram Moolenaar | 1cae5a0 | 2021-12-27 21:28:34 +0000 | [diff] [blame] | 2563 | The alphabetic list of all builtin functions and details are in a separate |
| 2564 | help file: |builtin-functions|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2565 | |
| 2566 | ============================================================================== |
| 2567 | 5. Defining functions *user-functions* |
| 2568 | |
| 2569 | New functions can be defined. These can be called just like builtin |
| 2570 | functions. The function executes a sequence of Ex commands. Normal mode |
| 2571 | commands can be executed with the |:normal| command. |
| 2572 | |
Bram Moolenaar | 8a7d654 | 2020-01-26 15:56:19 +0100 | [diff] [blame] | 2573 | This section is about the legacy functions. For the Vim9 functions, which |
| 2574 | execute much faster, support type checking and more, see |vim9.txt|. |
| 2575 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2576 | The function name must start with an uppercase letter, to avoid confusion with |
| 2577 | builtin functions. To prevent from using the same name in different scripts |
| 2578 | avoid obvious, short names. A good habit is to start the function name with |
| 2579 | the name of the script, e.g., "HTMLcolor()". |
| 2580 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 2581 | In legacy script it is also possible to use curly braces, see |
| 2582 | |curly-braces-names|. |
| 2583 | The |autoload| facility is useful to define a function only when it's called. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2584 | |
| 2585 | *local-function* |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 2586 | A function local to a legacy script must start with "s:". A local script |
| 2587 | function can only be called from within the script and from functions, user |
| 2588 | commands and autocommands defined in the script. It is also possible to call |
| 2589 | the function from a mapping defined in the script, but then |<SID>| must be |
| 2590 | used instead of "s:" when the mapping is expanded outside of the script. |
Bram Moolenaar | bcb9898 | 2014-05-01 14:08:19 +0200 | [diff] [blame] | 2591 | There are only script-local functions, no buffer-local or window-local |
| 2592 | functions. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2593 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 2594 | In |Vim9| script functions are local to the script by default, prefix "g:" to |
| 2595 | define a global function. |
| 2596 | |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 2597 | *:fu* *:function* *E128* *E129* *E123* *E454* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2598 | :fu[nction] List all functions and their arguments. |
| 2599 | |
| 2600 | :fu[nction] {name} List function {name}. |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 2601 | {name} can also be a |Dictionary| entry that is a |
| 2602 | |Funcref|: > |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 2603 | :function dict.init |
Bram Moolenaar | 92d640f | 2005-09-05 22:11:52 +0000 | [diff] [blame] | 2604 | |
| 2605 | :fu[nction] /{pattern} List functions with a name matching {pattern}. |
| 2606 | Example that lists all functions ending with "File": > |
| 2607 | :function /File$ |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 2608 | < |
| 2609 | *:function-verbose* |
| 2610 | When 'verbose' is non-zero, listing a function will also display where it was |
| 2611 | last defined. Example: > |
| 2612 | |
| 2613 | :verbose function SetFileTypeSH |
| 2614 | function SetFileTypeSH(name) |
| 2615 | Last set from /usr/share/vim/vim-7.0/filetype.vim |
| 2616 | < |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 2617 | See |:verbose-cmd| for more information. |
Bram Moolenaar | 5b8d8fd | 2005-08-16 23:01:50 +0000 | [diff] [blame] | 2618 | |
Bram Moolenaar | bcb9898 | 2014-05-01 14:08:19 +0200 | [diff] [blame] | 2619 | *E124* *E125* *E853* *E884* |
Bram Moolenaar | 10ce39a | 2016-07-29 22:37:06 +0200 | [diff] [blame] | 2620 | :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 2621 | Define a new function by the name {name}. The body of |
| 2622 | the function follows in the next lines, until the |
| 2623 | matching |:endfunction|. |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 2624 | |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 2625 | The name must be made of alphanumeric characters and |
| 2626 | '_', and must start with a capital or "s:" (see |
| 2627 | above). Note that using "b:" or "g:" is not allowed. |
| 2628 | (since patch 7.4.260 E884 is given if the function |
| 2629 | name has a colon in the name, e.g. for "foo:bar()". |
| 2630 | Before that patch no error was given). |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 2631 | |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 2632 | {name} can also be a |Dictionary| entry that is a |
| 2633 | |Funcref|: > |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 2634 | :function dict.init(arg) |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2635 | < "dict" must be an existing dictionary. The entry |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 2636 | "init" is added if it didn't exist yet. Otherwise [!] |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2637 | is required to overwrite an existing function. The |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 2638 | result is a |Funcref| to a numbered function. The |
| 2639 | function can only be used with a |Funcref| and will be |
| 2640 | deleted if there are no more references to it. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2641 | *E127* *E122* |
| 2642 | When a function by this name already exists and [!] is |
Bram Moolenaar | ded5f1b | 2018-11-10 17:33:29 +0100 | [diff] [blame] | 2643 | not used an error message is given. There is one |
| 2644 | exception: When sourcing a script again, a function |
| 2645 | that was previously defined in that script will be |
| 2646 | silently replaced. |
| 2647 | When [!] is used, an existing function is silently |
| 2648 | replaced. Unless it is currently being executed, that |
| 2649 | is an error. |
Bram Moolenaar | f8be461 | 2017-06-23 20:52:40 +0200 | [diff] [blame] | 2650 | NOTE: Use ! wisely. If used without care it can cause |
| 2651 | an existing function to be replaced unexpectedly, |
| 2652 | which is hard to debug. |
Bram Moolenaar | 388a5d4 | 2020-05-26 21:20:45 +0200 | [diff] [blame] | 2653 | NOTE: In Vim9 script script-local functions cannot be |
| 2654 | deleted or redefined. |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 2655 | |
| 2656 | For the {arguments} see |function-argument|. |
| 2657 | |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2658 | *:func-range* *a:firstline* *a:lastline* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2659 | When the [range] argument is added, the function is |
| 2660 | expected to take care of a range itself. The range is |
| 2661 | passed as "a:firstline" and "a:lastline". If [range] |
| 2662 | is excluded, ":{range}call" will call the function for |
| 2663 | each line in the range, with the cursor on the start |
| 2664 | of each line. See |function-range-example|. |
Bram Moolenaar | 2df58b4 | 2012-11-28 18:21:11 +0100 | [diff] [blame] | 2665 | The cursor is still moved to the first line of the |
| 2666 | range, as is the case with all Ex commands. |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2667 | *:func-abort* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2668 | When the [abort] argument is added, the function will |
| 2669 | abort as soon as an error is detected. |
Bram Moolenaar | 8d04317 | 2014-01-23 14:24:41 +0100 | [diff] [blame] | 2670 | *:func-dict* |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 2671 | When the [dict] argument is added, the function must |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2672 | be invoked through an entry in a |Dictionary|. The |
Bram Moolenaar | 2fda12f | 2005-01-15 22:14:15 +0000 | [diff] [blame] | 2673 | local variable "self" will then be set to the |
| 2674 | dictionary. See |Dictionary-function|. |
Bram Moolenaar | 10ce39a | 2016-07-29 22:37:06 +0200 | [diff] [blame] | 2675 | *:func-closure* *E932* |
| 2676 | When the [closure] argument is added, the function |
| 2677 | can access variables and arguments from the outer |
| 2678 | scope. This is usually called a closure. In this |
| 2679 | example Bar() uses "x" from the scope of Foo(). It |
| 2680 | remains referenced even after Foo() returns: > |
| 2681 | :function! Foo() |
| 2682 | : let x = 0 |
| 2683 | : function! Bar() closure |
| 2684 | : let x += 1 |
| 2685 | : return x |
| 2686 | : endfunction |
Bram Moolenaar | bc8801c | 2016-08-02 21:04:33 +0200 | [diff] [blame] | 2687 | : return funcref('Bar') |
Bram Moolenaar | 10ce39a | 2016-07-29 22:37:06 +0200 | [diff] [blame] | 2688 | :endfunction |
| 2689 | |
| 2690 | :let F = Foo() |
| 2691 | :echo F() |
| 2692 | < 1 > |
| 2693 | :echo F() |
| 2694 | < 2 > |
| 2695 | :echo F() |
| 2696 | < 3 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2697 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2698 | *function-search-undo* |
Bram Moolenaar | 9869207 | 2006-02-04 00:57:42 +0000 | [diff] [blame] | 2699 | The last used search pattern and the redo command "." |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2700 | will not be changed by the function. This also |
| 2701 | implies that the effect of |:nohlsearch| is undone |
| 2702 | when the function returns. |
Bram Moolenaar | 9869207 | 2006-02-04 00:57:42 +0000 | [diff] [blame] | 2703 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 2704 | *:endf* *:endfunction* *E126* *E193* *W22* *E1151* |
Bram Moolenaar | 663bb23 | 2017-06-22 19:12:10 +0200 | [diff] [blame] | 2705 | :endf[unction] [argument] |
| 2706 | The end of a function definition. Best is to put it |
| 2707 | on a line by its own, without [argument]. |
| 2708 | |
| 2709 | [argument] can be: |
| 2710 | | command command to execute next |
| 2711 | \n command command to execute next |
| 2712 | " comment always ignored |
Bram Moolenaar | f8be461 | 2017-06-23 20:52:40 +0200 | [diff] [blame] | 2713 | anything else ignored, warning given when |
| 2714 | 'verbose' is non-zero |
Bram Moolenaar | 663bb23 | 2017-06-22 19:12:10 +0200 | [diff] [blame] | 2715 | The support for a following command was added in Vim |
| 2716 | 8.0.0654, before that any argument was silently |
| 2717 | ignored. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2718 | |
Bram Moolenaar | f8be461 | 2017-06-23 20:52:40 +0200 | [diff] [blame] | 2719 | To be able to define a function inside an `:execute` |
| 2720 | command, use line breaks instead of |:bar|: > |
| 2721 | :exe "func Foo()\necho 'foo'\nendfunc" |
| 2722 | < |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 2723 | *:delf* *:delfunction* *E131* *E933* *E1084* |
Bram Moolenaar | 663bb23 | 2017-06-22 19:12:10 +0200 | [diff] [blame] | 2724 | :delf[unction][!] {name} |
| 2725 | Delete function {name}. |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 2726 | {name} can also be a |Dictionary| entry that is a |
| 2727 | |Funcref|: > |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 2728 | :delfunc dict.init |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2729 | < This will remove the "init" entry from "dict". The |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 2730 | function is deleted if there are no more references to |
| 2731 | it. |
Bram Moolenaar | 663bb23 | 2017-06-22 19:12:10 +0200 | [diff] [blame] | 2732 | With the ! there is no error if the function does not |
| 2733 | exist. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2734 | *:retu* *:return* *E133* |
| 2735 | :retu[rn] [expr] Return from a function. When "[expr]" is given, it is |
| 2736 | evaluated and returned as the result of the function. |
| 2737 | If "[expr]" is not given, the number 0 is returned. |
| 2738 | When a function ends without an explicit ":return", |
| 2739 | the number 0 is returned. |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 2740 | In a :def function *E1095* is given if unreachable |
| 2741 | code follows after the `:return`. |
| 2742 | In legacy script there is no check for unreachable |
| 2743 | lines, thus there is no warning if commands follow |
| 2744 | `:return`. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2745 | |
| 2746 | If the ":return" is used after a |:try| but before the |
| 2747 | matching |:finally| (if present), the commands |
| 2748 | following the ":finally" up to the matching |:endtry| |
| 2749 | are executed first. This process applies to all |
| 2750 | nested ":try"s inside the function. The function |
| 2751 | returns at the outermost ":endtry". |
| 2752 | |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 2753 | *function-argument* *a:var* |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2754 | An argument can be defined by giving its name. In the function this can then |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 2755 | be used as "a:name" ("a:" for argument). |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2756 | *a:0* *a:1* *a:000* *E740* *...* |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 2757 | Up to 20 arguments can be given, separated by commas. After the named |
| 2758 | arguments an argument "..." can be specified, which means that more arguments |
| 2759 | may optionally be following. In the function the extra arguments can be used |
| 2760 | as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 2761 | can be 0). "a:000" is set to a |List| that contains these arguments. Note |
| 2762 | that "a:1" is the same as "a:000[0]". |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 2763 | *E742* *E1090* |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 2764 | The a: scope and the variables in it cannot be changed, they are fixed. |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 2765 | However, if a composite type is used, such as |List| or |Dictionary| , you can |
| 2766 | change their contents. Thus you can pass a |List| to a function and have the |
| 2767 | function add an item to it. If you want to make sure the function cannot |
| 2768 | change a |List| or |Dictionary| use |:lockvar|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2769 | |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 2770 | It is also possible to define a function without any arguments. You must |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 2771 | still supply the () then. |
| 2772 | |
Bram Moolenaar | 98ef233 | 2018-03-18 14:44:37 +0100 | [diff] [blame] | 2773 | It is allowed to define another function inside a function body. |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 2774 | |
Bram Moolenaar | 42ae78c | 2019-05-09 21:08:58 +0200 | [diff] [blame] | 2775 | *optional-function-argument* |
| 2776 | You can provide default values for positional named arguments. This makes |
| 2777 | them optional for function calls. When a positional argument is not |
| 2778 | specified at a call, the default expression is used to initialize it. |
Bram Moolenaar | d1caa94 | 2020-04-10 22:10:56 +0200 | [diff] [blame] | 2779 | This only works for functions declared with `:function` or `:def`, not for |
| 2780 | lambda expressions |expr-lambda|. |
Bram Moolenaar | 42ae78c | 2019-05-09 21:08:58 +0200 | [diff] [blame] | 2781 | |
| 2782 | Example: > |
| 2783 | function Something(key, value = 10) |
Bram Moolenaar | 8aad88d | 2019-05-12 13:53:50 +0200 | [diff] [blame] | 2784 | echo a:key .. ": " .. a:value |
Bram Moolenaar | 42ae78c | 2019-05-09 21:08:58 +0200 | [diff] [blame] | 2785 | endfunction |
| 2786 | call Something('empty') "empty: 10" |
Bram Moolenaar | 8aad88d | 2019-05-12 13:53:50 +0200 | [diff] [blame] | 2787 | call Something('key', 20) "key: 20" |
Bram Moolenaar | 42ae78c | 2019-05-09 21:08:58 +0200 | [diff] [blame] | 2788 | |
| 2789 | The argument default expressions are evaluated at the time of the function |
| 2790 | call, not definition. Thus it is possible to use an expression which is |
Bram Moolenaar | 68e6560 | 2019-05-26 21:33:31 +0200 | [diff] [blame] | 2791 | invalid the moment the function is defined. The expressions are also only |
Bram Moolenaar | 42ae78c | 2019-05-09 21:08:58 +0200 | [diff] [blame] | 2792 | evaluated when arguments are not specified during a call. |
Bram Moolenaar | 2547aa9 | 2020-07-26 17:00:44 +0200 | [diff] [blame] | 2793 | *none-function_argument* |
Bram Moolenaar | 42ae78c | 2019-05-09 21:08:58 +0200 | [diff] [blame] | 2794 | You can pass |v:none| to use the default expression. Note that this means you |
| 2795 | cannot pass v:none as an ordinary value when an argument has a default |
| 2796 | expression. |
| 2797 | |
| 2798 | Example: > |
| 2799 | function Something(a = 10, b = 20, c = 30) |
| 2800 | endfunction |
| 2801 | call Something(1, v:none, 3) " b = 20 |
| 2802 | < |
| 2803 | *E989* |
| 2804 | Optional arguments with default expressions must occur after any mandatory |
| 2805 | arguments. You can use "..." after all optional named arguments. |
| 2806 | |
| 2807 | It is possible for later argument defaults to refer to prior arguments, |
| 2808 | but not the other way around. They must be prefixed with "a:", as with all |
| 2809 | arguments. |
| 2810 | |
| 2811 | Example that works: > |
| 2812 | :function Okay(mandatory, optional = a:mandatory) |
| 2813 | :endfunction |
| 2814 | Example that does NOT work: > |
| 2815 | :function NoGood(first = a:second, second = 10) |
| 2816 | :endfunction |
| 2817 | < |
Bram Moolenaar | d1caa94 | 2020-04-10 22:10:56 +0200 | [diff] [blame] | 2818 | When not using "...", the number of arguments in a function call must be at |
| 2819 | least equal to the number of mandatory named arguments. When using "...", the |
| 2820 | number of arguments may be larger than the total of mandatory and optional |
| 2821 | arguments. |
Bram Moolenaar | 42ae78c | 2019-05-09 21:08:58 +0200 | [diff] [blame] | 2822 | |
Bram Moolenaar | 8f999f1 | 2005-01-25 22:12:55 +0000 | [diff] [blame] | 2823 | *local-variables* |
Bram Moolenaar | 069c1e7 | 2016-07-15 21:25:08 +0200 | [diff] [blame] | 2824 | Inside a function local variables can be used. These will disappear when the |
| 2825 | function returns. Global variables need to be accessed with "g:". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2826 | |
| 2827 | Example: > |
| 2828 | :function Table(title, ...) |
| 2829 | : echohl Title |
| 2830 | : echo a:title |
| 2831 | : echohl None |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 2832 | : echo a:0 .. " items:" |
Bram Moolenaar | 677ee68 | 2005-01-27 14:41:15 +0000 | [diff] [blame] | 2833 | : for s in a:000 |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 2834 | : echon ' ' .. s |
Bram Moolenaar | 677ee68 | 2005-01-27 14:41:15 +0000 | [diff] [blame] | 2835 | : endfor |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2836 | :endfunction |
| 2837 | |
| 2838 | This function can then be called with: > |
Bram Moolenaar | 677ee68 | 2005-01-27 14:41:15 +0000 | [diff] [blame] | 2839 | call Table("Table", "line1", "line2") |
| 2840 | call Table("Empty Table") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2841 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2842 | To return more than one value, return a |List|: > |
| 2843 | :function Compute(n1, n2) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2844 | : if a:n2 == 0 |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2845 | : return ["fail", 0] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2846 | : endif |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2847 | : return ["ok", a:n1 / a:n2] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2848 | :endfunction |
| 2849 | |
| 2850 | This function can then be called with: > |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2851 | :let [success, div] = Compute(102, 6) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2852 | :if success == "ok" |
| 2853 | : echo div |
| 2854 | :endif |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2855 | < |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 2856 | *:cal* *:call* *E107* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2857 | :[range]cal[l] {name}([arguments]) |
| 2858 | Call a function. The name of the function and its arguments |
Bram Moolenaar | 68e6560 | 2019-05-26 21:33:31 +0200 | [diff] [blame] | 2859 | are as specified with `:function`. Up to 20 arguments can be |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2860 | used. The returned value is discarded. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 2861 | In |Vim9| script using `:call` is optional, these two lines do |
| 2862 | the same thing: > |
| 2863 | call SomeFunc(arg) |
| 2864 | SomeFunc(arg) |
| 2865 | < Without a range and for functions that accept a range, the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2866 | function is called once. When a range is given the cursor is |
| 2867 | positioned at the start of the first line before executing the |
| 2868 | function. |
| 2869 | When a range is given and the function doesn't handle it |
| 2870 | itself, the function is executed for each line in the range, |
| 2871 | with the cursor in the first column of that line. The cursor |
| 2872 | is left at the last line (possibly moved by the last function |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2873 | call). The arguments are re-evaluated for each line. Thus |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2874 | this works: |
| 2875 | *function-range-example* > |
| 2876 | :function Mynumber(arg) |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 2877 | : echo line(".") .. " " .. a:arg |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2878 | :endfunction |
| 2879 | :1,5call Mynumber(getline(".")) |
| 2880 | < |
| 2881 | The "a:firstline" and "a:lastline" are defined anyway, they |
| 2882 | can be used to do something different at the start or end of |
| 2883 | the range. |
| 2884 | |
| 2885 | Example of a function that handles the range itself: > |
| 2886 | |
| 2887 | :function Cont() range |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 2888 | : execute (a:firstline + 1) .. "," .. a:lastline .. 's/^/\t\\ ' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2889 | :endfunction |
| 2890 | :4,8call Cont() |
| 2891 | < |
| 2892 | This function inserts the continuation character "\" in front |
| 2893 | of all the lines in the range, except the first one. |
| 2894 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 2895 | When the function returns a composite value it can be further |
| 2896 | dereferenced, but the range will not be used then. Example: > |
| 2897 | :4,8call GetDict().method() |
| 2898 | < Here GetDict() gets the range but method() does not. |
| 2899 | |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 2900 | *E117* |
| 2901 | When a function cannot be found the error "E117: Unknown function" will be |
| 2902 | given. If the function was using an autoload path or an autoload import and |
| 2903 | the script is a |Vim9| script, this may also be caused by the function not |
| 2904 | being exported. |
| 2905 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2906 | *E132* |
| 2907 | The recursiveness of user functions is restricted with the |'maxfuncdepth'| |
| 2908 | option. |
| 2909 | |
Bram Moolenaar | 25e4223 | 2019-08-04 15:04:10 +0200 | [diff] [blame] | 2910 | It is also possible to use `:eval`. It does not support a range, but does |
| 2911 | allow for method chaining, e.g.: > |
| 2912 | eval GetList()->Filter()->append('$') |
| 2913 | |
Bram Moolenaar | 088e8e3 | 2019-08-08 22:15:18 +0200 | [diff] [blame] | 2914 | A function can also be called as part of evaluating an expression or when it |
| 2915 | is used as a method: > |
| 2916 | let x = GetList() |
| 2917 | let y = GetList()->Filter() |
| 2918 | |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2919 | |
| 2920 | AUTOMATICALLY LOADING FUNCTIONS ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2921 | *autoload-functions* |
| 2922 | When using many or large functions, it's possible to automatically define them |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2923 | only when they are used. There are two methods: with an autocommand and with |
| 2924 | the "autoload" directory in 'runtimepath'. |
| 2925 | |
| 2926 | |
| 2927 | Using an autocommand ~ |
| 2928 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 2929 | This is introduced in the user manual, section |41.14|. |
| 2930 | |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2931 | The autocommand is useful if you have a plugin that is a long Vim script file. |
Bram Moolenaar | 68e6560 | 2019-05-26 21:33:31 +0200 | [diff] [blame] | 2932 | You can define the autocommand and quickly quit the script with `:finish`. |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 2933 | That makes Vim startup faster. The autocommand should then load the same file |
Bram Moolenaar | 68e6560 | 2019-05-26 21:33:31 +0200 | [diff] [blame] | 2934 | again, setting a variable to skip the `:finish` command. |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2935 | |
| 2936 | Use the FuncUndefined autocommand event with a pattern that matches the |
| 2937 | function(s) to be defined. Example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2938 | |
| 2939 | :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim |
| 2940 | |
| 2941 | The file "~/vim/bufnetfuncs.vim" should then define functions that start with |
| 2942 | "BufNet". Also see |FuncUndefined|. |
| 2943 | |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2944 | |
| 2945 | Using an autoload script ~ |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2946 | *autoload* *E746* |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 2947 | This is introduced in the user manual, section |41.15|. |
| 2948 | |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2949 | Using a script in the "autoload" directory is simpler, but requires using |
| 2950 | exactly the right file name. A function that can be autoloaded has a name |
| 2951 | like this: > |
| 2952 | |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 2953 | :call filename#funcname() |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2954 | |
Bram Moolenaar | 65e0d77 | 2020-06-14 17:29:55 +0200 | [diff] [blame] | 2955 | These functions are always global, in Vim9 script "g:" needs to be used: > |
| 2956 | :call g:filename#funcname() |
| 2957 | |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2958 | When such a function is called, and it is not defined yet, Vim will search the |
| 2959 | "autoload" directories in 'runtimepath' for a script file called |
| 2960 | "filename.vim". For example "~/.vim/autoload/filename.vim". That file should |
| 2961 | then define the function like this: > |
| 2962 | |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 2963 | function filename#funcname() |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2964 | echo "Done!" |
| 2965 | endfunction |
| 2966 | |
Bram Moolenaar | 60a795a | 2005-09-16 21:55:43 +0000 | [diff] [blame] | 2967 | The file name and the name used before the # in the function must match |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2968 | exactly, and the defined function must have the name exactly as it will be |
Bram Moolenaar | 65e0d77 | 2020-06-14 17:29:55 +0200 | [diff] [blame] | 2969 | called. In Vim9 script the "g:" prefix must be used: > |
| 2970 | function g:filename#funcname() |
| 2971 | |
| 2972 | or for a compiled function: > |
| 2973 | def g:filename#funcname() |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2974 | |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 2975 | It is possible to use subdirectories. Every # in the function name works like |
| 2976 | a path separator. Thus when calling a function: > |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2977 | |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 2978 | :call foo#bar#func() |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2979 | |
| 2980 | Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. |
| 2981 | |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2982 | This also works when reading a variable that has not been set yet: > |
| 2983 | |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 2984 | :let l = foo#bar#lvar |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2985 | |
Bram Moolenaar | a5792f5 | 2005-11-23 21:25:05 +0000 | [diff] [blame] | 2986 | However, when the autoload script was already loaded it won't be loaded again |
| 2987 | for an unknown variable. |
| 2988 | |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2989 | When assigning a value to such a variable nothing special happens. This can |
| 2990 | be used to pass settings to the autoload script before it's loaded: > |
| 2991 | |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 2992 | :let foo#bar#toggle = 1 |
| 2993 | :call foo#bar#func() |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2994 | |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2995 | Note that when you make a mistake and call a function that is supposed to be |
| 2996 | defined in an autoload script, but the script doesn't actually define the |
Bram Moolenaar | cb80aa2 | 2020-10-26 21:12:46 +0100 | [diff] [blame] | 2997 | function, you will get an error message for the missing function. If you fix |
| 2998 | the autoload script it won't be automatically loaded again. Either restart |
| 2999 | Vim or manually source the script. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 3000 | |
| 3001 | Also note that if you have two script files, and one calls a function in the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3002 | other and vice versa, before the used function is defined, it won't work. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 3003 | Avoid using the autoload functionality at the toplevel. |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 3004 | |
Bram Moolenaar | 944697a | 2022-02-20 19:48:20 +0000 | [diff] [blame] | 3005 | In |Vim9| script you will get error *E1263* if you define a function with |
| 3006 | a "#" character in the name. You should use a name without "#" and use |
| 3007 | `:export`. |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 3008 | |
Bram Moolenaar | 433f7c8 | 2006-03-21 21:29:36 +0000 | [diff] [blame] | 3009 | Hint: If you distribute a bunch of scripts you can pack them together with the |
| 3010 | |vimball| utility. Also read the user manual |distribute-script|. |
| 3011 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3012 | ============================================================================== |
| 3013 | 6. Curly braces names *curly-braces-names* |
| 3014 | |
Bram Moolenaar | 84f7235 | 2012-03-11 15:57:40 +0100 | [diff] [blame] | 3015 | In most places where you can use a variable, you can use a "curly braces name" |
| 3016 | variable. This is a regular variable name with one or more expressions |
| 3017 | wrapped in braces {} like this: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3018 | my_{adjective}_variable |
| 3019 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 3020 | This only works in legacy Vim script, not in |Vim9| script. |
| 3021 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3022 | When Vim encounters this, it evaluates the expression inside the braces, puts |
| 3023 | that in place of the expression, and re-interprets the whole as a variable |
| 3024 | name. So in the above example, if the variable "adjective" was set to |
| 3025 | "noisy", then the reference would be to "my_noisy_variable", whereas if |
| 3026 | "adjective" was set to "quiet", then it would be to "my_quiet_variable". |
| 3027 | |
| 3028 | One application for this is to create a set of variables governed by an option |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3029 | value. For example, the statement > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3030 | echo my_{&background}_message |
| 3031 | |
| 3032 | would output the contents of "my_dark_message" or "my_light_message" depending |
| 3033 | on the current value of 'background'. |
| 3034 | |
| 3035 | You can use multiple brace pairs: > |
| 3036 | echo my_{adverb}_{adjective}_message |
| 3037 | ..or even nest them: > |
| 3038 | echo my_{ad{end_of_word}}_message |
| 3039 | where "end_of_word" is either "verb" or "jective". |
| 3040 | |
| 3041 | However, the expression inside the braces must evaluate to a valid single |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 3042 | variable name, e.g. this is invalid: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3043 | :let foo='a + b' |
| 3044 | :echo c{foo}d |
| 3045 | .. since the result of expansion is "ca + bd", which is not a variable name. |
| 3046 | |
| 3047 | *curly-braces-function-names* |
| 3048 | You can call and define functions by an evaluated name in a similar way. |
| 3049 | Example: > |
| 3050 | :let func_end='whizz' |
| 3051 | :call my_func_{func_end}(parameter) |
| 3052 | |
| 3053 | This would call the function "my_func_whizz(parameter)". |
| 3054 | |
Bram Moolenaar | 84f7235 | 2012-03-11 15:57:40 +0100 | [diff] [blame] | 3055 | This does NOT work: > |
| 3056 | :let i = 3 |
| 3057 | :let @{i} = '' " error |
| 3058 | :echo @{i} " error |
| 3059 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3060 | ============================================================================== |
| 3061 | 7. Commands *expression-commands* |
| 3062 | |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 3063 | Note: in |Vim9| script `:let` is not used. `:var` is used for variable |
| 3064 | declarations and assignments do not use a command. |vim9-declaration| |
Bram Moolenaar | 65e0d77 | 2020-06-14 17:29:55 +0200 | [diff] [blame] | 3065 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3066 | :let {var-name} = {expr1} *:let* *E18* |
| 3067 | Set internal variable {var-name} to the result of the |
| 3068 | expression {expr1}. The variable will get the type |
| 3069 | from the {expr}. If {var-name} didn't exist yet, it |
| 3070 | is created. |
| 3071 | |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 3072 | :let {var-name}[{idx}] = {expr1} *E689* *E1141* |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 3073 | Set a list item to the result of the expression |
| 3074 | {expr1}. {var-name} must refer to a list and {idx} |
| 3075 | must be a valid index in that list. For nested list |
| 3076 | the index can be repeated. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3077 | This cannot be used to add an item to a |List|. |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3078 | This cannot be used to set a byte in a String. You |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3079 | can do that like this: > |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 3080 | :let var = var[0:2] .. 'X' .. var[4:] |
Bram Moolenaar | 6e5ea8d | 2019-01-12 22:47:31 +0100 | [diff] [blame] | 3081 | < When {var-name} is a |Blob| then {idx} can be the |
| 3082 | length of the blob, in which case one byte is |
| 3083 | appended. |
| 3084 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 3085 | *E711* *E719* *E1165* *E1166* *E1183* |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3086 | :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710* |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3087 | Set a sequence of items in a |List| to the result of |
| 3088 | the expression {expr1}, which must be a list with the |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 3089 | correct number of items. |
| 3090 | {idx1} can be omitted, zero is used instead. |
| 3091 | {idx2} can be omitted, meaning the end of the list. |
| 3092 | When the selected range of items is partly past the |
| 3093 | end of the list, items will be added. |
| 3094 | |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 3095 | *:let+=* *:let-=* *:letstar=* *:let/=* *:let%=* |
| 3096 | *:let.=* *:let..=* *E734* *E985* *E1019* |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3097 | :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". |
| 3098 | :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". |
Bram Moolenaar | ff697e6 | 2019-02-12 22:28:33 +0100 | [diff] [blame] | 3099 | :let {var} *= {expr1} Like ":let {var} = {var} * {expr1}". |
| 3100 | :let {var} /= {expr1} Like ":let {var} = {var} / {expr1}". |
| 3101 | :let {var} %= {expr1} Like ":let {var} = {var} % {expr1}". |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3102 | :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 3103 | :let {var} ..= {expr1} Like ":let {var} = {var} .. {expr1}". |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3104 | These fail if {var} was not set yet and when the type |
| 3105 | of {var} and {expr1} don't fit the operator. |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 3106 | `.=` is not supported with Vim script version 2 and |
| 3107 | later, see |vimscript-version|. |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3108 | |
| 3109 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3110 | :let ${env-name} = {expr1} *:let-environment* *:let-$* |
| 3111 | Set environment variable {env-name} to the result of |
| 3112 | the expression {expr1}. The type is always String. |
Bram Moolenaar | 56c860c | 2019-08-17 20:09:31 +0200 | [diff] [blame] | 3113 | |
| 3114 | On some systems making an environment variable empty |
| 3115 | causes it to be deleted. Many systems do not make a |
| 3116 | difference between an environment variable that is not |
| 3117 | set and an environment variable that is empty. |
| 3118 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3119 | :let ${env-name} .= {expr1} |
| 3120 | Append {expr1} to the environment variable {env-name}. |
| 3121 | If the environment variable didn't exist yet this |
| 3122 | works like "=". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3123 | |
| 3124 | :let @{reg-name} = {expr1} *:let-register* *:let-@* |
| 3125 | Write the result of the expression {expr1} in register |
| 3126 | {reg-name}. {reg-name} must be a single letter, and |
| 3127 | must be the name of a writable register (see |
| 3128 | |registers|). "@@" can be used for the unnamed |
| 3129 | register, "@/" for the search pattern. |
| 3130 | If the result of {expr1} ends in a <CR> or <NL>, the |
| 3131 | register will be linewise, otherwise it will be set to |
| 3132 | characterwise. |
| 3133 | This can be used to clear the last search pattern: > |
| 3134 | :let @/ = "" |
| 3135 | < This is different from searching for an empty string, |
| 3136 | that would match everywhere. |
| 3137 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3138 | :let @{reg-name} .= {expr1} |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3139 | Append {expr1} to register {reg-name}. If the |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3140 | register was empty it's like setting it to {expr1}. |
| 3141 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 3142 | :let &{option-name} = {expr1} *:let-option* *:let-&* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3143 | Set option {option-name} to the result of the |
Bram Moolenaar | fca34d6 | 2005-01-04 21:38:36 +0000 | [diff] [blame] | 3144 | expression {expr1}. A String or Number value is |
| 3145 | always converted to the type of the option. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3146 | For an option local to a window or buffer the effect |
| 3147 | is just like using the |:set| command: both the local |
Bram Moolenaar | a5fac54 | 2005-10-12 20:58:49 +0000 | [diff] [blame] | 3148 | value and the global value are changed. |
Bram Moolenaar | fca34d6 | 2005-01-04 21:38:36 +0000 | [diff] [blame] | 3149 | Example: > |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 3150 | :let &path = &path .. ',/usr/local/include' |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3151 | < This also works for terminal codes in the form t_xx. |
| 3152 | But only for alphanumerical names. Example: > |
| 3153 | :let &t_k1 = "\<Esc>[234;" |
| 3154 | < When the code does not exist yet it will be created as |
| 3155 | a terminal key code, there is no error. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3156 | |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3157 | :let &{option-name} .= {expr1} |
| 3158 | For a string option: Append {expr1} to the value. |
| 3159 | Does not insert a comma like |:set+=|. |
| 3160 | |
| 3161 | :let &{option-name} += {expr1} |
| 3162 | :let &{option-name} -= {expr1} |
| 3163 | For a number or boolean option: Add or subtract |
| 3164 | {expr1}. |
| 3165 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3166 | :let &l:{option-name} = {expr1} |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3167 | :let &l:{option-name} .= {expr1} |
| 3168 | :let &l:{option-name} += {expr1} |
| 3169 | :let &l:{option-name} -= {expr1} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3170 | Like above, but only set the local value of an option |
| 3171 | (if there is one). Works like |:setlocal|. |
| 3172 | |
| 3173 | :let &g:{option-name} = {expr1} |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3174 | :let &g:{option-name} .= {expr1} |
| 3175 | :let &g:{option-name} += {expr1} |
| 3176 | :let &g:{option-name} -= {expr1} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3177 | Like above, but only set the global value of an option |
| 3178 | (if there is one). Works like |:setglobal|. |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 3179 | *E1093* |
Bram Moolenaar | 13065c4 | 2005-01-08 16:08:21 +0000 | [diff] [blame] | 3180 | :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688* |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3181 | {expr1} must evaluate to a |List|. The first item in |
Bram Moolenaar | fca34d6 | 2005-01-04 21:38:36 +0000 | [diff] [blame] | 3182 | the list is assigned to {name1}, the second item to |
| 3183 | {name2}, etc. |
| 3184 | The number of names must match the number of items in |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3185 | the |List|. |
Bram Moolenaar | fca34d6 | 2005-01-04 21:38:36 +0000 | [diff] [blame] | 3186 | Each name can be one of the items of the ":let" |
| 3187 | command as mentioned above. |
| 3188 | Example: > |
| 3189 | :let [s, item] = GetItem(s) |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3190 | < Detail: {expr1} is evaluated first, then the |
| 3191 | assignments are done in sequence. This matters if |
| 3192 | {name2} depends on {name1}. Example: > |
| 3193 | :let x = [0, 1] |
| 3194 | :let i = 0 |
| 3195 | :let [i, x[i]] = [1, 2] |
| 3196 | :echo x |
| 3197 | < The result is [0, 2]. |
| 3198 | |
| 3199 | :let [{name1}, {name2}, ...] .= {expr1} |
| 3200 | :let [{name1}, {name2}, ...] += {expr1} |
| 3201 | :let [{name1}, {name2}, ...] -= {expr1} |
| 3202 | Like above, but append/add/subtract the value for each |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3203 | |List| item. |
Bram Moolenaar | fca34d6 | 2005-01-04 21:38:36 +0000 | [diff] [blame] | 3204 | |
Bram Moolenaar | d1caa94 | 2020-04-10 22:10:56 +0200 | [diff] [blame] | 3205 | :let [{name}, ..., ; {lastname}] = {expr1} *E452* |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3206 | Like |:let-unpack| above, but the |List| may have more |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3207 | items than there are names. A list of the remaining |
| 3208 | items is assigned to {lastname}. If there are no |
| 3209 | remaining items {lastname} is set to an empty list. |
Bram Moolenaar | fca34d6 | 2005-01-04 21:38:36 +0000 | [diff] [blame] | 3210 | Example: > |
| 3211 | :let [a, b; rest] = ["aval", "bval", 3, 4] |
| 3212 | < |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3213 | :let [{name}, ..., ; {lastname}] .= {expr1} |
| 3214 | :let [{name}, ..., ; {lastname}] += {expr1} |
| 3215 | :let [{name}, ..., ; {lastname}] -= {expr1} |
| 3216 | Like above, but append/add/subtract the value for each |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3217 | |List| item. |
Bram Moolenaar | 4a74803 | 2010-09-30 21:47:56 +0200 | [diff] [blame] | 3218 | |
Bram Moolenaar | 2458200 | 2019-07-21 14:14:26 +0200 | [diff] [blame] | 3219 | *:let=<<* *:let-heredoc* |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 3220 | *E990* *E991* *E172* *E221* *E1145* |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3221 | :let {var-name} =<< [trim] {endmarker} |
Bram Moolenaar | f5842c5 | 2019-05-19 18:41:26 +0200 | [diff] [blame] | 3222 | text... |
| 3223 | text... |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3224 | {endmarker} |
Bram Moolenaar | e46a440 | 2020-06-30 20:38:27 +0200 | [diff] [blame] | 3225 | Set internal variable {var-name} to a |List| |
| 3226 | containing the lines of text bounded by the string |
Bram Moolenaar | aa970ab | 2020-08-02 16:10:39 +0200 | [diff] [blame] | 3227 | {endmarker}. The lines of text is used as a |
| 3228 | |literal-string|. |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3229 | {endmarker} must not contain white space. |
| 3230 | {endmarker} cannot start with a lower case character. |
| 3231 | The last line should end only with the {endmarker} |
| 3232 | string without any other character. Watch out for |
| 3233 | white space after {endmarker}! |
Bram Moolenaar | f5842c5 | 2019-05-19 18:41:26 +0200 | [diff] [blame] | 3234 | |
Bram Moolenaar | e7eb927 | 2019-06-24 00:58:07 +0200 | [diff] [blame] | 3235 | Without "trim" any white space characters in the lines |
| 3236 | of text are preserved. If "trim" is specified before |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3237 | {endmarker}, then indentation is stripped so you can |
| 3238 | do: > |
Bram Moolenaar | e7eb927 | 2019-06-24 00:58:07 +0200 | [diff] [blame] | 3239 | let text =<< trim END |
| 3240 | if ok |
| 3241 | echo 'done' |
| 3242 | endif |
| 3243 | END |
| 3244 | < Results in: ["if ok", " echo 'done'", "endif"] |
| 3245 | The marker must line up with "let" and the indentation |
| 3246 | of the first line is removed from all the text lines. |
| 3247 | Specifically: all the leading indentation exactly |
| 3248 | matching the leading indentation of the first |
| 3249 | non-empty text line is stripped from the input lines. |
| 3250 | All leading indentation exactly matching the leading |
| 3251 | indentation before `let` is stripped from the line |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3252 | containing {endmarker}. Note that the difference |
| 3253 | between space and tab matters here. |
Bram Moolenaar | f5842c5 | 2019-05-19 18:41:26 +0200 | [diff] [blame] | 3254 | |
| 3255 | If {var-name} didn't exist yet, it is created. |
| 3256 | Cannot be followed by another command, but can be |
| 3257 | followed by a comment. |
| 3258 | |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3259 | To avoid line continuation to be applied, consider |
| 3260 | adding 'C' to 'cpoptions': > |
| 3261 | set cpo+=C |
| 3262 | let var =<< END |
| 3263 | \ leading backslash |
| 3264 | END |
| 3265 | set cpo-=C |
| 3266 | < |
Bram Moolenaar | f5842c5 | 2019-05-19 18:41:26 +0200 | [diff] [blame] | 3267 | Examples: > |
| 3268 | let var1 =<< END |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3269 | Sample text 1 |
| 3270 | Sample text 2 |
| 3271 | Sample text 3 |
| 3272 | END |
Bram Moolenaar | f5842c5 | 2019-05-19 18:41:26 +0200 | [diff] [blame] | 3273 | |
| 3274 | let data =<< trim DATA |
Bram Moolenaar | 2e693a8 | 2019-10-16 22:35:02 +0200 | [diff] [blame] | 3275 | 1 2 3 4 |
| 3276 | 5 6 7 8 |
Bram Moolenaar | f5842c5 | 2019-05-19 18:41:26 +0200 | [diff] [blame] | 3277 | DATA |
| 3278 | < |
Bram Moolenaar | 4a74803 | 2010-09-30 21:47:56 +0200 | [diff] [blame] | 3279 | *E121* |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3280 | :let {var-name} .. List the value of variable {var-name}. Multiple |
Bram Moolenaar | dcaf10e | 2005-01-21 11:55:25 +0000 | [diff] [blame] | 3281 | variable names may be given. Special names recognized |
| 3282 | here: *E738* |
Bram Moolenaar | ca003e1 | 2006-03-17 23:19:38 +0000 | [diff] [blame] | 3283 | g: global variables |
| 3284 | b: local buffer variables |
| 3285 | w: local window variables |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 3286 | t: local tab page variables |
Bram Moolenaar | ca003e1 | 2006-03-17 23:19:38 +0000 | [diff] [blame] | 3287 | s: script-local variables |
| 3288 | l: local function variables |
Bram Moolenaar | dcaf10e | 2005-01-21 11:55:25 +0000 | [diff] [blame] | 3289 | v: Vim variables. |
Bram Moolenaar | 65e0d77 | 2020-06-14 17:29:55 +0200 | [diff] [blame] | 3290 | This does not work in Vim9 script. |vim9-declaration| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3291 | |
Bram Moolenaar | d7ee7ce | 2005-01-03 21:02:03 +0000 | [diff] [blame] | 3292 | :let List the values of all variables. The type of the |
| 3293 | variable is indicated before the value: |
| 3294 | <nothing> String |
| 3295 | # Number |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 3296 | * Funcref |
Bram Moolenaar | 65e0d77 | 2020-06-14 17:29:55 +0200 | [diff] [blame] | 3297 | This does not work in Vim9 script. |vim9-declaration| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3298 | |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 3299 | :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795* *E1081* |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3300 | Remove the internal variable {name}. Several variable |
| 3301 | names can be given, they are all removed. The name |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3302 | may also be a |List| or |Dictionary| item. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3303 | With [!] no error message is given for non-existing |
| 3304 | variables. |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3305 | One or more items from a |List| can be removed: > |
Bram Moolenaar | 9cd1516 | 2005-01-16 22:02:49 +0000 | [diff] [blame] | 3306 | :unlet list[3] " remove fourth item |
| 3307 | :unlet list[3:] " remove fourth item to last |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3308 | < One item from a |Dictionary| can be removed at a time: > |
Bram Moolenaar | 9cd1516 | 2005-01-16 22:02:49 +0000 | [diff] [blame] | 3309 | :unlet dict['two'] |
| 3310 | :unlet dict.two |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 3311 | < This is especially useful to clean up used global |
| 3312 | variables and script-local variables (these are not |
| 3313 | deleted when the script ends). Function-local |
| 3314 | variables are automatically deleted when the function |
| 3315 | ends. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3316 | |
Bram Moolenaar | 137374f | 2018-05-13 15:59:50 +0200 | [diff] [blame] | 3317 | :unl[et] ${env-name} ... *:unlet-environment* *:unlet-$* |
| 3318 | Remove environment variable {env-name}. |
| 3319 | Can mix {name} and ${env-name} in one :unlet command. |
| 3320 | No error message is given for a non-existing |
| 3321 | variable, also without !. |
| 3322 | If the system does not support deleting an environment |
Bram Moolenaar | 9937a05 | 2019-06-15 15:45:06 +0200 | [diff] [blame] | 3323 | variable, it is made empty. |
Bram Moolenaar | 137374f | 2018-05-13 15:59:50 +0200 | [diff] [blame] | 3324 | |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 3325 | *:cons* *:const* *E1018* |
Bram Moolenaar | 9937a05 | 2019-06-15 15:45:06 +0200 | [diff] [blame] | 3326 | :cons[t] {var-name} = {expr1} |
| 3327 | :cons[t] [{name1}, {name2}, ...] = {expr1} |
Bram Moolenaar | 9937a05 | 2019-06-15 15:45:06 +0200 | [diff] [blame] | 3328 | :cons[t] [{name}, ..., ; {lastname}] = {expr1} |
| 3329 | :cons[t] {var-name} =<< [trim] {marker} |
| 3330 | text... |
| 3331 | text... |
| 3332 | {marker} |
| 3333 | Similar to |:let|, but additionally lock the variable |
| 3334 | after setting the value. This is the same as locking |
| 3335 | the variable with |:lockvar| just after |:let|, thus: > |
| 3336 | :const x = 1 |
| 3337 | < is equivalent to: > |
| 3338 | :let x = 1 |
Bram Moolenaar | 021bda5 | 2020-08-17 21:07:22 +0200 | [diff] [blame] | 3339 | :lockvar! x |
Bram Moolenaar | a187c43 | 2020-09-16 21:08:28 +0200 | [diff] [blame] | 3340 | < NOTE: in Vim9 script `:const` works differently, see |
| 3341 | |vim9-const| |
| 3342 | This is useful if you want to make sure the variable |
Bram Moolenaar | 021bda5 | 2020-08-17 21:07:22 +0200 | [diff] [blame] | 3343 | is not modified. If the value is a List or Dictionary |
| 3344 | literal then the items also cannot be changed: > |
| 3345 | const ll = [1, 2, 3] |
| 3346 | let ll[1] = 5 " Error! |
Bram Moolenaar | 6e64922 | 2021-10-04 21:32:54 +0100 | [diff] [blame] | 3347 | < Nested references are not locked: > |
Bram Moolenaar | 021bda5 | 2020-08-17 21:07:22 +0200 | [diff] [blame] | 3348 | let lvar = ['a'] |
| 3349 | const lconst = [0, lvar] |
| 3350 | let lconst[0] = 2 " Error! |
| 3351 | let lconst[1][0] = 'b' " OK |
| 3352 | < *E995* |
Bram Moolenaar | 9b28352 | 2019-06-17 22:19:33 +0200 | [diff] [blame] | 3353 | |:const| does not allow to for changing a variable: > |
Bram Moolenaar | 9937a05 | 2019-06-15 15:45:06 +0200 | [diff] [blame] | 3354 | :let x = 1 |
| 3355 | :const x = 2 " Error! |
Bram Moolenaar | 1c196e7 | 2019-06-16 15:41:58 +0200 | [diff] [blame] | 3356 | < *E996* |
| 3357 | Note that environment variables, option values and |
| 3358 | register values cannot be used here, since they cannot |
| 3359 | be locked. |
| 3360 | |
Bram Moolenaar | 85850f3 | 2019-07-19 22:05:51 +0200 | [diff] [blame] | 3361 | :cons[t] |
| 3362 | :cons[t] {var-name} |
| 3363 | If no argument is given or only {var-name} is given, |
| 3364 | the behavior is the same as |:let|. |
| 3365 | |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3366 | :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv* |
| 3367 | Lock the internal variable {name}. Locking means that |
| 3368 | it can no longer be changed (until it is unlocked). |
| 3369 | A locked variable can be deleted: > |
| 3370 | :lockvar v |
Bram Moolenaar | dad4473 | 2021-03-31 20:07:33 +0200 | [diff] [blame] | 3371 | :let v = 'asdf' " fails! |
| 3372 | :unlet v " works |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 3373 | < *E741* *E940* *E1118* *E1119* *E1120* *E1121* *E1122* |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3374 | If you try to change a locked variable you get an |
Bram Moolenaar | e7877fe | 2017-02-20 22:35:33 +0100 | [diff] [blame] | 3375 | error message: "E741: Value is locked: {name}". |
| 3376 | If you try to lock or unlock a built-in variable you |
| 3377 | get an error message: "E940: Cannot lock or unlock |
| 3378 | variable {name}". |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3379 | |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3380 | [depth] is relevant when locking a |List| or |
| 3381 | |Dictionary|. It specifies how deep the locking goes: |
Bram Moolenaar | a187c43 | 2020-09-16 21:08:28 +0200 | [diff] [blame] | 3382 | 0 Lock the variable {name} but not its |
| 3383 | value. |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3384 | 1 Lock the |List| or |Dictionary| itself, |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3385 | cannot add or remove items, but can |
| 3386 | still change their values. |
| 3387 | 2 Also lock the values, cannot change |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3388 | the items. If an item is a |List| or |
| 3389 | |Dictionary|, cannot add or remove |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3390 | items, but can still change the |
| 3391 | values. |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3392 | 3 Like 2 but for the |List| / |
| 3393 | |Dictionary| in the |List| / |
| 3394 | |Dictionary|, one level deeper. |
| 3395 | The default [depth] is 2, thus when {name} is a |List| |
| 3396 | or |Dictionary| the values cannot be changed. |
Bram Moolenaar | a187c43 | 2020-09-16 21:08:28 +0200 | [diff] [blame] | 3397 | |
| 3398 | Example with [depth] 0: > |
| 3399 | let mylist = [1, 2, 3] |
| 3400 | lockvar 0 mylist |
Bram Moolenaar | 6e64922 | 2021-10-04 21:32:54 +0100 | [diff] [blame] | 3401 | let mylist[0] = 77 " OK |
| 3402 | call add(mylist, 4] " OK |
Bram Moolenaar | a187c43 | 2020-09-16 21:08:28 +0200 | [diff] [blame] | 3403 | let mylist = [7, 8, 9] " Error! |
| 3404 | < *E743* |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3405 | For unlimited depth use [!] and omit [depth]. |
| 3406 | However, there is a maximum depth of 100 to catch |
| 3407 | loops. |
| 3408 | |
Bram Moolenaar | 32466aa | 2006-02-24 23:53:04 +0000 | [diff] [blame] | 3409 | Note that when two variables refer to the same |List| |
| 3410 | and you lock one of them, the |List| will also be |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 3411 | locked when used through the other variable. |
| 3412 | Example: > |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3413 | :let l = [0, 1, 2, 3] |
| 3414 | :let cl = l |
| 3415 | :lockvar l |
| 3416 | :let cl[1] = 99 " won't work! |
| 3417 | < You may want to make a copy of a list to avoid this. |
| 3418 | See |deepcopy()|. |
| 3419 | |
| 3420 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 3421 | :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo* *E1246* |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 3422 | Unlock the internal variable {name}. Does the |
| 3423 | opposite of |:lockvar|. |
| 3424 | |
Bram Moolenaar | 61da1bf | 2019-06-06 12:14:49 +0200 | [diff] [blame] | 3425 | :if {expr1} *:if* *:end* *:endif* *:en* *E171* *E579* *E580* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3426 | :en[dif] Execute the commands until the next matching ":else" |
| 3427 | or ":endif" if {expr1} evaluates to non-zero. |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 3428 | Although the short forms work, it is recommended to |
| 3429 | always use `:endif` to avoid confusion. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3430 | |
| 3431 | From Vim version 4.5 until 5.0, every Ex command in |
| 3432 | between the ":if" and ":endif" is ignored. These two |
| 3433 | commands were just to allow for future expansions in a |
Bram Moolenaar | 85084ef | 2016-01-17 22:26:33 +0100 | [diff] [blame] | 3434 | backward compatible way. Nesting was allowed. Note |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3435 | that any ":else" or ":elseif" was ignored, the "else" |
| 3436 | part was not executed either. |
| 3437 | |
| 3438 | You can use this to remain compatible with older |
| 3439 | versions: > |
| 3440 | :if version >= 500 |
| 3441 | : version-5-specific-commands |
| 3442 | :endif |
| 3443 | < The commands still need to be parsed to find the |
| 3444 | "endif". Sometimes an older Vim has a problem with a |
| 3445 | new command. For example, ":silent" is recognized as |
| 3446 | a ":substitute" command. In that case ":execute" can |
| 3447 | avoid problems: > |
| 3448 | :if version >= 600 |
| 3449 | : execute "silent 1,$delete" |
| 3450 | :endif |
| 3451 | < |
| 3452 | NOTE: The ":append" and ":insert" commands don't work |
| 3453 | properly in between ":if" and ":endif". |
| 3454 | |
| 3455 | *:else* *:el* *E581* *E583* |
| 3456 | :el[se] Execute the commands until the next matching ":else" |
| 3457 | or ":endif" if they previously were not being |
| 3458 | executed. |
| 3459 | |
| 3460 | *:elseif* *:elsei* *E582* *E584* |
| 3461 | :elsei[f] {expr1} Short for ":else" ":if", with the addition that there |
| 3462 | is no extra ":endif". |
| 3463 | |
| 3464 | :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw* |
Bram Moolenaar | 3a3a723 | 2005-01-17 22:16:15 +0000 | [diff] [blame] | 3465 | *E170* *E585* *E588* *E733* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3466 | :endw[hile] Repeat the commands between ":while" and ":endwhile", |
| 3467 | as long as {expr1} evaluates to non-zero. |
| 3468 | When an error is detected from a command inside the |
| 3469 | loop, execution continues after the "endwhile". |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 3470 | Example: > |
| 3471 | :let lnum = 1 |
| 3472 | :while lnum <= line("$") |
| 3473 | :call FixLine(lnum) |
| 3474 | :let lnum = lnum + 1 |
| 3475 | :endwhile |
| 3476 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3477 | NOTE: The ":append" and ":insert" commands don't work |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 3478 | properly inside a ":while" and ":for" loop. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3479 | |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 3480 | :for {var} in {object} *:for* *E690* *E732* |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 3481 | :endfo[r] *:endfo* *:endfor* |
| 3482 | Repeat the commands between ":for" and ":endfor" for |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 3483 | each item in {object}. {object} can be a |List| or |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 3484 | a |Blob|. *E1177* |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 3485 | |
| 3486 | Variable {var} is set to the value of each item. |
| 3487 | In |Vim9| script the loop variable must not have been |
| 3488 | declared yet, unless when it is a |
| 3489 | global/window/tab/buffer variable. |
| 3490 | |
| 3491 | When an error is detected for a command inside the |
| 3492 | loop, execution continues after the "endfor". |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 3493 | Changing {object} inside the loop affects what items |
| 3494 | are used. Make a copy if this is unwanted: > |
Bram Moolenaar | de8866b | 2005-01-06 23:24:37 +0000 | [diff] [blame] | 3495 | :for item in copy(mylist) |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 3496 | < |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 3497 | When {object} is a |List| and not making a copy, in |
| 3498 | legacy script Vim stores a reference to the next item |
| 3499 | in the |List| before executing the commands with the |
| 3500 | current item. Thus the current item can be removed |
| 3501 | without effect. Removing any later item means it will |
| 3502 | not be found. Thus the following example works (an |
| 3503 | inefficient way to make a |List| empty): > |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3504 | for item in mylist |
| 3505 | call remove(mylist, 0) |
| 3506 | endfor |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 3507 | < Note that reordering the |List| (e.g., with sort() or |
Bram Moolenaar | 9588a0f | 2005-01-08 21:45:39 +0000 | [diff] [blame] | 3508 | reverse()) may have unexpected effects. |
Bram Moolenaar | 5da3605 | 2021-12-27 15:39:57 +0000 | [diff] [blame] | 3509 | In |Vim9| script the index is used. If an item before |
| 3510 | the current one is deleted the next item will be |
| 3511 | skipped. |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 3512 | |
Bram Moolenaar | 5e66b42 | 2019-01-24 21:58:10 +0100 | [diff] [blame] | 3513 | When {object} is a |Blob|, Vim always makes a copy to |
| 3514 | iterate over. Unlike with |List|, modifying the |
| 3515 | |Blob| does not affect the iteration. |
| 3516 | |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 3517 | :for [{var1}, {var2}, ...] in {listlist} |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 3518 | :endfo[r] *E1140* |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 3519 | Like ":for" above, but each item in {listlist} must be |
| 3520 | a list, of which each item is assigned to {var1}, |
| 3521 | {var2}, etc. Example: > |
| 3522 | :for [lnum, col] in [[1, 3], [2, 5], [3, 8]] |
| 3523 | :echo getline(lnum)[col] |
| 3524 | :endfor |
| 3525 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3526 | *:continue* *:con* *E586* |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 3527 | :con[tinue] When used inside a ":while" or ":for" loop, jumps back |
| 3528 | to the start of the loop. |
| 3529 | If it is used after a |:try| inside the loop but |
| 3530 | before the matching |:finally| (if present), the |
| 3531 | commands following the ":finally" up to the matching |
| 3532 | |:endtry| are executed first. This process applies to |
| 3533 | all nested ":try"s inside the loop. The outermost |
| 3534 | ":endtry" then jumps back to the start of the loop. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3535 | |
| 3536 | *:break* *:brea* *E587* |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 3537 | :brea[k] When used inside a ":while" or ":for" loop, skips to |
| 3538 | the command after the matching ":endwhile" or |
| 3539 | ":endfor". |
| 3540 | If it is used after a |:try| inside the loop but |
| 3541 | before the matching |:finally| (if present), the |
| 3542 | commands following the ":finally" up to the matching |
| 3543 | |:endtry| are executed first. This process applies to |
| 3544 | all nested ":try"s inside the loop. The outermost |
| 3545 | ":endtry" then jumps to the command after the loop. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3546 | |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 3547 | :try *:try* *:endt* *:endtry* |
| 3548 | *E600* *E601* *E602* *E1032* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3549 | :endt[ry] Change the error handling for the commands between |
| 3550 | ":try" and ":endtry" including everything being |
| 3551 | executed across ":source" commands, function calls, |
| 3552 | or autocommand invocations. |
| 3553 | |
| 3554 | When an error or interrupt is detected and there is |
| 3555 | a |:finally| command following, execution continues |
| 3556 | after the ":finally". Otherwise, or when the |
| 3557 | ":endtry" is reached thereafter, the next |
| 3558 | (dynamically) surrounding ":try" is checked for |
| 3559 | a corresponding ":finally" etc. Then the script |
Bram Moolenaar | bc93ceb | 2020-02-26 13:36:21 +0100 | [diff] [blame] | 3560 | processing is terminated. Whether a function |
| 3561 | definition has an "abort" argument does not matter. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3562 | Example: > |
Bram Moolenaar | bc93ceb | 2020-02-26 13:36:21 +0100 | [diff] [blame] | 3563 | try | call Unknown() | finally | echomsg "cleanup" | endtry |
| 3564 | echomsg "not reached" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3565 | < |
| 3566 | Moreover, an error or interrupt (dynamically) inside |
| 3567 | ":try" and ":endtry" is converted to an exception. It |
| 3568 | can be caught as if it were thrown by a |:throw| |
| 3569 | command (see |:catch|). In this case, the script |
| 3570 | processing is not terminated. |
| 3571 | |
| 3572 | The value "Vim:Interrupt" is used for an interrupt |
| 3573 | exception. An error in a Vim command is converted |
| 3574 | to a value of the form "Vim({command}):{errmsg}", |
| 3575 | other errors are converted to a value of the form |
| 3576 | "Vim:{errmsg}". {command} is the full command name, |
| 3577 | and {errmsg} is the message that is displayed if the |
| 3578 | error exception is not caught, always beginning with |
| 3579 | the error number. |
| 3580 | Examples: > |
Bram Moolenaar | bc93ceb | 2020-02-26 13:36:21 +0100 | [diff] [blame] | 3581 | try | sleep 100 | catch /^Vim:Interrupt$/ | endtry |
| 3582 | try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3583 | < |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 3584 | *:cat* *:catch* |
| 3585 | *E603* *E604* *E605* *E654* *E1033* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3586 | :cat[ch] /{pattern}/ The following commands until the next |:catch|, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3587 | |:finally|, or |:endtry| that belongs to the same |
| 3588 | |:try| as the ":catch" are executed when an exception |
| 3589 | matching {pattern} is being thrown and has not yet |
| 3590 | been caught by a previous ":catch". Otherwise, these |
| 3591 | commands are skipped. |
| 3592 | When {pattern} is omitted all errors are caught. |
| 3593 | Examples: > |
Bram Moolenaar | 647e24b | 2019-03-17 16:39:46 +0100 | [diff] [blame] | 3594 | :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C) |
| 3595 | :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors |
| 3596 | :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts |
| 3597 | :catch /^Vim(write):/ " catch all errors in :write |
| 3598 | :catch /^Vim\%((\a\+)\)\=:E123:/ " catch error E123 |
| 3599 | :catch /my-exception/ " catch user exception |
| 3600 | :catch /.*/ " catch everything |
| 3601 | :catch " same as /.*/ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3602 | < |
| 3603 | Another character can be used instead of / around the |
| 3604 | {pattern}, so long as it does not have a special |
| 3605 | meaning (e.g., '|' or '"') and doesn't occur inside |
Bram Moolenaar | 6f4754b | 2022-01-23 12:07:04 +0000 | [diff] [blame] | 3606 | {pattern}. *E1067* |
Bram Moolenaar | 7e38ea2 | 2014-04-05 22:55:53 +0200 | [diff] [blame] | 3607 | Information about the exception is available in |
| 3608 | |v:exception|. Also see |throw-variables|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3609 | NOTE: It is not reliable to ":catch" the TEXT of |
| 3610 | an error message because it may vary in different |
| 3611 | locales. |
| 3612 | |
| 3613 | *:fina* *:finally* *E606* *E607* |
| 3614 | :fina[lly] The following commands until the matching |:endtry| |
| 3615 | are executed whenever the part between the matching |
| 3616 | |:try| and the ":finally" is left: either by falling |
| 3617 | through to the ":finally" or by a |:continue|, |
| 3618 | |:break|, |:finish|, or |:return|, or by an error or |
| 3619 | interrupt or exception (see |:throw|). |
| 3620 | |
Bram Moolenaar | f10911e | 2022-01-29 22:20:48 +0000 | [diff] [blame] | 3621 | *:th* *:throw* *E608* *E1129* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3622 | :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. |
| 3623 | If the ":throw" is used after a |:try| but before the |
| 3624 | first corresponding |:catch|, commands are skipped |
| 3625 | until the first ":catch" matching {expr1} is reached. |
| 3626 | If there is no such ":catch" or if the ":throw" is |
| 3627 | used after a ":catch" but before the |:finally|, the |
| 3628 | commands following the ":finally" (if present) up to |
| 3629 | the matching |:endtry| are executed. If the ":throw" |
| 3630 | is after the ":finally", commands up to the ":endtry" |
| 3631 | are skipped. At the ":endtry", this process applies |
| 3632 | again for the next dynamically surrounding ":try" |
| 3633 | (which may be found in a calling function or sourcing |
| 3634 | script), until a matching ":catch" has been found. |
| 3635 | If the exception is not caught, the command processing |
| 3636 | is terminated. |
| 3637 | Example: > |
| 3638 | :try | throw "oops" | catch /^oo/ | echo "caught" | endtry |
Bram Moolenaar | 662db67 | 2011-03-22 14:05:35 +0100 | [diff] [blame] | 3639 | < Note that "catch" may need to be on a separate line |
| 3640 | for when an error causes the parsing to skip the whole |
| 3641 | line and not see the "|" that separates the commands. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3642 | |
| 3643 | *:ec* *:echo* |
| 3644 | :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The |
| 3645 | first {expr1} starts on a new line. |
| 3646 | Also see |:comment|. |
| 3647 | Use "\n" to start a new line. Use "\r" to move the |
| 3648 | cursor to the first column. |
| 3649 | Uses the highlighting set by the |:echohl| command. |
| 3650 | Cannot be followed by a comment. |
| 3651 | Example: > |
| 3652 | :echo "the value of 'shell' is" &shell |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 3653 | < *:echo-redraw* |
| 3654 | A later redraw may make the message disappear again. |
| 3655 | And since Vim mostly postpones redrawing until it's |
| 3656 | finished with a sequence of commands this happens |
| 3657 | quite often. To avoid that a command from before the |
| 3658 | ":echo" causes a redraw afterwards (redraws are often |
| 3659 | postponed until you type something), force a redraw |
| 3660 | with the |:redraw| command. Example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3661 | :new | redraw | echo "there is a new window" |
| 3662 | < |
| 3663 | *:echon* |
| 3664 | :echon {expr1} .. Echoes each {expr1}, without anything added. Also see |
| 3665 | |:comment|. |
| 3666 | Uses the highlighting set by the |:echohl| command. |
| 3667 | Cannot be followed by a comment. |
| 3668 | Example: > |
| 3669 | :echon "the value of 'shell' is " &shell |
| 3670 | < |
| 3671 | Note the difference between using ":echo", which is a |
| 3672 | Vim command, and ":!echo", which is an external shell |
| 3673 | command: > |
| 3674 | :!echo % --> filename |
| 3675 | < The arguments of ":!" are expanded, see |:_%|. > |
| 3676 | :!echo "%" --> filename or "filename" |
| 3677 | < Like the previous example. Whether you see the double |
| 3678 | quotes or not depends on your 'shell'. > |
| 3679 | :echo % --> nothing |
| 3680 | < The '%' is an illegal character in an expression. > |
| 3681 | :echo "%" --> % |
| 3682 | < This just echoes the '%' character. > |
| 3683 | :echo expand("%") --> filename |
| 3684 | < This calls the expand() function to expand the '%'. |
| 3685 | |
| 3686 | *:echoh* *:echohl* |
| 3687 | :echoh[l] {name} Use the highlight group {name} for the following |
| 3688 | |:echo|, |:echon| and |:echomsg| commands. Also used |
| 3689 | for the |input()| prompt. Example: > |
| 3690 | :echohl WarningMsg | echo "Don't panic!" | echohl None |
| 3691 | < Don't forget to set the group back to "None", |
| 3692 | otherwise all following echo's will be highlighted. |
| 3693 | |
| 3694 | *:echom* *:echomsg* |
| 3695 | :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the |
| 3696 | message in the |message-history|. |
| 3697 | Spaces are placed between the arguments as with the |
| 3698 | |:echo| command. But unprintable characters are |
| 3699 | displayed, not interpreted. |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 3700 | The parsing works slightly different from |:echo|, |
| 3701 | more like |:execute|. All the expressions are first |
| 3702 | evaluated and concatenated before echoing anything. |
Bram Moolenaar | 461a7fc | 2018-12-22 13:28:07 +0100 | [diff] [blame] | 3703 | If expressions does not evaluate to a Number or |
| 3704 | String, string() is used to turn it into a string. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3705 | Uses the highlighting set by the |:echohl| command. |
| 3706 | Example: > |
| 3707 | :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see." |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 3708 | < See |:echo-redraw| to avoid the message disappearing |
| 3709 | when the screen is redrawn. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3710 | *:echoe* *:echoerr* |
| 3711 | :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the |
| 3712 | message in the |message-history|. When used in a |
| 3713 | script or function the line number will be added. |
| 3714 | Spaces are placed between the arguments as with the |
Bram Moolenaar | 461a7fc | 2018-12-22 13:28:07 +0100 | [diff] [blame] | 3715 | |:echomsg| command. When used inside a try conditional, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3716 | the message is raised as an error exception instead |
| 3717 | (see |try-echoerr|). |
| 3718 | Example: > |
| 3719 | :echoerr "This script just failed!" |
| 3720 | < If you just want a highlighted message use |:echohl|. |
| 3721 | And to get a beep: > |
| 3722 | :exe "normal \<Esc>" |
Bram Moolenaar | 4c86830 | 2021-03-22 16:19:45 +0100 | [diff] [blame] | 3723 | |
| 3724 | :echoc[onsole] {expr1} .. *:echoc* *:echoconsole* |
| 3725 | Intended for testing: works like `:echomsg` but when |
| 3726 | running in the GUI and started from a terminal write |
| 3727 | the text to stdout. |
| 3728 | |
Bram Moolenaar | 09c6f26 | 2019-11-17 15:55:14 +0100 | [diff] [blame] | 3729 | *:eval* |
| 3730 | :eval {expr} Evaluate {expr} and discard the result. Example: > |
| 3731 | :eval Getlist()->Filter()->append('$') |
| 3732 | |
| 3733 | < The expression is supposed to have a side effect, |
| 3734 | since the resulting value is not used. In the example |
| 3735 | the `append()` call appends the List with text to the |
| 3736 | buffer. This is similar to `:call` but works with any |
| 3737 | expression. |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 3738 | In |Vim9| script an expression without an effect will |
| 3739 | result in error *E1207* . This should help noticing |
| 3740 | mistakes. |
Bram Moolenaar | 09c6f26 | 2019-11-17 15:55:14 +0100 | [diff] [blame] | 3741 | |
| 3742 | The command can be shortened to `:ev` or `:eva`, but |
| 3743 | these are hard to recognize and therefore not to be |
| 3744 | used. |
| 3745 | |
Bram Moolenaar | bc93ceb | 2020-02-26 13:36:21 +0100 | [diff] [blame] | 3746 | The command cannot be followed by "|" and another |
| 3747 | command, since "|" is seen as part of the expression. |
| 3748 | |
Bram Moolenaar | 09c6f26 | 2019-11-17 15:55:14 +0100 | [diff] [blame] | 3749 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3750 | *:exe* *:execute* |
| 3751 | :exe[cute] {expr1} .. Executes the string that results from the evaluation |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3752 | of {expr1} as an Ex command. |
| 3753 | Multiple arguments are concatenated, with a space in |
Bram Moolenaar | 7e6a515 | 2021-01-02 16:39:53 +0100 | [diff] [blame] | 3754 | between. To avoid the extra space use the ".." |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3755 | operator to concatenate strings into one argument. |
| 3756 | {expr1} is used as the processed command, command line |
| 3757 | editing keys are not recognized. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3758 | Cannot be followed by a comment. |
| 3759 | Examples: > |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 3760 | :execute "buffer" nextbuf |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 3761 | :execute "normal" count .. "w" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3762 | < |
| 3763 | ":execute" can be used to append a command to commands |
| 3764 | that don't accept a '|'. Example: > |
| 3765 | :execute '!ls' | echo "theend" |
| 3766 | |
| 3767 | < ":execute" is also a nice way to avoid having to type |
| 3768 | control characters in a Vim script for a ":normal" |
| 3769 | command: > |
| 3770 | :execute "normal ixxx\<Esc>" |
| 3771 | < This has an <Esc> character, see |expr-string|. |
| 3772 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3773 | Be careful to correctly escape special characters in |
| 3774 | file names. The |fnameescape()| function can be used |
Bram Moolenaar | 05bb953 | 2008-07-04 09:44:11 +0000 | [diff] [blame] | 3775 | for Vim commands, |shellescape()| for |:!| commands. |
| 3776 | Examples: > |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 3777 | :execute "e " .. fnameescape(filename) |
| 3778 | :execute "!ls " .. shellescape(filename, 1) |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3779 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3780 | Note: The executed string may be any command-line, but |
Bram Moolenaar | 76f3b1a | 2014-03-27 22:30:07 +0100 | [diff] [blame] | 3781 | starting or ending "if", "while" and "for" does not |
| 3782 | always work, because when commands are skipped the |
| 3783 | ":execute" is not evaluated and Vim loses track of |
| 3784 | where blocks start and end. Also "break" and |
| 3785 | "continue" should not be inside ":execute". |
| 3786 | This example does not work, because the ":execute" is |
| 3787 | not evaluated and Vim does not see the "while", and |
| 3788 | gives an error for finding an ":endwhile": > |
| 3789 | :if 0 |
| 3790 | : execute 'while i > 5' |
| 3791 | : echo "test" |
| 3792 | : endwhile |
| 3793 | :endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3794 | < |
| 3795 | It is allowed to have a "while" or "if" command |
| 3796 | completely in the executed string: > |
| 3797 | :execute 'while i < 5 | echo i | let i = i + 1 | endwhile' |
| 3798 | < |
| 3799 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3800 | *:exe-comment* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3801 | ":execute", ":echo" and ":echon" cannot be followed by |
| 3802 | a comment directly, because they see the '"' as the |
| 3803 | start of a string. But, you can use '|' followed by a |
| 3804 | comment. Example: > |
| 3805 | :echo "foo" | "this is a comment |
| 3806 | |
| 3807 | ============================================================================== |
| 3808 | 8. Exception handling *exception-handling* |
| 3809 | |
| 3810 | The Vim script language comprises an exception handling feature. This section |
| 3811 | explains how it can be used in a Vim script. |
| 3812 | |
| 3813 | Exceptions may be raised by Vim on an error or on interrupt, see |
| 3814 | |catch-errors| and |catch-interrupt|. You can also explicitly throw an |
| 3815 | exception by using the ":throw" command, see |throw-catch|. |
| 3816 | |
| 3817 | |
| 3818 | TRY CONDITIONALS *try-conditionals* |
| 3819 | |
| 3820 | Exceptions can be caught or can cause cleanup code to be executed. You can |
| 3821 | use a try conditional to specify catch clauses (that catch exceptions) and/or |
| 3822 | a finally clause (to be executed for cleanup). |
| 3823 | A try conditional begins with a |:try| command and ends at the matching |
| 3824 | |:endtry| command. In between, you can use a |:catch| command to start |
| 3825 | a catch clause, or a |:finally| command to start a finally clause. There may |
| 3826 | be none or multiple catch clauses, but there is at most one finally clause, |
| 3827 | which must not be followed by any catch clauses. The lines before the catch |
| 3828 | clauses and the finally clause is called a try block. > |
| 3829 | |
| 3830 | :try |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3831 | : ... |
| 3832 | : ... TRY BLOCK |
| 3833 | : ... |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3834 | :catch /{pattern}/ |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3835 | : ... |
| 3836 | : ... CATCH CLAUSE |
| 3837 | : ... |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3838 | :catch /{pattern}/ |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3839 | : ... |
| 3840 | : ... CATCH CLAUSE |
| 3841 | : ... |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3842 | :finally |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3843 | : ... |
| 3844 | : ... FINALLY CLAUSE |
| 3845 | : ... |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3846 | :endtry |
| 3847 | |
| 3848 | The try conditional allows to watch code for exceptions and to take the |
| 3849 | appropriate actions. Exceptions from the try block may be caught. Exceptions |
| 3850 | from the try block and also the catch clauses may cause cleanup actions. |
| 3851 | When no exception is thrown during execution of the try block, the control |
| 3852 | is transferred to the finally clause, if present. After its execution, the |
| 3853 | script continues with the line following the ":endtry". |
| 3854 | When an exception occurs during execution of the try block, the remaining |
| 3855 | lines in the try block are skipped. The exception is matched against the |
| 3856 | patterns specified as arguments to the ":catch" commands. The catch clause |
| 3857 | after the first matching ":catch" is taken, other catch clauses are not |
| 3858 | executed. The catch clause ends when the next ":catch", ":finally", or |
| 3859 | ":endtry" command is reached - whatever is first. Then, the finally clause |
| 3860 | (if present) is executed. When the ":endtry" is reached, the script execution |
| 3861 | continues in the following line as usual. |
| 3862 | When an exception that does not match any of the patterns specified by the |
| 3863 | ":catch" commands is thrown in the try block, the exception is not caught by |
| 3864 | that try conditional and none of the catch clauses is executed. Only the |
| 3865 | finally clause, if present, is taken. The exception pends during execution of |
| 3866 | the finally clause. It is resumed at the ":endtry", so that commands after |
| 3867 | the ":endtry" are not executed and the exception might be caught elsewhere, |
| 3868 | see |try-nesting|. |
| 3869 | When during execution of a catch clause another exception is thrown, the |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3870 | remaining lines in that catch clause are not executed. The new exception is |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3871 | not matched against the patterns in any of the ":catch" commands of the same |
| 3872 | try conditional and none of its catch clauses is taken. If there is, however, |
| 3873 | a finally clause, it is executed, and the exception pends during its |
| 3874 | execution. The commands following the ":endtry" are not executed. The new |
| 3875 | exception might, however, be caught elsewhere, see |try-nesting|. |
| 3876 | When during execution of the finally clause (if present) an exception is |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3877 | thrown, the remaining lines in the finally clause are skipped. If the finally |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3878 | clause has been taken because of an exception from the try block or one of the |
| 3879 | catch clauses, the original (pending) exception is discarded. The commands |
| 3880 | following the ":endtry" are not executed, and the exception from the finally |
| 3881 | clause is propagated and can be caught elsewhere, see |try-nesting|. |
| 3882 | |
| 3883 | The finally clause is also executed, when a ":break" or ":continue" for |
| 3884 | a ":while" loop enclosing the complete try conditional is executed from the |
| 3885 | try block or a catch clause. Or when a ":return" or ":finish" is executed |
| 3886 | from the try block or a catch clause of a try conditional in a function or |
| 3887 | sourced script, respectively. The ":break", ":continue", ":return", or |
| 3888 | ":finish" pends during execution of the finally clause and is resumed when the |
| 3889 | ":endtry" is reached. It is, however, discarded when an exception is thrown |
| 3890 | from the finally clause. |
| 3891 | When a ":break" or ":continue" for a ":while" loop enclosing the complete |
| 3892 | try conditional or when a ":return" or ":finish" is encountered in the finally |
| 3893 | clause, the rest of the finally clause is skipped, and the ":break", |
| 3894 | ":continue", ":return" or ":finish" is executed as usual. If the finally |
| 3895 | clause has been taken because of an exception or an earlier ":break", |
| 3896 | ":continue", ":return", or ":finish" from the try block or a catch clause, |
| 3897 | this pending exception or command is discarded. |
| 3898 | |
| 3899 | For examples see |throw-catch| and |try-finally|. |
| 3900 | |
| 3901 | |
| 3902 | NESTING OF TRY CONDITIONALS *try-nesting* |
| 3903 | |
| 3904 | Try conditionals can be nested arbitrarily. That is, a complete try |
| 3905 | conditional can be put into the try block, a catch clause, or the finally |
| 3906 | clause of another try conditional. If the inner try conditional does not |
| 3907 | catch an exception thrown in its try block or throws a new exception from one |
| 3908 | of its catch clauses or its finally clause, the outer try conditional is |
| 3909 | checked according to the rules above. If the inner try conditional is in the |
| 3910 | try block of the outer try conditional, its catch clauses are checked, but |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3911 | otherwise only the finally clause is executed. It does not matter for |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3912 | nesting, whether the inner try conditional is directly contained in the outer |
| 3913 | one, or whether the outer one sources a script or calls a function containing |
| 3914 | the inner try conditional. |
| 3915 | |
| 3916 | When none of the active try conditionals catches an exception, just their |
| 3917 | finally clauses are executed. Thereafter, the script processing terminates. |
| 3918 | An error message is displayed in case of an uncaught exception explicitly |
| 3919 | thrown by a ":throw" command. For uncaught error and interrupt exceptions |
| 3920 | implicitly raised by Vim, the error message(s) or interrupt message are shown |
| 3921 | as usual. |
| 3922 | |
| 3923 | For examples see |throw-catch|. |
| 3924 | |
| 3925 | |
| 3926 | EXAMINING EXCEPTION HANDLING CODE *except-examine* |
| 3927 | |
| 3928 | Exception handling code can get tricky. If you are in doubt what happens, set |
| 3929 | 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your |
| 3930 | script file. Then you see when an exception is thrown, discarded, caught, or |
| 3931 | finished. When using a verbosity level of at least 14, things pending in |
| 3932 | a finally clause are also shown. This information is also given in debug mode |
| 3933 | (see |debug-scripts|). |
| 3934 | |
| 3935 | |
| 3936 | THROWING AND CATCHING EXCEPTIONS *throw-catch* |
| 3937 | |
| 3938 | You can throw any number or string as an exception. Use the |:throw| command |
| 3939 | and pass the value to be thrown as argument: > |
| 3940 | :throw 4711 |
| 3941 | :throw "string" |
| 3942 | < *throw-expression* |
| 3943 | You can also specify an expression argument. The expression is then evaluated |
| 3944 | first, and the result is thrown: > |
| 3945 | :throw 4705 + strlen("string") |
| 3946 | :throw strpart("strings", 0, 6) |
| 3947 | |
| 3948 | An exception might be thrown during evaluation of the argument of the ":throw" |
| 3949 | command. Unless it is caught there, the expression evaluation is abandoned. |
| 3950 | The ":throw" command then does not throw a new exception. |
| 3951 | Example: > |
| 3952 | |
| 3953 | :function! Foo(arg) |
| 3954 | : try |
| 3955 | : throw a:arg |
| 3956 | : catch /foo/ |
| 3957 | : endtry |
| 3958 | : return 1 |
| 3959 | :endfunction |
| 3960 | : |
| 3961 | :function! Bar() |
| 3962 | : echo "in Bar" |
| 3963 | : return 4710 |
| 3964 | :endfunction |
| 3965 | : |
| 3966 | :throw Foo("arrgh") + Bar() |
| 3967 | |
| 3968 | This throws "arrgh", and "in Bar" is not displayed since Bar() is not |
| 3969 | executed. > |
| 3970 | :throw Foo("foo") + Bar() |
| 3971 | however displays "in Bar" and throws 4711. |
| 3972 | |
| 3973 | Any other command that takes an expression as argument might also be |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 3974 | abandoned by an (uncaught) exception during the expression evaluation. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3975 | exception is then propagated to the caller of the command. |
| 3976 | Example: > |
| 3977 | |
| 3978 | :if Foo("arrgh") |
| 3979 | : echo "then" |
| 3980 | :else |
| 3981 | : echo "else" |
| 3982 | :endif |
| 3983 | |
| 3984 | Here neither of "then" or "else" is displayed. |
| 3985 | |
| 3986 | *catch-order* |
| 3987 | Exceptions can be caught by a try conditional with one or more |:catch| |
| 3988 | commands, see |try-conditionals|. The values to be caught by each ":catch" |
| 3989 | command can be specified as a pattern argument. The subsequent catch clause |
| 3990 | gets executed when a matching exception is caught. |
| 3991 | Example: > |
| 3992 | |
| 3993 | :function! Foo(value) |
| 3994 | : try |
| 3995 | : throw a:value |
| 3996 | : catch /^\d\+$/ |
| 3997 | : echo "Number thrown" |
| 3998 | : catch /.*/ |
| 3999 | : echo "String thrown" |
| 4000 | : endtry |
| 4001 | :endfunction |
| 4002 | : |
| 4003 | :call Foo(0x1267) |
| 4004 | :call Foo('string') |
| 4005 | |
| 4006 | The first call to Foo() displays "Number thrown", the second "String thrown". |
| 4007 | An exception is matched against the ":catch" commands in the order they are |
| 4008 | specified. Only the first match counts. So you should place the more |
| 4009 | specific ":catch" first. The following order does not make sense: > |
| 4010 | |
| 4011 | : catch /.*/ |
| 4012 | : echo "String thrown" |
| 4013 | : catch /^\d\+$/ |
| 4014 | : echo "Number thrown" |
| 4015 | |
| 4016 | The first ":catch" here matches always, so that the second catch clause is |
| 4017 | never taken. |
| 4018 | |
| 4019 | *throw-variables* |
| 4020 | If you catch an exception by a general pattern, you may access the exact value |
| 4021 | in the variable |v:exception|: > |
| 4022 | |
| 4023 | : catch /^\d\+$/ |
| 4024 | : echo "Number thrown. Value is" v:exception |
| 4025 | |
| 4026 | You may also be interested where an exception was thrown. This is stored in |
| 4027 | |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the |
| 4028 | exception most recently caught as long it is not finished. |
| 4029 | Example: > |
| 4030 | |
| 4031 | :function! Caught() |
| 4032 | : if v:exception != "" |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4033 | : echo 'Caught "' . v:exception .. '" in ' .. v:throwpoint |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4034 | : else |
| 4035 | : echo 'Nothing caught' |
| 4036 | : endif |
| 4037 | :endfunction |
| 4038 | : |
| 4039 | :function! Foo() |
| 4040 | : try |
| 4041 | : try |
| 4042 | : try |
| 4043 | : throw 4711 |
| 4044 | : finally |
| 4045 | : call Caught() |
| 4046 | : endtry |
| 4047 | : catch /.*/ |
| 4048 | : call Caught() |
| 4049 | : throw "oops" |
| 4050 | : endtry |
| 4051 | : catch /.*/ |
| 4052 | : call Caught() |
| 4053 | : finally |
| 4054 | : call Caught() |
| 4055 | : endtry |
| 4056 | :endfunction |
| 4057 | : |
| 4058 | :call Foo() |
| 4059 | |
| 4060 | This displays > |
| 4061 | |
| 4062 | Nothing caught |
| 4063 | Caught "4711" in function Foo, line 4 |
| 4064 | Caught "oops" in function Foo, line 10 |
| 4065 | Nothing caught |
| 4066 | |
| 4067 | A practical example: The following command ":LineNumber" displays the line |
| 4068 | number in the script or function where it has been used: > |
| 4069 | |
| 4070 | :function! LineNumber() |
| 4071 | : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "") |
| 4072 | :endfunction |
| 4073 | :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry |
| 4074 | < |
| 4075 | *try-nested* |
| 4076 | An exception that is not caught by a try conditional can be caught by |
| 4077 | a surrounding try conditional: > |
| 4078 | |
| 4079 | :try |
| 4080 | : try |
| 4081 | : throw "foo" |
| 4082 | : catch /foobar/ |
| 4083 | : echo "foobar" |
| 4084 | : finally |
| 4085 | : echo "inner finally" |
| 4086 | : endtry |
| 4087 | :catch /foo/ |
| 4088 | : echo "foo" |
| 4089 | :endtry |
| 4090 | |
| 4091 | The inner try conditional does not catch the exception, just its finally |
| 4092 | clause is executed. The exception is then caught by the outer try |
| 4093 | conditional. The example displays "inner finally" and then "foo". |
| 4094 | |
| 4095 | *throw-from-catch* |
| 4096 | You can catch an exception and throw a new one to be caught elsewhere from the |
| 4097 | catch clause: > |
| 4098 | |
| 4099 | :function! Foo() |
| 4100 | : throw "foo" |
| 4101 | :endfunction |
| 4102 | : |
| 4103 | :function! Bar() |
| 4104 | : try |
| 4105 | : call Foo() |
| 4106 | : catch /foo/ |
| 4107 | : echo "Caught foo, throw bar" |
| 4108 | : throw "bar" |
| 4109 | : endtry |
| 4110 | :endfunction |
| 4111 | : |
| 4112 | :try |
| 4113 | : call Bar() |
| 4114 | :catch /.*/ |
| 4115 | : echo "Caught" v:exception |
| 4116 | :endtry |
| 4117 | |
| 4118 | This displays "Caught foo, throw bar" and then "Caught bar". |
| 4119 | |
| 4120 | *rethrow* |
| 4121 | There is no real rethrow in the Vim script language, but you may throw |
| 4122 | "v:exception" instead: > |
| 4123 | |
| 4124 | :function! Bar() |
| 4125 | : try |
| 4126 | : call Foo() |
| 4127 | : catch /.*/ |
| 4128 | : echo "Rethrow" v:exception |
| 4129 | : throw v:exception |
| 4130 | : endtry |
| 4131 | :endfunction |
| 4132 | < *try-echoerr* |
| 4133 | Note that this method cannot be used to "rethrow" Vim error or interrupt |
| 4134 | exceptions, because it is not possible to fake Vim internal exceptions. |
| 4135 | Trying so causes an error exception. You should throw your own exception |
| 4136 | denoting the situation. If you want to cause a Vim error exception containing |
| 4137 | the original error exception value, you can use the |:echoerr| command: > |
| 4138 | |
| 4139 | :try |
| 4140 | : try |
| 4141 | : asdf |
| 4142 | : catch /.*/ |
| 4143 | : echoerr v:exception |
| 4144 | : endtry |
| 4145 | :catch /.*/ |
| 4146 | : echo v:exception |
| 4147 | :endtry |
| 4148 | |
| 4149 | This code displays |
| 4150 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4151 | Vim(echoerr):Vim:E492: Not an editor command: asdf ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4152 | |
| 4153 | |
| 4154 | CLEANUP CODE *try-finally* |
| 4155 | |
| 4156 | Scripts often change global settings and restore them at their end. If the |
| 4157 | user however interrupts the script by pressing CTRL-C, the settings remain in |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4158 | an inconsistent state. The same may happen to you in the development phase of |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4159 | a script when an error occurs or you explicitly throw an exception without |
| 4160 | catching it. You can solve these problems by using a try conditional with |
| 4161 | a finally clause for restoring the settings. Its execution is guaranteed on |
| 4162 | normal control flow, on error, on an explicit ":throw", and on interrupt. |
| 4163 | (Note that errors and interrupts from inside the try conditional are converted |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4164 | to exceptions. When not caught, they terminate the script after the finally |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4165 | clause has been executed.) |
| 4166 | Example: > |
| 4167 | |
| 4168 | :try |
| 4169 | : let s:saved_ts = &ts |
| 4170 | : set ts=17 |
| 4171 | : |
| 4172 | : " Do the hard work here. |
| 4173 | : |
| 4174 | :finally |
| 4175 | : let &ts = s:saved_ts |
| 4176 | : unlet s:saved_ts |
| 4177 | :endtry |
| 4178 | |
| 4179 | This method should be used locally whenever a function or part of a script |
| 4180 | changes global settings which need to be restored on failure or normal exit of |
| 4181 | that function or script part. |
| 4182 | |
| 4183 | *break-finally* |
| 4184 | Cleanup code works also when the try block or a catch clause is left by |
| 4185 | a ":continue", ":break", ":return", or ":finish". |
| 4186 | Example: > |
| 4187 | |
| 4188 | :let first = 1 |
| 4189 | :while 1 |
| 4190 | : try |
| 4191 | : if first |
| 4192 | : echo "first" |
| 4193 | : let first = 0 |
| 4194 | : continue |
| 4195 | : else |
| 4196 | : throw "second" |
| 4197 | : endif |
| 4198 | : catch /.*/ |
| 4199 | : echo v:exception |
| 4200 | : break |
| 4201 | : finally |
| 4202 | : echo "cleanup" |
| 4203 | : endtry |
| 4204 | : echo "still in while" |
| 4205 | :endwhile |
| 4206 | :echo "end" |
| 4207 | |
| 4208 | This displays "first", "cleanup", "second", "cleanup", and "end". > |
| 4209 | |
| 4210 | :function! Foo() |
| 4211 | : try |
| 4212 | : return 4711 |
| 4213 | : finally |
| 4214 | : echo "cleanup\n" |
| 4215 | : endtry |
| 4216 | : echo "Foo still active" |
| 4217 | :endfunction |
| 4218 | : |
| 4219 | :echo Foo() "returned by Foo" |
| 4220 | |
| 4221 | This displays "cleanup" and "4711 returned by Foo". You don't need to add an |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4222 | extra ":return" in the finally clause. (Above all, this would override the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4223 | return value.) |
| 4224 | |
| 4225 | *except-from-finally* |
| 4226 | Using either of ":continue", ":break", ":return", ":finish", or ":throw" in |
| 4227 | a finally clause is possible, but not recommended since it abandons the |
| 4228 | cleanup actions for the try conditional. But, of course, interrupt and error |
| 4229 | exceptions might get raised from a finally clause. |
| 4230 | Example where an error in the finally clause stops an interrupt from |
| 4231 | working correctly: > |
| 4232 | |
| 4233 | :try |
| 4234 | : try |
| 4235 | : echo "Press CTRL-C for interrupt" |
| 4236 | : while 1 |
| 4237 | : endwhile |
| 4238 | : finally |
| 4239 | : unlet novar |
| 4240 | : endtry |
| 4241 | :catch /novar/ |
| 4242 | :endtry |
| 4243 | :echo "Script still running" |
| 4244 | :sleep 1 |
| 4245 | |
| 4246 | If you need to put commands that could fail into a finally clause, you should |
| 4247 | think about catching or ignoring the errors in these commands, see |
| 4248 | |catch-errors| and |ignore-errors|. |
| 4249 | |
| 4250 | |
| 4251 | CATCHING ERRORS *catch-errors* |
| 4252 | |
| 4253 | If you want to catch specific errors, you just have to put the code to be |
| 4254 | watched in a try block and add a catch clause for the error message. The |
| 4255 | presence of the try conditional causes all errors to be converted to an |
| 4256 | exception. No message is displayed and |v:errmsg| is not set then. To find |
| 4257 | the right pattern for the ":catch" command, you have to know how the format of |
| 4258 | the error exception is. |
| 4259 | Error exceptions have the following format: > |
| 4260 | |
| 4261 | Vim({cmdname}):{errmsg} |
| 4262 | or > |
| 4263 | Vim:{errmsg} |
| 4264 | |
| 4265 | {cmdname} is the name of the command that failed; the second form is used when |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4266 | the command name is not known. {errmsg} is the error message usually produced |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4267 | when the error occurs outside try conditionals. It always begins with |
| 4268 | a capital "E", followed by a two or three-digit error number, a colon, and |
| 4269 | a space. |
| 4270 | |
| 4271 | Examples: |
| 4272 | |
| 4273 | The command > |
| 4274 | :unlet novar |
| 4275 | normally produces the error message > |
| 4276 | E108: No such variable: "novar" |
| 4277 | which is converted inside try conditionals to an exception > |
| 4278 | Vim(unlet):E108: No such variable: "novar" |
| 4279 | |
| 4280 | The command > |
| 4281 | :dwim |
| 4282 | normally produces the error message > |
| 4283 | E492: Not an editor command: dwim |
| 4284 | which is converted inside try conditionals to an exception > |
| 4285 | Vim:E492: Not an editor command: dwim |
| 4286 | |
| 4287 | You can catch all ":unlet" errors by a > |
| 4288 | :catch /^Vim(unlet):/ |
| 4289 | or all errors for misspelled command names by a > |
| 4290 | :catch /^Vim:E492:/ |
| 4291 | |
| 4292 | Some error messages may be produced by different commands: > |
| 4293 | :function nofunc |
| 4294 | and > |
| 4295 | :delfunction nofunc |
| 4296 | both produce the error message > |
| 4297 | E128: Function name must start with a capital: nofunc |
| 4298 | which is converted inside try conditionals to an exception > |
| 4299 | Vim(function):E128: Function name must start with a capital: nofunc |
| 4300 | or > |
| 4301 | Vim(delfunction):E128: Function name must start with a capital: nofunc |
| 4302 | respectively. You can catch the error by its number independently on the |
| 4303 | command that caused it if you use the following pattern: > |
| 4304 | :catch /^Vim(\a\+):E128:/ |
| 4305 | |
| 4306 | Some commands like > |
| 4307 | :let x = novar |
| 4308 | produce multiple error messages, here: > |
| 4309 | E121: Undefined variable: novar |
| 4310 | E15: Invalid expression: novar |
| 4311 | Only the first is used for the exception value, since it is the most specific |
| 4312 | one (see |except-several-errors|). So you can catch it by > |
| 4313 | :catch /^Vim(\a\+):E121:/ |
| 4314 | |
| 4315 | You can catch all errors related to the name "nofunc" by > |
| 4316 | :catch /\<nofunc\>/ |
| 4317 | |
| 4318 | You can catch all Vim errors in the ":write" and ":read" commands by > |
| 4319 | :catch /^Vim(\(write\|read\)):E\d\+:/ |
| 4320 | |
| 4321 | You can catch all Vim errors by the pattern > |
| 4322 | :catch /^Vim\((\a\+)\)\=:E\d\+:/ |
| 4323 | < |
| 4324 | *catch-text* |
| 4325 | NOTE: You should never catch the error message text itself: > |
| 4326 | :catch /No such variable/ |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 4327 | only works in the English locale, but not when the user has selected |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4328 | a different language by the |:language| command. It is however helpful to |
| 4329 | cite the message text in a comment: > |
| 4330 | :catch /^Vim(\a\+):E108:/ " No such variable |
| 4331 | |
| 4332 | |
| 4333 | IGNORING ERRORS *ignore-errors* |
| 4334 | |
| 4335 | You can ignore errors in a specific Vim command by catching them locally: > |
| 4336 | |
| 4337 | :try |
| 4338 | : write |
| 4339 | :catch |
| 4340 | :endtry |
| 4341 | |
| 4342 | But you are strongly recommended NOT to use this simple form, since it could |
| 4343 | catch more than you want. With the ":write" command, some autocommands could |
| 4344 | be executed and cause errors not related to writing, for instance: > |
| 4345 | |
| 4346 | :au BufWritePre * unlet novar |
| 4347 | |
| 4348 | There could even be such errors you are not responsible for as a script |
| 4349 | writer: a user of your script might have defined such autocommands. You would |
| 4350 | then hide the error from the user. |
| 4351 | It is much better to use > |
| 4352 | |
| 4353 | :try |
| 4354 | : write |
| 4355 | :catch /^Vim(write):/ |
| 4356 | :endtry |
| 4357 | |
| 4358 | which only catches real write errors. So catch only what you'd like to ignore |
| 4359 | intentionally. |
| 4360 | |
| 4361 | For a single command that does not cause execution of autocommands, you could |
| 4362 | even suppress the conversion of errors to exceptions by the ":silent!" |
| 4363 | command: > |
| 4364 | :silent! nunmap k |
| 4365 | This works also when a try conditional is active. |
| 4366 | |
| 4367 | |
| 4368 | CATCHING INTERRUPTS *catch-interrupt* |
| 4369 | |
| 4370 | When there are active try conditionals, an interrupt (CTRL-C) is converted to |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4371 | the exception "Vim:Interrupt". You can catch it like every exception. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4372 | script is not terminated, then. |
| 4373 | Example: > |
| 4374 | |
| 4375 | :function! TASK1() |
| 4376 | : sleep 10 |
| 4377 | :endfunction |
| 4378 | |
| 4379 | :function! TASK2() |
| 4380 | : sleep 20 |
| 4381 | :endfunction |
| 4382 | |
| 4383 | :while 1 |
| 4384 | : let command = input("Type a command: ") |
| 4385 | : try |
| 4386 | : if command == "" |
| 4387 | : continue |
| 4388 | : elseif command == "END" |
| 4389 | : break |
| 4390 | : elseif command == "TASK1" |
| 4391 | : call TASK1() |
| 4392 | : elseif command == "TASK2" |
| 4393 | : call TASK2() |
| 4394 | : else |
| 4395 | : echo "\nIllegal command:" command |
| 4396 | : continue |
| 4397 | : endif |
| 4398 | : catch /^Vim:Interrupt$/ |
| 4399 | : echo "\nCommand interrupted" |
| 4400 | : " Caught the interrupt. Continue with next prompt. |
| 4401 | : endtry |
| 4402 | :endwhile |
| 4403 | |
| 4404 | You can interrupt a task here by pressing CTRL-C; the script then asks for |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4405 | a new command. If you press CTRL-C at the prompt, the script is terminated. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4406 | |
| 4407 | For testing what happens when CTRL-C would be pressed on a specific line in |
| 4408 | your script, use the debug mode and execute the |>quit| or |>interrupt| |
| 4409 | command on that line. See |debug-scripts|. |
| 4410 | |
| 4411 | |
| 4412 | CATCHING ALL *catch-all* |
| 4413 | |
| 4414 | The commands > |
| 4415 | |
| 4416 | :catch /.*/ |
| 4417 | :catch // |
| 4418 | :catch |
| 4419 | |
| 4420 | catch everything, error exceptions, interrupt exceptions and exceptions |
| 4421 | explicitly thrown by the |:throw| command. This is useful at the top level of |
| 4422 | a script in order to catch unexpected things. |
| 4423 | Example: > |
| 4424 | |
| 4425 | :try |
| 4426 | : |
| 4427 | : " do the hard work here |
| 4428 | : |
| 4429 | :catch /MyException/ |
| 4430 | : |
| 4431 | : " handle known problem |
| 4432 | : |
| 4433 | :catch /^Vim:Interrupt$/ |
| 4434 | : echo "Script interrupted" |
| 4435 | :catch /.*/ |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4436 | : echo "Internal error (" .. v:exception .. ")" |
| 4437 | : echo " - occurred at " .. v:throwpoint |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4438 | :endtry |
| 4439 | :" end of script |
| 4440 | |
| 4441 | Note: Catching all might catch more things than you want. Thus, you are |
| 4442 | strongly encouraged to catch only for problems that you can really handle by |
| 4443 | specifying a pattern argument to the ":catch". |
| 4444 | Example: Catching all could make it nearly impossible to interrupt a script |
| 4445 | by pressing CTRL-C: > |
| 4446 | |
| 4447 | :while 1 |
| 4448 | : try |
| 4449 | : sleep 1 |
| 4450 | : catch |
| 4451 | : endtry |
| 4452 | :endwhile |
| 4453 | |
| 4454 | |
| 4455 | EXCEPTIONS AND AUTOCOMMANDS *except-autocmd* |
| 4456 | |
| 4457 | Exceptions may be used during execution of autocommands. Example: > |
| 4458 | |
| 4459 | :autocmd User x try |
| 4460 | :autocmd User x throw "Oops!" |
| 4461 | :autocmd User x catch |
| 4462 | :autocmd User x echo v:exception |
| 4463 | :autocmd User x endtry |
| 4464 | :autocmd User x throw "Arrgh!" |
| 4465 | :autocmd User x echo "Should not be displayed" |
| 4466 | : |
| 4467 | :try |
| 4468 | : doautocmd User x |
| 4469 | :catch |
| 4470 | : echo v:exception |
| 4471 | :endtry |
| 4472 | |
| 4473 | This displays "Oops!" and "Arrgh!". |
| 4474 | |
| 4475 | *except-autocmd-Pre* |
| 4476 | For some commands, autocommands get executed before the main action of the |
| 4477 | command takes place. If an exception is thrown and not caught in the sequence |
| 4478 | of autocommands, the sequence and the command that caused its execution are |
| 4479 | abandoned and the exception is propagated to the caller of the command. |
| 4480 | Example: > |
| 4481 | |
| 4482 | :autocmd BufWritePre * throw "FAIL" |
| 4483 | :autocmd BufWritePre * echo "Should not be displayed" |
| 4484 | : |
| 4485 | :try |
| 4486 | : write |
| 4487 | :catch |
| 4488 | : echo "Caught:" v:exception "from" v:throwpoint |
| 4489 | :endtry |
| 4490 | |
| 4491 | Here, the ":write" command does not write the file currently being edited (as |
| 4492 | you can see by checking 'modified'), since the exception from the BufWritePre |
| 4493 | autocommand abandons the ":write". The exception is then caught and the |
| 4494 | script displays: > |
| 4495 | |
| 4496 | Caught: FAIL from BufWrite Auto commands for "*" |
| 4497 | < |
| 4498 | *except-autocmd-Post* |
| 4499 | For some commands, autocommands get executed after the main action of the |
| 4500 | command has taken place. If this main action fails and the command is inside |
| 4501 | an active try conditional, the autocommands are skipped and an error exception |
| 4502 | is thrown that can be caught by the caller of the command. |
| 4503 | Example: > |
| 4504 | |
| 4505 | :autocmd BufWritePost * echo "File successfully written!" |
| 4506 | : |
| 4507 | :try |
| 4508 | : write /i/m/p/o/s/s/i/b/l/e |
| 4509 | :catch |
| 4510 | : echo v:exception |
| 4511 | :endtry |
| 4512 | |
| 4513 | This just displays: > |
| 4514 | |
| 4515 | Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e) |
| 4516 | |
| 4517 | If you really need to execute the autocommands even when the main action |
| 4518 | fails, trigger the event from the catch clause. |
| 4519 | Example: > |
| 4520 | |
| 4521 | :autocmd BufWritePre * set noreadonly |
| 4522 | :autocmd BufWritePost * set readonly |
| 4523 | : |
| 4524 | :try |
| 4525 | : write /i/m/p/o/s/s/i/b/l/e |
| 4526 | :catch |
| 4527 | : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e |
| 4528 | :endtry |
| 4529 | < |
| 4530 | You can also use ":silent!": > |
| 4531 | |
| 4532 | :let x = "ok" |
| 4533 | :let v:errmsg = "" |
| 4534 | :autocmd BufWritePost * if v:errmsg != "" |
| 4535 | :autocmd BufWritePost * let x = "after fail" |
| 4536 | :autocmd BufWritePost * endif |
| 4537 | :try |
| 4538 | : silent! write /i/m/p/o/s/s/i/b/l/e |
| 4539 | :catch |
| 4540 | :endtry |
| 4541 | :echo x |
| 4542 | |
| 4543 | This displays "after fail". |
| 4544 | |
| 4545 | If the main action of the command does not fail, exceptions from the |
| 4546 | autocommands will be catchable by the caller of the command: > |
| 4547 | |
| 4548 | :autocmd BufWritePost * throw ":-(" |
| 4549 | :autocmd BufWritePost * echo "Should not be displayed" |
| 4550 | : |
| 4551 | :try |
| 4552 | : write |
| 4553 | :catch |
| 4554 | : echo v:exception |
| 4555 | :endtry |
| 4556 | < |
| 4557 | *except-autocmd-Cmd* |
| 4558 | For some commands, the normal action can be replaced by a sequence of |
| 4559 | autocommands. Exceptions from that sequence will be catchable by the caller |
| 4560 | of the command. |
| 4561 | Example: For the ":write" command, the caller cannot know whether the file |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4562 | had actually been written when the exception occurred. You need to tell it in |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4563 | some way. > |
| 4564 | |
| 4565 | :if !exists("cnt") |
| 4566 | : let cnt = 0 |
| 4567 | : |
| 4568 | : autocmd BufWriteCmd * if &modified |
| 4569 | : autocmd BufWriteCmd * let cnt = cnt + 1 |
| 4570 | : autocmd BufWriteCmd * if cnt % 3 == 2 |
| 4571 | : autocmd BufWriteCmd * throw "BufWriteCmdError" |
| 4572 | : autocmd BufWriteCmd * endif |
| 4573 | : autocmd BufWriteCmd * write | set nomodified |
| 4574 | : autocmd BufWriteCmd * if cnt % 3 == 0 |
| 4575 | : autocmd BufWriteCmd * throw "BufWriteCmdError" |
| 4576 | : autocmd BufWriteCmd * endif |
| 4577 | : autocmd BufWriteCmd * echo "File successfully written!" |
| 4578 | : autocmd BufWriteCmd * endif |
| 4579 | :endif |
| 4580 | : |
| 4581 | :try |
| 4582 | : write |
| 4583 | :catch /^BufWriteCmdError$/ |
| 4584 | : if &modified |
| 4585 | : echo "Error on writing (file contents not changed)" |
| 4586 | : else |
| 4587 | : echo "Error after writing" |
| 4588 | : endif |
| 4589 | :catch /^Vim(write):/ |
| 4590 | : echo "Error on writing" |
| 4591 | :endtry |
| 4592 | |
| 4593 | When this script is sourced several times after making changes, it displays |
| 4594 | first > |
| 4595 | File successfully written! |
| 4596 | then > |
| 4597 | Error on writing (file contents not changed) |
| 4598 | then > |
| 4599 | Error after writing |
| 4600 | etc. |
| 4601 | |
| 4602 | *except-autocmd-ill* |
| 4603 | You cannot spread a try conditional over autocommands for different events. |
| 4604 | The following code is ill-formed: > |
| 4605 | |
| 4606 | :autocmd BufWritePre * try |
| 4607 | : |
| 4608 | :autocmd BufWritePost * catch |
| 4609 | :autocmd BufWritePost * echo v:exception |
| 4610 | :autocmd BufWritePost * endtry |
| 4611 | : |
| 4612 | :write |
| 4613 | |
| 4614 | |
| 4615 | EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param* |
| 4616 | |
| 4617 | Some programming languages allow to use hierarchies of exception classes or to |
| 4618 | pass additional information with the object of an exception class. You can do |
| 4619 | similar things in Vim. |
| 4620 | In order to throw an exception from a hierarchy, just throw the complete |
| 4621 | class name with the components separated by a colon, for instance throw the |
| 4622 | string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. |
| 4623 | When you want to pass additional information with your exception class, add |
| 4624 | it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" |
| 4625 | for an error when writing "myfile". |
| 4626 | With the appropriate patterns in the ":catch" command, you can catch for |
| 4627 | base classes or derived classes of your hierarchy. Additional information in |
| 4628 | parentheses can be cut out from |v:exception| with the ":substitute" command. |
| 4629 | Example: > |
| 4630 | |
| 4631 | :function! CheckRange(a, func) |
| 4632 | : if a:a < 0 |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4633 | : throw "EXCEPT:MATHERR:RANGE(" .. a:func .. ")" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4634 | : endif |
| 4635 | :endfunction |
| 4636 | : |
| 4637 | :function! Add(a, b) |
| 4638 | : call CheckRange(a:a, "Add") |
| 4639 | : call CheckRange(a:b, "Add") |
| 4640 | : let c = a:a + a:b |
| 4641 | : if c < 0 |
| 4642 | : throw "EXCEPT:MATHERR:OVERFLOW" |
| 4643 | : endif |
| 4644 | : return c |
| 4645 | :endfunction |
| 4646 | : |
| 4647 | :function! Div(a, b) |
| 4648 | : call CheckRange(a:a, "Div") |
| 4649 | : call CheckRange(a:b, "Div") |
| 4650 | : if (a:b == 0) |
| 4651 | : throw "EXCEPT:MATHERR:ZERODIV" |
| 4652 | : endif |
| 4653 | : return a:a / a:b |
| 4654 | :endfunction |
| 4655 | : |
| 4656 | :function! Write(file) |
| 4657 | : try |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4658 | : execute "write" fnameescape(a:file) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4659 | : catch /^Vim(write):/ |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4660 | : throw "EXCEPT:IO(" .. getcwd() .. ", " .. a:file .. "):WRITEERR" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4661 | : endtry |
| 4662 | :endfunction |
| 4663 | : |
| 4664 | :try |
| 4665 | : |
| 4666 | : " something with arithmetics and I/O |
| 4667 | : |
| 4668 | :catch /^EXCEPT:MATHERR:RANGE/ |
| 4669 | : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "") |
| 4670 | : echo "Range error in" function |
| 4671 | : |
| 4672 | :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV |
| 4673 | : echo "Math error" |
| 4674 | : |
| 4675 | :catch /^EXCEPT:IO/ |
| 4676 | : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "") |
| 4677 | : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "") |
| 4678 | : if file !~ '^/' |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4679 | : let file = dir .. "/" .. file |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4680 | : endif |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4681 | : echo 'I/O error for "' .. file .. '"' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4682 | : |
| 4683 | :catch /^EXCEPT/ |
| 4684 | : echo "Unspecified error" |
| 4685 | : |
| 4686 | :endtry |
| 4687 | |
| 4688 | The exceptions raised by Vim itself (on error or when pressing CTRL-C) use |
| 4689 | a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself |
| 4690 | exceptions with the "Vim" prefix; they are reserved for Vim. |
| 4691 | Vim error exceptions are parameterized with the name of the command that |
| 4692 | failed, if known. See |catch-errors|. |
| 4693 | |
| 4694 | |
| 4695 | PECULIARITIES |
| 4696 | *except-compat* |
| 4697 | The exception handling concept requires that the command sequence causing the |
| 4698 | exception is aborted immediately and control is transferred to finally clauses |
| 4699 | and/or a catch clause. |
| 4700 | |
| 4701 | In the Vim script language there are cases where scripts and functions |
| 4702 | continue after an error: in functions without the "abort" flag or in a command |
| 4703 | after ":silent!", control flow goes to the following line, and outside |
| 4704 | functions, control flow goes to the line following the outermost ":endwhile" |
| 4705 | or ":endif". On the other hand, errors should be catchable as exceptions |
| 4706 | (thus, requiring the immediate abortion). |
| 4707 | |
| 4708 | This problem has been solved by converting errors to exceptions and using |
| 4709 | immediate abortion (if not suppressed by ":silent!") only when a try |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4710 | conditional is active. This is no restriction since an (error) exception can |
| 4711 | be caught only from an active try conditional. If you want an immediate |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4712 | termination without catching the error, just use a try conditional without |
| 4713 | catch clause. (You can cause cleanup code being executed before termination |
| 4714 | by specifying a finally clause.) |
| 4715 | |
| 4716 | When no try conditional is active, the usual abortion and continuation |
| 4717 | behavior is used instead of immediate abortion. This ensures compatibility of |
| 4718 | scripts written for Vim 6.1 and earlier. |
| 4719 | |
| 4720 | However, when sourcing an existing script that does not use exception handling |
| 4721 | commands (or when calling one of its functions) from inside an active try |
| 4722 | conditional of a new script, you might change the control flow of the existing |
| 4723 | script on error. You get the immediate abortion on error and can catch the |
| 4724 | error in the new script. If however the sourced script suppresses error |
| 4725 | messages by using the ":silent!" command (checking for errors by testing |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4726 | |v:errmsg| if appropriate), its execution path is not changed. The error is |
| 4727 | not converted to an exception. (See |:silent|.) So the only remaining cause |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4728 | where this happens is for scripts that don't care about errors and produce |
| 4729 | error messages. You probably won't want to use such code from your new |
| 4730 | scripts. |
| 4731 | |
| 4732 | *except-syntax-err* |
| 4733 | Syntax errors in the exception handling commands are never caught by any of |
| 4734 | the ":catch" commands of the try conditional they belong to. Its finally |
| 4735 | clauses, however, is executed. |
| 4736 | Example: > |
| 4737 | |
| 4738 | :try |
| 4739 | : try |
| 4740 | : throw 4711 |
| 4741 | : catch /\(/ |
| 4742 | : echo "in catch with syntax error" |
| 4743 | : catch |
| 4744 | : echo "inner catch-all" |
| 4745 | : finally |
| 4746 | : echo "inner finally" |
| 4747 | : endtry |
| 4748 | :catch |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4749 | : echo 'outer catch-all caught "' .. v:exception .. '"' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4750 | : finally |
| 4751 | : echo "outer finally" |
| 4752 | :endtry |
| 4753 | |
| 4754 | This displays: > |
| 4755 | inner finally |
| 4756 | outer catch-all caught "Vim(catch):E54: Unmatched \(" |
| 4757 | outer finally |
| 4758 | The original exception is discarded and an error exception is raised, instead. |
| 4759 | |
| 4760 | *except-single-line* |
| 4761 | The ":try", ":catch", ":finally", and ":endtry" commands can be put on |
| 4762 | a single line, but then syntax errors may make it difficult to recognize the |
| 4763 | "catch" line, thus you better avoid this. |
| 4764 | Example: > |
| 4765 | :try | unlet! foo # | catch | endtry |
| 4766 | raises an error exception for the trailing characters after the ":unlet!" |
| 4767 | argument, but does not see the ":catch" and ":endtry" commands, so that the |
| 4768 | error exception is discarded and the "E488: Trailing characters" message gets |
| 4769 | displayed. |
| 4770 | |
| 4771 | *except-several-errors* |
| 4772 | When several errors appear in a single command, the first error message is |
Bram Moolenaar | 53f7fcc | 2021-07-28 20:10:16 +0200 | [diff] [blame] | 4773 | usually the most specific one and therefore converted to the error exception. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4774 | Example: > |
| 4775 | echo novar |
| 4776 | causes > |
| 4777 | E121: Undefined variable: novar |
| 4778 | E15: Invalid expression: novar |
| 4779 | The value of the error exception inside try conditionals is: > |
| 4780 | Vim(echo):E121: Undefined variable: novar |
| 4781 | < *except-syntax-error* |
| 4782 | But when a syntax error is detected after a normal error in the same command, |
| 4783 | the syntax error is used for the exception being thrown. |
| 4784 | Example: > |
| 4785 | unlet novar # |
| 4786 | causes > |
| 4787 | E108: No such variable: "novar" |
| 4788 | E488: Trailing characters |
| 4789 | The value of the error exception inside try conditionals is: > |
| 4790 | Vim(unlet):E488: Trailing characters |
| 4791 | This is done because the syntax error might change the execution path in a way |
| 4792 | not intended by the user. Example: > |
| 4793 | try |
| 4794 | try | unlet novar # | catch | echo v:exception | endtry |
| 4795 | catch /.*/ |
| 4796 | echo "outer catch:" v:exception |
| 4797 | endtry |
| 4798 | This displays "outer catch: Vim(unlet):E488: Trailing characters", and then |
| 4799 | a "E600: Missing :endtry" error message is given, see |except-single-line|. |
| 4800 | |
| 4801 | ============================================================================== |
| 4802 | 9. Examples *eval-examples* |
| 4803 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4804 | Printing in Binary ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4805 | > |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 4806 | :" The function Nr2Bin() returns the binary string representation of a number. |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4807 | :func Nr2Bin(nr) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4808 | : let n = a:nr |
| 4809 | : let r = "" |
| 4810 | : while n |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4811 | : let r = '01'[n % 2] .. r |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4812 | : let n = n / 2 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4813 | : endwhile |
| 4814 | : return r |
| 4815 | :endfunc |
| 4816 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4817 | :" The function String2Bin() converts each character in a string to a |
| 4818 | :" binary string, separated with dashes. |
| 4819 | :func String2Bin(str) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4820 | : let out = '' |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4821 | : for ix in range(strlen(a:str)) |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 4822 | : let out = out .. '-' .. Nr2Bin(char2nr(a:str[ix])) |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4823 | : endfor |
| 4824 | : return out[1:] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4825 | :endfunc |
| 4826 | |
| 4827 | Example of its use: > |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4828 | :echo Nr2Bin(32) |
| 4829 | result: "100000" > |
| 4830 | :echo String2Bin("32") |
| 4831 | result: "110011-110010" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4832 | |
| 4833 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4834 | Sorting lines ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4835 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4836 | This example sorts lines with a specific compare function. > |
| 4837 | |
| 4838 | :func SortBuffer() |
| 4839 | : let lines = getline(1, '$') |
| 4840 | : call sort(lines, function("Strcmp")) |
| 4841 | : call setline(1, lines) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4842 | :endfunction |
| 4843 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4844 | As a one-liner: > |
| 4845 | :call setline(1, sort(getline(1, '$'), function("Strcmp"))) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4846 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4847 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4848 | scanf() replacement ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4849 | *sscanf* |
| 4850 | There is no sscanf() function in Vim. If you need to extract parts from a |
| 4851 | line, you can use matchstr() and substitute() to do it. This example shows |
| 4852 | how to get the file name, line number and column number out of a line like |
| 4853 | "foobar.txt, 123, 45". > |
| 4854 | :" Set up the match bit |
| 4855 | :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)' |
| 4856 | :"get the part matching the whole expression |
| 4857 | :let l = matchstr(line, mx) |
| 4858 | :"get each item out of the match |
| 4859 | :let file = substitute(l, mx, '\1', '') |
| 4860 | :let lnum = substitute(l, mx, '\2', '') |
| 4861 | :let col = substitute(l, mx, '\3', '') |
| 4862 | |
| 4863 | The input is in the variable "line", the results in the variables "file", |
| 4864 | "lnum" and "col". (idea from Michael Geddes) |
| 4865 | |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4866 | |
| 4867 | getting the scriptnames in a Dictionary ~ |
| 4868 | *scriptnames-dictionary* |
| 4869 | The |:scriptnames| command can be used to get a list of all script files that |
| 4870 | have been sourced. There is no equivalent function or variable for this |
| 4871 | (because it's rarely needed). In case you need to manipulate the list this |
| 4872 | code can be used: > |
| 4873 | " Get the output of ":scriptnames" in the scriptnames_output variable. |
| 4874 | let scriptnames_output = '' |
| 4875 | redir => scriptnames_output |
| 4876 | silent scriptnames |
| 4877 | redir END |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 4878 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4879 | " Split the output into lines and parse each line. Add an entry to the |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4880 | " "scripts" dictionary. |
| 4881 | let scripts = {} |
| 4882 | for line in split(scriptnames_output, "\n") |
| 4883 | " Only do non-blank lines. |
| 4884 | if line =~ '\S' |
| 4885 | " Get the first number in the line. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4886 | let nr = matchstr(line, '\d\+') |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4887 | " Get the file name, remove the script number " 123: ". |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4888 | let name = substitute(line, '.\+:\s*', '', '') |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4889 | " Add an item to the Dictionary |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4890 | let scripts[nr] = name |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 4891 | endif |
| 4892 | endfor |
| 4893 | unlet scriptnames_output |
| 4894 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4895 | ============================================================================== |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4896 | 10. Vim script versions *vimscript-version* *vimscript-versions* |
Bram Moolenaar | 911ead1 | 2019-04-21 00:03:35 +0200 | [diff] [blame] | 4897 | *scriptversion* |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4898 | Over time many features have been added to Vim script. This includes Ex |
| 4899 | commands, functions, variable types, etc. Each individual feature can be |
| 4900 | checked with the |has()| and |exists()| functions. |
| 4901 | |
| 4902 | Sometimes old syntax of functionality gets in the way of making Vim better. |
| 4903 | When support is taken away this will break older Vim scripts. To make this |
| 4904 | explicit the |:scriptversion| command can be used. When a Vim script is not |
| 4905 | compatible with older versions of Vim this will give an explicit error, |
Bram Moolenaar | 3ff5f0f | 2019-06-10 13:11:22 +0200 | [diff] [blame] | 4906 | instead of failing in mysterious ways. |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4907 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 4908 | When using a legacy function, defined with `:function`, in |Vim9| script then |
| 4909 | scriptversion 4 is used. |
| 4910 | |
Bram Moolenaar | 3ff5f0f | 2019-06-10 13:11:22 +0200 | [diff] [blame] | 4911 | *scriptversion-1* > |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4912 | :scriptversion 1 |
| 4913 | < This is the original Vim script, same as not using a |:scriptversion| |
| 4914 | command. Can be used to go back to old syntax for a range of lines. |
| 4915 | Test for support with: > |
| 4916 | has('vimscript-1') |
| 4917 | |
Bram Moolenaar | 3ff5f0f | 2019-06-10 13:11:22 +0200 | [diff] [blame] | 4918 | < *scriptversion-2* > |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4919 | :scriptversion 2 |
Bram Moolenaar | 68e6560 | 2019-05-26 21:33:31 +0200 | [diff] [blame] | 4920 | < String concatenation with "." is not supported, use ".." instead. |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4921 | This avoids the ambiguity using "." for Dict member access and |
| 4922 | floating point numbers. Now ".5" means the number 0.5. |
Bram Moolenaar | 3ff5f0f | 2019-06-10 13:11:22 +0200 | [diff] [blame] | 4923 | |
| 4924 | *scriptversion-3* > |
Bram Moolenaar | 911ead1 | 2019-04-21 00:03:35 +0200 | [diff] [blame] | 4925 | :scriptversion 3 |
| 4926 | < All |vim-variable|s must be prefixed by "v:". E.g. "version" doesn't |
| 4927 | work as |v:version| anymore, it can be used as a normal variable. |
| 4928 | Same for some obvious names as "count" and others. |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4929 | |
Bram Moolenaar | 911ead1 | 2019-04-21 00:03:35 +0200 | [diff] [blame] | 4930 | Test for support with: > |
| 4931 | has('vimscript-3') |
Bram Moolenaar | 60a8de2 | 2019-09-15 14:33:22 +0200 | [diff] [blame] | 4932 | < |
| 4933 | *scriptversion-4* > |
| 4934 | :scriptversion 4 |
Bram Moolenaar | c17e66c | 2020-06-02 21:38:22 +0200 | [diff] [blame] | 4935 | < Numbers with a leading zero are not recognized as octal. "0o" or "0O" |
| 4936 | is still recognized as octal. With the |
Bram Moolenaar | 60a8de2 | 2019-09-15 14:33:22 +0200 | [diff] [blame] | 4937 | previous version you get: > |
Bram Moolenaar | c17e66c | 2020-06-02 21:38:22 +0200 | [diff] [blame] | 4938 | echo 017 " displays 15 (octal) |
| 4939 | echo 0o17 " displays 15 (octal) |
| 4940 | echo 018 " displays 18 (decimal) |
Bram Moolenaar | 60a8de2 | 2019-09-15 14:33:22 +0200 | [diff] [blame] | 4941 | < with script version 4: > |
Bram Moolenaar | c17e66c | 2020-06-02 21:38:22 +0200 | [diff] [blame] | 4942 | echo 017 " displays 17 (decimal) |
| 4943 | echo 0o17 " displays 15 (octal) |
| 4944 | echo 018 " displays 18 (decimal) |
Bram Moolenaar | 60a8de2 | 2019-09-15 14:33:22 +0200 | [diff] [blame] | 4945 | < Also, it is possible to use single quotes inside numbers to make them |
| 4946 | easier to read: > |
| 4947 | echo 1'000'000 |
| 4948 | < The quotes must be surrounded by digits. |
| 4949 | |
| 4950 | Test for support with: > |
| 4951 | has('vimscript-4') |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 4952 | |
| 4953 | ============================================================================== |
| 4954 | 11. No +eval feature *no-eval-feature* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4955 | |
| 4956 | When the |+eval| feature was disabled at compile time, none of the expression |
| 4957 | evaluation commands are available. To prevent this from causing Vim scripts |
| 4958 | to generate all kinds of errors, the ":if" and ":endif" commands are still |
| 4959 | recognized, though the argument of the ":if" and everything between the ":if" |
| 4960 | and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but |
| 4961 | only if the commands are at the start of the line. The ":else" command is not |
| 4962 | recognized. |
| 4963 | |
| 4964 | Example of how to avoid executing commands when the |+eval| feature is |
| 4965 | missing: > |
| 4966 | |
| 4967 | :if 1 |
| 4968 | : echo "Expression evaluation is compiled in" |
| 4969 | :else |
| 4970 | : echo "You will _never_ see this message" |
| 4971 | :endif |
| 4972 | |
Bram Moolenaar | 773a97c | 2019-06-06 20:39:55 +0200 | [diff] [blame] | 4973 | To execute a command only when the |+eval| feature is disabled can be done in |
| 4974 | two ways. The simplest is to exit the script (or Vim) prematurely: > |
| 4975 | if 1 |
| 4976 | echo "commands executed with +eval" |
| 4977 | finish |
| 4978 | endif |
| 4979 | args " command executed without +eval |
| 4980 | |
| 4981 | If you do not want to abort loading the script you can use a trick, as this |
| 4982 | example shows: > |
Bram Moolenaar | 45d2cca | 2017-04-30 16:36:05 +0200 | [diff] [blame] | 4983 | |
| 4984 | silent! while 0 |
| 4985 | set history=111 |
| 4986 | silent! endwhile |
| 4987 | |
| 4988 | When the |+eval| feature is available the command is skipped because of the |
| 4989 | "while 0". Without the |+eval| feature the "while 0" is an error, which is |
| 4990 | silently ignored, and the command is executed. |
Bram Moolenaar | cd5c8f8 | 2017-04-09 20:11:58 +0200 | [diff] [blame] | 4991 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4992 | ============================================================================== |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 4993 | 12. The sandbox *eval-sandbox* *sandbox* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4994 | |
Bram Moolenaar | 368373e | 2010-07-19 20:46:22 +0200 | [diff] [blame] | 4995 | The 'foldexpr', 'formatexpr', 'includeexpr', 'indentexpr', 'statusline' and |
| 4996 | 'foldtext' options may be evaluated in a sandbox. This means that you are |
| 4997 | protected from these expressions having nasty side effects. This gives some |
| 4998 | safety for when these options are set from a modeline. It is also used when |
| 4999 | the command from a tags file is executed and for CTRL-R = in the command line. |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 5000 | The sandbox is also used for the |:sandbox| command. |
Bram Moolenaar | 2f0936c | 2022-01-08 21:51:59 +0000 | [diff] [blame] | 5001 | *E48* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5002 | These items are not allowed in the sandbox: |
| 5003 | - changing the buffer text |
Bram Moolenaar | b477af2 | 2018-07-15 20:20:18 +0200 | [diff] [blame] | 5004 | - defining or changing mapping, autocommands, user commands |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5005 | - setting certain options (see |option-summary|) |
Bram Moolenaar | ef2f656 | 2007-05-06 13:32:59 +0000 | [diff] [blame] | 5006 | - setting certain v: variables (see |v:var|) *E794* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5007 | - executing a shell command |
| 5008 | - reading or writing a file |
| 5009 | - jumping to another buffer or editing a file |
Bram Moolenaar | 4770d09 | 2006-01-12 23:22:24 +0000 | [diff] [blame] | 5010 | - executing Python, Perl, etc. commands |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 5011 | This is not guaranteed 100% secure, but it should block most attacks. |
| 5012 | |
| 5013 | *:san* *:sandbox* |
Bram Moolenaar | 045e82d | 2005-07-08 22:25:33 +0000 | [diff] [blame] | 5014 | :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 5015 | option that may have been set from a modeline, e.g. |
| 5016 | 'foldexpr'. |
| 5017 | |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 5018 | *sandbox-option* |
| 5019 | A few options contain an expression. When this expression is evaluated it may |
Bram Moolenaar | 9b2200a | 2006-03-20 21:55:45 +0000 | [diff] [blame] | 5020 | have to be done in the sandbox to avoid a security risk. But the sandbox is |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 5021 | restrictive, thus this only happens when the option was set from an insecure |
| 5022 | location. Insecure in this context are: |
Bram Moolenaar | 551dbcc | 2006-04-25 22:13:59 +0000 | [diff] [blame] | 5023 | - sourcing a .vimrc or .exrc in the current directory |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 5024 | - while executing in the sandbox |
| 5025 | - value coming from a modeline |
Bram Moolenaar | b477af2 | 2018-07-15 20:20:18 +0200 | [diff] [blame] | 5026 | - executing a function that was defined in the sandbox |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 5027 | |
| 5028 | Note that when in the sandbox and saving an option value and restoring it, the |
| 5029 | option will still be marked as it was set in the sandbox. |
| 5030 | |
| 5031 | ============================================================================== |
Bram Moolenaar | 558ca4a | 2019-04-04 18:15:38 +0200 | [diff] [blame] | 5032 | 13. Textlock *textlock* |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 5033 | |
| 5034 | In a few situations it is not allowed to change the text in the buffer, jump |
| 5035 | to another window and some other things that might confuse or break what Vim |
| 5036 | is currently doing. This mostly applies to things that happen when Vim is |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 5037 | actually doing something else. For example, evaluating the 'balloonexpr' may |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 5038 | happen any moment the mouse cursor is resting at some position. |
| 5039 | |
| 5040 | This is not allowed when the textlock is active: |
| 5041 | - changing the buffer text |
| 5042 | - jumping to another buffer or window |
| 5043 | - editing another file |
| 5044 | - closing a window or quitting Vim |
| 5045 | - etc. |
| 5046 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5047 | |
Bram Moolenaar | 91f84f6 | 2018-07-29 15:07:52 +0200 | [diff] [blame] | 5048 | vim:tw=78:ts=8:noet:ft=help:norl: |