blob: 15e9a702bcd74007aa3cda66e71d10f6c58bfd32 [file] [log] [blame]
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001*vim9.txt* For Vim version 9.0. Last change: 2022 Sep 19
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 Moolenaar1d59aa12020-09-19 18:50:13 +0200196. Future work: classes |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`
108 `:xit`
109- 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`: >
116 :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 Moolenaard58a3bf2020-09-28 21:48:16 +0200120
121
Bram Moolenaar2c330432020-04-13 14:41:35 +0200122Comments starting with # ~
123
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200124In legacy Vim script comments start with double quote. In Vim9 script
125comments start with #. >
126 # declarations
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200127 var count = 0 # number of occurrences
Bram Moolenaar2c330432020-04-13 14:41:35 +0200128
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200129The reason is that a double quote can also be the start of a string. In many
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200130places, especially halfway through an expression with a line break, it's hard
131to tell what the meaning is, since both a string and a comment can be followed
132by arbitrary text. To avoid confusion only # comments are recognized. This
133is the same as in shell scripts and Python programs.
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200134
135In Vi # is a command to list text with numbers. In Vim9 script you can use
136`:number` for that. >
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000137 :101 number
Bram Moolenaarf5be8cd2020-07-17 20:36:00 +0200138
139To improve readability there must be a space between a command and the #
Bram Moolenaar2b327002020-12-26 15:39:31 +0100140that starts a comment: >
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100141 var name = value # comment
142 var name = value# error!
Bram Moolenaara2baa732022-02-04 16:09:54 +0000143< *E1170*
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200144Do not start a comment with #{, it looks like the legacy dictionary literal
145and produces an error where this might be confusing. #{{ or #{{{ are OK,
146these can be used to start a fold.
147
Bram Moolenaar5ed11532022-07-06 13:18:11 +0100148When starting to read a script file Vim doesn't know it is |Vim9| script until
149the `vim9script` command is found. Until that point you would need to use
150legacy comments: >
151 " legacy comment
152 vim9script
153 # Vim9 comment
154
155That looks ugly, better put `vim9script` in the very first line: >
156 vim9script
157 # Vim9 comment
158
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100159In legacy Vim script # is also used for the alternate file name. In Vim9
160script you need to use %% instead. Instead of ## use %%% (stands for all
161arguments).
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200162
Bram Moolenaar2c330432020-04-13 14:41:35 +0200163
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100164Vim9 functions ~
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000165 *E1099*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200166A function defined with `:def` is compiled. Execution is many times faster,
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200167often 10 to 100 times.
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200168
Bram Moolenaar388a5d42020-05-26 21:20:45 +0200169Many errors are already found when compiling, before the function is executed.
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200170The syntax is strict, to enforce code that is easy to read and understand.
171
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200172Compilation is done when any of these is encountered:
Bram Moolenaar1b884a02020-12-10 21:11:27 +0100173- the first time the function is called
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200174- when the `:defcompile` command is encountered in the script after the
Bram Moolenaar207f0092020-08-30 17:20:20 +0200175 function was defined
176- `:disassemble` is used for the function.
177- a function that is compiled calls the function or uses it as a function
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200178 reference (so that the argument and return types can be checked)
Bram Moolenaara2baa732022-02-04 16:09:54 +0000179 *E1091* *E1191*
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200180If compilation fails it is not tried again on the next call, instead this
181error is given: "E1091: Function is not compiled: {name}".
Bram Moolenaar4c295022021-05-02 17:19:11 +0200182Compilation will fail when encountering a user command that has not been
183created yet. In this case you can call `execute()` to invoke it at runtime. >
184 def MyFunc()
185 execute('DefinedLater')
186 enddef
Bram Moolenaar388a5d42020-05-26 21:20:45 +0200187
188`:def` has no options like `:function` does: "range", "abort", "dict" or
Bram Moolenaar1b884a02020-12-10 21:11:27 +0100189"closure". A `:def` function always aborts on an error (unless `:silent!` was
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000190used for the command or the error was caught a `:try` block), does not get a
Bram Moolenaar63f32602022-06-09 20:45:54 +0100191range passed, cannot be a "dict" function, and can always be a closure.
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200192 *vim9-no-dict-function*
Bram Moolenaar74235772021-06-12 14:53:05 +0200193Later classes will be added, which replaces the "dict function" mechanism.
194For now you will need to pass the dictionary explicitly: >
Bram Moolenaar63f32602022-06-09 20:45:54 +0100195 def DictFunc(self: dict<any>, arg: string)
196 echo self[arg]
Bram Moolenaar74235772021-06-12 14:53:05 +0200197 enddef
Bram Moolenaar46eea442022-03-30 10:51:39 +0100198 var ad = {item: 'value', func: DictFunc}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100199 ad.func(ad, 'item')
Bram Moolenaar74235772021-06-12 14:53:05 +0200200
Bram Moolenaar34cc7d82021-09-21 20:09:51 +0200201You can call a legacy dict function though: >
202 func Legacy() dict
203 echo self.value
204 endfunc
205 def CallLegacy()
206 var d = {func: Legacy, value: 'text'}
207 d.func()
208 enddef
Bram Moolenaara2baa732022-02-04 16:09:54 +0000209< *E1096* *E1174* *E1175*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200210The argument types and return type need to be specified. The "any" type can
211be used, type checking will then be done at runtime, like with legacy
212functions.
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000213 *E1106*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200214Arguments are accessed by name, without "a:", just like any other language.
215There is no "a:" dictionary or "a:000" list.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000216 *vim9-variable-arguments* *E1055* *E1160* *E1180*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200217Variable arguments are defined as the last argument, with a name and have a
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200218list type, similar to TypeScript. For example, a list of numbers: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200219 def MyFunc(...itemlist: list<number>)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100220 for item in itemlist
221 ...
222
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200223When a function argument is optional (it has a default value) passing `v:none`
224as the argument results in using the default value. This is useful when you
225want to specify a value for an argument that comes after an argument that
226should use its default value. Example: >
Bram Moolenaar22863042021-10-16 15:23:36 +0100227 def MyFunc(one = 'one', last = 'last')
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200228 ...
229 enddef
230 MyFunc(v:none, 'LAST') # first argument uses default value 'one'
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200231<
Bram Moolenaara2baa732022-02-04 16:09:54 +0000232 *vim9-ignored-argument* *E1181*
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200233The argument "_" (an underscore) can be used to ignore the argument. This is
234most useful in callbacks where you don't need it, but do need to give an
235argument to match the call. E.g. when using map() two arguments are passed,
236the key and the value, to ignore the key: >
Bram Moolenaar63f32602022-06-09 20:45:54 +0100237 map(numberList, (_, v) => v * 2)
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200238There is no error for using the "_" argument multiple times. No type needs to
239be given.
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200240
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100241
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200242Functions and variables are script-local by default ~
Bram Moolenaar65e0d772020-06-14 17:29:55 +0200243 *vim9-scopes*
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200244When using `:function` or `:def` to specify a new function at the script level
Bram Moolenaar92f645b2022-02-11 13:29:40 +0000245in a Vim9 script, the function is local to the script. Like prefixing "s:" in
246legacy script. To define a global function or variable the "g:" prefix must
247be used. For functions in a script that is to be imported and in an autoload
Bram Moolenaar63f32602022-06-09 20:45:54 +0100248script "export" needs to be used for those to be used elsewhere. >
Bram Moolenaarea2d8d22020-07-29 22:11:05 +0200249 def ThisFunction() # script-local
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200250 def g:ThatFunction() # global
Bram Moolenaar9da17d72022-02-09 21:50:44 +0000251 export def Function() # for import and import autoload
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000252< *E1058* *E1075*
Bram Moolenaar2bb26582020-10-03 22:52:39 +0200253When using `:function` or `:def` to specify a nested function inside a `:def`
Bram Moolenaar47003982021-12-05 21:54:04 +0000254function and no namespace was given, this nested function is local to the code
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000255block it is defined in. It cannot be used in `function()` with a string
256argument, pass the function reference itself: >
257 def Outer()
258 def Inner()
259 echo 'inner'
260 enddef
261 var Fok = function(Inner) # OK
262 var Fbad = function('Inner') # does not work
263
Bram Moolenaar63f32602022-06-09 20:45:54 +0100264Detail: this is because "Inner" will actually become a function reference to a
265function with a generated name.
266
267It is not possible to define a script-local function in a function. You can
268define a local function and assign it to a script-local funcref (it must have
269been declared at the script level). It is possible to define a global
270function by using the "g:" prefix.
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200271
272When referring to a function and no "s:" or "g:" prefix is used, Vim will
Bram Moolenaar13106602020-10-04 16:06:05 +0200273search for the function:
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +0200274- in the function scope, in block scopes
Bram Moolenaar63f32602022-06-09 20:45:54 +0100275- in the script scope
276
277Imported functions are found with the prefix from the `:import` command.
Bram Moolenaar13106602020-10-04 16:06:05 +0200278
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200279Since a script-local function reference can be used without "s:" the name must
Bram Moolenaardad44732021-03-31 20:07:33 +0200280start with an upper case letter even when using the "s:" prefix. In legacy
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200281script "s:funcref" could be used, because it could not be referred to with
282"funcref". In Vim9 script it can, therefore "s:Funcref" must be used to avoid
283that the name interferes with builtin functions.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +0100284 *vim9-s-namespace* *E1268*
Bram Moolenaar92f645b2022-02-11 13:29:40 +0000285The use of the "s:" prefix is not supported at the Vim9 script level. All
286functions and variables without a prefix are script-local.
Bram Moolenaarafa048f2022-02-22 20:43:36 +0000287
288In :def functions the use of "s:" depends on the script: Script-local
289variables and functions in a legacy script do use "s:", while in a Vim9 script
290they do not use "s:". This matches what you see in the rest of the file.
291
Bram Moolenaar92f645b2022-02-11 13:29:40 +0000292In legacy functions the use of "s:" for script items is required, as before.
Bram Moolenaar63f32602022-06-09 20:45:54 +0100293No matter if the script is Vim9 or legacy.
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200294
Bram Moolenaar13106602020-10-04 16:06:05 +0200295In all cases the function must be defined before used. That is when it is
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100296called, when `:defcompile` causes it to be compiled, or when code that calls
297it is being compiled (to figure out the return type).
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200298
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200299The result is that functions and variables without a namespace can usually be
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200300found in the script, either defined there or imported. Global functions and
Bram Moolenaar63f32602022-06-09 20:45:54 +0100301variables could be defined anywhere (good luck finding out where! You can
302often see where it was last set using |:verbose|).
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000303 *E1102*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200304Global functions can still be defined and deleted at nearly any time. In
Bram Moolenaar2cfb4a22020-05-07 18:56:00 +0200305Vim9 script script-local functions are defined once when the script is sourced
Bram Moolenaar63f32602022-06-09 20:45:54 +0100306and cannot be deleted or replaced by itself (it can be by reloading the
307script).
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200308
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100309When compiling a function and a function call is encountered for a function
310that is not (yet) defined, the |FuncUndefined| autocommand is not triggered.
311You can use an autoload function if needed, or call a legacy function and have
312|FuncUndefined| triggered there.
313
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200314
Bram Moolenaar2b327002020-12-26 15:39:31 +0100315Reloading a Vim9 script clears functions and variables by default ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000316 *vim9-reload* *E1149* *E1150*
Bram Moolenaar2b327002020-12-26 15:39:31 +0100317When loading a legacy Vim script a second time nothing is removed, the
Bram Moolenaar30ab04e2022-05-14 13:33:50 +0100318commands will replace existing variables and functions, create new ones, and
319leave removed things hanging around.
Bram Moolenaar2b327002020-12-26 15:39:31 +0100320
321When loading a Vim9 script a second time all existing script-local functions
322and variables are deleted, thus you start with a clean slate. This is useful
323if you are developing a plugin and want to try a new version. If you renamed
324something you don't have to worry about the old name still hanging around.
325
326If you do want to keep items, use: >
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100327 vim9script noclear
Bram Moolenaar2b327002020-12-26 15:39:31 +0100328
329You want to use this in scripts that use a `finish` command to bail out at
Bram Moolenaar944697a2022-02-20 19:48:20 +0000330some point when loaded again. E.g. when a buffer local option is set to a
331function, the function does not need to be defined more than once: >
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100332 vim9script noclear
Bram Moolenaar2b327002020-12-26 15:39:31 +0100333 setlocal completefunc=SomeFunc
Bram Moolenaar944697a2022-02-20 19:48:20 +0000334 if exists('*SomeFunc')
Bram Moolenaar9da17d72022-02-09 21:50:44 +0000335 finish
336 endif
Bram Moolenaar944697a2022-02-20 19:48:20 +0000337 def SomeFunc()
Bram Moolenaar2b327002020-12-26 15:39:31 +0100338 ....
339
Bram Moolenaar2b327002020-12-26 15:39:31 +0100340
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200341Variable declarations with :var, :final and :const ~
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000342 *vim9-declaration* *:var* *E1079*
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000343 *E1017* *E1020* *E1054* *E1087* *E1108* *E1124*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200344Local variables need to be declared with `:var`. Local constants need to be
345declared with `:final` or `:const`. We refer to both as "variables" in this
346section.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100347
348Variables can be local to a script, function or code block: >
349 vim9script
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200350 var script_var = 123
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100351 def SomeFunc()
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200352 var func_var = script_var
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100353 if cond
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200354 var block_var = func_var
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100355 ...
356
357The variables are only visible in the block where they are defined and nested
358blocks. Once the block ends the variable is no longer accessible: >
359 if cond
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200360 var inner = 5
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100361 else
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200362 var inner = 0
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100363 endif
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200364 echo inner # Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100365
366The declaration must be done earlier: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200367 var inner: number
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100368 if cond
369 inner = 5
370 else
371 inner = 0
372 endif
373 echo inner
Bram Moolenaar63f32602022-06-09 20:45:54 +0100374
375Although this is shorter and faster for simple values: >
376 var inner = 0
377 if cond
378 inner = 5
379 endif
380 echo inner
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000381< *E1025* *E1128*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200382To intentionally hide a variable from code that follows, a block can be
383used: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100384 {
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200385 var temp = 'temp'
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100386 ...
387 }
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200388 echo temp # Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100389
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200390This is especially useful in a user command: >
391
392 command -range Rename {
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200393 var save = @a
394 @a = 'some expression'
395 echo 'do something with ' .. @a
396 @a = save
397 }
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200398
399And with autocommands: >
400
401 au BufWritePre *.go {
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200402 var save = winsaveview()
403 silent! exe ':%! some formatting command'
404 winrestview(save)
405 }
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200406
407Although using a :def function probably works better.
Bram Moolenaar46eea442022-03-30 10:51:39 +0100408
Bram Moolenaara2baa732022-02-04 16:09:54 +0000409 *E1022* *E1103* *E1130* *E1131* *E1133*
Dominique Pelle7765f5c2022-04-10 11:26:53 +0100410 *E1134*
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200411Declaring a variable with a type but without an initializer will initialize to
Bram Moolenaar1f318c62021-12-26 18:09:31 +0000412false (for bool), empty (for string, list, dict, etc.) or zero (for number,
413any, etc.). This matters especially when using the "any" type, the value will
Bram Moolenaar46eea442022-03-30 10:51:39 +0100414default to the number zero. For example, when declaring a list, items can be
415added: >
416 var myList: list<number>
417 myList->add(7)
418
419Initializing a variable to a null value, e.g. `null_list`, differs from not
420initializing the variable. This throws an error: >
421 var myList = null_list
422 myList->add(7) # E1130: Cannot add to null list
423
424< *E1016* *E1052* *E1066*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200425In Vim9 script `:let` cannot be used. An existing variable is assigned to
426without any command. The same for global, window, tab, buffer and Vim
Bram Moolenaar5da36052021-12-27 15:39:57 +0000427variables, because they are not really declared. Those can also be deleted
Bram Moolenaarf5a48012020-08-01 17:00:03 +0200428with `:unlet`.
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +0000429 *E1065*
430You cannot use `:va` to declare a variable, it must be written with the full
431name `:var`. Just to make sure it is easy to read.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000432 *E1178*
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200433`:lockvar` does not work on local variables. Use `:const` and `:final`
434instead.
435
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200436The `exists()` and `exists_compiled()` functions do not work on local variables
437or arguments.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000438 *E1006* *E1041* *E1167* *E1168* *E1213*
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100439Variables, functions and function arguments cannot shadow previously defined
440or imported variables and functions in the same script file.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100441Variables may shadow Ex commands, rename the variable if needed.
442
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200443Global variables must be prefixed with "g:", also at the script level. >
Bram Moolenaard1caa942020-04-10 22:10:56 +0200444 vim9script
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200445 var script_local = 'text'
Bram Moolenaar2547aa92020-07-26 17:00:44 +0200446 g:global = 'value'
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200447 var Funcref = g:ThatFunction
Bram Moolenaard1caa942020-04-10 22:10:56 +0200448
Bram Moolenaarc4573eb2022-01-31 15:40:56 +0000449Global functions must be prefixed with "g:": >
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200450 vim9script
451 def g:GlobalFunc(): string
452 return 'text'
453 enddef
Bram Moolenaarc4573eb2022-01-31 15:40:56 +0000454 echo g:GlobalFunc()
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200455The "g:" prefix is not needed for auto-load functions.
456
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200457 *vim9-function-defined-later*
458Although global functions can be called without the "g:" prefix, they must
459exist when compiled. By adding the "g:" prefix the function can be defined
460later. Example: >
461 def CallPluginFunc()
462 if exists('g:loaded_plugin')
463 g:PluginFunc()
464 endif
465 enddef
466
Bram Moolenaarb79ee0c2022-01-01 12:17:00 +0000467If you do it like this, you get an error at compile time that "PluginFunc"
468does not exist, even when "g:loaded_plugin" does not exist: >
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200469 def CallPluginFunc()
470 if exists('g:loaded_plugin')
471 PluginFunc() # Error - function not found
472 endif
473 enddef
474
475You can use exists_compiled() to avoid the error, but then the function would
476not be called, even when "g:loaded_plugin" is defined later: >
477 def CallPluginFunc()
478 if exists_compiled('g:loaded_plugin')
479 PluginFunc() # Function may never be called
480 endif
481 enddef
482
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200483Since `&opt = value` is now assigning a value to option "opt", ":&" cannot be
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100484used to repeat a `:substitute` command.
Bram Moolenaar56994d22021-04-17 16:31:09 +0200485 *vim9-unpack-ignore*
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200486For an unpack assignment the underscore can be used to ignore a list item,
487similar to how a function argument can be ignored: >
488 [a, _, c] = theList
Bram Moolenaar56994d22021-04-17 16:31:09 +0200489To ignore any remaining items: >
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200490 [a, b; _] = longList
Bram Moolenaar944697a2022-02-20 19:48:20 +0000491< *E1163* *E1080*
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200492Declaring more than one variable at a time, using the unpack notation, is
Bram Moolenaarab36e6a2021-11-30 16:14:49 +0000493possible. Each variable can have a type or infer it from the value: >
494 var [v1: number, v2] = GetValues()
495Use this only when there is a list with values, declaring one variable per
496line is much easier to read and change later.
Bram Moolenaarf93bbd02021-04-10 22:35:43 +0200497
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200498
499Constants ~
500 *vim9-const* *vim9-final*
501How constants work varies between languages. Some consider a variable that
502can't be assigned another value a constant. JavaScript is an example. Others
503also make the value immutable, thus when a constant uses a list, the list
504cannot be changed. In Vim9 we can use both.
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000505 *E1021*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200506`:const` is used for making both the variable and the value a constant. Use
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200507this for composite structures that you want to make sure will not be modified.
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200508Example: >
509 const myList = [1, 2]
510 myList = [3, 4] # Error!
511 myList[0] = 9 # Error!
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100512 myList->add(3) # Error!
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000513< *:final* *E1125*
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200514`:final` is used for making only the variable a constant, the value can be
515changed. This is well known from Java. Example: >
516 final myList = [1, 2]
517 myList = [3, 4] # Error!
518 myList[0] = 9 # OK
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100519 myList->add(3) # OK
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200520
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200521It is common to write constants as ALL_CAPS, but you don't have to.
522
523The constant only applies to the value itself, not what it refers to. >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200524 final females = ["Mary"]
525 const NAMES = [["John", "Peter"], females]
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200526 NAMES[0] = ["Jack"] # Error!
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200527 NAMES[0][0] = "Jack" # Error!
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200528 NAMES[1] = ["Emma"] # Error!
Bram Moolenaar82be4842021-01-11 19:40:15 +0100529 NAMES[1][0] = "Emma" # OK, now females[0] == "Emma"
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +0200530
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100531
532Omitting :call and :eval ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000533 *E1190*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100534Functions can be called without `:call`: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200535 writefile(lines, 'file')
Bram Moolenaar560979e2020-02-04 22:53:05 +0100536Using `:call` is still possible, but this is discouraged.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100537
538A method call without `eval` is possible, so long as the start is an
Bram Moolenaar0289a092021-03-14 18:40:19 +0100539identifier or can't be an Ex command. For a function either "(" or "->" must
540be following, without a line break. Examples: >
Bram Moolenaarae616492020-07-28 20:07:27 +0200541 myList->add(123)
542 g:myList->add(123)
543 [1, 2, 3]->Process()
Bram Moolenaar2bede172020-11-19 18:53:18 +0100544 {a: 1, b: 2}->Process()
Bram Moolenaarae616492020-07-28 20:07:27 +0200545 "foobar"->Process()
546 ("foobar")->Process()
547 'foobar'->Process()
548 ('foobar')->Process()
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100549
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200550In the rare case there is ambiguity between a function name and an Ex command,
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200551prepend ":" to make clear you want to use the Ex command. For example, there
552is both the `:substitute` command and the `substitute()` function. When the
553line starts with `substitute(` this will use the function. Prepend a colon to
554use the command instead: >
Bram Moolenaar0c6ceaf2020-02-22 18:36:32 +0100555 :substitute(pattern (replacement (
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +0100556
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200557If the expression starts with "!" this is interpreted as a shell command, not
558negation of a condition. Thus this is a shell command: >
559 !shellCommand->something
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200560Put the expression in parentheses to use the "!" for negation: >
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200561 (!expression)->Method()
562
Bram Moolenaarcc390ff2020-02-29 22:06:30 +0100563Note that while variables need to be defined before they can be used,
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200564functions can be called before being defined. This is required to allow
565for cyclic dependencies between functions. It is slightly less efficient,
Bram Moolenaarcc390ff2020-02-29 22:06:30 +0100566since the function has to be looked up by name. And a typo in the function
Bram Moolenaarae616492020-07-28 20:07:27 +0200567name will only be found when the function is called.
Bram Moolenaarcc390ff2020-02-29 22:06:30 +0100568
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100569
Bram Moolenaard1caa942020-04-10 22:10:56 +0200570Omitting function() ~
571
572A user defined function can be used as a function reference in an expression
573without `function()`. The argument types and return type will then be checked.
574The function must already have been defined. >
575
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200576 var Funcref = MyFunction
Bram Moolenaard1caa942020-04-10 22:10:56 +0200577
578When using `function()` the resulting type is "func", a function with any
Bram Moolenaar90df4b92021-07-07 20:26:08 +0200579number of arguments and any return type (including void). The function can be
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000580defined later if the argument is in quotes.
Bram Moolenaard1caa942020-04-10 22:10:56 +0200581
582
Bram Moolenaar2b327002020-12-26 15:39:31 +0100583Lambda using => instead of -> ~
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200584 *vim9-lambda*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100585In legacy script there can be confusion between using "->" for a method call
586and for a lambda. Also, when a "{" is found the parser needs to figure out if
587it is the start of a lambda or a dictionary, which is now more complicated
588because of the use of argument types.
589
590To avoid these problems Vim9 script uses a different syntax for a lambda,
Bram Moolenaar74235772021-06-12 14:53:05 +0200591which is similar to JavaScript: >
Bram Moolenaar65c44152020-12-24 15:14:01 +0100592 var Lambda = (arg) => expression
Bram Moolenaara2baa732022-02-04 16:09:54 +0000593 var Lambda = (arg): type => expression
594< *E1157*
Bram Moolenaar2b327002020-12-26 15:39:31 +0100595No line break is allowed in the arguments of a lambda up to and including the
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200596"=>" (so that Vim can tell the difference between an expression in parentheses
Bram Moolenaar2346a632021-06-13 19:02:49 +0200597and lambda arguments). This is OK: >
Bram Moolenaar65c44152020-12-24 15:14:01 +0100598 filter(list, (k, v) =>
599 v > 0)
600This does not work: >
601 filter(list, (k, v)
602 => v > 0)
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100603This also does not work: >
Bram Moolenaar65c44152020-12-24 15:14:01 +0100604 filter(list, (k,
605 v) => v > 0)
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100606But you can use a backslash to concatenate the lines before parsing: >
607 filter(list, (k,
608 \ v)
609 \ => v > 0)
Bram Moolenaara2baa732022-02-04 16:09:54 +0000610< *vim9-lambda-arguments* *E1172*
Bram Moolenaar962c43b2021-04-10 17:18:09 +0200611In legacy script a lambda could be called with any number of extra arguments,
612there was no way to warn for not using them. In Vim9 script the number of
613arguments must match. If you do want to accept any arguments, or any further
614arguments, use "..._", which makes the function accept
615|vim9-variable-arguments|. Example: >
616 var Callback = (..._) => 'anything'
617 echo Callback(1, 2, 3) # displays "anything"
618
Bram Moolenaara2baa732022-02-04 16:09:54 +0000619< *inline-function* *E1171*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100620Additionally, a lambda can contain statements in {}: >
621 var Lambda = (arg) => {
622 g:was_called = 'yes'
623 return expression
624 }
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200625This can be useful for a timer, for example: >
626 var count = 0
627 var timer = timer_start(500, (_) => {
628 count += 1
629 echom 'Handler called ' .. count
630 }, {repeat: 3})
631
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200632The ending "}" must be at the start of a line. It can be followed by other
633characters, e.g.: >
634 var d = mapnew(dict, (k, v): string => {
635 return 'value'
636 })
637No command can follow the "{", only a comment can be used there.
638
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000639 *command-block* *E1026*
Bram Moolenaar259f4432021-12-17 12:45:22 +0000640The block can also be used for defining a user command. Inside the block Vim9
641syntax will be used.
642
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000643If the statements include a dictionary, its closing bracket must not be
644written at the start of a line. Otherwise, it would be parsed as the end of
645the block. This does not work: >
646 command NewCommand {
Bram Moolenaar259f4432021-12-17 12:45:22 +0000647 g:mydict = {
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000648 'key': 'value',
649 } # ERROR: will be recognized as the end of the block
650 }
651Put the '}' after the last item to avoid this: >
652 command NewCommand {
Bram Moolenaar259f4432021-12-17 12:45:22 +0000653 g:mydict = {
Bram Moolenaar0e6adf82021-12-16 14:41:10 +0000654 'key': 'value' }
655 }
656
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +0200657Rationale: The "}" cannot be after a command because it would require parsing
658the commands to find it. For consistency with that no command can follow the
659"{". Unfortunately this means using "() => { command }" does not work, line
660breaks are always required.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100661
Bram Moolenaare0e39172021-01-25 21:14:57 +0100662 *vim9-curly*
Bram Moolenaar2b327002020-12-26 15:39:31 +0100663To avoid the "{" of a dictionary literal to be recognized as a statement block
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100664wrap it in parentheses: >
Bram Moolenaar2b327002020-12-26 15:39:31 +0100665 var Lambda = (arg) => ({key: 42})
Bram Moolenaar65c44152020-12-24 15:14:01 +0100666
Bram Moolenaare0e39172021-01-25 21:14:57 +0100667Also when confused with the start of a command block: >
668 ({
669 key: value
670 })->method()
671
Bram Moolenaar65c44152020-12-24 15:14:01 +0100672
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200673Automatic line continuation ~
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000674 *vim9-line-continuation* *E1097*
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200675In many cases it is obvious that an expression continues on the next line. In
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100676those cases there is no need to prefix the line with a backslash (see
677|line-continuation|). For example, when a list spans multiple lines: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200678 var mylist = [
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200679 'one',
680 'two',
681 ]
Bram Moolenaare6085c52020-04-12 20:19:16 +0200682And when a dict spans multiple lines: >
Bram Moolenaar2bede172020-11-19 18:53:18 +0100683 var mydict = {
Bram Moolenaare6085c52020-04-12 20:19:16 +0200684 one: 1,
685 two: 2,
686 }
Bram Moolenaar74235772021-06-12 14:53:05 +0200687With a function call: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200688 var result = Func(
Bram Moolenaare6085c52020-04-12 20:19:16 +0200689 arg1,
690 arg2
691 )
692
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200693For binary operators in expressions not in [], {} or () a line break is
694possible just before or after the operator. For example: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200695 var text = lead
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200696 .. middle
697 .. end
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200698 var total = start +
Bram Moolenaar82be4842021-01-11 19:40:15 +0100699 end -
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200700 correction
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200701 var result = positive
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200702 ? PosFunc(arg)
703 : NegFunc(arg)
Bram Moolenaar9c7e6dd2020-04-12 20:55:20 +0200704
Bram Moolenaar2547aa92020-07-26 17:00:44 +0200705For a method call using "->" and a member using a dot, a line break is allowed
706before it: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200707 var result = GetBuilder()
Bram Moolenaar73fef332020-06-21 22:12:03 +0200708 ->BuilderSetWidth(333)
709 ->BuilderSetHeight(777)
710 ->BuilderBuild()
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200711 var result = MyDict
Bram Moolenaar2547aa92020-07-26 17:00:44 +0200712 .member
Bram Moolenaar73fef332020-06-21 22:12:03 +0200713
Bram Moolenaardcc58e02020-12-28 20:53:21 +0100714For commands that have an argument that is a list of commands, the | character
715at the start of the line indicates line continuation: >
716 autocmd BufNewFile *.match if condition
717 | echo 'match'
718 | endif
719
Bram Moolenaar22863042021-10-16 15:23:36 +0100720Note that this means that in heredoc the first line cannot start with a bar: >
Bram Moolenaar74235772021-06-12 14:53:05 +0200721 var lines =<< trim END
722 | this doesn't work
723 END
724Either use an empty line at the start or do not use heredoc. Or temporarily
725add the "C" flag to 'cpoptions': >
726 set cpo+=C
727 var lines =<< trim END
Bram Moolenaar22863042021-10-16 15:23:36 +0100728 | this works
Bram Moolenaar74235772021-06-12 14:53:05 +0200729 END
730 set cpo-=C
731If the heredoc is inside a function 'cpoptions' must be set before :def and
732restored after the :enddef.
733
734In places where line continuation with a backslash is still needed, such as
Bram Moolenaar90df4b92021-07-07 20:26:08 +0200735splitting up a long Ex command, comments can start with '#\ ': >
736 syn region Text
Bram Moolenaar74235772021-06-12 14:53:05 +0200737 \ start='foo'
738 #\ comment
739 \ end='bar'
Bram Moolenaar90df4b92021-07-07 20:26:08 +0200740Like with legacy script '"\ ' is used. This is also needed when line
741continuation is used without a backslash and a line starts with a bar: >
742 au CursorHold * echom 'BEFORE bar'
743 #\ some comment
744 | echom 'AFTER bar'
745<
746 *E1050*
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200747To make it possible for the operator at the start of the line to be
Bram Moolenaar74235772021-06-12 14:53:05 +0200748recognized, it is required to put a colon before a range. This example will
749add "start" and print: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200750 var result = start
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200751 + print
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200752Like this: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200753 var result = start + print
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200754
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200755This will assign "start" and print a line: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +0200756 var result = start
Bram Moolenaardf069ee2020-06-22 23:02:51 +0200757 :+ print
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200758
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000759After the range an Ex command must follow. Without the colon you can call a
760function without `:call`, but after a range you do need it: >
761 MyFunc()
762 :% call MyFunc()
763
Bram Moolenaar23515b42020-11-29 14:36:24 +0100764Note that the colon is not required for the |+cmd| argument: >
765 edit +6 fname
766
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200767It is also possible to split a function header over multiple lines, in between
768arguments: >
769 def MyFunc(
770 text: string,
771 separator = '-'
772 ): string
773
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100774Since a continuation line cannot be easily recognized the parsing of commands
Bram Moolenaar65c44152020-12-24 15:14:01 +0100775has been made stricter. E.g., because of the error in the first line, the
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100776second line is seen as a separate command: >
777 popup_create(some invalid expression, {
778 exit_cb: Func})
779Now "exit_cb: Func})" is actually a valid command: save any changes to the
780file "_cb: Func})" and exit. To avoid this kind of mistake in Vim9 script
781there must be white space between most command names and the argument.
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000782*E1144*
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100783
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100784However, the argument of a command that is a command won't be recognized. For
785example, after "windo echo expr" a line break inside "expr" will not be seen.
786
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100787
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200788Notes:
789- "enddef" cannot be used at the start of a continuation line, it ends the
790 current function.
791- No line break is allowed in the LHS of an assignment. Specifically when
792 unpacking a list |:let-unpack|. This is OK: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200793 [var1, var2] =
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200794 Func()
795< This does not work: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200796 [var1,
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200797 var2] =
798 Func()
799- No line break is allowed in between arguments of an `:echo`, `:execute` and
800 similar commands. This is OK: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200801 echo [1,
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200802 2] [3,
803 4]
804< This does not work: >
Bram Moolenaar1c6737b2020-09-07 22:18:52 +0200805 echo [1, 2]
Bram Moolenaar7ff78462020-07-10 22:00:53 +0200806 [3, 4]
Bram Moolenaar74235772021-06-12 14:53:05 +0200807- In some cases it is difficult for Vim to parse a command, especially when
808 commands are used as an argument to another command, such as `windo`. In
809 those cases the line continuation with a backslash has to be used.
Bram Moolenaar4fdae992020-04-12 16:38:57 +0200810
Bram Moolenaar4c295022021-05-02 17:19:11 +0200811
812White space ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000813 *E1004* *E1068* *E1069* *E1074* *E1127* *E1202*
Bram Moolenaar4c295022021-05-02 17:19:11 +0200814Vim9 script enforces proper use of white space. This is no longer allowed: >
815 var name=234 # Error!
816 var name= 234 # Error!
817 var name =234 # Error!
818There must be white space before and after the "=": >
819 var name = 234 # OK
820White space must also be put before the # that starts a comment after a
821command: >
822 var name = 234# Error!
823 var name = 234 # OK
824
825White space is required around most operators.
826
827White space is required in a sublist (list slice) around the ":", except at
828the start and end: >
829 otherlist = mylist[v : count] # v:count has a different meaning
830 otherlist = mylist[:] # make a copy of the List
831 otherlist = mylist[v :]
832 otherlist = mylist[: v]
833
834White space is not allowed:
835- Between a function name and the "(": >
836 Func (arg) # Error!
837 Func
838 \ (arg) # Error!
839 Func
840 (arg) # Error!
841 Func(arg) # OK
842 Func(
843 arg) # OK
844 Func(
845 arg # OK
846 )
Bram Moolenaara2baa732022-02-04 16:09:54 +0000847< *E1205*
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200848White space is not allowed in a `:set` command between the option name and a
849following "&", "!", "<", "=", "+=", "-=" or "^=".
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +0200850
Bram Moolenaar4c295022021-05-02 17:19:11 +0200851
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100852No curly braces expansion ~
853
854|curly-braces-names| cannot be used.
855
856
Bram Moolenaara2baa732022-02-04 16:09:54 +0000857Command modifiers are not ignored ~
858 *E1176*
859Using a command modifier for a command that does not use it gives an error.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +0100860 *E1082*
861Also, using a command modifier without a following command is now an error.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000862
863
Bram Moolenaar2bede172020-11-19 18:53:18 +0100864Dictionary literals ~
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000865 *vim9-literal-dict* *E1014*
Bram Moolenaar2bede172020-11-19 18:53:18 +0100866Traditionally Vim has supported dictionary literals with a {} syntax: >
867 let dict = {'key': value}
868
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100869Later it became clear that using a simple text key is very common, thus
870literal dictionaries were introduced in a backwards compatible way: >
Bram Moolenaar2bede172020-11-19 18:53:18 +0100871 let dict = #{key: value}
872
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100873However, this #{} syntax is unlike any existing language. As it turns out
874that using a literal key is much more common than using an expression, and
Bram Moolenaar2bede172020-11-19 18:53:18 +0100875considering that JavaScript uses this syntax, using the {} form for dictionary
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100876literals is considered a much more useful syntax. In Vim9 script the {} form
Bram Moolenaar2bede172020-11-19 18:53:18 +0100877uses literal keys: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100878 var dict = {key: value}
Bram Moolenaar2bede172020-11-19 18:53:18 +0100879
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100880This works for alphanumeric characters, underscore and dash. If you want to
881use another character, use a single or double quoted string: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100882 var dict = {'key with space': value}
883 var dict = {"key\twith\ttabs": value}
884 var dict = {'': value} # empty key
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000885< *E1139*
Bram Moolenaarc5e6a712020-12-04 19:12:14 +0100886In case the key needs to be an expression, square brackets can be used, just
887like in JavaScript: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100888 var dict = {["key" .. nr]: value}
Bram Moolenaar2bede172020-11-19 18:53:18 +0100889
Bram Moolenaar2e5910b2021-02-03 17:41:24 +0100890The key type can be string, number, bool or float. Other types result in an
Bram Moolenaard899e512022-05-07 21:54:03 +0100891error. Without using [] the value is used as a string, keeping leading zeros.
892An expression given with [] is evaluated and then converted to a string.
893Leading zeros will then be dropped: >
894 var dict = {000123: 'without', [000456]: 'with'}
Bram Moolenaar2e5910b2021-02-03 17:41:24 +0100895 echo dict
Bram Moolenaard899e512022-05-07 21:54:03 +0100896 {'456': 'with', '000123': 'without'}
897A float only works inside [] because the dot is not accepted otherwise: >
898 var dict = {[00.013]: 'float'}
899 echo dict
900 {'0.013': 'float'}
Bram Moolenaar2e5910b2021-02-03 17:41:24 +0100901
Bram Moolenaar2bede172020-11-19 18:53:18 +0100902
Bram Moolenaar10b94212021-02-19 21:42:57 +0100903No :xit, :t, :k, :append, :change or :insert ~
Bram Moolenaarf10911e2022-01-29 22:20:48 +0000904 *E1100*
Bram Moolenaarf5a48012020-08-01 17:00:03 +0200905These commands are too easily confused with local variable names.
906Instead of `:x` or `:xit` you can use `:exit`.
907Instead of `:t` you can use `:copy`.
Bram Moolenaar10b94212021-02-19 21:42:57 +0100908Instead of `:k` you can use `:mark`.
Bram Moolenaar560979e2020-02-04 22:53:05 +0100909
910
911Comparators ~
912
913The 'ignorecase' option is not used for comparators that use strings.
Bram Moolenaar944697a2022-02-20 19:48:20 +0000914Thus "=~" works like "=~#".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100915
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100916"is" and "isnot" (|expr-is| and |expr-isnot|) when used on strings now return
917false. In legacy script they just compare the strings, in |Vim9| script they
918check identity, and strings are copied when used, thus two strings are never
919the same (this might change some day if strings are not copied but reference
920counted).
921
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100922
Bram Moolenaar4c295022021-05-02 17:19:11 +0200923Abort after error ~
924
925In legacy script, when an error is encountered, Vim continues to execute
926following lines. This can lead to a long sequence of errors and need to type
927CTRL-C to stop it. In Vim9 script execution of commands stops at the first
928error. Example: >
929 vim9script
930 var x = does-not-exist
931 echo 'not executed'
932
933
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100934For loop ~
Bram Moolenaara2baa732022-02-04 16:09:54 +0000935 *E1254*
Bram Moolenaar47003982021-12-05 21:54:04 +0000936The loop variable must not be declared yet: >
Bram Moolenaar6304be62021-11-27 10:57:26 +0000937 var i = 1
938 for i in [1, 2, 3] # Error!
939
Bram Moolenaar47003982021-12-05 21:54:04 +0000940It is possible to use a global variable though: >
941 g:i = 1
942 for g:i in [1, 2, 3]
943 echo g:i
944 endfor
945
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100946Legacy Vim script has some tricks to make a for loop over a list handle
947deleting items at the current or previous item. In Vim9 script it just uses
948the index, if items are deleted then items in the list will be skipped.
949Example legacy script: >
950 let l = [1, 2, 3, 4]
951 for i in l
952 echo i
953 call remove(l, index(l, i))
954 endfor
955Would echo:
956 1
957 2
958 3
959 4
960In compiled Vim9 script you get:
961 1
962 3
963Generally, you should not change the list that is iterated over. Make a copy
964first if needed.
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +0100965 *E1306*
966The depth of loops, :for and :while loops added together, cannot exceed 10.
Bram Moolenaar98a29d02021-01-18 19:55:44 +0100967
968
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100969Conditions and expressions ~
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000970 *vim9-boolean*
Bram Moolenaar13106602020-10-04 16:06:05 +0200971Conditions and expressions are mostly working like they do in other languages.
972Some values are different from legacy Vim script:
973 value legacy Vim script Vim9 script ~
974 0 falsy falsy
975 1 truthy truthy
976 99 truthy Error!
977 "0" falsy Error!
978 "99" truthy Error!
979 "text" falsy Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100980
Bram Moolenaar13106602020-10-04 16:06:05 +0200981For the "??" operator and when using "!" then there is no error, every value
982is either falsy or truthy. This is mostly like JavaScript, except that an
983empty list and dict is falsy:
984
985 type truthy when ~
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100986 bool true, v:true or 1
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100987 number non-zero
988 float non-zero
989 string non-empty
990 blob non-empty
991 list non-empty (different from JavaScript)
992 dictionary non-empty (different from JavaScript)
Bram Moolenaard1caa942020-04-10 22:10:56 +0200993 func when there is a function name
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100994 special true or v:true
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100995 job when not NULL
996 channel when not NULL
997 class when not NULL
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100998 object when not NULL (TODO: when isTrue() returns true)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100999
Bram Moolenaar2bb26582020-10-03 22:52:39 +02001000The boolean operators "||" and "&&" expect the values to be boolean, zero or
1001one: >
1002 1 || false == true
1003 0 || 1 == true
1004 0 || false == false
1005 1 && true == true
1006 0 && 1 == false
1007 8 || 0 Error!
1008 'yes' && 0 Error!
1009 [] || 99 Error!
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001010
Bram Moolenaar2bb26582020-10-03 22:52:39 +02001011When using "!" for inverting, there is no error for using any type and the
Bram Moolenaar13106602020-10-04 16:06:05 +02001012result is a boolean. "!!" can be used to turn any value into boolean: >
Bram Moolenaar82be4842021-01-11 19:40:15 +01001013 !'yes' == false
Bram Moolenaar13106602020-10-04 16:06:05 +02001014 !![] == false
Bram Moolenaar82be4842021-01-11 19:40:15 +01001015 !![1, 2, 3] == true
Bram Moolenaar2bb26582020-10-03 22:52:39 +02001016
1017When using "`.."` for string concatenation arguments of simple types are
Bram Moolenaar13106602020-10-04 16:06:05 +02001018always converted to string: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001019 'hello ' .. 123 == 'hello 123'
Bram Moolenaar7e6a5152021-01-02 16:39:53 +01001020 'hello ' .. v:true == 'hello true'
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001021
Bram Moolenaar5da36052021-12-27 15:39:57 +00001022Simple types are Number, Float, Special and Bool. For other types |string()|
1023should be used.
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001024 *false* *true* *null* *E1034*
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001025In Vim9 script one can use the following predefined values: >
1026 true
1027 false
1028 null
1029 null_blob
1030 null_channel
1031 null_dict
1032 null_function
1033 null_job
1034 null_list
1035 null_partial
1036 null_string
1037`true` is the same as `v:true`, `false` the same as `v:false`, `null` the same
1038as `v:null`.
1039
1040While `null` has the type "special", the other "null_" types have the type
1041indicated by their name. Quite often a null value is handled the same as an
1042empty value, but not always. The values can be useful to clear a script-local
1043variable, since they cannot be deleted with `:unlet`. E.g.: >
1044 var theJob = job_start(...)
1045 # let the job do its work
1046 theJob = null_job
1047
1048The values can also be useful as the default value for an argument: >
1049 def MyFunc(b: blob = null_blob)
1050 if b == null_blob
1051 # b argument was not given
1052
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001053It is possible to compare `null` with any value, this will not give a type
1054error. However, comparing `null` with a number, float or bool will always
1055result in `false`. This is different from legacy script, where comparing
1056`null` with zero or `false` would return `true`.
1057
Bram Moolenaar8acb9cc2022-03-08 13:18:55 +00001058When converting a boolean to a string `false` and `true` are used, not
1059`v:false` and `v:true` like in legacy script. `v:none` has no `none`
1060replacement, it has no equivalent in other languages.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001061
Bram Moolenaar0289a092021-03-14 18:40:19 +01001062Indexing a string with [idx] or taking a slice with [idx : idx] uses character
1063indexes instead of byte indexes. Composing characters are included.
1064Example: >
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001065 echo 'bár'[1]
1066In legacy script this results in the character 0xc3 (an illegal byte), in Vim9
1067script this results in the string 'á'.
Bram Moolenaar82be4842021-01-11 19:40:15 +01001068A negative index is counting from the end, "[-1]" is the last character.
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001069To exclude the last character use |slice()|.
Bram Moolenaar38a3bfa2021-03-29 22:14:55 +02001070To count composing characters separately use |strcharpart()|.
Bram Moolenaar82be4842021-01-11 19:40:15 +01001071If the index is out of range then an empty string results.
1072
1073In legacy script "++var" and "--var" would be silently accepted and have no
1074effect. This is an error in Vim9 script.
1075
1076Numbers starting with zero are not considered to be octal, only numbers
1077starting with "0o" are octal: "0o744". |scriptversion-4|
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001078
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001079
Bram Moolenaare46a4402020-06-30 20:38:27 +02001080What to watch out for ~
1081 *vim9-gotchas*
1082Vim9 was designed to be closer to often used programming languages, but at the
1083same time tries to support the legacy Vim commands. Some compromises had to
1084be made. Here is a summary of what might be unexpected.
1085
1086Ex command ranges need to be prefixed with a colon. >
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001087 -> legacy Vim: shifts the previous line to the right
1088 ->func() Vim9: method call in a continuation line
1089 :-> Vim9: shifts the previous line to the right
Bram Moolenaare46a4402020-06-30 20:38:27 +02001090
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001091 %s/a/b legacy Vim: substitute on all lines
Bram Moolenaare46a4402020-06-30 20:38:27 +02001092 x = alongname
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001093 % another Vim9: modulo operator in a continuation line
1094 :%s/a/b Vim9: substitute on all lines
1095 't legacy Vim: jump to mark t
1096 'text'->func() Vim9: method call
1097 :'t Vim9: jump to mark t
Bram Moolenaare46a4402020-06-30 20:38:27 +02001098
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02001099Some Ex commands can be confused with assignments in Vim9 script: >
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001100 g:name = value # assignment
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001101 :g:pattern:cmd # :global command
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02001102
Bram Moolenaar7b829262021-10-13 15:04:34 +01001103To avoid confusion between a `:global` or `:substitute` command and an
1104expression or assignment, a few separators cannot be used when these commands
1105are abbreviated to a single character: ':', '-' and '.'. >
1106 g:pattern:cmd # invalid command - ERROR
1107 s:pattern:repl # invalid command - ERROR
1108 g-pattern-cmd # invalid command - ERROR
1109 s-pattern-repl # invalid command - ERROR
1110 g.pattern.cmd # invalid command - ERROR
1111 s.pattern.repl # invalid command - ERROR
1112
1113Also, there cannot be a space between the command and the separator: >
1114 g /pattern/cmd # invalid command - ERROR
1115 s /pattern/repl # invalid command - ERROR
1116
Bram Moolenaare46a4402020-06-30 20:38:27 +02001117Functions defined with `:def` compile the whole function. Legacy functions
1118can bail out, and the following lines are not parsed: >
1119 func Maybe()
1120 if !has('feature')
1121 return
1122 endif
1123 use-feature
1124 endfunc
1125Vim9 functions are compiled as a whole: >
1126 def Maybe()
1127 if !has('feature')
1128 return
1129 endif
Bram Moolenaar82be4842021-01-11 19:40:15 +01001130 use-feature # May give a compilation error
Bram Moolenaare46a4402020-06-30 20:38:27 +02001131 enddef
1132For a workaround, split it in two functions: >
1133 func Maybe()
1134 if has('feature')
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001135 call MaybeInner()
Bram Moolenaare46a4402020-06-30 20:38:27 +02001136 endif
1137 endfunc
1138 if has('feature')
1139 def MaybeInner()
1140 use-feature
1141 enddef
1142 endif
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02001143Or put the unsupported code inside an `if` with a constant expression that
Bram Moolenaar207f0092020-08-30 17:20:20 +02001144evaluates to false: >
1145 def Maybe()
1146 if has('feature')
1147 use-feature
1148 endif
1149 enddef
Bram Moolenaar6aa57292021-08-14 21:25:52 +02001150The `exists_compiled()` function can also be used for this.
1151 *vim9-user-command*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01001152Another side effect of compiling a function is that the presence of a user
Bram Moolenaar82be4842021-01-11 19:40:15 +01001153command is checked at compile time. If the user command is defined later an
1154error will result. This works: >
1155 command -nargs=1 MyCommand echom <q-args>
1156 def Works()
1157 MyCommand 123
1158 enddef
1159This will give an error for "MyCommand" not being defined: >
1160 def Works()
1161 command -nargs=1 MyCommand echom <q-args>
1162 MyCommand 123
1163 enddef
1164A workaround is to invoke the command indirectly with `:execute`: >
1165 def Works()
1166 command -nargs=1 MyCommand echom <q-args>
1167 execute 'MyCommand 123'
1168 enddef
1169
Bram Moolenaar207f0092020-08-30 17:20:20 +02001170Note that for unrecognized commands there is no check for "|" and a following
1171command. This will give an error for missing `endif`: >
1172 def Maybe()
1173 if has('feature') | use-feature | endif
1174 enddef
Bram Moolenaare46a4402020-06-30 20:38:27 +02001175
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001176Other differences ~
1177
1178Patterns are used like 'magic' is set, unless explicitly overruled.
1179The 'edcompatible' option value is not used.
1180The 'gdefault' option value is not used.
1181
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001182You may also find this wiki useful. It was written by an early adopter of
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +01001183Vim9 script: https://github.com/lacygoill/wiki/blob/master/vim/vim9.md
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001184
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02001185 *:++* *:--*
1186The ++ and -- commands have been added. They are very similar to adding or
1187subtracting one: >
1188 ++var
1189 var += 1
1190 --var
1191 var -= 1
1192
1193Using ++var or --var in an expression is not supported yet.
1194
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001195==============================================================================
1196
11973. New style functions *fast-functions*
1198
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001199 *:def* *E1028*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001200:def[!] {name}([arguments])[: {return-type}]
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001201 Define a new function by the name {name}. The body of
1202 the function follows in the next lines, until the
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001203 matching `:enddef`. *E1073*
1204 *E1011*
1205 The {name} must be less than 100 bytes long.
1206 *E1003* *E1027* *E1056* *E1059*
1207 The type of value used with `:return` must match
1208 {return-type}. When {return-type} is omitted or is
1209 "void" the function is not expected to return
1210 anything.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001211 *E1077* *E1123*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001212 {arguments} is a sequence of zero or more argument
1213 declarations. There are three forms:
1214 {name}: {type}
1215 {name} = {value}
1216 {name}: {type} = {value}
1217 The first form is a mandatory argument, the caller
1218 must always provide them.
1219 The second and third form are optional arguments.
1220 When the caller omits an argument the {value} is used.
1221
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001222 The function will be compiled into instructions when
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001223 called, or when `:disassemble` or `:defcompile` is
1224 used. Syntax and type errors will be produced at that
1225 time.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001226
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001227 It is possible to nest `:def` inside another `:def` or
1228 `:function` up to about 50 levels deep.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001229 *E1117*
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001230 [!] is used as with `:function`. Note that
1231 script-local functions cannot be deleted or redefined
1232 later in Vim9 script. They can only be removed by
1233 reloading the same script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001234
Bram Moolenaara2baa732022-02-04 16:09:54 +00001235 *:enddef* *E1057* *E1152* *E1173*
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001236:enddef End of a function defined with `:def`. It should be on
1237 a line by its own.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001238
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001239You may also find this wiki useful. It was written by an early adopter of
Bram Moolenaar0289a092021-03-14 18:40:19 +01001240Vim9 script: https://github.com/lacygoill/wiki/blob/master/vim/vim9.md
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001241
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01001242If the script the function is defined in is Vim9 script, then script-local
1243variables can be accessed without the "s:" prefix. They must be defined
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001244before the function is compiled. If the script the function is defined in is
1245legacy script, then script-local variables must be accessed with the "s:"
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001246prefix if they do not exist at the time of compiling.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01001247 *E1269*
1248Script-local variables in a |Vim9| script must be declared at the script
1249level. They cannot be created in a function, also not in a legacy function.
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01001250
Bram Moolenaar388a5d42020-05-26 21:20:45 +02001251 *:defc* *:defcompile*
1252:defc[ompile] Compile functions defined in the current script that
1253 were not compiled yet.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01001254 This will report any errors found during compilation.
1255
1256:defc[ompile] {func}
1257:defc[ompile] debug {func}
1258:defc[ompile] profile {func}
1259 Compile function {func}, if needed. Use "debug" and
1260 "profile" to specify the compilation mode.
1261 This will report any errors found during compilation.
Bram Moolenaar5b1c8fe2020-02-21 18:42:43 +01001262
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001263 *:disa* *:disassemble*
1264:disa[ssemble] {func} Show the instructions generated for {func}.
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001265 This is for debugging and testing. *E1061*
Bram Moolenaarcc390ff2020-02-29 22:06:30 +01001266 Note that for command line completion of {func} you
1267 can prepend "s:" to find script-local functions.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001268
Bram Moolenaar2346a632021-06-13 19:02:49 +02001269:disa[ssemble] profile {func}
1270 Like `:disassemble` but with the instructions used for
Bram Moolenaare0e39172021-01-25 21:14:57 +01001271 profiling.
1272
Bram Moolenaar2346a632021-06-13 19:02:49 +02001273:disa[ssemble] debug {func}
1274 Like `:disassemble` but with the instructions used for
1275 debugging.
1276
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001277Limitations ~
1278
1279Local variables will not be visible to string evaluation. For example: >
Bram Moolenaar2b327002020-12-26 15:39:31 +01001280 def MapList(): list<string>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001281 var list = ['aa', 'bb', 'cc', 'dd']
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001282 return range(1, 2)->map('list[v:val]')
1283 enddef
1284
1285The map argument is a string expression, which is evaluated without the
1286function scope. Instead, use a lambda: >
Bram Moolenaar2b327002020-12-26 15:39:31 +01001287 def MapList(): list<string>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001288 var list = ['aa', 'bb', 'cc', 'dd']
Bram Moolenaar22863042021-10-16 15:23:36 +01001289 return range(1, 2)->map((_, v) => list[v])
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001290 enddef
1291
Bram Moolenaar3d2e0312021-12-01 09:27:20 +00001292For commands that are not compiled, such as `:edit`, backtick expansion can be
1293used and it can use the local scope. Example: >
Bram Moolenaar2b327002020-12-26 15:39:31 +01001294 def Replace()
Bram Moolenaar3d2e0312021-12-01 09:27:20 +00001295 var fname = 'blah.txt'
1296 edit `=fname`
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001297 enddef
1298
Bram Moolenaardad44732021-03-31 20:07:33 +02001299Closures defined in a loop will share the same context. For example: >
1300 var flist: list<func>
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001301 for i in range(5)
Bram Moolenaardad44732021-03-31 20:07:33 +02001302 var inloop = i
1303 flist[i] = () => inloop
1304 endfor
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001305 echo range(5)->map((i, _) => flist[i]())
1306 # Result: [4, 4, 4, 4, 4]
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001307< *E1271*
1308A closure must be compiled in the context that it is defined in, so that
1309variables in that context can be found. This mostly happens correctly, except
1310when a function is marked for debugging with `breakadd` after it was compiled.
Bram Moolenaar46eea442022-03-30 10:51:39 +01001311Make sure to define the breakpoint before compiling the outer function.
Bram Moolenaardad44732021-03-31 20:07:33 +02001312
1313The "inloop" variable will exist only once, all closures put in the list refer
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001314to the same instance, which in the end will have the value 4. This is
1315efficient, also when looping many times. If you do want a separate context
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001316for each closure, call a function to define it: >
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001317 def GetClosure(i: number): func
1318 var infunc = i
1319 return () => infunc
Bram Moolenaardad44732021-03-31 20:07:33 +02001320 enddef
1321
1322 var flist: list<func>
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001323 for i in range(5)
1324 flist[i] = GetClosure(i)
Bram Moolenaardad44732021-03-31 20:07:33 +02001325 endfor
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001326 echo range(5)->map((i, _) => flist[i]())
1327 # Result: [0, 1, 2, 3, 4]
Bram Moolenaardad44732021-03-31 20:07:33 +02001328
Bram Moolenaara2baa732022-02-04 16:09:54 +00001329In some situations, especially when calling a Vim9 closure from legacy
1330context, the evaluation will fail. *E1248*
1331
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001332Note that at the script level the loop variable will be invalid after the
1333loop, also when used in a closure that is called later, e.g. with a timer.
1334This will generate error |E1302|: >
1335 for n in range(4)
1336 timer_start(500 * n, (_) => {
1337 echowin n
1338 })
1339 endfor
1340
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001341You need to use a block and define a variable there, and use that one in the
1342closure: >
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001343 for n in range(4)
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001344 {
1345 var nr = n
1346 timer_start(500 * n, (_) => {
1347 echowin nr
1348 })
1349 }
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001350 endfor
1351
1352Using `echowindow` is useful in a timer, the messages go into a popup and will
1353not interfere with what the user is doing when it triggers.
1354
Bram Moolenaara2baa732022-02-04 16:09:54 +00001355
1356Converting a function from legacy to Vim9 ~
1357 *convert_legacy_function_to_vim9*
1358These are the most changes that need to be made to convert a legacy function
1359to a Vim9 function:
1360
1361- Change `func` or `function` to `def`.
1362- Change `endfunc` or `endfunction` to `enddef`.
1363- Add types to the function arguments.
1364- If the function returns something, add the return type.
1365- Change comments to start with # instead of ".
1366
1367 For example, a legacy function: >
1368 func MyFunc(text)
1369 " function body
1370 endfunc
1371< Becomes: >
1372 def MyFunc(text: string): number
1373 # function body
1374 enddef
1375
1376- Remove "a:" used for arguments. E.g.: >
1377 return len(a:text)
1378< Becomes: >
1379 return len(text)
1380
1381- Change `let` used to declare a variable to `var`.
1382- Remove `let` used to assign a value to a variable. This is for local
1383 variables already declared and b: w: g: and t: variables.
1384
1385 For example, legacy function: >
1386 let lnum = 1
1387 let lnum += 3
1388 let b:result = 42
1389< Becomes: >
1390 var lnum = 1
1391 lnum += 3
1392 b:result = 42
1393
1394- Insert white space in expressions where needed.
1395- Change "." used for concatenation to "..".
1396
1397 For example, legacy function: >
1398 echo line(1).line(2)
1399< Becomes: >
1400 echo line(1) .. line(2)
1401
1402- line continuation does not always require a backslash: >
1403 echo ['one',
1404 \ 'two',
1405 \ 'three'
1406 \ ]
1407< Becomes: >
1408 echo ['one',
1409 'two',
1410 'three'
1411 ]
1412
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01001413
1414Calling a function in an expr option ~
1415 *expr-option-function*
1416A few options, such as 'foldexpr', are an expresison that is evaluated to get
1417a value. The evaluation can have quite a bit of overhead. One way to
1418minimize the overhead, and also to keep the option value very simple, is to
1419defined a compiled function and set the option to call it without arguments.
1420Example: >
1421 vim9script
1422 def MyFoldFunc(): any
1423 ... compute fold level for line v:lnum
1424 return level
1425 enddef
1426 set foldexpr=s:MyFoldFunc()
1427
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001428==============================================================================
1429
14304. Types *vim9-types*
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001431 *E1008* *E1009* *E1010* *E1012*
1432 *E1013* *E1029* *E1030*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001433The following builtin types are supported:
1434 bool
1435 number
1436 float
1437 string
1438 blob
Bram Moolenaard77a8522020-04-03 21:59:57 +02001439 list<{type}>
1440 dict<{type}>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001441 job
1442 channel
Bram Moolenaarb17893a2020-03-14 08:19:51 +01001443 func
Bram Moolenaard1caa942020-04-10 22:10:56 +02001444 func: {type}
Bram Moolenaard77a8522020-04-03 21:59:57 +02001445 func({type}, ...)
1446 func({type}, ...): {type}
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001447 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001448
1449Not supported yet:
Bram Moolenaard77a8522020-04-03 21:59:57 +02001450 tuple<a: {type}, b: {type}, ...>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001451
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001452These types can be used in declarations, but no simple value will actually
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001453have the "void" type. Trying to use a void (e.g. a function without a
Bram Moolenaara2baa732022-02-04 16:09:54 +00001454return value) results in error *E1031* *E1186* .
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001455
Bram Moolenaard77a8522020-04-03 21:59:57 +02001456There is no array type, use list<{type}> instead. For a list constant an
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001457efficient implementation is used that avoids allocating lot of small pieces of
1458memory.
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001459 *E1005* *E1007*
Bram Moolenaard77a8522020-04-03 21:59:57 +02001460A partial and function can be declared in more or less specific ways:
1461func any kind of function reference, no type
Bram Moolenaard1caa942020-04-10 22:10:56 +02001462 checking for arguments or return value
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001463func: void any number and type of arguments, no return
1464 value
Bram Moolenaard77a8522020-04-03 21:59:57 +02001465func: {type} any number and type of arguments with specific
1466 return type
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001467
1468func() function with no argument, does not return a
1469 value
1470func(): void same
1471func(): {type} function with no argument and return type
1472
Bram Moolenaard1caa942020-04-10 22:10:56 +02001473func({type}) function with argument type, does not return
Bram Moolenaard77a8522020-04-03 21:59:57 +02001474 a value
Bram Moolenaard1caa942020-04-10 22:10:56 +02001475func({type}): {type} function with argument type and return type
1476func(?{type}) function with type of optional argument, does
1477 not return a value
1478func(...{type}) function with type of variable number of
1479 arguments, does not return a value
1480func({type}, ?{type}, ...{type}): {type}
1481 function with:
1482 - type of mandatory argument
1483 - type of optional argument
1484 - type of variable number of arguments
1485 - return type
Bram Moolenaard77a8522020-04-03 21:59:57 +02001486
1487If the return type is "void" the function does not return a value.
1488
1489The reference can also be a |Partial|, in which case it stores extra arguments
1490and/or a dictionary, which are not visible to the caller. Since they are
1491called in the same way the declaration is the same.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001492
1493Custom types can be defined with `:type`: >
1494 :type MyList list<string>
Bram Moolenaar127542b2020-08-09 17:22:04 +02001495Custom types must start with a capital letter, to avoid name clashes with
1496builtin types added later, similarly to user functions.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001497{not implemented yet}
1498
1499And classes and interfaces can be used as types: >
1500 :class MyClass
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001501 :var mine: MyClass
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001502
1503 :interface MyInterface
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001504 :var mine: MyInterface
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001505
1506 :class MyTemplate<Targ>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001507 :var mine: MyTemplate<number>
1508 :var mine: MyTemplate<string>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001509
1510 :class MyInterface<Targ>
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001511 :var mine: MyInterface<number>
1512 :var mine: MyInterface<string>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001513{not implemented yet}
1514
1515
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001516Variable types and type casting ~
1517 *variable-types*
Bram Moolenaar64d662d2020-08-09 19:02:50 +02001518Variables declared in Vim9 script or in a `:def` function have a type, either
1519specified explicitly or inferred from the initialization.
1520
1521Global, buffer, window and tab page variables do not have a specific type, the
1522value can be changed at any time, possibly changing the type. Therefore, in
1523compiled code the "any" type is assumed.
1524
1525This can be a problem when the "any" type is undesired and the actual type is
1526expected to always be the same. For example, when declaring a list: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001527 var l: list<number> = [1, g:two]
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001528At compile time Vim doesn't know the type of "g:two" and the expression type
1529becomes list<any>. An instruction is generated to check the list type before
1530doing the assignment, which is a bit inefficient.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001531 *type-casting* *E1104*
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001532To avoid this, use a type cast: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001533 var l: list<number> = [1, <number>g:two]
Bram Moolenaar4072ba52020-12-23 13:56:35 +01001534The compiled code will then only check that "g:two" is a number and give an
1535error if it isn't. This is called type casting.
Bram Moolenaar64d662d2020-08-09 19:02:50 +02001536
1537The syntax of a type cast is: "<" {type} ">". There cannot be white space
1538after the "<" or before the ">" (to avoid them being confused with
1539smaller-than and bigger-than operators).
1540
1541The semantics is that, if needed, a runtime type check is performed. The
1542value is not actually changed. If you need to change the type, e.g. to change
1543it to a string, use the |string()| function. Or use |str2nr()| to convert a
1544string to a number.
1545
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01001546If a type is given where it is not expected you can get *E1272* .
1547
Bram Moolenaar64d662d2020-08-09 19:02:50 +02001548
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001549Type inference ~
1550 *type-inference*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001551In general: Whenever the type is clear it can be omitted. For example, when
1552declaring a variable and giving it a value: >
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001553 var name = 0 # infers number type
1554 var name = 'hello' # infers string type
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001555
Bram Moolenaar127542b2020-08-09 17:22:04 +02001556The type of a list and dictionary comes from the common type of the values.
1557If the values all have the same type, that type is used for the list or
1558dictionary. If there is a mix of types, the "any" type is used. >
1559 [1, 2, 3] list<number>
1560 ['a', 'b', 'c'] list<string>
1561 [1, 'x', 3] list<any>
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001562
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001563The common type of function references, if they do not all have the same
1564number of arguments, uses "(...)" to indicate the number of arguments is not
1565specified. For example: >
1566 def Foo(x: bool)
1567 enddef
1568 def Bar(x: bool, y: bool)
1569 enddef
1570 var funclist = [Foo, Bar]
1571 echo funclist->typename()
1572Results in:
1573 list<func(...)>
1574
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001575For script-local variables in Vim9 script the type is checked, also when the
1576variable was declared in a legacy function.
1577
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001578When a type has been declared this is attached to a List or Dictionary. When
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001579later some expression attempts to change the type an error will be given: >
1580 var ll: list<number> = [1, 2, 3]
Bram Moolenaarc4573eb2022-01-31 15:40:56 +00001581 ll->extend(['x']) # Error, 'x' is not a number
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001582
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001583If the type is not declared then it is allowed to change: >
Bram Moolenaarc4573eb2022-01-31 15:40:56 +00001584 [1, 2, 3]->extend(['x']) # result: [1, 2, 3, 'x']
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001585
Bram Moolenaar9da17d72022-02-09 21:50:44 +00001586For a variable declaration an inferred type matters: >
1587 var ll = [1, 2, 3]
1588 ll->extend(['x']) # Error, 'x' is not a number
1589That is because the declaration looks like a list of numbers, thus is
1590equivalent to: >
1591 var ll: list<number> = [1, 2, 3]
1592If you do want a more permissive list you need to declare the type: >
1593 var ll: list<any = [1, 2, 3]
1594 ll->extend(['x']) # OK
1595
Bram Moolenaar207f0092020-08-30 17:20:20 +02001596
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001597Stricter type checking ~
1598 *type-checking*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001599In legacy Vim script, where a number was expected, a string would be
1600automatically converted to a number. This was convenient for an actual number
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02001601such as "123", but leads to unexpected problems (and no error message) if the
Bram Moolenaar207f0092020-08-30 17:20:20 +02001602string doesn't start with a number. Quite often this leads to hard-to-find
Bram Moolenaar944697a2022-02-20 19:48:20 +00001603bugs. e.g.: >
1604 echo 123 == '123'
1605< 1 ~
1606With an accidental space: >
1607 echo 123 == ' 123'
1608< 0 ~
Bram Moolenaara2baa732022-02-04 16:09:54 +00001609 *E1206* *E1210* *E1212*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001610In Vim9 script this has been made stricter. In most places it works just as
Bram Moolenaar944697a2022-02-20 19:48:20 +00001611before if the value used matches the expected type. There will sometimes be
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02001612an error, thus breaking backwards compatibility. For example:
Bram Moolenaar207f0092020-08-30 17:20:20 +02001613- Using a number other than 0 or 1 where a boolean is expected. *E1023*
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001614- Using a string value when setting a number option.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001615- Using a number where a string is expected. *E1024* *E1105*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001616
Bram Moolenaar22863042021-10-16 15:23:36 +01001617One consequence is that the item type of a list or dict given to |map()| must
Bram Moolenaar944697a2022-02-20 19:48:20 +00001618not change, if the type was declared. This will give an error in Vim9
1619script: >
1620 var mylist: list<number> = [1, 2, 3]
1621 echo map(mylist, (i, v) => 'item ' .. i)
1622< E1012: Type mismatch; expected number but got string in map() ~
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001623
Bram Moolenaar944697a2022-02-20 19:48:20 +00001624Instead use |mapnew()|, it creates a new list: >
1625 var mylist: list<number> = [1, 2, 3]
1626 echo mapnew(mylist, (i, v) => 'item ' .. i)
1627< ['item 0', 'item 1', 'item 2'] ~
1628
1629If the item type was not declared or determined to be "any" it can change to a
1630more specific type. E.g. when a list of mixed types gets changed to a list of
1631strings: >
Bram Moolenaar90df4b92021-07-07 20:26:08 +02001632 var mylist = [1, 2.0, '3']
1633 # typename(mylist) == "list<any>"
1634 map(mylist, (i, v) => 'item ' .. i)
1635 # typename(mylist) == "list<string>", no error
Bram Moolenaar944697a2022-02-20 19:48:20 +00001636
1637There is a subtle difference between using a list constant directly and
Bram Moolenaarafa048f2022-02-22 20:43:36 +00001638through a variable declaration. Because of type inference, when using a list
Bram Moolenaar944697a2022-02-20 19:48:20 +00001639constant to initialize a variable, this also sets the declared type: >
1640 var mylist = [1, 2, 3]
1641 # typename(mylist) == "list<number>"
1642 echo map(mylist, (i, v) => 'item ' .. i) # Error!
1643
1644When using the list constant directly, the type is not declared and is allowed
1645to change: >
1646 echo map([1, 2, 3], (i, v) => 'item ' .. i) # OK
1647
1648The reasoning behind this is that when a type is declared and the list is
1649passed around and changed, the declaration must always hold. So that you can
1650rely on the type to match the declared type. For a constant this is not
1651needed.
1652
1653 *E1158*
Bram Moolenaar9faec4e2021-02-27 16:38:07 +01001654Same for |extend()|, use |extendnew()| instead, and for |flatten()|, use
Bram Moolenaar944697a2022-02-20 19:48:20 +00001655|flattennew()| instead. Since |flatten()| is intended to always change the
1656type, it can not be used in Vim9 script.
1657
Bram Moolenaara2baa732022-02-04 16:09:54 +00001658 *E1211* *E1217* *E1218* *E1219* *E1220* *E1221*
1659 *E1222* *E1223* *E1224* *E1225* *E1226* *E1227*
1660 *E1228* *E1238* *E1250* *E1251* *E1252* *E1253*
Bram Moolenaar71b6d332022-09-10 13:13:14 +01001661 *E1256* *E1297* *E1298* *E1301*
Bram Moolenaara2baa732022-02-04 16:09:54 +00001662Types are checked for most builtin functions to make it easier to spot
1663mistakes.
Bram Moolenaar82be4842021-01-11 19:40:15 +01001664
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001665==============================================================================
1666
Bram Moolenaar30fd8202020-09-26 15:09:30 +020016675. Namespace, Import and Export
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001668 *vim9script* *vim9-export* *vim9-import*
1669
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001670A Vim9 script can be written to be imported. This means that some items are
1671intentionally exported, made available to other scripts. When the exporting
1672script is imported in another script, these exported items can then be used in
1673that script. All the other items remain script-local in the exporting script
1674and cannot be accessed by the importing script.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001675
1676This mechanism exists for writing a script that can be sourced (imported) by
1677other scripts, while making sure these other scripts only have access to what
1678you want them to. This also avoids using the global namespace, which has a
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01001679risk of name collisions. For example when you have two plugins with similar
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001680functionality.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001681
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001682You can cheat by using the global namespace explicitly. That should be done
1683only for things that really are global.
Bram Moolenaar207f0092020-08-30 17:20:20 +02001684
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001685
1686Namespace ~
Bram Moolenaardcc58e02020-12-28 20:53:21 +01001687 *vim9-namespace*
Bram Moolenaar560979e2020-02-04 22:53:05 +01001688To recognize a file that can be imported the `vim9script` statement must
Bram Moolenaard3f8a9e2021-02-17 21:57:03 +01001689appear as the first statement in the file (see |vim9-mix| for an exception).
1690It tells Vim to interpret the script in its own namespace, instead of the
1691global namespace. If a file starts with: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001692 vim9script
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001693 var myvar = 'yes'
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001694Then "myvar" will only exist in this file. While without `vim9script` it would
1695be available as `g:myvar` from any other script and function.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001696 *E1101*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001697The variables at the file level are very much like the script-local "s:"
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +02001698variables in legacy Vim script, but the "s:" is omitted. And they cannot be
1699deleted.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001700
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +02001701In Vim9 script the global "g:" namespace can still be used as before. And the
1702"w:", "b:" and "t:" namespaces. These have in common that variables are not
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001703declared, have no specific type and they can be deleted. *E1304*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001704
1705A side effect of `:vim9script` is that the 'cpoptions' option is set to the
1706Vim default value, like with: >
1707 :set cpo&vim
1708One of the effects is that |line-continuation| is always enabled.
Bram Moolenaar3e191692021-03-17 17:46:00 +01001709The original value of 'cpoptions' is restored at the end of the script, while
1710flags added or removed in the script are also added to or removed from the
1711original value to get the same effect. The order of flags may change.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00001712In the |vimrc| file sourced on startup this does not happen.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001713
Bram Moolenaard3f8a9e2021-02-17 21:57:03 +01001714 *vim9-mix*
1715There is one way to use both legacy and Vim9 syntax in one script file: >
1716 " comments may go here
1717 if !has('vim9script')
1718 " legacy script commands go here
1719 finish
1720 endif
1721 vim9script
1722 # Vim9 script commands go here
1723This allows for writing a script that takes advantage of the Vim9 script
Bram Moolenaar9faec4e2021-02-27 16:38:07 +01001724syntax if possible, but will also work on a Vim version without it.
Bram Moolenaard3f8a9e2021-02-17 21:57:03 +01001725
1726This can only work in two ways:
17271. The "if" statement evaluates to false, the commands up to `endif` are
1728 skipped and `vim9script` is then the first command actually executed.
17292. The "if" statement evaluates to true, the commands up to `endif` are
1730 executed and `finish` bails out before reaching `vim9script`.
1731
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001732
1733Export ~
1734 *:export* *:exp*
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001735Exporting an item can be written as: >
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001736 export const EXPORTED_CONST = 1234
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001737 export var someValue = ...
1738 export final someValue = ...
1739 export const someValue = ...
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001740 export def MyFunc() ...
1741 export class MyClass ...
Bram Moolenaar74235772021-06-12 14:53:05 +02001742 export interface MyClass ...
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001743< *E1043* *E1044*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001744As this suggests, only constants, variables, `:def` functions and classes can
Bram Moolenaar74235772021-06-12 14:53:05 +02001745be exported. {not implemented yet: class, interface}
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001746
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001747 *E1042*
1748`:export` can only be used in Vim9 script, at the script level.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001749
1750
1751Import ~
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01001752 *:import* *:imp* *E1094* *E1047* *E1262*
1753 *E1048* *E1049* *E1053* *E1071* *E1088* *E1236*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001754The exported items can be imported in another script. The import syntax has
1755two forms. The simple form: >
1756 import {filename}
1757<
1758Where {filename} is an expression that must evaluate to a string. In this
1759form the filename should end in ".vim" and the portion before ".vim" will
1760become the script local name of the namespace. For example: >
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001761 import "myscript.vim"
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001762<
1763This makes each exported item in "myscript.vim" available as "myscript.item".
Bram Moolenaara2baa732022-02-04 16:09:54 +00001764 *:import-as* *E1257* *E1261*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001765In case the name is long or ambiguous, this form can be used to specify
1766another name: >
1767 import {longfilename} as {name}
1768<
1769In this form {name} becomes a specific script local name for the imported
1770namespace. Therefore {name} must consist of letters, digits and '_', like
1771|internal-variables|. The {longfilename} expression must evaluate to any
1772filename. For example: >
1773 import "thatscript.vim.v2" as that
Bram Moolenaara2baa732022-02-04 16:09:54 +00001774< *E1060* *E1258* *E1259* *E1260*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001775Then you can use "that.item", etc. You are free to choose the name "that".
1776Use something that will be recognized as referring to the imported script.
1777Avoid command names, command modifiers and builtin function names, because the
1778name will shadow them. Better not start the name starts with a capital
1779letter, since it can then also shadow global user commands and functions.
1780Also, you cannot use the name for something else in the script, such as a
1781function or variable name.
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001782
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001783In case the dot in the name is undesired, a local reference can be made for a
1784function: >
1785 var LongFunc = that.LongFuncName
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001786
1787This also works for constants: >
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001788 const MAXLEN = that.MAX_LEN_OF_NAME
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001789
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001790This does not work for variables, since the value would be copied once and
1791when changing the variable the copy will change, not the original variable.
1792You will need to use the full name, with the dot.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001793
Bram Moolenaar4db572e2021-07-18 18:21:38 +02001794`:import` can not be used in a function. Imported items are intended to exist
1795at the script level and only imported once.
1796
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001797The script name after `import` can be:
1798- A relative path, starting "." or "..". This finds a file relative to the
1799 location of the script file itself. This is useful to split up a large
1800 plugin into several files.
1801- An absolute path, starting with "/" on Unix or "D:/" on MS-Windows. This
Bram Moolenaarcb80aa22020-10-26 21:12:46 +01001802 will rarely be used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001803- A path not being relative or absolute. This will be found in the
1804 "import" subdirectories of 'runtimepath' entries. The name will usually be
1805 longer and unique, to avoid loading the wrong file.
Bram Moolenaar6aa57292021-08-14 21:25:52 +02001806 Note that "after/import" is not used.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001807
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001808If the name does not end in ".vim" then the use of "as name" is required.
1809
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001810Once a vim9 script file has been imported, the result is cached and used the
1811next time the same script is imported. It will not be read again.
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001812
1813It is not allowed to import the same script twice, also when using two
1814different "as" names.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001815
1816When using the imported name the dot and the item name must be in the same
1817line, there can be no line break: >
1818 echo that.
1819 name # Error!
1820 echo that
1821 .name # Error!
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01001822< *import-map*
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001823When you've imported a function from one script into a vim9 script you can
1824refer to the imported function in a mapping by prefixing it with |<SID>|: >
Bram Moolenaar89445512022-04-14 12:58:23 +01001825 noremap <silent> ,a :call <SID>name.Function()<CR>
1826
1827When the mapping is defined "<SID>name." will be replaced with <SNR> and the
1828script ID of the imported script.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01001829An even simpler solution is using |<ScriptCmd>|: >
1830 noremap ,a <ScriptCmd>name.Function()<CR>
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001831
1832Note that this does not work for variables, only for functions.
1833
1834 *import-legacy* *legacy-import*
1835`:import` can also be used in legacy Vim script. The imported namespace still
1836becomes script-local, even when the "s:" prefix is not given. For example: >
1837 import "myfile.vim"
1838 call s:myfile.MyFunc()
1839
1840And using the "as name" form: >
1841 import "otherfile.vim9script" as that
1842 call s:that.OtherFunc()
1843
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001844However, the namespace cannot be resolved on its own: >
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001845 import "that.vim"
1846 echo s:that
1847 " ERROR: E1060: Expected dot after name: s:that
1848<
1849This also affects the use of |<SID>| in the legacy mapping context. Since
1850|<SID>| is only a valid prefix for a function and NOT for a namespace, you
1851cannot use it
1852to scope a function in a script local namespace. Instead of prefixing the
1853function with |<SID>| you should use|<ScriptCmd>|. For example: >
1854 noremap ,a <ScriptCmd>:call s:that.OtherFunc()<CR>
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01001855<
Bram Moolenaar89445512022-04-14 12:58:23 +01001856 *:import-cycle*
Bram Moolenaara2baa732022-02-04 16:09:54 +00001857The `import` commands are executed when encountered. If script A imports
1858script B, and B (directly or indirectly) imports A, this will be skipped over.
1859At this point items in A after "import B" will not have been processed and
1860defined yet. Therefore cyclic imports can exist and not result in an error
1861directly, but may result in an error for items in A after "import B" not being
1862defined. This does not apply to autoload imports, see the next section.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001863
1864
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001865Importing an autoload script ~
Bram Moolenaarfd999452022-08-24 18:30:14 +01001866 *vim9-autoload* *import-autoload*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001867For optimal startup speed, loading scripts should be postponed until they are
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001868actually needed. Using the autoload mechanism is recommended:
Bram Moolenaara2baa732022-02-04 16:09:54 +00001869 *E1264*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010018701. In the plugin define user commands, functions and/or mappings that refer to
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001871 items imported from an autoload script. >
1872 import autoload 'for/search.vim'
1873 command -nargs=1 SearchForStuff search.Stuff(<f-args>)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001874
1875< This goes in .../plugin/anyname.vim. "anyname.vim" can be freely chosen.
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001876 The "SearchForStuff" command is now available to the user.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001877
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001878 The "autoload" argument to `:import` means that the script is not loaded
1879 until one of the items is actually used. The script will be found under
1880 the "autoload" directory in 'runtimepath' instead of the "import"
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001881 directory. Alternatively a relative or absolute name can be used, see
1882 below.
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001883
18842. In the autoload script put the bulk of the code. >
Bram Moolenaarfd218c82022-01-18 16:26:24 +00001885 vim9script
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001886 export def Stuff(arg: string)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001887 ...
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001888
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001889< This goes in .../autoload/for/search.vim.
1890
Bram Moolenaarfd218c82022-01-18 16:26:24 +00001891 Putting the "search.vim" script under the "/autoload/for/" directory has
1892 the effect that "for#search#" will be prefixed to every exported item. The
1893 prefix is obtained from the file name, as you would to manually in a
1894 legacy autoload script. Thus the exported function can be found with
1895 "for#search#Stuff", but you would normally use `import autoload` and not
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001896 use the prefix (which has the side effect of loading the autoload script
1897 when compiling a function that encounters this name).
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001898
1899 You can split up the functionality and import other scripts from the
1900 autoload script as you like. This way you can share code between plugins.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001901
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001902Searching for the autoload script in all entries in 'runtimepath' can be a bit
1903slow. If the plugin knows where the script is located, quite often a relative
1904path can be used. This avoids the search and should be quite a bit faster.
1905Another advantage is that the script name does not need to be unique. An
1906absolute path is also possible. Examples: >
1907 import autoload '../lib/implement.vim'
1908 import autoload MyScriptsDir .. '/lib/implement.vim'
1909
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001910For defining a mapping that uses the imported autoload script the special key
1911|<ScriptCmd>| is useful. It allows for a command in a mapping to use the
1912script context of where the mapping was defined.
1913
Bram Moolenaar418f1df2020-08-12 21:34:49 +02001914When compiling a `:def` function and a function in an autoload script is
1915encountered, the script is not loaded until the `:def` function is called.
Bram Moolenaardc4451d2022-01-09 21:36:37 +00001916This also means you get any errors only at runtime, since the argument and
Bram Moolenaar47c532e2022-03-19 15:18:53 +00001917return types are not known yet. If you would use the name with '#' characters
1918then the autoload script IS loaded.
1919
1920Be careful to not refer to an item in an autoload script that does trigger
1921loading it unintentionally. For example, when setting an option that takes a
1922function name, make sure to use a string, not a function reference: >
1923 import autoload 'qftf.vim'
1924 &quickfixtextfunc = 'qftf.Func' # autoload script NOT loaded
1925 &quickfixtextfunc = qftf.Func # autoload script IS loaded
1926On the other hand, it can be useful to load the script early, at a time when
1927any errors should be given.
Bram Moolenaar418f1df2020-08-12 21:34:49 +02001928
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001929For testing the |test_override()| function can be used to have the
1930`import autoload` load the script right away, so that the items and types can
1931be checked without waiting for them to be actually used: >
1932 test_override('autoload', 1)
1933Reset it later with: >
1934 test_override('autoload', 0)
1935Or: >
1936 test_override('ALL', 0)
1937
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001938
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001939==============================================================================
1940
Bram Moolenaar1d59aa12020-09-19 18:50:13 +020019416. Future work: classes *vim9-classes*
1942
1943Above "class" was mentioned a few times, but it has not been implemented yet.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02001944Most of Vim9 script can be created without this functionality, and since
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001945implementing classes is going to be a lot of work, it is left for the future.
1946For now we'll just make sure classes can be added later.
1947
1948Thoughts:
Bram Moolenaar74235772021-06-12 14:53:05 +02001949- `class` / `endclass`, the whole class must be in one file
1950- Class names are always CamelCase (to avoid a name clash with builtin types)
1951- A single constructor called "constructor"
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001952- Single inheritance with `class ThisClass extends BaseClass`
Bram Moolenaar74235772021-06-12 14:53:05 +02001953- `abstract class` (class with incomplete implementation)
1954- `interface` / `endinterface` (abstract class without any implementation)
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001955- `class SomeClass implements SomeInterface`
1956- Generics for class: `class <Tkey, Tentry>`
1957- Generics for function: `def <Tkey> GetLast(key: Tkey)`
1958
Bram Moolenaar74235772021-06-12 14:53:05 +02001959Again, much of this is from TypeScript with a slightly different syntax.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001960
1961Some things that look like good additions:
1962- Use a class as an interface (like Dart)
1963- Extend a class with methods, using an import (like Dart)
Bram Moolenaar74235772021-06-12 14:53:05 +02001964- Mixins
1965- For testing: Mock mechanism
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001966
1967An important class that will be provided is "Promise". Since Vim is single
1968threaded, connecting asynchronous operations is a natural way of allowing
1969plugins to do their work without blocking the user. It's a uniform way to
1970invoke callbacks and handle timeouts and errors.
1971
Bram Moolenaar1588bc82022-03-08 21:35:07 +00001972Some commands have already been reserved:
1973 *:class*
1974 *:endclass*
1975 *:abstract*
1976 *:enum*
1977 *:endenum*
1978 *:interface*
1979 *:endinterface*
1980 *:static*
1981 *:type*
1982
Bram Moolenaar74235772021-06-12 14:53:05 +02001983Some examples: >
1984
1985 abstract class Person
1986 static const prefix = 'xxx'
1987 var name: string
1988
1989 def constructor(name: string)
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02001990 this.name = name
Bram Moolenaar74235772021-06-12 14:53:05 +02001991 enddef
1992
1993 def display(): void
1994 echo name
1995 enddef
1996
1997 abstract def find(string): Person
1998 endclass
1999
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002000==============================================================================
2001
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010020029. Rationale *vim9-rationale*
2003
2004The :def command ~
2005
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002006Plugin writers have asked for much faster Vim script. Investigations have
Bram Moolenaar560979e2020-02-04 22:53:05 +01002007shown that keeping the existing semantics of function calls make this close to
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002008impossible, because of the overhead involved with calling a function, setting
2009up the local function scope and executing lines. There are many details that
2010need to be handled, such as error messages and exceptions. The need to create
2011a dictionary for a: and l: scopes, the a:000 list and several others add too
2012much overhead that cannot be avoided.
2013
2014Therefore the `:def` method to define a new-style function had to be added,
2015which allows for a function with different semantics. Most things still work
2016as before, but some parts do not. A new way to define a function was
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002017considered the best way to separate the legacy style code from Vim9 style code.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002018
2019Using "def" to define a function comes from Python. Other languages use
2020"function" which clashes with legacy Vim script.
2021
2022
2023Type checking ~
2024
2025When compiling lines of Vim commands into instructions as much as possible
2026should be done at compile time. Postponing it to runtime makes the execution
2027slower and means mistakes are found only later. For example, when
2028encountering the "+" character and compiling this into a generic add
Bram Moolenaar98a29d02021-01-18 19:55:44 +01002029instruction, at runtime the instruction would have to inspect the type of the
2030arguments and decide what kind of addition to do. And when the type is
2031dictionary throw an error. If the types are known to be numbers then an "add
2032number" instruction can be used, which is faster. The error can be given at
2033compile time, no error handling is needed at runtime, since adding two numbers
2034cannot fail.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002035
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002036The syntax for types, using <type> for compound types, is similar to Java. It
2037is easy to understand and widely used. The type names are what were used in
2038Vim before, with some additions such as "void" and "bool".
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002039
2040
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002041Removing clutter and weirdness ~
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002042
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002043Once decided that `:def` functions have different syntax than legacy functions,
2044we are free to add improvements to make the code more familiar for users who
2045know popular programming languages. In other words: remove weird things that
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002046only Vim does.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002047
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002048We can also remove clutter, mainly things that were done to make Vim script
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002049backwards compatible with the good old Vi commands.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002050
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002051Examples:
Bram Moolenaar63f32602022-06-09 20:45:54 +01002052- Drop `:call` for calling a function and `:eval` for evaluating an
2053 expression.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002054- Drop using a leading backslash for line continuation, automatically figure
2055 out where an expression ends.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002056
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002057However, this does require that some things need to change:
2058- Comments start with # instead of ", to avoid confusing them with strings.
Bram Moolenaar63f32602022-06-09 20:45:54 +01002059 This is good anyway, it is also used by several popular languages.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002060- Ex command ranges need to be prefixed with a colon, to avoid confusion with
2061 expressions (single quote can be a string or a mark, "/" can be divide or a
2062 search command, etc.).
2063
2064Goal is to limit the differences. A good criteria is that when the old syntax
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002065is accidentally used you are very likely to get an error message.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002066
2067
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002068Syntax and semantics from popular languages ~
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002069
2070Script writers have complained that the Vim script syntax is unexpectedly
2071different from what they are used to. To reduce this complaint popular
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002072languages are used as an example. At the same time, we do not want to abandon
2073the well-known parts of legacy Vim script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002074
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002075For many things TypeScript is followed. It's a recent language that is
2076gaining popularity and has similarities with Vim script. It also has a
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002077mix of static typing (a variable always has a known value type) and dynamic
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002078typing (a variable can have different types, this changes at runtime). Since
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002079legacy Vim script is dynamically typed and a lot of existing functionality
2080(esp. builtin functions) depends on that, while static typing allows for much
2081faster execution, we need to have this mix in Vim9 script.
2082
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002083There is no intention to completely match TypeScript syntax and semantics. We
2084just want to take those parts that we can use for Vim and we expect Vim users
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002085will be happy with. TypeScript is a complex language with its own history,
2086advantages and disadvantages. To get an idea of the disadvantages read the
2087book: "JavaScript: The Good Parts". Or find the article "TypeScript: the good
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002088parts" and read the "Things to avoid" section.
2089
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002090People familiar with other languages (Java, Python, etc.) will also find
2091things in TypeScript that they do not like or do not understand. We'll try to
2092avoid those things.
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002093
2094Specific items from TypeScript we avoid:
2095- Overloading "+", using it both for addition and string concatenation. This
2096 goes against legacy Vim script and often leads to mistakes. For that reason
2097 we will keep using ".." for string concatenation. Lua also uses ".." this
2098 way. And it allows for conversion to string for more values.
2099- TypeScript can use an expression like "99 || 'yes'" in a condition, but
2100 cannot assign the value to a boolean. That is inconsistent and can be
2101 annoying. Vim recognizes an expression with && or || and allows using the
Bram Moolenaar1f318c62021-12-26 18:09:31 +00002102 result as a bool. The |falsy-operator| was added for the mechanism to use a
2103 default value.
Bram Moolenaar0b4c66c2020-09-14 21:39:44 +02002104- TypeScript considers an empty string as Falsy, but an empty list or dict as
2105 Truthy. That is inconsistent. In Vim an empty list and dict are also
2106 Falsy.
2107- TypeScript has various "Readonly" types, which have limited usefulness,
2108 since a type cast can remove the immutable nature. Vim locks the value,
2109 which is more flexible, but is only checked at runtime.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002110- TypeScript has a complicated "import" statement that does not match how the
2111 Vim import mechanism works. A much simpler mechanism is used instead, which
2112 matches that the imported script is only sourced once.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002113
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002114
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002115Declarations ~
2116
2117Legacy Vim script uses `:let` for every assignment, while in Vim9 declarations
2118are used. That is different, thus it's good to use a different command:
2119`:var`. This is used in many languages. The semantics might be slightly
2120different, but it's easily recognized as a declaration.
2121
Bram Moolenaar23515b42020-11-29 14:36:24 +01002122Using `:const` for constants is common, but the semantics varies. Some
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002123languages only make the variable immutable, others also make the value
2124immutable. Since "final" is well known from Java for only making the variable
2125immutable we decided to use that. And then `:const` can be used for making
2126both immutable. This was also used in legacy Vim script and the meaning is
2127almost the same.
2128
2129What we end up with is very similar to Dart: >
2130 :var name # mutable variable and value
2131 :final name # immutable variable, mutable value
2132 :const name # immutable variable and value
2133
2134Since legacy and Vim9 script will be mixed and global variables will be
2135shared, optional type checking is desirable. Also, type inference will avoid
2136the need for specifying the type in many cases. The TypeScript syntax fits
2137best for adding types to declarations: >
2138 var name: string # string type is specified
2139 ...
2140 name = 'John'
2141 const greeting = 'hello' # string type is inferred
2142
2143This is how we put types in a declaration: >
2144 var mylist: list<string>
2145 final mylist: list<string> = ['foo']
2146 def Func(arg1: number, arg2: string): bool
2147
2148Two alternatives were considered:
21491. Put the type before the name, like Dart: >
2150 var list<string> mylist
2151 final list<string> mylist = ['foo']
2152 def Func(number arg1, string arg2) bool
21532. Put the type after the variable name, but do not use a colon, like Go: >
2154 var mylist list<string>
2155 final mylist list<string> = ['foo']
2156 def Func(arg1 number, arg2 string) bool
2157
2158The first is more familiar for anyone used to C or Java. The second one
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002159doesn't really have an advantage over the first, so let's discard the second.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002160
2161Since we use type inference the type can be left out when it can be inferred
2162from the value. This means that after `var` we don't know if a type or a name
2163follows. That makes parsing harder, not only for Vim but also for humans.
2164Also, it will not be allowed to use a variable name that could be a type name,
2165using `var string string` is too confusing.
2166
2167The chosen syntax, using a colon to separate the name from the type, adds
2168punctuation, but it actually makes it easier to recognize the parts of a
2169declaration.
2170
2171
2172Expressions ~
2173
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002174Expression evaluation was already close to what other languages are doing.
2175Some details are unexpected and can be improved. For example a boolean
2176condition would accept a string, convert it to a number and check if the
2177number is non-zero. This is unexpected and often leads to mistakes, since
2178text not starting with a number would be converted to zero, which is
Bram Moolenaarcb80aa22020-10-26 21:12:46 +01002179considered false. Thus using a string for a condition would often not give an
2180error and be considered false. That is confusing.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002181
Bram Moolenaar23515b42020-11-29 14:36:24 +01002182In Vim9 type checking is stricter to avoid mistakes. Where a condition is
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002183used, e.g. with the `:if` command and the `||` operator, only boolean-like
2184values are accepted:
2185 true: `true`, `v:true`, `1`, `0 < 9`
2186 false: `false`, `v:false`, `0`, `0 > 9`
2187Note that the number zero is false and the number one is true. This is more
Bram Moolenaarcb80aa22020-10-26 21:12:46 +01002188permissive than most other languages. It was done because many builtin
Bram Moolenaar63f32602022-06-09 20:45:54 +01002189functions return these values, and changing that causes more problems than it
2190solves. After using this for a while it turned out to work well.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002191
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002192If you have any type of value and want to use it as a boolean, use the `!!`
2193operator:
Bram Moolenaar63f32602022-06-09 20:45:54 +01002194 true: `!!'text'` `!![99]` `!!{'x': 1}` `!!99`
2195 false: `!!''` `!![]` `!!{}`
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002196
2197From a language like JavaScript we have this handy construct: >
2198 GetName() || 'unknown'
2199However, this conflicts with only allowing a boolean for a condition.
2200Therefore the "??" operator was added: >
2201 GetName() ?? 'unknown'
2202Here you can explicitly express your intention to use the value as-is and not
2203result in a boolean. This is called the |falsy-operator|.
Bram Moolenaar30fd8202020-09-26 15:09:30 +02002204
2205
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002206Import and Export ~
2207
2208A problem of legacy Vim script is that by default all functions and variables
2209are global. It is possible to make them script-local, but then they are not
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002210available in other scripts. This defies the concept of a package that only
2211exports selected items and keeps the rest local.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002212
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02002213In Vim9 script a mechanism very similar to the JavaScript import and export
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002214mechanism is supported. It is a variant to the existing `:source` command
2215that works like one would expect:
2216- Instead of making everything global by default, everything is script-local,
Bram Moolenaar63f32602022-06-09 20:45:54 +01002217 some of these are exported.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002218- When importing a script the symbols that are imported are explicitly listed,
2219 avoiding name conflicts and failures if functionality is added later.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002220- The mechanism allows for writing a big, long script with a very clear API:
Bram Moolenaar63f32602022-06-09 20:45:54 +01002221 the exported functions, variables and classes.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002222- By using relative paths loading can be much faster for an import inside of a
2223 package, no need to search many directories.
Bram Moolenaar63f32602022-06-09 20:45:54 +01002224- Once an import has been used, its items are cached and loading it again is
2225 not needed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002226- The Vim-specific use of "s:" to make things script-local can be dropped.
2227
Bram Moolenaar63f32602022-06-09 20:45:54 +01002228When sourcing a Vim9 script (from a Vim9 or legacy script), only the items
2229defined globally can be used, not the exported items. Alternatives
2230considered:
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002231- All the exported items become available as script-local items. This makes
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002232 it uncontrollable what items get defined and likely soon leads to trouble.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002233- Use the exported items and make them global. Disadvantage is that it's then
2234 not possible to avoid name clashes in the global namespace.
2235- Completely disallow sourcing a Vim9 script, require using `:import`. That
2236 makes it difficult to use scripts for testing, or sourcing them from the
2237 command line to try them out.
Bram Moolenaar63f32602022-06-09 20:45:54 +01002238Note that you CAN also use `:import` in legacy Vim script, see above.
Bram Moolenaar65e0d772020-06-14 17:29:55 +02002239
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002240
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002241Compiling functions early ~
2242
2243Functions are compiled when called or when `:defcompile` is used. Why not
2244compile them early, so that syntax and type errors are reported early?
2245
2246The functions can't be compiled right away when encountered, because there may
2247be forward references to functions defined later. Consider defining functions
2248A, B and C, where A calls B, B calls C, and C calls A again. It's impossible
2249to reorder the functions to avoid forward references.
2250
2251An alternative would be to first scan through the file to locate items and
2252figure out their type, so that forward references are found, and only then
2253execute the script and compile the functions. This means the script has to be
2254parsed twice, which is slower, and some conditions at the script level, such
2255as checking if a feature is supported, are hard to use. An attempt was made
Bram Moolenaar63f32602022-06-09 20:45:54 +01002256to see if it works, but it turned out to be impossible to make work well.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002257
2258It would be possible to compile all the functions at the end of the script.
2259The drawback is that if a function never gets called, the overhead of
2260compiling it counts anyway. Since startup speed is very important, in most
2261cases it's better to do it later and accept that syntax and type errors are
2262only reported then. In case these errors should be found early, e.g. when
Bram Moolenaar63f32602022-06-09 20:45:54 +01002263testing, a `:defcompile` command at the end of the script will help out.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002264
2265
Bram Moolenaar63f32602022-06-09 20:45:54 +01002266Why not use an existing embedded language? ~
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002267
2268Vim supports interfaces to Perl, Python, Lua, Tcl and a few others. But
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002269these interfaces have never become widely used, for various reasons. When
2270Vim9 was designed a decision was made to make these interfaces lower priority
2271and concentrate on Vim script.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002272
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002273Still, plugin writers may find other languages more familiar, want to use
2274existing libraries or see a performance benefit. We encourage plugin authors
Bram Moolenaar63f32602022-06-09 20:45:54 +01002275to write code in any language and run it as an external process, using jobs
2276and channels. We can try to make this easier somehow.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002277
2278Using an external tool also has disadvantages. An alternative is to convert
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002279the tool into Vim script. For that to be possible without too much
2280translation, and keeping the code fast at the same time, the constructs of the
2281tool need to be supported. Since most languages support classes the lack of
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02002282support for classes in Vim is then a problem.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002283
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002284
2285Classes ~
2286
2287Vim supports a kind-of object oriented programming by adding methods to a
2288dictionary. With some care this can be made to work, but it does not look
2289like real classes. On top of that, it's quite slow, because of the use of
2290dictionaries.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002291
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01002292It would be good to support real classes, and this is planned for a later
Bram Moolenaar63f32602022-06-09 20:45:54 +01002293version. The support is a "minimal common functionality" of class support in
2294most languages. It will work much like Java, which is the most popular
2295programming language.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002296
2297
2298
2299 vim:tw=78:ts=8:noet:ft=help:norl: