blob: 0f4ea17ec7a67feb81311758ce395d8d9d1487d3 [file] [log] [blame]
zeertzjq61e984e2023-12-09 15:18:33 +08001*vim9.txt* For Vim version 9.0. Last change: 2023 Dec 09
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
Bram Moolenaardcc58e02020-12-28 20:53:21 +01007Vim9 script commands and expressions. *Vim9* *vim9*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01008
9Most expression help is in |eval.txt|. This file is about the new syntax and
10features in Vim9 script.
11
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010012
13
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100141. What is Vim9 script? |Vim9-script|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100152. Differences |vim9-differences|
163. New style functions |fast-functions|
174. Types |vim9-types|
185. Namespace, Import and Export |vim9script|
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000196. Classes and interfaces |vim9-classes|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010020
219. Rationale |vim9-rationale|
22
23==============================================================================
24
Bram Moolenaar2b327002020-12-26 15:39:31 +0100251. What is Vim9 script? *Vim9-script*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010026
Bram Moolenaar7ceefb32020-05-01 16:07:38 +020027Vim script has been growing over time, while preserving backwards
28compatibility. That means bad choices from the past often can't be changed
Bram Moolenaar73fef332020-06-21 22:12:03 +020029and compatibility with Vi restricts possible solutions. Execution is quite
Bram Moolenaar7ceefb32020-05-01 16:07:38 +020030slow, each line is parsed every time it is executed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010031
Bram Moolenaar7ceefb32020-05-01 16:07:38 +020032The main goal of Vim9 script is to drastically improve performance. This is
33accomplished by compiling commands into instructions that can be efficiently
34executed. An increase in execution speed of 10 to 100 times can be expected.
35
36A secondary goal is to avoid Vim-specific constructs and get closer to
37commonly used programming languages, such as JavaScript, TypeScript and Java.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010038
39The performance improvements can only be achieved by not being 100% backwards
Bram Moolenaar8a3b8052022-06-26 12:21:15 +010040compatible. For example, making function arguments available in the "a:"
41dictionary adds quite a lot of overhead. In a Vim9 function this dictionary
42is not available. Other differences are more subtle, such as how errors are
43handled.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010044
45The Vim9 script syntax and semantics are used in:
46- a function defined with the `:def` command
47- a script file where the first command is `vim9script`
Bram Moolenaar1d59aa12020-09-19 18:50:13 +020048- an autocommand defined in the context of the above
Bram Moolenaar39f3b142021-02-14 12:57:36 +010049- a command prefixed with the `vim9cmd` command modifier
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010050
Bram Moolenaar82be4842021-01-11 19:40:15 +010051When using `:function` in a Vim9 script file the legacy syntax is used, with
52the highest |scriptversion|. However, this can be confusing and is therefore
53discouraged.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010054
Bram Moolenaar7ceefb32020-05-01 16:07:38 +020055Vim9 script and legacy Vim script can be mixed. There is no requirement to
Bram Moolenaar1d59aa12020-09-19 18:50:13 +020056rewrite old scripts, they keep working as before. You may want to use a few
57`:def` functions for code that needs to be fast.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010058
Bram Moolenaara2baa732022-02-04 16:09:54 +000059:vim9[cmd] {cmd} *:vim9* *:vim9cmd* *E1164*
Bram Moolenaar5b1d6e92022-02-11 20:33:48 +000060 Evaluate and execute {cmd} using Vim9 script syntax and
61 semantics. Useful when typing a command and in a legacy
62 script or function.
Bram Moolenaar39f3b142021-02-14 12:57:36 +010063
Bram Moolenaara2baa732022-02-04 16:09:54 +000064:leg[acy] {cmd} *:leg* *:legacy* *E1189* *E1234*
Bram Moolenaar5b1d6e92022-02-11 20:33:48 +000065 Evaluate and execute {cmd} using legacy script syntax and
66 semantics. Only useful in a Vim9 script or a :def function.
Bram Moolenaar96cf4ba2021-04-24 14:15:41 +020067 Note that {cmd} cannot use local variables, since it is parsed
68 with legacy expression syntax.
69
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010070==============================================================================
71
722. Differences from legacy Vim script *vim9-differences*
73
Bram Moolenaard58a3bf2020-09-28 21:48:16 +020074Overview ~
Bram Moolenaara2baa732022-02-04 16:09:54 +000075 *E1146*
Bram Moolenaard58a3bf2020-09-28 21:48:16 +020076Brief summary of the differences you will most often encounter when using Vim9
77script and `:def` functions; details are below:
78- Comments start with #, not ": >
Bram Moolenaar82be4842021-01-11 19:40:15 +010079 echo "hello" # comment
Bram Moolenaard58a3bf2020-09-28 21:48:16 +020080- Using a backslash for line continuation is hardly ever needed: >
Bram Moolenaar82be4842021-01-11 19:40:15 +010081 echo "hello "
Bram Moolenaard58a3bf2020-09-28 21:48:16 +020082 .. yourName
83 .. ", how are you?"
Bram Moolenaar5da36052021-12-27 15:39:57 +000084- White space is required in many places to improve readability.
Bram Moolenaarf10911e2022-01-29 22:20:48 +000085- Assign values without `:let` *E1126* , declare variables with `:var`: >
Bram Moolenaar82be4842021-01-11 19:40:15 +010086 var count = 0
Bram Moolenaard58a3bf2020-09-28 21:48:16 +020087 count += 3
88- Constants can be declared with `:final` and `:const`: >
Bram Moolenaar63f32602022-06-09 20:45:54 +010089 final matches = [] # add to the list later
Bram Moolenaard58a3bf2020-09-28 21:48:16 +020090 const names = ['Betty', 'Peter'] # cannot be changed
91- `:final` cannot be used as an abbreviation of `:finally`.
92- Variables and functions are script-local by default.
93- Functions are declared with argument types and return type: >
94 def CallMe(count: number, message: string): bool
95- Call functions without `:call`: >
Bram Moolenaar82be4842021-01-11 19:40:15 +010096 writefile(['done'], 'file.txt')
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +000097- You cannot use old Ex commands:
98 `:Print`
99 `:append`
100 `:change`
101 `:d` directly followed by 'd' or 'p'.
102 `:insert`
103 `:k`
104 `:mode`
105 `:open`
106 `:s` with only flags
107 `:t`
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000108 `:xit`
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000109- Some commands, especially those used for flow control, cannot be shortened.
Bram Moolenaar9712ff12022-09-18 13:04:22 +0100110 E.g., `:throw` cannot be written as `:th`. *vim9-no-shorten*
Bram Moolenaar22863042021-10-16 15:23:36 +0100111- You cannot use curly-braces names.
Bram Moolenaard58a3bf2020-09-28 21:48:16 +0200112- A range before a command must be prefixed with a colon: >
Bram Moolenaar82be4842021-01-11 19:40:15 +0100113 :%s/this/that
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200114- Executing a register with "@r" does not work, you can prepend a colon or use
115 `:exe`: >
Bram Moolenaar938ae282023-02-20 20:44:55 +0000116 :exe @a
Bram Moolenaar82be4842021-01-11 19:40:15 +0100117- Unless mentioned specifically, the highest |scriptversion| is used.
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000118- When defining an expression mapping, the expression will be evaluated in the
119 context of the script where it was defined.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +0100120- When indexing a string the index is counted in characters, not bytes:
121 |vim9-string-index|
122- Some possibly unexpected differences: |vim9-gotchas|.
Bram Moolenaard58a3bf2020-09-28 21:48:16 +0200123
124
Bram Moolenaar2c330432020-04-13 14:41:35 +0200125Comments starting with # ~
126
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200127In legacy Vim script comments start with double quote. In Vim9 script
128comments start with #. >
129 # declarations
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200130 var count = 0 # number of occurrences
Bram Moolenaar2c330432020-04-13 14:41:35 +0200131
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200132The reason is that a double quote can also be the start of a string. In many
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200133places, especially halfway through an expression with a line break, it's hard
134to tell what the meaning is, since both a string and a comment can be followed
135by arbitrary text. To avoid confusion only # comments are recognized. This
136is the same as in shell scripts and Python programs.
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200137
138In Vi # is a command to list text with numbers. In Vim9 script you can use
139`:number` for that. >
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000140 :101 number
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200141
142To improve readability there must be a space between a command and the #
Bram Moolenaar2b327002020-12-26 15:39:31 +0100143that starts a comment: >
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100144 var name = value # comment
145 var name = value# error!
Bram Moolenaara2baa732022-02-04 16:09:54 +0000146< *E1170*
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200147Do not start a comment with #{, it looks like the legacy dictionary literal
148and produces an error where this might be confusing. #{{ or #{{{ are OK,
149these can be used to start a fold.
150
Bram Moolenaar5ed11532022-07-06 13:18:11 +0100151When starting to read a script file Vim doesn't know it is |Vim9| script until
152the `vim9script` command is found. Until that point you would need to use
153legacy comments: >
154 " legacy comment
155 vim9script
156 # Vim9 comment
157
158That looks ugly, better put `vim9script` in the very first line: >
159 vim9script
160 # Vim9 comment
161
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100162In legacy Vim script # is also used for the alternate file name. In Vim9
163script you need to use %% instead. Instead of ## use %%% (stands for all
164arguments).
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200165
Bram Moolenaar2c330432020-04-13 14:41:35 +0200166
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100167Vim9 functions ~
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000168 *E1099*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200169A function defined with `:def` is compiled. Execution is many times faster,
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200170often 10 to 100 times.
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200171
Bram Moolenaar388a5d42020-05-26 21:20:45 +0200172Many errors are already found when compiling, before the function is executed.
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200173The syntax is strict, to enforce code that is easy to read and understand.
174
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200175Compilation is done when any of these is encountered:
Bram Moolenaar1b884a02020-12-10 21:11:27 +0100176- the first time the function is called
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200177- when the `:defcompile` command is encountered in the script after the
Bram Moolenaar207f0092020-08-30 17:20:20 +0200178 function was defined
179- `:disassemble` is used for the function.
180- a function that is compiled calls the function or uses it as a function
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200181 reference (so that the argument and return types can be checked)
Bram Moolenaara2baa732022-02-04 16:09:54 +0000182 *E1091* *E1191*
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200183If compilation fails it is not tried again on the next call, instead this
184error is given: "E1091: Function is not compiled: {name}".
Bram Moolenaar4c295022021-05-02 17:19:11 +0200185Compilation will fail when encountering a user command that has not been
186created yet. In this case you can call `execute()` to invoke it at runtime. >
187 def MyFunc()
188 execute('DefinedLater')
189 enddef
Bram Moolenaar388a5d42020-05-26 21:20:45 +0200190
191`:def` has no options like `:function` does: "range", "abort", "dict" or
Bram Moolenaar1b884a02020-12-10 21:11:27 +0100192"closure". A `:def` function always aborts on an error (unless `:silent!` was
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000193used for the command or the error was caught a `:try` block), does not get a
Bram Moolenaar63f32602022-06-09 20:45:54 +0100194range passed, cannot be a "dict" function, and can always be a closure.
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200195 *vim9-no-dict-function*
Bram Moolenaar10e8ff92023-06-10 21:40:39 +0100196You can use a Vim9 Class (|Vim9-class|) instead of a "dict function".
197You can also pass the dictionary explicitly: >
Bram Moolenaar63f32602022-06-09 20:45:54 +0100198 def DictFunc(self: dict<any>, arg: string)
199 echo self[arg]
Bram Moolenaar74235772021-06-12 14:53:05 +0200200 enddef
Bram Moolenaar46eea442022-03-30 10:51:39 +0100201 var ad = {item: 'value', func: DictFunc}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100202 ad.func(ad, 'item')
Bram Moolenaar74235772021-06-12 14:53:05 +0200203
Bram Moolenaar34cc7d82021-09-21 20:09:51 +0200204You can call a legacy dict function though: >
205 func Legacy() dict
206 echo self.value
207 endfunc
208 def CallLegacy()
209 var d = {func: Legacy, value: 'text'}
210 d.func()
211 enddef
Bram Moolenaara2baa732022-02-04 16:09:54 +0000212< *E1096* *E1174* *E1175*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200213The argument types and return type need to be specified. The "any" type can
214be used, type checking will then be done at runtime, like with legacy
215functions.
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000216 *E1106*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200217Arguments are accessed by name, without "a:", just like any other language.
218There is no "a:" dictionary or "a:000" list.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000219 *vim9-variable-arguments* *E1055* *E1160* *E1180*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200220Variable arguments are defined as the last argument, with a name and have a
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200221list type, similar to TypeScript. For example, a list of numbers: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200222 def MyFunc(...itemlist: list<number>)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100223 for item in itemlist
224 ...
225
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200226When a function argument is optional (it has a default value) passing `v:none`
227as the argument results in using the default value. This is useful when you
228want to specify a value for an argument that comes after an argument that
229should use its default value. Example: >
Bram Moolenaar22863042021-10-16 15:23:36 +0100230 def MyFunc(one = 'one', last = 'last')
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200231 ...
232 enddef
233 MyFunc(v:none, 'LAST') # first argument uses default value 'one'
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200234<
Bram Moolenaara2baa732022-02-04 16:09:54 +0000235 *vim9-ignored-argument* *E1181*
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200236The argument "_" (an underscore) can be used to ignore the argument. This is
237most useful in callbacks where you don't need it, but do need to give an
238argument to match the call. E.g. when using map() two arguments are passed,
239the key and the value, to ignore the key: >
Bram Moolenaar63f32602022-06-09 20:45:54 +0100240 map(numberList, (_, v) => v * 2)
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200241There is no error for using the "_" argument multiple times. No type needs to
242be given.
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200243
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100244
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200245Functions and variables are script-local by default ~
Bram Moolenaar65e0d772020-06-14 17:29:55 +0200246 *vim9-scopes*
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200247When using `:function` or `:def` to specify a new function at the script level
Bram Moolenaar92f645b2022-02-11 13:29:40 +0000248in a Vim9 script, the function is local to the script. Like prefixing "s:" in
249legacy script. To define a global function or variable the "g:" prefix must
250be used. For functions in a script that is to be imported and in an autoload
Bram Moolenaar63f32602022-06-09 20:45:54 +0100251script "export" needs to be used for those to be used elsewhere. >
Bram Moolenaarea2d8d22020-07-29 22:11:05 +0200252 def ThisFunction() # script-local
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200253 def g:ThatFunction() # global
Bram Moolenaar9da17d72022-02-09 21:50:44 +0000254 export def Function() # for import and import autoload
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000255< *E1058* *E1075*
Bram Moolenaar2bb26582020-10-03 22:52:39 +0200256When using `:function` or `:def` to specify a nested function inside a `:def`
Bram Moolenaar47003982021-12-05 21:54:04 +0000257function and no namespace was given, this nested function is local to the code
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000258block it is defined in. It cannot be used in `function()` with a string
259argument, pass the function reference itself: >
260 def Outer()
261 def Inner()
262 echo 'inner'
263 enddef
264 var Fok = function(Inner) # OK
265 var Fbad = function('Inner') # does not work
266
Bram Moolenaar63f32602022-06-09 20:45:54 +0100267Detail: this is because "Inner" will actually become a function reference to a
268function with a generated name.
269
270It is not possible to define a script-local function in a function. You can
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000271define a local function and assign it to a script-local Funcref (it must have
Bram Moolenaar63f32602022-06-09 20:45:54 +0100272been declared at the script level). It is possible to define a global
273function by using the "g:" prefix.
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200274
275When referring to a function and no "s:" or "g:" prefix is used, Vim will
Bram Moolenaar13106602020-10-04 16:06:05 +0200276search for the function:
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +0200277- in the function scope, in block scopes
Bram Moolenaar63f32602022-06-09 20:45:54 +0100278- in the script scope
279
280Imported functions are found with the prefix from the `:import` command.
Bram Moolenaar13106602020-10-04 16:06:05 +0200281
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200282Since a script-local function reference can be used without "s:" the name must
Bram Moolenaardad44732021-03-31 20:07:33 +0200283start with an upper case letter even when using the "s:" prefix. In legacy
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200284script "s:funcref" could be used, because it could not be referred to with
285"funcref". In Vim9 script it can, therefore "s:Funcref" must be used to avoid
286that the name interferes with builtin functions.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +0100287 *vim9-s-namespace* *E1268*
Bram Moolenaar92f645b2022-02-11 13:29:40 +0000288The use of the "s:" prefix is not supported at the Vim9 script level. All
289functions and variables without a prefix are script-local.
Bram Moolenaarafa048f2022-02-22 20:43:36 +0000290
291In :def functions the use of "s:" depends on the script: Script-local
292variables and functions in a legacy script do use "s:", while in a Vim9 script
293they do not use "s:". This matches what you see in the rest of the file.
294
Bram Moolenaar92f645b2022-02-11 13:29:40 +0000295In legacy functions the use of "s:" for script items is required, as before.
Bram Moolenaar63f32602022-06-09 20:45:54 +0100296No matter if the script is Vim9 or legacy.
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200297
Bram Moolenaar13106602020-10-04 16:06:05 +0200298In all cases the function must be defined before used. That is when it is
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100299called, when `:defcompile` causes it to be compiled, or when code that calls
300it is being compiled (to figure out the return type).
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200301
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200302The result is that functions and variables without a namespace can usually be
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200303found in the script, either defined there or imported. Global functions and
Bram Moolenaar63f32602022-06-09 20:45:54 +0100304variables could be defined anywhere (good luck finding out where! You can
305often see where it was last set using |:verbose|).
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000306 *E1102*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200307Global functions can still be defined and deleted at nearly any time. In
Bram Moolenaar2cfb4a22020-05-07 18:56:00 +0200308Vim9 script script-local functions are defined once when the script is sourced
Bram Moolenaar63f32602022-06-09 20:45:54 +0100309and cannot be deleted or replaced by itself (it can be by reloading the
310script).
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200311
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100312When compiling a function and a function call is encountered for a function
313that is not (yet) defined, the |FuncUndefined| autocommand is not triggered.
314You can use an autoload function if needed, or call a legacy function and have
315|FuncUndefined| triggered there.
316
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200317
Bram Moolenaar2b327002020-12-26 15:39:31 +0100318Reloading a Vim9 script clears functions and variables by default ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000319 *vim9-reload* *E1149* *E1150*
Bram Moolenaar2b327002020-12-26 15:39:31 +0100320When loading a legacy Vim script a second time nothing is removed, the
Bram Moolenaar30ab04e2022-05-14 13:33:50 +0100321commands will replace existing variables and functions, create new ones, and
322leave removed things hanging around.
Bram Moolenaar2b327002020-12-26 15:39:31 +0100323
324When loading a Vim9 script a second time all existing script-local functions
325and variables are deleted, thus you start with a clean slate. This is useful
326if you are developing a plugin and want to try a new version. If you renamed
327something you don't have to worry about the old name still hanging around.
328
329If you do want to keep items, use: >
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100330 vim9script noclear
Bram Moolenaar2b327002020-12-26 15:39:31 +0100331
332You want to use this in scripts that use a `finish` command to bail out at
Bram Moolenaar944697a2022-02-20 19:48:20 +0000333some point when loaded again. E.g. when a buffer local option is set to a
334function, the function does not need to be defined more than once: >
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100335 vim9script noclear
Bram Moolenaar2b327002020-12-26 15:39:31 +0100336 setlocal completefunc=SomeFunc
Bram Moolenaar944697a2022-02-20 19:48:20 +0000337 if exists('*SomeFunc')
Bram Moolenaar9da17d72022-02-09 21:50:44 +0000338 finish
339 endif
Bram Moolenaar944697a2022-02-20 19:48:20 +0000340 def SomeFunc()
Bram Moolenaar2b327002020-12-26 15:39:31 +0100341 ....
342
Bram Moolenaar2b327002020-12-26 15:39:31 +0100343
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200344Variable declarations with :var, :final and :const ~
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000345 *vim9-declaration* *:var* *E1079*
Dominique Pellee764d1b2023-03-12 21:20:59 +0000346 *E1017* *E1020* *E1054* *E1087* *E1124*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200347Local variables need to be declared with `:var`. Local constants need to be
348declared with `:final` or `:const`. We refer to both as "variables" in this
349section.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100350
351Variables can be local to a script, function or code block: >
352 vim9script
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200353 var script_var = 123
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100354 def SomeFunc()
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200355 var func_var = script_var
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100356 if cond
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200357 var block_var = func_var
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100358 ...
359
360The variables are only visible in the block where they are defined and nested
361blocks. Once the block ends the variable is no longer accessible: >
362 if cond
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200363 var inner = 5
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100364 else
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200365 var inner = 0
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100366 endif
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200367 echo inner # Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100368
369The declaration must be done earlier: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200370 var inner: number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100371 if cond
372 inner = 5
373 else
374 inner = 0
375 endif
376 echo inner
Bram Moolenaar63f32602022-06-09 20:45:54 +0100377
378Although this is shorter and faster for simple values: >
379 var inner = 0
380 if cond
381 inner = 5
382 endif
383 echo inner
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000384< *E1025* *E1128*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200385To intentionally hide a variable from code that follows, a block can be
386used: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100387 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200388 var temp = 'temp'
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100389 ...
390 }
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200391 echo temp # Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100392
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200393This is especially useful in a user command: >
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200394 command -range Rename {
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200395 var save = @a
396 @a = 'some expression'
397 echo 'do something with ' .. @a
398 @a = save
399 }
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200400
401And with autocommands: >
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200402 au BufWritePre *.go {
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200403 var save = winsaveview()
404 silent! exe ':%! some formatting command'
405 winrestview(save)
406 }
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200407
408Although using a :def function probably works better.
Bram Moolenaar46eea442022-03-30 10:51:39 +0100409
Bram Moolenaara2baa732022-02-04 16:09:54 +0000410 *E1022* *E1103* *E1130* *E1131* *E1133*
Dominique Pelle7765f5c2022-04-10 11:26:53 +0100411 *E1134*
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200412Declaring a variable with a type but without an initializer will initialize to
Bram Moolenaar1f318c62021-12-26 18:09:31 +0000413false (for bool), empty (for string, list, dict, etc.) or zero (for number,
414any, etc.). This matters especially when using the "any" type, the value will
Bram Moolenaar46eea442022-03-30 10:51:39 +0100415default to the number zero. For example, when declaring a list, items can be
416added: >
417 var myList: list<number>
418 myList->add(7)
419
420Initializing a variable to a null value, e.g. `null_list`, differs from not
421initializing the variable. This throws an error: >
422 var myList = null_list
423 myList->add(7) # E1130: Cannot add to null list
424
425< *E1016* *E1052* *E1066*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200426In Vim9 script `:let` cannot be used. An existing variable is assigned to
427without any command. The same for global, window, tab, buffer and Vim
Bram Moolenaar5da36052021-12-27 15:39:57 +0000428variables, because they are not really declared. Those can also be deleted
Bram Moolenaarf5a48012020-08-01 17:00:03 +0200429with `:unlet`.
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000430 *E1065*
431You cannot use `:va` to declare a variable, it must be written with the full
432name `:var`. Just to make sure it is easy to read.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000433 *E1178*
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200434`:lockvar` does not work on local variables. Use `:const` and `:final`
435instead.
436
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200437The `exists()` and `exists_compiled()` functions do not work on local variables
438or arguments.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000439 *E1006* *E1041* *E1167* *E1168* *E1213*
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100440Variables, functions and function arguments cannot shadow previously defined
441or imported variables and functions in the same script file.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100442Variables may shadow Ex commands, rename the variable if needed.
443
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200444Global variables must be prefixed with "g:", also at the script level. >
Bram Moolenaard1caa942020-04-10 22:10:56 +0200445 vim9script
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200446 var script_local = 'text'
Bram Moolenaar2547aa92020-07-26 17:00:44 +0200447 g:global = 'value'
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200448 var Funcref = g:ThatFunction
Bram Moolenaard1caa942020-04-10 22:10:56 +0200449
Bram Moolenaarc4573eb2022-01-31 15:40:56 +0000450Global functions must be prefixed with "g:": >
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200451 vim9script
452 def g:GlobalFunc(): string
453 return 'text'
454 enddef
Bram Moolenaarc4573eb2022-01-31 15:40:56 +0000455 echo g:GlobalFunc()
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200456The "g:" prefix is not needed for auto-load functions.
457
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200458 *vim9-function-defined-later*
459Although global functions can be called without the "g:" prefix, they must
460exist when compiled. By adding the "g:" prefix the function can be defined
461later. Example: >
462 def CallPluginFunc()
463 if exists('g:loaded_plugin')
464 g:PluginFunc()
465 endif
466 enddef
467
Bram Moolenaarb79ee0c2022-01-01 12:17:00 +0000468If you do it like this, you get an error at compile time that "PluginFunc"
469does not exist, even when "g:loaded_plugin" does not exist: >
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200470 def CallPluginFunc()
471 if exists('g:loaded_plugin')
472 PluginFunc() # Error - function not found
473 endif
474 enddef
475
476You can use exists_compiled() to avoid the error, but then the function would
477not be called, even when "g:loaded_plugin" is defined later: >
478 def CallPluginFunc()
479 if exists_compiled('g:loaded_plugin')
480 PluginFunc() # Function may never be called
481 endif
482 enddef
483
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200484Since `&opt = value` is now assigning a value to option "opt", ":&" cannot be
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100485used to repeat a `:substitute` command.
Bram Moolenaar56994d22021-04-17 16:31:09 +0200486 *vim9-unpack-ignore*
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200487For an unpack assignment the underscore can be used to ignore a list item,
488similar to how a function argument can be ignored: >
489 [a, _, c] = theList
Bram Moolenaar56994d22021-04-17 16:31:09 +0200490To ignore any remaining items: >
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200491 [a, b; _] = longList
Bram Moolenaar944697a2022-02-20 19:48:20 +0000492< *E1163* *E1080*
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200493Declaring more than one variable at a time, using the unpack notation, is
Bram Moolenaarab36e6a2021-11-30 16:14:49 +0000494possible. Each variable can have a type or infer it from the value: >
495 var [v1: number, v2] = GetValues()
496Use this only when there is a list with values, declaring one variable per
497line is much easier to read and change later.
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200498
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200499
500Constants ~
501 *vim9-const* *vim9-final*
502How constants work varies between languages. Some consider a variable that
503can't be assigned another value a constant. JavaScript is an example. Others
504also make the value immutable, thus when a constant uses a list, the list
505cannot be changed. In Vim9 we can use both.
Bram Moolenaarf269eab2022-10-03 18:04:35 +0100506 *E1021* *E1307*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200507`:const` is used for making both the variable and the value a constant. Use
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200508this for composite structures that you want to make sure will not be modified.
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200509Example: >
510 const myList = [1, 2]
511 myList = [3, 4] # Error!
512 myList[0] = 9 # Error!
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100513 myList->add(3) # Error!
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000514< *:final* *E1125*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200515`:final` is used for making only the variable a constant, the value can be
516changed. This is well known from Java. Example: >
517 final myList = [1, 2]
518 myList = [3, 4] # Error!
519 myList[0] = 9 # OK
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100520 myList->add(3) # OK
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200521
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200522It is common to write constants as ALL_CAPS, but you don't have to.
523
524The constant only applies to the value itself, not what it refers to. >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200525 final females = ["Mary"]
526 const NAMES = [["John", "Peter"], females]
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200527 NAMES[0] = ["Jack"] # Error!
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200528 NAMES[0][0] = "Jack" # Error!
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200529 NAMES[1] = ["Emma"] # Error!
Bram Moolenaar82be4842021-01-11 19:40:15 +0100530 NAMES[1][0] = "Emma" # OK, now females[0] == "Emma"
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200531
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100532
533Omitting :call and :eval ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000534 *E1190*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100535Functions can be called without `:call`: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200536 writefile(lines, 'file')
Bram Moolenaar560979e2020-02-04 22:53:05 +0100537Using `:call` is still possible, but this is discouraged.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100538
539A method call without `eval` is possible, so long as the start is an
Bram Moolenaar0289a092021-03-14 18:40:19 +0100540identifier or can't be an Ex command. For a function either "(" or "->" must
541be following, without a line break. Examples: >
Bram Moolenaarae616492020-07-28 20:07:27 +0200542 myList->add(123)
543 g:myList->add(123)
544 [1, 2, 3]->Process()
Bram Moolenaar2bede172020-11-19 18:53:18 +0100545 {a: 1, b: 2}->Process()
Bram Moolenaarae616492020-07-28 20:07:27 +0200546 "foobar"->Process()
547 ("foobar")->Process()
548 'foobar'->Process()
549 ('foobar')->Process()
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100550
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200551In the rare case there is ambiguity between a function name and an Ex command,
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200552prepend ":" to make clear you want to use the Ex command. For example, there
553is both the `:substitute` command and the `substitute()` function. When the
554line starts with `substitute(` this will use the function. Prepend a colon to
555use the command instead: >
Bram Moolenaar0c6ceaf2020-02-22 18:36:32 +0100556 :substitute(pattern (replacement (
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +0100557
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200558If the expression starts with "!" this is interpreted as a shell command, not
559negation of a condition. Thus this is a shell command: >
560 !shellCommand->something
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200561Put the expression in parentheses to use the "!" for negation: >
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200562 (!expression)->Method()
563
Bram Moolenaarcc390ff2020-02-29 22:06:30 +0100564Note that while variables need to be defined before they can be used,
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200565functions can be called before being defined. This is required to allow
566for cyclic dependencies between functions. It is slightly less efficient,
Bram Moolenaarcc390ff2020-02-29 22:06:30 +0100567since the function has to be looked up by name. And a typo in the function
Bram Moolenaarae616492020-07-28 20:07:27 +0200568name will only be found when the function is called.
Bram Moolenaarcc390ff2020-02-29 22:06:30 +0100569
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100570
Bram Moolenaard1caa942020-04-10 22:10:56 +0200571Omitting function() ~
572
573A user defined function can be used as a function reference in an expression
574without `function()`. The argument types and return type will then be checked.
575The function must already have been defined. >
576
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200577 var Funcref = MyFunction
Bram Moolenaard1caa942020-04-10 22:10:56 +0200578
579When using `function()` the resulting type is "func", a function with any
Bram Moolenaar90df4b92021-07-07 20:26:08 +0200580number of arguments and any return type (including void). The function can be
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000581defined later if the argument is in quotes.
Bram Moolenaard1caa942020-04-10 22:10:56 +0200582
583
Bram Moolenaar2b327002020-12-26 15:39:31 +0100584Lambda using => instead of -> ~
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200585 *vim9-lambda*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100586In legacy script there can be confusion between using "->" for a method call
587and for a lambda. Also, when a "{" is found the parser needs to figure out if
588it is the start of a lambda or a dictionary, which is now more complicated
589because of the use of argument types.
590
591To avoid these problems Vim9 script uses a different syntax for a lambda,
Bram Moolenaar74235772021-06-12 14:53:05 +0200592which is similar to JavaScript: >
Bram Moolenaar65c44152020-12-24 15:14:01 +0100593 var Lambda = (arg) => expression
Bram Moolenaara2baa732022-02-04 16:09:54 +0000594 var Lambda = (arg): type => expression
595< *E1157*
Bram Moolenaar2b327002020-12-26 15:39:31 +0100596No line break is allowed in the arguments of a lambda up to and including the
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200597"=>" (so that Vim can tell the difference between an expression in parentheses
Bram Moolenaar2346a632021-06-13 19:02:49 +0200598and lambda arguments). This is OK: >
Bram Moolenaar65c44152020-12-24 15:14:01 +0100599 filter(list, (k, v) =>
600 v > 0)
601This does not work: >
602 filter(list, (k, v)
603 => v > 0)
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100604This also does not work: >
Bram Moolenaar65c44152020-12-24 15:14:01 +0100605 filter(list, (k,
606 v) => v > 0)
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100607But you can use a backslash to concatenate the lines before parsing: >
608 filter(list, (k,
609 \ v)
610 \ => v > 0)
Bram Moolenaara2baa732022-02-04 16:09:54 +0000611< *vim9-lambda-arguments* *E1172*
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200612In legacy script a lambda could be called with any number of extra arguments,
613there was no way to warn for not using them. In Vim9 script the number of
614arguments must match. If you do want to accept any arguments, or any further
615arguments, use "..._", which makes the function accept
616|vim9-variable-arguments|. Example: >
617 var Callback = (..._) => 'anything'
618 echo Callback(1, 2, 3) # displays "anything"
619
Bram Moolenaara2baa732022-02-04 16:09:54 +0000620< *inline-function* *E1171*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100621Additionally, a lambda can contain statements in {}: >
622 var Lambda = (arg) => {
623 g:was_called = 'yes'
624 return expression
625 }
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200626This can be useful for a timer, for example: >
627 var count = 0
Bram Moolenaar938ae282023-02-20 20:44:55 +0000628 var timer = timer_start(500, (_) => {
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200629 count += 1
630 echom 'Handler called ' .. count
631 }, {repeat: 3})
632
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200633The ending "}" must be at the start of a line. It can be followed by other
634characters, e.g.: >
635 var d = mapnew(dict, (k, v): string => {
636 return 'value'
637 })
638No command can follow the "{", only a comment can be used there.
639
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000640 *command-block* *E1026*
Bram Moolenaar259f4432021-12-17 12:45:22 +0000641The block can also be used for defining a user command. Inside the block Vim9
642syntax will be used.
643
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000644If the statements include a dictionary, its closing bracket must not be
645written at the start of a line. Otherwise, it would be parsed as the end of
646the block. This does not work: >
647 command NewCommand {
Bram Moolenaar259f4432021-12-17 12:45:22 +0000648 g:mydict = {
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000649 'key': 'value',
650 } # ERROR: will be recognized as the end of the block
651 }
652Put the '}' after the last item to avoid this: >
653 command NewCommand {
Bram Moolenaar259f4432021-12-17 12:45:22 +0000654 g:mydict = {
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000655 'key': 'value' }
656 }
657
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200658Rationale: The "}" cannot be after a command because it would require parsing
659the commands to find it. For consistency with that no command can follow the
660"{". Unfortunately this means using "() => { command }" does not work, line
661breaks are always required.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100662
Bram Moolenaare0e39172021-01-25 21:14:57 +0100663 *vim9-curly*
Bram Moolenaar2b327002020-12-26 15:39:31 +0100664To avoid the "{" of a dictionary literal to be recognized as a statement block
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100665wrap it in parentheses: >
Bram Moolenaar2b327002020-12-26 15:39:31 +0100666 var Lambda = (arg) => ({key: 42})
Bram Moolenaar65c44152020-12-24 15:14:01 +0100667
Bram Moolenaare0e39172021-01-25 21:14:57 +0100668Also when confused with the start of a command block: >
669 ({
670 key: value
671 })->method()
672
Bram Moolenaar65c44152020-12-24 15:14:01 +0100673
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200674Automatic line continuation ~
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000675 *vim9-line-continuation* *E1097*
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200676In many cases it is obvious that an expression continues on the next line. In
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100677those cases there is no need to prefix the line with a backslash (see
678|line-continuation|). For example, when a list spans multiple lines: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200679 var mylist = [
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200680 'one',
681 'two',
682 ]
Bram Moolenaare6085c52020-04-12 20:19:16 +0200683And when a dict spans multiple lines: >
Bram Moolenaar2bede172020-11-19 18:53:18 +0100684 var mydict = {
Bram Moolenaare6085c52020-04-12 20:19:16 +0200685 one: 1,
686 two: 2,
687 }
Bram Moolenaar74235772021-06-12 14:53:05 +0200688With a function call: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200689 var result = Func(
Bram Moolenaare6085c52020-04-12 20:19:16 +0200690 arg1,
691 arg2
692 )
693
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200694For binary operators in expressions not in [], {} or () a line break is
695possible just before or after the operator. For example: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200696 var text = lead
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200697 .. middle
698 .. end
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200699 var total = start +
Bram Moolenaar82be4842021-01-11 19:40:15 +0100700 end -
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200701 correction
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200702 var result = positive
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200703 ? PosFunc(arg)
704 : NegFunc(arg)
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200705
Bram Moolenaar2547aa92020-07-26 17:00:44 +0200706For a method call using "->" and a member using a dot, a line break is allowed
707before it: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200708 var result = GetBuilder()
Bram Moolenaar73fef332020-06-21 22:12:03 +0200709 ->BuilderSetWidth(333)
710 ->BuilderSetHeight(777)
711 ->BuilderBuild()
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200712 var result = MyDict
Bram Moolenaar2547aa92020-07-26 17:00:44 +0200713 .member
Bram Moolenaar73fef332020-06-21 22:12:03 +0200714
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100715For commands that have an argument that is a list of commands, the | character
716at the start of the line indicates line continuation: >
717 autocmd BufNewFile *.match if condition
718 | echo 'match'
719 | endif
720
Bram Moolenaar22863042021-10-16 15:23:36 +0100721Note that this means that in heredoc the first line cannot start with a bar: >
Bram Moolenaar74235772021-06-12 14:53:05 +0200722 var lines =<< trim END
723 | this doesn't work
724 END
725Either use an empty line at the start or do not use heredoc. Or temporarily
726add the "C" flag to 'cpoptions': >
727 set cpo+=C
728 var lines =<< trim END
Bram Moolenaar22863042021-10-16 15:23:36 +0100729 | this works
Bram Moolenaar74235772021-06-12 14:53:05 +0200730 END
731 set cpo-=C
732If the heredoc is inside a function 'cpoptions' must be set before :def and
733restored after the :enddef.
734
735In places where line continuation with a backslash is still needed, such as
Bram Moolenaar90df4b92021-07-07 20:26:08 +0200736splitting up a long Ex command, comments can start with '#\ ': >
737 syn region Text
Bram Moolenaar74235772021-06-12 14:53:05 +0200738 \ start='foo'
739 #\ comment
740 \ end='bar'
Bram Moolenaar90df4b92021-07-07 20:26:08 +0200741Like with legacy script '"\ ' is used. This is also needed when line
742continuation is used without a backslash and a line starts with a bar: >
743 au CursorHold * echom 'BEFORE bar'
744 #\ some comment
745 | echom 'AFTER bar'
746<
747 *E1050*
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200748To make it possible for the operator at the start of the line to be
Bram Moolenaar74235772021-06-12 14:53:05 +0200749recognized, it is required to put a colon before a range. This example will
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000750add "start" and "print": >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200751 var result = start
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200752 + print
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200753Like this: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200754 var result = start + print
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200755
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200756This will assign "start" and print a line: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200757 var result = start
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200758 :+ print
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200759
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000760After the range an Ex command must follow. Without the colon you can call a
761function without `:call`, but after a range you do need it: >
762 MyFunc()
763 :% call MyFunc()
764
Bram Moolenaar23515b42020-11-29 14:36:24 +0100765Note that the colon is not required for the |+cmd| argument: >
766 edit +6 fname
767
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200768It is also possible to split a function header over multiple lines, in between
769arguments: >
770 def MyFunc(
771 text: string,
772 separator = '-'
773 ): string
774
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100775Since a continuation line cannot be easily recognized the parsing of commands
Bram Moolenaar65c44152020-12-24 15:14:01 +0100776has been made stricter. E.g., because of the error in the first line, the
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100777second line is seen as a separate command: >
778 popup_create(some invalid expression, {
779 exit_cb: Func})
780Now "exit_cb: Func})" is actually a valid command: save any changes to the
781file "_cb: Func})" and exit. To avoid this kind of mistake in Vim9 script
782there must be white space between most command names and the argument.
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000783*E1144*
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100784
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100785However, the argument of a command that is a command won't be recognized. For
786example, after "windo echo expr" a line break inside "expr" will not be seen.
787
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100788
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200789Notes:
790- "enddef" cannot be used at the start of a continuation line, it ends the
791 current function.
792- No line break is allowed in the LHS of an assignment. Specifically when
793 unpacking a list |:let-unpack|. This is OK: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200794 [var1, var2] =
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200795 Func()
796< This does not work: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200797 [var1,
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200798 var2] =
799 Func()
800- No line break is allowed in between arguments of an `:echo`, `:execute` and
801 similar commands. This is OK: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200802 echo [1,
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200803 2] [3,
804 4]
805< This does not work: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200806 echo [1, 2]
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200807 [3, 4]
Bram Moolenaar74235772021-06-12 14:53:05 +0200808- In some cases it is difficult for Vim to parse a command, especially when
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000809 commands are used as an argument to another command, such as `:windo`. In
Bram Moolenaar74235772021-06-12 14:53:05 +0200810 those cases the line continuation with a backslash has to be used.
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200811
Bram Moolenaar4c295022021-05-02 17:19:11 +0200812
813White space ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000814 *E1004* *E1068* *E1069* *E1074* *E1127* *E1202*
Bram Moolenaar4c295022021-05-02 17:19:11 +0200815Vim9 script enforces proper use of white space. This is no longer allowed: >
816 var name=234 # Error!
817 var name= 234 # Error!
818 var name =234 # Error!
819There must be white space before and after the "=": >
820 var name = 234 # OK
821White space must also be put before the # that starts a comment after a
822command: >
823 var name = 234# Error!
824 var name = 234 # OK
825
826White space is required around most operators.
827
828White space is required in a sublist (list slice) around the ":", except at
829the start and end: >
Bram Moolenaar938ae282023-02-20 20:44:55 +0000830 otherlist = mylist[v : count] # v:count has a different meaning
Bram Moolenaar4c295022021-05-02 17:19:11 +0200831 otherlist = mylist[:] # make a copy of the List
832 otherlist = mylist[v :]
833 otherlist = mylist[: v]
834
835White space is not allowed:
836- Between a function name and the "(": >
837 Func (arg) # Error!
838 Func
839 \ (arg) # Error!
840 Func
841 (arg) # Error!
842 Func(arg) # OK
843 Func(
844 arg) # OK
845 Func(
846 arg # OK
847 )
Bram Moolenaara2baa732022-02-04 16:09:54 +0000848< *E1205*
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200849White space is not allowed in a `:set` command between the option name and a
850following "&", "!", "<", "=", "+=", "-=" or "^=".
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200851
Bram Moolenaar4c295022021-05-02 17:19:11 +0200852
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100853No curly braces expansion ~
854
855|curly-braces-names| cannot be used.
856
857
Bram Moolenaara2baa732022-02-04 16:09:54 +0000858Command modifiers are not ignored ~
859 *E1176*
860Using a command modifier for a command that does not use it gives an error.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +0100861 *E1082*
862Also, using a command modifier without a following command is now an error.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000863
864
Bram Moolenaar2bede172020-11-19 18:53:18 +0100865Dictionary literals ~
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000866 *vim9-literal-dict* *E1014*
Bram Moolenaar2bede172020-11-19 18:53:18 +0100867Traditionally Vim has supported dictionary literals with a {} syntax: >
868 let dict = {'key': value}
869
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100870Later it became clear that using a simple text key is very common, thus
871literal dictionaries were introduced in a backwards compatible way: >
Bram Moolenaar2bede172020-11-19 18:53:18 +0100872 let dict = #{key: value}
873
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100874However, this #{} syntax is unlike any existing language. As it turns out
875that using a literal key is much more common than using an expression, and
Bram Moolenaar2bede172020-11-19 18:53:18 +0100876considering that JavaScript uses this syntax, using the {} form for dictionary
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100877literals is considered a much more useful syntax. In Vim9 script the {} form
Bram Moolenaar2bede172020-11-19 18:53:18 +0100878uses literal keys: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100879 var dict = {key: value}
Bram Moolenaar2bede172020-11-19 18:53:18 +0100880
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100881This works for alphanumeric characters, underscore and dash. If you want to
882use another character, use a single or double quoted string: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100883 var dict = {'key with space': value}
884 var dict = {"key\twith\ttabs": value}
Bram Moolenaar938ae282023-02-20 20:44:55 +0000885 var dict = {'': value} # empty key
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000886< *E1139*
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100887In case the key needs to be an expression, square brackets can be used, just
888like in JavaScript: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100889 var dict = {["key" .. nr]: value}
Bram Moolenaar2bede172020-11-19 18:53:18 +0100890
Bram Moolenaar2e5910b2021-02-03 17:41:24 +0100891The key type can be string, number, bool or float. Other types result in an
Bram Moolenaard899e512022-05-07 21:54:03 +0100892error. Without using [] the value is used as a string, keeping leading zeros.
893An expression given with [] is evaluated and then converted to a string.
894Leading zeros will then be dropped: >
895 var dict = {000123: 'without', [000456]: 'with'}
Bram Moolenaar2e5910b2021-02-03 17:41:24 +0100896 echo dict
Bram Moolenaard899e512022-05-07 21:54:03 +0100897 {'456': 'with', '000123': 'without'}
898A float only works inside [] because the dot is not accepted otherwise: >
899 var dict = {[00.013]: 'float'}
900 echo dict
901 {'0.013': 'float'}
Bram Moolenaar2e5910b2021-02-03 17:41:24 +0100902
Bram Moolenaar2bede172020-11-19 18:53:18 +0100903
Bram Moolenaar10b94212021-02-19 21:42:57 +0100904No :xit, :t, :k, :append, :change or :insert ~
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000905 *E1100*
Bram Moolenaarf5a48012020-08-01 17:00:03 +0200906These commands are too easily confused with local variable names.
907Instead of `:x` or `:xit` you can use `:exit`.
908Instead of `:t` you can use `:copy`.
Bram Moolenaar10b94212021-02-19 21:42:57 +0100909Instead of `:k` you can use `:mark`.
Bram Moolenaar560979e2020-02-04 22:53:05 +0100910
911
912Comparators ~
913
914The 'ignorecase' option is not used for comparators that use strings.
Bram Moolenaar944697a2022-02-20 19:48:20 +0000915Thus "=~" works like "=~#".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100916
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100917"is" and "isnot" (|expr-is| and |expr-isnot|) when used on strings now return
918false. In legacy script they just compare the strings, in |Vim9| script they
919check identity, and strings are copied when used, thus two strings are never
Bram Moolenaar71badf92023-04-22 22:40:14 +0100920the same (this might change someday if strings are not copied but reference
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100921counted).
922
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100923
Bram Moolenaar4c295022021-05-02 17:19:11 +0200924Abort after error ~
925
926In legacy script, when an error is encountered, Vim continues to execute
927following lines. This can lead to a long sequence of errors and need to type
928CTRL-C to stop it. In Vim9 script execution of commands stops at the first
929error. Example: >
930 vim9script
931 var x = does-not-exist
932 echo 'not executed'
933
934
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100935For loop ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000936 *E1254*
Bram Moolenaar47003982021-12-05 21:54:04 +0000937The loop variable must not be declared yet: >
Bram Moolenaar6304be62021-11-27 10:57:26 +0000938 var i = 1
939 for i in [1, 2, 3] # Error!
940
Bram Moolenaar47003982021-12-05 21:54:04 +0000941It is possible to use a global variable though: >
942 g:i = 1
943 for g:i in [1, 2, 3]
944 echo g:i
945 endfor
946
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100947Legacy Vim script has some tricks to make a for loop over a list handle
948deleting items at the current or previous item. In Vim9 script it just uses
949the index, if items are deleted then items in the list will be skipped.
950Example legacy script: >
951 let l = [1, 2, 3, 4]
952 for i in l
953 echo i
954 call remove(l, index(l, i))
955 endfor
956Would echo:
957 1
958 2
959 3
960 4
961In compiled Vim9 script you get:
962 1
963 3
964Generally, you should not change the list that is iterated over. Make a copy
965first if needed.
Bram Moolenaar7c6cd442022-10-11 21:54:04 +0100966When looping over a list of lists, the nested lists can be changed. The loop
967variable is "final", it cannot be changed but what its value can be changed.
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +0100968 *E1306*
969The depth of loops, :for and :while loops added together, cannot exceed 10.
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100970
971
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100972Conditions and expressions ~
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000973 *vim9-boolean*
Bram Moolenaar13106602020-10-04 16:06:05 +0200974Conditions and expressions are mostly working like they do in other languages.
975Some values are different from legacy Vim script:
976 value legacy Vim script Vim9 script ~
977 0 falsy falsy
978 1 truthy truthy
979 99 truthy Error!
980 "0" falsy Error!
981 "99" truthy Error!
982 "text" falsy Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100983
Bram Moolenaar13106602020-10-04 16:06:05 +0200984For the "??" operator and when using "!" then there is no error, every value
985is either falsy or truthy. This is mostly like JavaScript, except that an
986empty list and dict is falsy:
987
988 type truthy when ~
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100989 bool true, v:true or 1
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100990 number non-zero
991 float non-zero
992 string non-empty
993 blob non-empty
994 list non-empty (different from JavaScript)
995 dictionary non-empty (different from JavaScript)
Bram Moolenaard1caa942020-04-10 22:10:56 +0200996 func when there is a function name
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100997 special true or v:true
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100998 job when not NULL
999 channel when not NULL
1000 class when not NULL
Bram Moolenaar7e6a5152021-01-02 16:39:53 +01001001 object when not NULL (TODO: when isTrue() returns true)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001002
Bram Moolenaar2bb26582020-10-03 22:52:39 +02001003The boolean operators "||" and "&&" expect the values to be boolean, zero or
1004one: >
1005 1 || false == true
1006 0 || 1 == true
1007 0 || false == false
1008 1 && true == true
1009 0 && 1 == false
1010 8 || 0 Error!
1011 'yes' && 0 Error!
1012 [] || 99 Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001013
Bram Moolenaar2bb26582020-10-03 22:52:39 +02001014When using "!" for inverting, there is no error for using any type and the
Bram Moolenaar13106602020-10-04 16:06:05 +02001015result is a boolean. "!!" can be used to turn any value into boolean: >
Bram Moolenaar82be4842021-01-11 19:40:15 +01001016 !'yes' == false
Bram Moolenaar13106602020-10-04 16:06:05 +02001017 !![] == false
Bram Moolenaar82be4842021-01-11 19:40:15 +01001018 !![1, 2, 3] == true
Bram Moolenaar2bb26582020-10-03 22:52:39 +02001019
1020When using "`.."` for string concatenation arguments of simple types are
Bram Moolenaar13106602020-10-04 16:06:05 +02001021always converted to string: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001022 'hello ' .. 123 == 'hello 123'
Bram Moolenaar7e6a5152021-01-02 16:39:53 +01001023 'hello ' .. v:true == 'hello true'
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001024
Bram Moolenaar5da36052021-12-27 15:39:57 +00001025Simple types are Number, Float, Special and Bool. For other types |string()|
1026should be used.
Bram Moolenaar7db29e42022-12-11 15:53:04 +00001027 *false* *true* *null* *null_blob* *null_channel*
dkearns521fb7e2023-11-11 19:33:43 +11001028 *null_class* *null_dict* *null_function* *null_job*
1029 *null_list* *null_object* *null_partial* *null_string*
1030 *E1034*
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001031In Vim9 script one can use the following predefined values: >
1032 true
1033 false
1034 null
1035 null_blob
1036 null_channel
Yegappan Lakshmanane750f8c2023-08-24 07:07:05 -07001037 null_class
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001038 null_dict
1039 null_function
1040 null_job
1041 null_list
Yegappan Lakshmanane750f8c2023-08-24 07:07:05 -07001042 null_object
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001043 null_partial
1044 null_string
1045`true` is the same as `v:true`, `false` the same as `v:false`, `null` the same
1046as `v:null`.
1047
Bram Moolenaar76db9e02022-11-09 21:21:04 +00001048While `null` has the type "special", the other "null_" values have the type
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001049indicated by their name. Quite often a null value is handled the same as an
1050empty value, but not always. The values can be useful to clear a script-local
1051variable, since they cannot be deleted with `:unlet`. E.g.: >
1052 var theJob = job_start(...)
1053 # let the job do its work
1054 theJob = null_job
1055
1056The values can also be useful as the default value for an argument: >
1057 def MyFunc(b: blob = null_blob)
1058 if b == null_blob
1059 # b argument was not given
1060
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001061It is possible to compare `null` with any value, this will not give a type
1062error. However, comparing `null` with a number, float or bool will always
1063result in `false`. This is different from legacy script, where comparing
1064`null` with zero or `false` would return `true`.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001065 *vim9-false-true*
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001066When converting a boolean to a string `false` and `true` are used, not
1067`v:false` and `v:true` like in legacy script. `v:none` has no `none`
1068replacement, it has no equivalent in other languages.
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001069 *vim9-string-index*
Bram Moolenaar0289a092021-03-14 18:40:19 +01001070Indexing a string with [idx] or taking a slice with [idx : idx] uses character
1071indexes instead of byte indexes. Composing characters are included.
1072Example: >
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001073 echo 'bár'[1]
1074In legacy script this results in the character 0xc3 (an illegal byte), in Vim9
1075script this results in the string 'á'.
Bram Moolenaar82be4842021-01-11 19:40:15 +01001076A negative index is counting from the end, "[-1]" is the last character.
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001077To exclude the last character use |slice()|.
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02001078To count composing characters separately use |strcharpart()|.
Bram Moolenaar82be4842021-01-11 19:40:15 +01001079If the index is out of range then an empty string results.
1080
1081In legacy script "++var" and "--var" would be silently accepted and have no
1082effect. This is an error in Vim9 script.
1083
1084Numbers starting with zero are not considered to be octal, only numbers
1085starting with "0o" are octal: "0o744". |scriptversion-4|
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001086
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001087
Bram Moolenaare46a4402020-06-30 20:38:27 +02001088What to watch out for ~
1089 *vim9-gotchas*
1090Vim9 was designed to be closer to often used programming languages, but at the
1091same time tries to support the legacy Vim commands. Some compromises had to
1092be made. Here is a summary of what might be unexpected.
1093
1094Ex command ranges need to be prefixed with a colon. >
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001095 -> legacy Vim: shifts the previous line to the right
1096 ->func() Vim9: method call in a continuation line
1097 :-> Vim9: shifts the previous line to the right
Bram Moolenaare46a4402020-06-30 20:38:27 +02001098
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001099 %s/a/b legacy Vim: substitute on all lines
Bram Moolenaare46a4402020-06-30 20:38:27 +02001100 x = alongname
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001101 % another Vim9: modulo operator in a continuation line
1102 :%s/a/b Vim9: substitute on all lines
1103 't legacy Vim: jump to mark t
1104 'text'->func() Vim9: method call
1105 :'t Vim9: jump to mark t
Bram Moolenaare46a4402020-06-30 20:38:27 +02001106
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02001107Some Ex commands can be confused with assignments in Vim9 script: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001108 g:name = value # assignment
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001109 :g:pattern:cmd # :global command
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02001110
Bram Moolenaar7b829262021-10-13 15:04:34 +01001111To avoid confusion between a `:global` or `:substitute` command and an
1112expression or assignment, a few separators cannot be used when these commands
1113are abbreviated to a single character: ':', '-' and '.'. >
1114 g:pattern:cmd # invalid command - ERROR
1115 s:pattern:repl # invalid command - ERROR
1116 g-pattern-cmd # invalid command - ERROR
1117 s-pattern-repl # invalid command - ERROR
1118 g.pattern.cmd # invalid command - ERROR
1119 s.pattern.repl # invalid command - ERROR
1120
1121Also, there cannot be a space between the command and the separator: >
1122 g /pattern/cmd # invalid command - ERROR
1123 s /pattern/repl # invalid command - ERROR
1124
Bram Moolenaare46a4402020-06-30 20:38:27 +02001125Functions defined with `:def` compile the whole function. Legacy functions
1126can bail out, and the following lines are not parsed: >
1127 func Maybe()
1128 if !has('feature')
1129 return
1130 endif
1131 use-feature
1132 endfunc
1133Vim9 functions are compiled as a whole: >
1134 def Maybe()
1135 if !has('feature')
1136 return
1137 endif
Bram Moolenaar82be4842021-01-11 19:40:15 +01001138 use-feature # May give a compilation error
Bram Moolenaare46a4402020-06-30 20:38:27 +02001139 enddef
1140For a workaround, split it in two functions: >
1141 func Maybe()
1142 if has('feature')
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001143 call MaybeInner()
Bram Moolenaare46a4402020-06-30 20:38:27 +02001144 endif
1145 endfunc
1146 if has('feature')
1147 def MaybeInner()
1148 use-feature
1149 enddef
1150 endif
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02001151Or put the unsupported code inside an `if` with a constant expression that
Bram Moolenaar207f0092020-08-30 17:20:20 +02001152evaluates to false: >
1153 def Maybe()
1154 if has('feature')
1155 use-feature
1156 endif
1157 enddef
Bram Moolenaar6aa57292021-08-14 21:25:52 +02001158The `exists_compiled()` function can also be used for this.
1159 *vim9-user-command*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001160Another side effect of compiling a function is that the presence of a user
Bram Moolenaar82be4842021-01-11 19:40:15 +01001161command is checked at compile time. If the user command is defined later an
1162error will result. This works: >
1163 command -nargs=1 MyCommand echom <q-args>
1164 def Works()
1165 MyCommand 123
1166 enddef
1167This will give an error for "MyCommand" not being defined: >
1168 def Works()
1169 command -nargs=1 MyCommand echom <q-args>
1170 MyCommand 123
1171 enddef
1172A workaround is to invoke the command indirectly with `:execute`: >
1173 def Works()
1174 command -nargs=1 MyCommand echom <q-args>
1175 execute 'MyCommand 123'
1176 enddef
1177
Bram Moolenaar207f0092020-08-30 17:20:20 +02001178Note that for unrecognized commands there is no check for "|" and a following
1179command. This will give an error for missing `endif`: >
1180 def Maybe()
1181 if has('feature') | use-feature | endif
1182 enddef
Bram Moolenaare46a4402020-06-30 20:38:27 +02001183
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001184Other differences ~
1185
1186Patterns are used like 'magic' is set, unless explicitly overruled.
1187The 'edcompatible' option value is not used.
1188The 'gdefault' option value is not used.
1189
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001190You may also find this wiki useful. It was written by an early adopter of
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +01001191Vim9 script: https://github.com/lacygoill/wiki/blob/master/vim/vim9.md
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001192
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02001193 *:++* *:--*
1194The ++ and -- commands have been added. They are very similar to adding or
1195subtracting one: >
1196 ++var
1197 var += 1
1198 --var
1199 var -= 1
1200
1201Using ++var or --var in an expression is not supported yet.
1202
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001203==============================================================================
1204
12053. New style functions *fast-functions*
1206
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001207 *:def* *E1028*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001208:def[!] {name}([arguments])[: {return-type}]
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001209 Define a new function by the name {name}. The body of
1210 the function follows in the next lines, until the
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001211 matching `:enddef`. *E1073*
1212 *E1011*
1213 The {name} must be less than 100 bytes long.
1214 *E1003* *E1027* *E1056* *E1059*
1215 The type of value used with `:return` must match
1216 {return-type}. When {return-type} is omitted or is
1217 "void" the function is not expected to return
1218 anything.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001219 *E1077* *E1123*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001220 {arguments} is a sequence of zero or more argument
1221 declarations. There are three forms:
1222 {name}: {type}
1223 {name} = {value}
1224 {name}: {type} = {value}
1225 The first form is a mandatory argument, the caller
1226 must always provide them.
1227 The second and third form are optional arguments.
1228 When the caller omits an argument the {value} is used.
1229
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001230 The function will be compiled into instructions when
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001231 called, or when `:disassemble` or `:defcompile` is
1232 used. Syntax and type errors will be produced at that
1233 time.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001234
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001235 It is possible to nest `:def` inside another `:def` or
1236 `:function` up to about 50 levels deep.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001237 *E1117*
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001238 [!] is used as with `:function`. Note that
1239 script-local functions cannot be deleted or redefined
1240 later in Vim9 script. They can only be removed by
1241 reloading the same script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001242
Bram Moolenaara2baa732022-02-04 16:09:54 +00001243 *:enddef* *E1057* *E1152* *E1173*
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001244:enddef End of a function defined with `:def`. It should be on
1245 a line by its own.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001246
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001247You may also find this wiki useful. It was written by an early adopter of
Bram Moolenaar0289a092021-03-14 18:40:19 +01001248Vim9 script: https://github.com/lacygoill/wiki/blob/master/vim/vim9.md
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001249
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01001250If the script the function is defined in is Vim9 script, then script-local
1251variables can be accessed without the "s:" prefix. They must be defined
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001252before the function is compiled. If the script the function is defined in is
1253legacy script, then script-local variables must be accessed with the "s:"
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001254prefix if they do not exist at the time of compiling.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01001255 *E1269*
1256Script-local variables in a |Vim9| script must be declared at the script
1257level. They cannot be created in a function, also not in a legacy function.
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01001258
Bram Moolenaar388a5d42020-05-26 21:20:45 +02001259 *:defc* *:defcompile*
1260:defc[ompile] Compile functions defined in the current script that
1261 were not compiled yet.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01001262 This will report any errors found during compilation.
Bram Moolenaardd60c362023-02-27 15:49:53 +00001263 This excludes functions defined inside a class.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01001264
1265:defc[ompile] {func}
1266:defc[ompile] debug {func}
1267:defc[ompile] profile {func}
1268 Compile function {func}, if needed. Use "debug" and
1269 "profile" to specify the compilation mode.
1270 This will report any errors found during compilation.
Bram Moolenaardd60c362023-02-27 15:49:53 +00001271 {func} call also be "ClassName.functionName" to
1272 compile a function or method in a class.
1273 {func} call also be "ClassName" to compile all
1274 functions and methods in a class.
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01001275
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001276 *:disa* *:disassemble*
1277:disa[ssemble] {func} Show the instructions generated for {func}.
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001278 This is for debugging and testing. *E1061*
Bram Moolenaarcc390ff2020-02-29 22:06:30 +01001279 Note that for command line completion of {func} you
1280 can prepend "s:" to find script-local functions.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001281
Bram Moolenaar2346a632021-06-13 19:02:49 +02001282:disa[ssemble] profile {func}
1283 Like `:disassemble` but with the instructions used for
Bram Moolenaare0e39172021-01-25 21:14:57 +01001284 profiling.
1285
Bram Moolenaar2346a632021-06-13 19:02:49 +02001286:disa[ssemble] debug {func}
1287 Like `:disassemble` but with the instructions used for
1288 debugging.
1289
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001290Limitations ~
1291
1292Local variables will not be visible to string evaluation. For example: >
Bram Moolenaar2b327002020-12-26 15:39:31 +01001293 def MapList(): list<string>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001294 var list = ['aa', 'bb', 'cc', 'dd']
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001295 return range(1, 2)->map('list[v:val]')
1296 enddef
1297
1298The map argument is a string expression, which is evaluated without the
1299function scope. Instead, use a lambda: >
Bram Moolenaar2b327002020-12-26 15:39:31 +01001300 def MapList(): list<string>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001301 var list = ['aa', 'bb', 'cc', 'dd']
Bram Moolenaar22863042021-10-16 15:23:36 +01001302 return range(1, 2)->map((_, v) => list[v])
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001303 enddef
1304
Bram Moolenaar3d2e0312021-12-01 09:27:20 +00001305For commands that are not compiled, such as `:edit`, backtick expansion can be
1306used and it can use the local scope. Example: >
Bram Moolenaar2b327002020-12-26 15:39:31 +01001307 def Replace()
Bram Moolenaar3d2e0312021-12-01 09:27:20 +00001308 var fname = 'blah.txt'
1309 edit `=fname`
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001310 enddef
1311
Bram Moolenaardad44732021-03-31 20:07:33 +02001312Closures defined in a loop will share the same context. For example: >
1313 var flist: list<func>
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001314 for i in range(5)
Bram Moolenaardad44732021-03-31 20:07:33 +02001315 var inloop = i
1316 flist[i] = () => inloop
1317 endfor
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001318 echo range(5)->map((i, _) => flist[i]())
1319 # Result: [4, 4, 4, 4, 4]
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001320< *E1271*
1321A closure must be compiled in the context that it is defined in, so that
1322variables in that context can be found. This mostly happens correctly, except
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001323when a function is marked for debugging with `:breakadd` after it was compiled.
Bram Moolenaar46eea442022-03-30 10:51:39 +01001324Make sure to define the breakpoint before compiling the outer function.
Bram Moolenaardad44732021-03-31 20:07:33 +02001325
1326The "inloop" variable will exist only once, all closures put in the list refer
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001327to the same instance, which in the end will have the value 4. This is
1328efficient, also when looping many times. If you do want a separate context
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001329for each closure, call a function to define it: >
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001330 def GetClosure(i: number): func
1331 var infunc = i
1332 return () => infunc
Bram Moolenaardad44732021-03-31 20:07:33 +02001333 enddef
1334
1335 var flist: list<func>
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001336 for i in range(5)
1337 flist[i] = GetClosure(i)
Bram Moolenaardad44732021-03-31 20:07:33 +02001338 endfor
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001339 echo range(5)->map((i, _) => flist[i]())
1340 # Result: [0, 1, 2, 3, 4]
Bram Moolenaardad44732021-03-31 20:07:33 +02001341
Bram Moolenaara2baa732022-02-04 16:09:54 +00001342In some situations, especially when calling a Vim9 closure from legacy
1343context, the evaluation will fail. *E1248*
1344
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001345Note that at the script level the loop variable will be invalid after the
1346loop, also when used in a closure that is called later, e.g. with a timer.
1347This will generate error |E1302|: >
1348 for n in range(4)
1349 timer_start(500 * n, (_) => {
1350 echowin n
1351 })
1352 endfor
1353
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001354You need to use a block and define a variable there, and use that one in the
1355closure: >
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001356 for n in range(4)
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001357 {
1358 var nr = n
1359 timer_start(500 * n, (_) => {
1360 echowin nr
1361 })
1362 }
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001363 endfor
1364
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001365Using `:echowindow` is useful in a timer, the messages go into a popup and will
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001366not interfere with what the user is doing when it triggers.
1367
Bram Moolenaara2baa732022-02-04 16:09:54 +00001368
1369Converting a function from legacy to Vim9 ~
1370 *convert_legacy_function_to_vim9*
1371These are the most changes that need to be made to convert a legacy function
1372to a Vim9 function:
1373
1374- Change `func` or `function` to `def`.
1375- Change `endfunc` or `endfunction` to `enddef`.
1376- Add types to the function arguments.
1377- If the function returns something, add the return type.
1378- Change comments to start with # instead of ".
1379
1380 For example, a legacy function: >
1381 func MyFunc(text)
1382 " function body
1383 endfunc
1384< Becomes: >
1385 def MyFunc(text: string): number
1386 # function body
1387 enddef
1388
1389- Remove "a:" used for arguments. E.g.: >
1390 return len(a:text)
1391< Becomes: >
1392 return len(text)
1393
1394- Change `let` used to declare a variable to `var`.
1395- Remove `let` used to assign a value to a variable. This is for local
1396 variables already declared and b: w: g: and t: variables.
1397
1398 For example, legacy function: >
1399 let lnum = 1
1400 let lnum += 3
1401 let b:result = 42
1402< Becomes: >
1403 var lnum = 1
1404 lnum += 3
1405 b:result = 42
1406
1407- Insert white space in expressions where needed.
1408- Change "." used for concatenation to "..".
1409
1410 For example, legacy function: >
1411 echo line(1).line(2)
1412< Becomes: >
1413 echo line(1) .. line(2)
1414
1415- line continuation does not always require a backslash: >
Bram Moolenaar938ae282023-02-20 20:44:55 +00001416 echo ['one',
Bram Moolenaara2baa732022-02-04 16:09:54 +00001417 \ 'two',
1418 \ 'three'
1419 \ ]
1420< Becomes: >
1421 echo ['one',
1422 'two',
1423 'three'
1424 ]
1425
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01001426
1427Calling a function in an expr option ~
1428 *expr-option-function*
Bram Moolenaarf269eab2022-10-03 18:04:35 +01001429The value of a few options, such as 'foldexpr', is an expression that is
1430evaluated to get a value. The evaluation can have quite a bit of overhead.
1431One way to minimize the overhead, and also to keep the option value very
1432simple, is to define a compiled function and set the option to call it
1433without arguments. Example: >
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01001434 vim9script
1435 def MyFoldFunc(): any
1436 ... compute fold level for line v:lnum
1437 return level
1438 enddef
1439 set foldexpr=s:MyFoldFunc()
1440
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001441==============================================================================
1442
14434. Types *vim9-types*
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001444 *E1008* *E1009* *E1010* *E1012*
1445 *E1013* *E1029* *E1030*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001446The following builtin types are supported:
1447 bool
1448 number
1449 float
1450 string
1451 blob
Bram Moolenaard77a8522020-04-03 21:59:57 +02001452 list<{type}>
1453 dict<{type}>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001454 job
1455 channel
Bram Moolenaarb17893a2020-03-14 08:19:51 +01001456 func
Bram Moolenaard1caa942020-04-10 22:10:56 +02001457 func: {type}
Bram Moolenaard77a8522020-04-03 21:59:57 +02001458 func({type}, ...)
1459 func({type}, ...): {type}
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001460 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001461
1462Not supported yet:
Bram Moolenaard77a8522020-04-03 21:59:57 +02001463 tuple<a: {type}, b: {type}, ...>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001464
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001465These types can be used in declarations, but no simple value will actually
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001466have the "void" type. Trying to use a void (e.g. a function without a
Bram Moolenaara2baa732022-02-04 16:09:54 +00001467return value) results in error *E1031* *E1186* .
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001468
Bram Moolenaard77a8522020-04-03 21:59:57 +02001469There is no array type, use list<{type}> instead. For a list constant an
Bram Moolenaar71badf92023-04-22 22:40:14 +01001470efficient implementation is used that avoids allocating a lot of small pieces
1471of memory.
Ernie Rael3ec6c1f2023-10-21 11:45:38 +02001472 *vim9-func-declaration* *E1005* *E1007*
Bram Moolenaard77a8522020-04-03 21:59:57 +02001473A partial and function can be declared in more or less specific ways:
1474func any kind of function reference, no type
Bram Moolenaard1caa942020-04-10 22:10:56 +02001475 checking for arguments or return value
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001476func: void any number and type of arguments, no return
1477 value
Bram Moolenaard77a8522020-04-03 21:59:57 +02001478func: {type} any number and type of arguments with specific
1479 return type
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001480
1481func() function with no argument, does not return a
1482 value
1483func(): void same
1484func(): {type} function with no argument and return type
1485
Bram Moolenaard1caa942020-04-10 22:10:56 +02001486func({type}) function with argument type, does not return
Bram Moolenaard77a8522020-04-03 21:59:57 +02001487 a value
Bram Moolenaard1caa942020-04-10 22:10:56 +02001488func({type}): {type} function with argument type and return type
1489func(?{type}) function with type of optional argument, does
1490 not return a value
Ernie Raela5a15342023-10-23 19:08:38 +02001491func(...list<{type}>) function with type of list for variable number
1492 of arguments, does not return a value
1493func({type}, ?{type}, ...list<{type}>): {type}
Bram Moolenaard1caa942020-04-10 22:10:56 +02001494 function with:
1495 - type of mandatory argument
1496 - type of optional argument
Ernie Raela5a15342023-10-23 19:08:38 +02001497 - type of list for variable number of
1498 arguments
Bram Moolenaard1caa942020-04-10 22:10:56 +02001499 - return type
Bram Moolenaard77a8522020-04-03 21:59:57 +02001500
1501If the return type is "void" the function does not return a value.
1502
1503The reference can also be a |Partial|, in which case it stores extra arguments
1504and/or a dictionary, which are not visible to the caller. Since they are
1505called in the same way the declaration is the same.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001506
1507Custom types can be defined with `:type`: >
1508 :type MyList list<string>
Bram Moolenaar127542b2020-08-09 17:22:04 +02001509Custom types must start with a capital letter, to avoid name clashes with
1510builtin types added later, similarly to user functions.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001511{not implemented yet}
1512
1513And classes and interfaces can be used as types: >
1514 :class MyClass
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001515 :var mine: MyClass
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001516
1517 :interface MyInterface
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001518 :var mine: MyInterface
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001519
1520 :class MyTemplate<Targ>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001521 :var mine: MyTemplate<number>
1522 :var mine: MyTemplate<string>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001523
1524 :class MyInterface<Targ>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001525 :var mine: MyInterface<number>
1526 :var mine: MyInterface<string>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001527{not implemented yet}
1528
1529
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001530Variable types and type casting ~
1531 *variable-types*
Bram Moolenaar64d662d2020-08-09 19:02:50 +02001532Variables declared in Vim9 script or in a `:def` function have a type, either
1533specified explicitly or inferred from the initialization.
1534
1535Global, buffer, window and tab page variables do not have a specific type, the
1536value can be changed at any time, possibly changing the type. Therefore, in
1537compiled code the "any" type is assumed.
1538
1539This can be a problem when the "any" type is undesired and the actual type is
1540expected to always be the same. For example, when declaring a list: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001541 var l: list<number> = [1, g:two]
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001542At compile time Vim doesn't know the type of "g:two" and the expression type
1543becomes list<any>. An instruction is generated to check the list type before
1544doing the assignment, which is a bit inefficient.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001545 *type-casting* *E1104*
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001546To avoid this, use a type cast: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001547 var l: list<number> = [1, <number>g:two]
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001548The compiled code will then only check that "g:two" is a number and give an
1549error if it isn't. This is called type casting.
Bram Moolenaar64d662d2020-08-09 19:02:50 +02001550
1551The syntax of a type cast is: "<" {type} ">". There cannot be white space
1552after the "<" or before the ">" (to avoid them being confused with
1553smaller-than and bigger-than operators).
1554
1555The semantics is that, if needed, a runtime type check is performed. The
1556value is not actually changed. If you need to change the type, e.g. to change
1557it to a string, use the |string()| function. Or use |str2nr()| to convert a
1558string to a number.
1559
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01001560If a type is given where it is not expected you can get *E1272* .
1561
h_eastba77bbb2023-10-03 04:47:13 +09001562If a type is incomplete you get *E1363* , e.g. when you have an object for
Bram Moolenaar71badf92023-04-22 22:40:14 +01001563which the class is not known (usually that is a null object).
Bram Moolenaar64d662d2020-08-09 19:02:50 +02001564
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001565Type inference ~
1566 *type-inference*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001567In general: Whenever the type is clear it can be omitted. For example, when
1568declaring a variable and giving it a value: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001569 var name = 0 # infers number type
1570 var name = 'hello' # infers string type
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001571
Bram Moolenaar127542b2020-08-09 17:22:04 +02001572The type of a list and dictionary comes from the common type of the values.
1573If the values all have the same type, that type is used for the list or
1574dictionary. If there is a mix of types, the "any" type is used. >
1575 [1, 2, 3] list<number>
1576 ['a', 'b', 'c'] list<string>
1577 [1, 'x', 3] list<any>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001578
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001579The common type of function references, if they do not all have the same
1580number of arguments, uses "(...)" to indicate the number of arguments is not
1581specified. For example: >
1582 def Foo(x: bool)
1583 enddef
1584 def Bar(x: bool, y: bool)
1585 enddef
1586 var funclist = [Foo, Bar]
1587 echo funclist->typename()
1588Results in:
1589 list<func(...)>
1590
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001591For script-local variables in Vim9 script the type is checked, also when the
1592variable was declared in a legacy function.
1593
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001594When a type has been declared this is attached to a List or Dictionary. When
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001595later some expression attempts to change the type an error will be given: >
1596 var ll: list<number> = [1, 2, 3]
Bram Moolenaarc4573eb2022-01-31 15:40:56 +00001597 ll->extend(['x']) # Error, 'x' is not a number
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001598
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001599If the type is not declared then it is allowed to change: >
Bram Moolenaarc4573eb2022-01-31 15:40:56 +00001600 [1, 2, 3]->extend(['x']) # result: [1, 2, 3, 'x']
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001601
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001602For a variable declaration an inferred type matters: >
1603 var ll = [1, 2, 3]
1604 ll->extend(['x']) # Error, 'x' is not a number
1605That is because the declaration looks like a list of numbers, thus is
1606equivalent to: >
1607 var ll: list<number> = [1, 2, 3]
1608If you do want a more permissive list you need to declare the type: >
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00001609 var ll: list<any> = [1, 2, 3]
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001610 ll->extend(['x']) # OK
1611
Bram Moolenaar207f0092020-08-30 17:20:20 +02001612
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001613Stricter type checking ~
1614 *type-checking*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001615In legacy Vim script, where a number was expected, a string would be
1616automatically converted to a number. This was convenient for an actual number
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001617such as "123", but leads to unexpected problems (and no error message) if the
Bram Moolenaar207f0092020-08-30 17:20:20 +02001618string doesn't start with a number. Quite often this leads to hard-to-find
Bram Moolenaar944697a2022-02-20 19:48:20 +00001619bugs. e.g.: >
1620 echo 123 == '123'
1621< 1 ~
1622With an accidental space: >
1623 echo 123 == ' 123'
1624< 0 ~
Bram Moolenaara2baa732022-02-04 16:09:54 +00001625 *E1206* *E1210* *E1212*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001626In Vim9 script this has been made stricter. In most places it works just as
Bram Moolenaar944697a2022-02-20 19:48:20 +00001627before if the value used matches the expected type. There will sometimes be
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02001628an error, thus breaking backwards compatibility. For example:
Bram Moolenaar207f0092020-08-30 17:20:20 +02001629- Using a number other than 0 or 1 where a boolean is expected. *E1023*
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001630- Using a string value when setting a number option.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001631- Using a number where a string is expected. *E1024* *E1105*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001632
Bram Moolenaar22863042021-10-16 15:23:36 +01001633One consequence is that the item type of a list or dict given to |map()| must
Bram Moolenaar944697a2022-02-20 19:48:20 +00001634not change, if the type was declared. This will give an error in Vim9
1635script: >
1636 var mylist: list<number> = [1, 2, 3]
1637 echo map(mylist, (i, v) => 'item ' .. i)
1638< E1012: Type mismatch; expected number but got string in map() ~
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001639
Bram Moolenaar944697a2022-02-20 19:48:20 +00001640Instead use |mapnew()|, it creates a new list: >
1641 var mylist: list<number> = [1, 2, 3]
1642 echo mapnew(mylist, (i, v) => 'item ' .. i)
1643< ['item 0', 'item 1', 'item 2'] ~
1644
1645If the item type was not declared or determined to be "any" it can change to a
1646more specific type. E.g. when a list of mixed types gets changed to a list of
1647strings: >
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001648 var mylist = [1, 2.0, '3']
1649 # typename(mylist) == "list<any>"
1650 map(mylist, (i, v) => 'item ' .. i)
1651 # typename(mylist) == "list<string>", no error
Bram Moolenaar944697a2022-02-20 19:48:20 +00001652
1653There is a subtle difference between using a list constant directly and
Bram Moolenaarafa048f2022-02-22 20:43:36 +00001654through a variable declaration. Because of type inference, when using a list
Bram Moolenaar944697a2022-02-20 19:48:20 +00001655constant to initialize a variable, this also sets the declared type: >
1656 var mylist = [1, 2, 3]
1657 # typename(mylist) == "list<number>"
1658 echo map(mylist, (i, v) => 'item ' .. i) # Error!
1659
1660When using the list constant directly, the type is not declared and is allowed
1661to change: >
1662 echo map([1, 2, 3], (i, v) => 'item ' .. i) # OK
1663
1664The reasoning behind this is that when a type is declared and the list is
1665passed around and changed, the declaration must always hold. So that you can
1666rely on the type to match the declared type. For a constant this is not
1667needed.
1668
1669 *E1158*
Bram Moolenaar9faec4e2021-02-27 16:38:07 +01001670Same for |extend()|, use |extendnew()| instead, and for |flatten()|, use
Bram Moolenaar944697a2022-02-20 19:48:20 +00001671|flattennew()| instead. Since |flatten()| is intended to always change the
1672type, it can not be used in Vim9 script.
1673
Ernie Rael3ec6c1f2023-10-21 11:45:38 +02001674Assigning to a funcref with specified arguments (see |vim9-func-declaration|)
1675does strict type checking of the arguments. For variable number of arguments
1676the type must match: >
1677 var FuncRef: func(string, number, bool): number
1678 FuncRef = (v1: string, v2: number, v3: bool) => 777 # OK
1679 FuncRef = (v1: string, v2: number, v3: number) => 777 # Error!
1680 # variable number of arguments must have same type
1681 var FuncVA: func(...list<string>): number
1682 FuncVA = (...v: list<number>): number => v # Error!
1683 FuncVA = (...v: list<any>): number => v # OK, `any` runtime check
1684 FuncVA = (v1: string, v: string2): number => 333 # Error!
1685 FuncVA = (v: list<string>): number => 3 # Error!
1686
zeertzjq61e984e2023-12-09 15:18:33 +08001687If the destination funcref has no specified arguments, then there is no
Ernie Rael3ec6c1f2023-10-21 11:45:38 +02001688argument type checking: >
1689 var FuncUnknownArgs: func: number
1690 FuncUnknownArgs = (v): number => v # OK
1691 FuncUnknownArgs = (v1: string, v2: string): number => 3 # OK
Ernie Raela5a15342023-10-23 19:08:38 +02001692 FuncUnknownArgs = (...v1: list<string>): number => 333 # OK
1693<
Bram Moolenaara2baa732022-02-04 16:09:54 +00001694 *E1211* *E1217* *E1218* *E1219* *E1220* *E1221*
1695 *E1222* *E1223* *E1224* *E1225* *E1226* *E1227*
Dominique Pellee764d1b2023-03-12 21:20:59 +00001696 *E1228* *E1238* *E1250* *E1251* *E1252* *E1256*
1697 *E1297* *E1298* *E1301*
Bram Moolenaara2baa732022-02-04 16:09:54 +00001698Types are checked for most builtin functions to make it easier to spot
1699mistakes.
Bram Moolenaar82be4842021-01-11 19:40:15 +01001700
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001701==============================================================================
1702
Bram Moolenaar30fd8202020-09-26 15:09:30 +020017035. Namespace, Import and Export
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001704 *vim9script* *vim9-export* *vim9-import*
1705
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001706A Vim9 script can be written to be imported. This means that some items are
1707intentionally exported, made available to other scripts. When the exporting
1708script is imported in another script, these exported items can then be used in
1709that script. All the other items remain script-local in the exporting script
1710and cannot be accessed by the importing script.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001711
1712This mechanism exists for writing a script that can be sourced (imported) by
1713other scripts, while making sure these other scripts only have access to what
1714you want them to. This also avoids using the global namespace, which has a
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01001715risk of name collisions. For example when you have two plugins with similar
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001716functionality.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001717
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001718You can cheat by using the global namespace explicitly. That should be done
1719only for things that really are global.
Bram Moolenaar207f0092020-08-30 17:20:20 +02001720
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001721
1722Namespace ~
Bram Moolenaardcc58e02020-12-28 20:53:21 +01001723 *vim9-namespace*
Bram Moolenaar560979e2020-02-04 22:53:05 +01001724To recognize a file that can be imported the `vim9script` statement must
Bram Moolenaard3f8a9e2021-02-17 21:57:03 +01001725appear as the first statement in the file (see |vim9-mix| for an exception).
1726It tells Vim to interpret the script in its own namespace, instead of the
1727global namespace. If a file starts with: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001728 vim9script
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001729 var myvar = 'yes'
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001730Then "myvar" will only exist in this file. While without `vim9script` it would
1731be available as `g:myvar` from any other script and function.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001732 *E1101*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001733The variables at the file level are very much like the script-local "s:"
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +02001734variables in legacy Vim script, but the "s:" is omitted. And they cannot be
1735deleted.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001736
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +02001737In Vim9 script the global "g:" namespace can still be used as before. And the
1738"w:", "b:" and "t:" namespaces. These have in common that variables are not
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001739declared, have no specific type and they can be deleted. *E1304*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001740
1741A side effect of `:vim9script` is that the 'cpoptions' option is set to the
1742Vim default value, like with: >
1743 :set cpo&vim
1744One of the effects is that |line-continuation| is always enabled.
Bram Moolenaar3e191692021-03-17 17:46:00 +01001745The original value of 'cpoptions' is restored at the end of the script, while
1746flags added or removed in the script are also added to or removed from the
1747original value to get the same effect. The order of flags may change.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00001748In the |vimrc| file sourced on startup this does not happen.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001749
Bram Moolenaard3f8a9e2021-02-17 21:57:03 +01001750 *vim9-mix*
1751There is one way to use both legacy and Vim9 syntax in one script file: >
1752 " comments may go here
1753 if !has('vim9script')
1754 " legacy script commands go here
1755 finish
1756 endif
1757 vim9script
1758 # Vim9 script commands go here
1759This allows for writing a script that takes advantage of the Vim9 script
Bram Moolenaar9faec4e2021-02-27 16:38:07 +01001760syntax if possible, but will also work on a Vim version without it.
Bram Moolenaard3f8a9e2021-02-17 21:57:03 +01001761
1762This can only work in two ways:
17631. The "if" statement evaluates to false, the commands up to `endif` are
1764 skipped and `vim9script` is then the first command actually executed.
17652. The "if" statement evaluates to true, the commands up to `endif` are
1766 executed and `finish` bails out before reaching `vim9script`.
1767
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001768
1769Export ~
1770 *:export* *:exp*
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001771Exporting an item can be written as: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001772 export const EXPORTED_CONST = 1234
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001773 export var someValue = ...
1774 export final someValue = ...
1775 export const someValue = ...
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001776 export def MyFunc() ...
1777 export class MyClass ...
Bram Moolenaar74235772021-06-12 14:53:05 +02001778 export interface MyClass ...
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001779< *E1043* *E1044*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001780As this suggests, only constants, variables, `:def` functions and classes can
h_eastba77bbb2023-10-03 04:47:13 +09001781be exported.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001782
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001783 *E1042*
1784`:export` can only be used in Vim9 script, at the script level.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001785
1786
1787Import ~
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01001788 *:import* *:imp* *E1094* *E1047* *E1262*
1789 *E1048* *E1049* *E1053* *E1071* *E1088* *E1236*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001790The exported items can be imported in another script. The import syntax has
1791two forms. The simple form: >
1792 import {filename}
1793<
1794Where {filename} is an expression that must evaluate to a string. In this
1795form the filename should end in ".vim" and the portion before ".vim" will
1796become the script local name of the namespace. For example: >
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001797 import "myscript.vim"
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001798<
1799This makes each exported item in "myscript.vim" available as "myscript.item".
Bram Moolenaara2baa732022-02-04 16:09:54 +00001800 *:import-as* *E1257* *E1261*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001801In case the name is long or ambiguous, this form can be used to specify
1802another name: >
1803 import {longfilename} as {name}
1804<
1805In this form {name} becomes a specific script local name for the imported
1806namespace. Therefore {name} must consist of letters, digits and '_', like
1807|internal-variables|. The {longfilename} expression must evaluate to any
1808filename. For example: >
1809 import "thatscript.vim.v2" as that
Bram Moolenaara2baa732022-02-04 16:09:54 +00001810< *E1060* *E1258* *E1259* *E1260*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001811Then you can use "that.item", etc. You are free to choose the name "that".
1812Use something that will be recognized as referring to the imported script.
1813Avoid command names, command modifiers and builtin function names, because the
Aliaksei Budaveib043ff32023-10-03 17:39:53 +03001814name will shadow them. It's better not to start the name with a capital
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001815letter, since it can then also shadow global user commands and functions.
1816Also, you cannot use the name for something else in the script, such as a
1817function or variable name.
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001818
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001819In case the dot in the name is undesired, a local reference can be made for a
1820function: >
1821 var LongFunc = that.LongFuncName
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001822
1823This also works for constants: >
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001824 const MAXLEN = that.MAX_LEN_OF_NAME
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001825
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001826This does not work for variables, since the value would be copied once and
1827when changing the variable the copy will change, not the original variable.
1828You will need to use the full name, with the dot.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001829
Bram Moolenaar4db572e2021-07-18 18:21:38 +02001830`:import` can not be used in a function. Imported items are intended to exist
1831at the script level and only imported once.
1832
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001833The script name after `import` can be:
1834- A relative path, starting "." or "..". This finds a file relative to the
1835 location of the script file itself. This is useful to split up a large
1836 plugin into several files.
1837- An absolute path, starting with "/" on Unix or "D:/" on MS-Windows. This
Bram Moolenaarcb80aa22020-10-26 21:12:46 +01001838 will rarely be used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001839- A path not being relative or absolute. This will be found in the
1840 "import" subdirectories of 'runtimepath' entries. The name will usually be
1841 longer and unique, to avoid loading the wrong file.
Bram Moolenaar6aa57292021-08-14 21:25:52 +02001842 Note that "after/import" is not used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001843
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001844If the name does not end in ".vim" then the use of "as name" is required.
1845
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001846Once a vim9 script file has been imported, the result is cached and used the
1847next time the same script is imported. It will not be read again.
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001848
1849It is not allowed to import the same script twice, also when using two
1850different "as" names.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001851
1852When using the imported name the dot and the item name must be in the same
1853line, there can be no line break: >
1854 echo that.
1855 name # Error!
1856 echo that
1857 .name # Error!
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01001858< *import-map*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001859When you've imported a function from one script into a vim9 script you can
1860refer to the imported function in a mapping by prefixing it with |<SID>|: >
Bram Moolenaar89445512022-04-14 12:58:23 +01001861 noremap <silent> ,a :call <SID>name.Function()<CR>
1862
1863When the mapping is defined "<SID>name." will be replaced with <SNR> and the
1864script ID of the imported script.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01001865An even simpler solution is using |<ScriptCmd>|: >
1866 noremap ,a <ScriptCmd>name.Function()<CR>
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001867
1868Note that this does not work for variables, only for functions.
1869
1870 *import-legacy* *legacy-import*
1871`:import` can also be used in legacy Vim script. The imported namespace still
1872becomes script-local, even when the "s:" prefix is not given. For example: >
1873 import "myfile.vim"
1874 call s:myfile.MyFunc()
1875
1876And using the "as name" form: >
1877 import "otherfile.vim9script" as that
1878 call s:that.OtherFunc()
1879
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001880However, the namespace cannot be resolved on its own: >
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001881 import "that.vim"
1882 echo s:that
1883 " ERROR: E1060: Expected dot after name: s:that
1884<
1885This also affects the use of |<SID>| in the legacy mapping context. Since
1886|<SID>| is only a valid prefix for a function and NOT for a namespace, you
h_eastba77bbb2023-10-03 04:47:13 +09001887cannot use it to scope a function in a script local namespace. Instead of
1888prefixing the function with |<SID>| you should use|<ScriptCmd>|. For example:
1889>
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001890 noremap ,a <ScriptCmd>:call s:that.OtherFunc()<CR>
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01001891<
Bram Moolenaar89445512022-04-14 12:58:23 +01001892 *:import-cycle*
Bram Moolenaara2baa732022-02-04 16:09:54 +00001893The `import` commands are executed when encountered. If script A imports
1894script B, and B (directly or indirectly) imports A, this will be skipped over.
1895At this point items in A after "import B" will not have been processed and
1896defined yet. Therefore cyclic imports can exist and not result in an error
1897directly, but may result in an error for items in A after "import B" not being
1898defined. This does not apply to autoload imports, see the next section.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001899
1900
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001901Importing an autoload script ~
Bram Moolenaarfd999452022-08-24 18:30:14 +01001902 *vim9-autoload* *import-autoload*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001903For optimal startup speed, loading scripts should be postponed until they are
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001904actually needed. Using the autoload mechanism is recommended:
Bram Moolenaara2baa732022-02-04 16:09:54 +00001905 *E1264*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010019061. In the plugin define user commands, functions and/or mappings that refer to
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001907 items imported from an autoload script. >
1908 import autoload 'for/search.vim'
1909 command -nargs=1 SearchForStuff search.Stuff(<f-args>)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001910
1911< This goes in .../plugin/anyname.vim. "anyname.vim" can be freely chosen.
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001912 The "SearchForStuff" command is now available to the user.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001913
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001914 The "autoload" argument to `:import` means that the script is not loaded
1915 until one of the items is actually used. The script will be found under
1916 the "autoload" directory in 'runtimepath' instead of the "import"
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001917 directory. Alternatively a relative or absolute name can be used, see
1918 below.
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001919
19202. In the autoload script put the bulk of the code. >
Bram Moolenaarfd218c82022-01-18 16:26:24 +00001921 vim9script
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001922 export def Stuff(arg: string)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001923 ...
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001924
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001925< This goes in .../autoload/for/search.vim.
1926
Bram Moolenaarfd218c82022-01-18 16:26:24 +00001927 Putting the "search.vim" script under the "/autoload/for/" directory has
1928 the effect that "for#search#" will be prefixed to every exported item. The
1929 prefix is obtained from the file name, as you would to manually in a
1930 legacy autoload script. Thus the exported function can be found with
1931 "for#search#Stuff", but you would normally use `import autoload` and not
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001932 use the prefix (which has the side effect of loading the autoload script
1933 when compiling a function that encounters this name).
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001934
1935 You can split up the functionality and import other scripts from the
1936 autoload script as you like. This way you can share code between plugins.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001937
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001938Searching for the autoload script in all entries in 'runtimepath' can be a bit
1939slow. If the plugin knows where the script is located, quite often a relative
1940path can be used. This avoids the search and should be quite a bit faster.
1941Another advantage is that the script name does not need to be unique. An
1942absolute path is also possible. Examples: >
1943 import autoload '../lib/implement.vim'
1944 import autoload MyScriptsDir .. '/lib/implement.vim'
1945
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001946For defining a mapping that uses the imported autoload script the special key
1947|<ScriptCmd>| is useful. It allows for a command in a mapping to use the
1948script context of where the mapping was defined.
1949
Bram Moolenaar418f1df2020-08-12 21:34:49 +02001950When compiling a `:def` function and a function in an autoload script is
1951encountered, the script is not loaded until the `:def` function is called.
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001952This also means you get any errors only at runtime, since the argument and
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001953return types are not known yet. If you would use the name with '#' characters
1954then the autoload script IS loaded.
1955
1956Be careful to not refer to an item in an autoload script that does trigger
1957loading it unintentionally. For example, when setting an option that takes a
1958function name, make sure to use a string, not a function reference: >
1959 import autoload 'qftf.vim'
1960 &quickfixtextfunc = 'qftf.Func' # autoload script NOT loaded
1961 &quickfixtextfunc = qftf.Func # autoload script IS loaded
1962On the other hand, it can be useful to load the script early, at a time when
1963any errors should be given.
Bram Moolenaar418f1df2020-08-12 21:34:49 +02001964
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001965For testing the |test_override()| function can be used to have the
1966`import autoload` load the script right away, so that the items and types can
1967be checked without waiting for them to be actually used: >
1968 test_override('autoload', 1)
1969Reset it later with: >
1970 test_override('autoload', 0)
1971Or: >
1972 test_override('ALL', 0)
1973
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001974
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001975==============================================================================
1976
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000019776. Classes and interfaces *vim9-classes*
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001978
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001979In legacy script a Dictionary could be used as a kind-of object, by adding
1980members that are functions. However, this is quite inefficient and requires
1981the writer to do the work of making sure all the objects have the right
1982members. See |Dictionary-function|.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001983
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00001984In |Vim9| script you can have classes, objects and interfaces like in most
1985popular object-oriented programming languages. Since this is a lot of
1986functionality it is located in a separate help file: |vim9class.txt|.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001987
Bram Moolenaar74235772021-06-12 14:53:05 +02001988
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001989==============================================================================
1990
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010019919. Rationale *vim9-rationale*
1992
1993The :def command ~
1994
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001995Plugin writers have asked for much faster Vim script. Investigations have
Bram Moolenaar560979e2020-02-04 22:53:05 +01001996shown that keeping the existing semantics of function calls make this close to
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001997impossible, because of the overhead involved with calling a function, setting
1998up the local function scope and executing lines. There are many details that
1999need to be handled, such as error messages and exceptions. The need to create
2000a dictionary for a: and l: scopes, the a:000 list and several others add too
2001much overhead that cannot be avoided.
2002
2003Therefore the `:def` method to define a new-style function had to be added,
2004which allows for a function with different semantics. Most things still work
2005as before, but some parts do not. A new way to define a function was
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002006considered the best way to separate the legacy style code from Vim9 style code.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002007
2008Using "def" to define a function comes from Python. Other languages use
2009"function" which clashes with legacy Vim script.
2010
2011
2012Type checking ~
2013
2014When compiling lines of Vim commands into instructions as much as possible
2015should be done at compile time. Postponing it to runtime makes the execution
2016slower and means mistakes are found only later. For example, when
2017encountering the "+" character and compiling this into a generic add
Bram Moolenaar98a29d02021-01-18 19:55:44 +01002018instruction, at runtime the instruction would have to inspect the type of the
2019arguments and decide what kind of addition to do. And when the type is
2020dictionary throw an error. If the types are known to be numbers then an "add
2021number" instruction can be used, which is faster. The error can be given at
2022compile time, no error handling is needed at runtime, since adding two numbers
2023cannot fail.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002025The syntax for types, using <type> for compound types, is similar to Java. It
2026is easy to understand and widely used. The type names are what were used in
2027Vim before, with some additions such as "void" and "bool".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002028
2029
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002030Removing clutter and weirdness ~
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002031
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002032Once decided that `:def` functions have different syntax than legacy functions,
2033we are free to add improvements to make the code more familiar for users who
2034know popular programming languages. In other words: remove weird things that
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002035only Vim does.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002036
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002037We can also remove clutter, mainly things that were done to make Vim script
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002038backwards compatible with the good old Vi commands.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002039
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002040Examples:
Bram Moolenaar63f32602022-06-09 20:45:54 +01002041- Drop `:call` for calling a function and `:eval` for evaluating an
2042 expression.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002043- Drop using a leading backslash for line continuation, automatically figure
2044 out where an expression ends.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002045
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002046However, this does require that some things need to change:
2047- Comments start with # instead of ", to avoid confusing them with strings.
Bram Moolenaar63f32602022-06-09 20:45:54 +01002048 This is good anyway, it is also used by several popular languages.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002049- Ex command ranges need to be prefixed with a colon, to avoid confusion with
2050 expressions (single quote can be a string or a mark, "/" can be divide or a
2051 search command, etc.).
2052
2053Goal is to limit the differences. A good criteria is that when the old syntax
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002054is accidentally used you are very likely to get an error message.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002055
2056
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002057Syntax and semantics from popular languages ~
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002058
2059Script writers have complained that the Vim script syntax is unexpectedly
2060different from what they are used to. To reduce this complaint popular
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002061languages are used as an example. At the same time, we do not want to abandon
2062the well-known parts of legacy Vim script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002063
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002064For many things TypeScript is followed. It's a recent language that is
2065gaining popularity and has similarities with Vim script. It also has a
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002066mix of static typing (a variable always has a known value type) and dynamic
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002067typing (a variable can have different types, this changes at runtime). Since
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002068legacy Vim script is dynamically typed and a lot of existing functionality
2069(esp. builtin functions) depends on that, while static typing allows for much
2070faster execution, we need to have this mix in Vim9 script.
2071
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002072There is no intention to completely match TypeScript syntax and semantics. We
2073just want to take those parts that we can use for Vim and we expect Vim users
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002074will be happy with. TypeScript is a complex language with its own history,
2075advantages and disadvantages. To get an idea of the disadvantages read the
2076book: "JavaScript: The Good Parts". Or find the article "TypeScript: the good
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002077parts" and read the "Things to avoid" section.
2078
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002079People familiar with other languages (Java, Python, etc.) will also find
2080things in TypeScript that they do not like or do not understand. We'll try to
2081avoid those things.
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002082
2083Specific items from TypeScript we avoid:
2084- Overloading "+", using it both for addition and string concatenation. This
2085 goes against legacy Vim script and often leads to mistakes. For that reason
2086 we will keep using ".." for string concatenation. Lua also uses ".." this
2087 way. And it allows for conversion to string for more values.
2088- TypeScript can use an expression like "99 || 'yes'" in a condition, but
2089 cannot assign the value to a boolean. That is inconsistent and can be
2090 annoying. Vim recognizes an expression with && or || and allows using the
Bram Moolenaar1f318c62021-12-26 18:09:31 +00002091 result as a bool. The |falsy-operator| was added for the mechanism to use a
2092 default value.
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002093- TypeScript considers an empty string as Falsy, but an empty list or dict as
2094 Truthy. That is inconsistent. In Vim an empty list and dict are also
2095 Falsy.
2096- TypeScript has various "Readonly" types, which have limited usefulness,
2097 since a type cast can remove the immutable nature. Vim locks the value,
2098 which is more flexible, but is only checked at runtime.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002099- TypeScript has a complicated "import" statement that does not match how the
2100 Vim import mechanism works. A much simpler mechanism is used instead, which
2101 matches that the imported script is only sourced once.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002102
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002103
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002104Declarations ~
2105
2106Legacy Vim script uses `:let` for every assignment, while in Vim9 declarations
2107are used. That is different, thus it's good to use a different command:
2108`:var`. This is used in many languages. The semantics might be slightly
2109different, but it's easily recognized as a declaration.
2110
Bram Moolenaar23515b42020-11-29 14:36:24 +01002111Using `:const` for constants is common, but the semantics varies. Some
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002112languages only make the variable immutable, others also make the value
2113immutable. Since "final" is well known from Java for only making the variable
2114immutable we decided to use that. And then `:const` can be used for making
2115both immutable. This was also used in legacy Vim script and the meaning is
2116almost the same.
2117
2118What we end up with is very similar to Dart: >
2119 :var name # mutable variable and value
2120 :final name # immutable variable, mutable value
2121 :const name # immutable variable and value
2122
2123Since legacy and Vim9 script will be mixed and global variables will be
2124shared, optional type checking is desirable. Also, type inference will avoid
2125the need for specifying the type in many cases. The TypeScript syntax fits
2126best for adding types to declarations: >
2127 var name: string # string type is specified
2128 ...
2129 name = 'John'
2130 const greeting = 'hello' # string type is inferred
2131
2132This is how we put types in a declaration: >
2133 var mylist: list<string>
2134 final mylist: list<string> = ['foo']
2135 def Func(arg1: number, arg2: string): bool
2136
2137Two alternatives were considered:
21381. Put the type before the name, like Dart: >
2139 var list<string> mylist
2140 final list<string> mylist = ['foo']
2141 def Func(number arg1, string arg2) bool
21422. Put the type after the variable name, but do not use a colon, like Go: >
2143 var mylist list<string>
2144 final mylist list<string> = ['foo']
2145 def Func(arg1 number, arg2 string) bool
2146
2147The first is more familiar for anyone used to C or Java. The second one
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002148doesn't really have an advantage over the first, so let's discard the second.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002149
2150Since we use type inference the type can be left out when it can be inferred
2151from the value. This means that after `var` we don't know if a type or a name
2152follows. That makes parsing harder, not only for Vim but also for humans.
2153Also, it will not be allowed to use a variable name that could be a type name,
2154using `var string string` is too confusing.
2155
2156The chosen syntax, using a colon to separate the name from the type, adds
2157punctuation, but it actually makes it easier to recognize the parts of a
2158declaration.
2159
2160
2161Expressions ~
2162
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002163Expression evaluation was already close to what other languages are doing.
2164Some details are unexpected and can be improved. For example a boolean
2165condition would accept a string, convert it to a number and check if the
2166number is non-zero. This is unexpected and often leads to mistakes, since
2167text not starting with a number would be converted to zero, which is
Bram Moolenaarcb80aa22020-10-26 21:12:46 +01002168considered false. Thus using a string for a condition would often not give an
2169error and be considered false. That is confusing.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002170
Bram Moolenaar23515b42020-11-29 14:36:24 +01002171In Vim9 type checking is stricter to avoid mistakes. Where a condition is
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002172used, e.g. with the `:if` command and the `||` operator, only boolean-like
2173values are accepted:
2174 true: `true`, `v:true`, `1`, `0 < 9`
2175 false: `false`, `v:false`, `0`, `0 > 9`
2176Note that the number zero is false and the number one is true. This is more
Bram Moolenaarcb80aa22020-10-26 21:12:46 +01002177permissive than most other languages. It was done because many builtin
Bram Moolenaar63f32602022-06-09 20:45:54 +01002178functions return these values, and changing that causes more problems than it
2179solves. After using this for a while it turned out to work well.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002180
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002181If you have any type of value and want to use it as a boolean, use the `!!`
2182operator:
Bram Moolenaar63f32602022-06-09 20:45:54 +01002183 true: `!!'text'` `!![99]` `!!{'x': 1}` `!!99`
2184 false: `!!''` `!![]` `!!{}`
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002185
2186From a language like JavaScript we have this handy construct: >
2187 GetName() || 'unknown'
2188However, this conflicts with only allowing a boolean for a condition.
2189Therefore the "??" operator was added: >
2190 GetName() ?? 'unknown'
2191Here you can explicitly express your intention to use the value as-is and not
2192result in a boolean. This is called the |falsy-operator|.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002193
2194
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002195Import and Export ~
2196
2197A problem of legacy Vim script is that by default all functions and variables
2198are global. It is possible to make them script-local, but then they are not
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002199available in other scripts. This defies the concept of a package that only
2200exports selected items and keeps the rest local.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002201
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02002202In Vim9 script a mechanism very similar to the JavaScript import and export
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002203mechanism is supported. It is a variant to the existing `:source` command
2204that works like one would expect:
2205- Instead of making everything global by default, everything is script-local,
Bram Moolenaar63f32602022-06-09 20:45:54 +01002206 some of these are exported.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002207- When importing a script the symbols that are imported are explicitly listed,
2208 avoiding name conflicts and failures if functionality is added later.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002209- The mechanism allows for writing a big, long script with a very clear API:
Bram Moolenaar63f32602022-06-09 20:45:54 +01002210 the exported functions, variables and classes.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002211- By using relative paths loading can be much faster for an import inside of a
2212 package, no need to search many directories.
Bram Moolenaar63f32602022-06-09 20:45:54 +01002213- Once an import has been used, its items are cached and loading it again is
2214 not needed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002215- The Vim-specific use of "s:" to make things script-local can be dropped.
2216
Bram Moolenaar63f32602022-06-09 20:45:54 +01002217When sourcing a Vim9 script (from a Vim9 or legacy script), only the items
2218defined globally can be used, not the exported items. Alternatives
2219considered:
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002220- All the exported items become available as script-local items. This makes
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002221 it uncontrollable what items get defined and likely soon leads to trouble.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002222- Use the exported items and make them global. Disadvantage is that it's then
2223 not possible to avoid name clashes in the global namespace.
2224- Completely disallow sourcing a Vim9 script, require using `:import`. That
2225 makes it difficult to use scripts for testing, or sourcing them from the
2226 command line to try them out.
Bram Moolenaar63f32602022-06-09 20:45:54 +01002227Note that you CAN also use `:import` in legacy Vim script, see above.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002228
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002229
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002230Compiling functions early ~
2231
2232Functions are compiled when called or when `:defcompile` is used. Why not
2233compile them early, so that syntax and type errors are reported early?
2234
2235The functions can't be compiled right away when encountered, because there may
2236be forward references to functions defined later. Consider defining functions
2237A, B and C, where A calls B, B calls C, and C calls A again. It's impossible
2238to reorder the functions to avoid forward references.
2239
2240An alternative would be to first scan through the file to locate items and
2241figure out their type, so that forward references are found, and only then
2242execute the script and compile the functions. This means the script has to be
2243parsed twice, which is slower, and some conditions at the script level, such
2244as checking if a feature is supported, are hard to use. An attempt was made
Bram Moolenaar63f32602022-06-09 20:45:54 +01002245to see if it works, but it turned out to be impossible to make work well.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002246
2247It would be possible to compile all the functions at the end of the script.
2248The drawback is that if a function never gets called, the overhead of
2249compiling it counts anyway. Since startup speed is very important, in most
2250cases it's better to do it later and accept that syntax and type errors are
2251only reported then. In case these errors should be found early, e.g. when
Bram Moolenaar63f32602022-06-09 20:45:54 +01002252testing, a `:defcompile` command at the end of the script will help out.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002253
2254
Bram Moolenaar63f32602022-06-09 20:45:54 +01002255Why not use an existing embedded language? ~
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002256
2257Vim supports interfaces to Perl, Python, Lua, Tcl and a few others. But
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002258these interfaces have never become widely used, for various reasons. When
2259Vim9 was designed a decision was made to make these interfaces lower priority
2260and concentrate on Vim script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002261
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002262Still, plugin writers may find other languages more familiar, want to use
2263existing libraries or see a performance benefit. We encourage plugin authors
Bram Moolenaar63f32602022-06-09 20:45:54 +01002264to write code in any language and run it as an external process, using jobs
2265and channels. We can try to make this easier somehow.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002266
2267Using an external tool also has disadvantages. An alternative is to convert
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002268the tool into Vim script. For that to be possible without too much
2269translation, and keeping the code fast at the same time, the constructs of the
2270tool need to be supported. Since most languages support classes the lack of
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002271support for classes in Vim is then a problem.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002272
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002273
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002274
2275 vim:tw=78:ts=8:noet:ft=help:norl: