Mercurial > vim
annotate runtime/doc/vim9.txt @ 28241:56e2b05a232f
Added tag v8.2.4646 for changeset 692f6a861c47ce8625ae4e0fe4cb463a9275f6e0
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Tue, 29 Mar 2022 14:30:04 +0200 |
| parents | dce918af0c00 |
| children | e3d6184b89fa |
| rev | line source |
|---|---|
| 28141 | 1 *vim9.txt* For Vim version 8.2. Last change: 2022 Mar 18 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
3 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
4 VIM REFERENCE MANUAL by Bram Moolenaar |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
5 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
6 |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
7 Vim9 script commands and expressions. *Vim9* *vim9* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
8 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
9 Most expression help is in |eval.txt|. This file is about the new syntax and |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
10 features in Vim9 script. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
11 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
12 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
13 |
| 23466 | 14 1. What is Vim9 script? |Vim9-script| |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
15 2. Differences |vim9-differences| |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
16 3. New style functions |fast-functions| |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
17 4. Types |vim9-types| |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
18 5. Namespace, Import and Export |vim9script| |
| 22328 | 19 6. Future work: classes |vim9-classes| |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
20 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
21 9. Rationale |vim9-rationale| |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
22 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
23 ============================================================================== |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
24 |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
25 1. What is Vim9 script? *Vim9-script* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
26 |
| 20241 | 27 Vim script has been growing over time, while preserving backwards |
| 28 compatibility. That means bad choices from the past often can't be changed | |
| 20965 | 29 and compatibility with Vi restricts possible solutions. Execution is quite |
| 20241 | 30 slow, each line is parsed every time it is executed. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
31 |
| 20241 | 32 The main goal of Vim9 script is to drastically improve performance. This is |
| 33 accomplished by compiling commands into instructions that can be efficiently | |
| 34 executed. An increase in execution speed of 10 to 100 times can be expected. | |
| 35 | |
| 36 A secondary goal is to avoid Vim-specific constructs and get closer to | |
| 37 commonly used programming languages, such as JavaScript, TypeScript and Java. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
38 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
39 The performance improvements can only be achieved by not being 100% backwards |
| 20552 | 40 compatible. For example, making function arguments available in the |
| 41 "a:" dictionary adds quite a lot of overhead. In a Vim9 function this | |
| 42 dictionary is not available. Other differences are more subtle, such as how | |
| 43 errors are handled. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
44 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
45 The Vim9 script syntax and semantics are used in: |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
46 - a function defined with the `:def` command |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
47 - a script file where the first command is `vim9script` |
| 22328 | 48 - an autocommand defined in the context of the above |
|
23938
2a885d095bff
patch 8.2.2511: Vim9: cannot use Vim9 script syntax in some places
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
49 - a command prefixed with the `vim9cmd` command modifier |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
50 |
| 23573 | 51 When using `:function` in a Vim9 script file the legacy syntax is used, with |
| 52 the highest |scriptversion|. However, this can be confusing and is therefore | |
| 53 discouraged. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
54 |
| 20241 | 55 Vim9 script and legacy Vim script can be mixed. There is no requirement to |
| 22328 | 56 rewrite old scripts, they keep working as before. You may want to use a few |
| 57 `:def` functions for code that needs to be fast. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
58 |
| 27537 | 59 :vim9[cmd] {cmd} *:vim9* *:vim9cmd* *E1164* |
|
27645
1712b102d642
patch 8.2.4348: "legacy exe cmd" does not do what one would expect
Bram Moolenaar <Bram@vim.org>
parents:
27634
diff
changeset
|
60 Evaluate and execute {cmd} using Vim9 script syntax and |
|
1712b102d642
patch 8.2.4348: "legacy exe cmd" does not do what one would expect
Bram Moolenaar <Bram@vim.org>
parents:
27634
diff
changeset
|
61 semantics. Useful when typing a command and in a legacy |
|
1712b102d642
patch 8.2.4348: "legacy exe cmd" does not do what one would expect
Bram Moolenaar <Bram@vim.org>
parents:
27634
diff
changeset
|
62 script or function. |
|
23938
2a885d095bff
patch 8.2.2511: Vim9: cannot use Vim9 script syntax in some places
Bram Moolenaar <Bram@vim.org>
parents:
23931
diff
changeset
|
63 |
| 27537 | 64 :leg[acy] {cmd} *:leg* *:legacy* *E1189* *E1234* |
|
27645
1712b102d642
patch 8.2.4348: "legacy exe cmd" does not do what one would expect
Bram Moolenaar <Bram@vim.org>
parents:
27634
diff
changeset
|
65 Evaluate and execute {cmd} using legacy script syntax and |
|
1712b102d642
patch 8.2.4348: "legacy exe cmd" does not do what one would expect
Bram Moolenaar <Bram@vim.org>
parents:
27634
diff
changeset
|
66 semantics. Only useful in a Vim9 script or a :def function. |
|
24531
3bfec39ce31c
patch 8.2.2805: Vim9: cannot use legacy syntax in Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
67 Note that {cmd} cannot use local variables, since it is parsed |
|
3bfec39ce31c
patch 8.2.2805: Vim9: cannot use legacy syntax in Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
68 with legacy expression syntax. |
|
3bfec39ce31c
patch 8.2.2805: Vim9: cannot use legacy syntax in Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
69 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
70 ============================================================================== |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
71 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
72 2. Differences from legacy Vim script *vim9-differences* |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
73 |
| 22441 | 74 Overview ~ |
| 27537 | 75 *E1146* |
| 22441 | 76 Brief summary of the differences you will most often encounter when using Vim9 |
| 77 script and `:def` functions; details are below: | |
| 78 - Comments start with #, not ": > | |
| 23573 | 79 echo "hello" # comment |
| 22441 | 80 - Using a backslash for line continuation is hardly ever needed: > |
| 23573 | 81 echo "hello " |
| 22441 | 82 .. yourName |
| 83 .. ", how are you?" | |
|
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26755
diff
changeset
|
84 - White space is required in many places to improve readability. |
| 27459 | 85 - Assign values without `:let` *E1126* , declare variables with `:var`: > |
| 23573 | 86 var count = 0 |
| 22441 | 87 count += 3 |
| 88 - Constants can be declared with `:final` and `:const`: > | |
| 23573 | 89 final matches = [] # add matches |
| 22441 | 90 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`: > | |
| 23573 | 96 writefile(['done'], 'file.txt') |
|
28002
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
97 - You cannot use old Ex commands: |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
98 `:Print` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
99 `:append` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
100 `:change` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
101 `:d` directly followed by 'd' or 'p'. |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
102 `:insert` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
103 `:k` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
104 `:mode` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
105 `:open` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
106 `:s` with only flags |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
107 `:t` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
108 `:xit` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
109 - Some commands, especially those used for flow control, cannot be shortened. |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
110 E.g., `:throw` cannot be written as `:th`. *E839* |
| 25973 | 111 - You cannot use curly-braces names. |
| 22441 | 112 - A range before a command must be prefixed with a colon: > |
| 23573 | 113 :%s/this/that |
| 25700 | 114 - Executing a register with "@r" does not work, you can prepend a colon or use |
| 115 `:exe`: > | |
| 116 :exe @a | |
| 23573 | 117 - Unless mentioned specifically, the highest |scriptversion| is used. |
| 27162 | 118 - When defining an expression mapping, the expression will be evaluated in the |
| 119 context of the script where it was defined. | |
| 22441 | 120 |
| 121 | |
|
20023
c85d4e173cc9
patch 8.2.0567: Vim9: cannot put comments halfway expressions
Bram Moolenaar <Bram@vim.org>
parents:
20015
diff
changeset
|
122 Comments starting with # ~ |
|
c85d4e173cc9
patch 8.2.0567: Vim9: cannot put comments halfway expressions
Bram Moolenaar <Bram@vim.org>
parents:
20015
diff
changeset
|
123 |
|
21353
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
124 In legacy Vim script comments start with double quote. In Vim9 script |
|
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
125 comments start with #. > |
|
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
126 # declarations |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
127 var count = 0 # number of occurrences |
|
20023
c85d4e173cc9
patch 8.2.0567: Vim9: cannot put comments halfway expressions
Bram Moolenaar <Bram@vim.org>
parents:
20015
diff
changeset
|
128 |
|
21353
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
129 The reason is that a double quote can also be the start of a string. In many |
| 21825 | 130 places, especially halfway through an expression with a line break, it's hard |
| 131 to tell what the meaning is, since both a string and a comment can be followed | |
| 132 by arbitrary text. To avoid confusion only # comments are recognized. This | |
| 133 is the same as in shell scripts and Python programs. | |
|
21353
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
134 |
|
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
135 In Vi # is a command to list text with numbers. In Vim9 script you can use |
|
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
136 `:number` for that. > |
| 27036 | 137 :101 number |
|
21353
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
138 |
|
fb8c8fcb7b60
patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing
Bram Moolenaar <Bram@vim.org>
parents:
21250
diff
changeset
|
139 To improve readability there must be a space between a command and the # |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
140 that starts a comment: > |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
141 var name = value # comment |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
142 var name = value# error! |
| 27537 | 143 < *E1170* |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
144 Do not start a comment with #{, it looks like the legacy dictionary literal |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
145 and produces an error where this might be confusing. #{{ or #{{{ are OK, |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
146 these can be used to start a fold. |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
147 |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
148 In legacy Vim script # is also used for the alternate file name. In Vim9 |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
149 script you need to use %% instead. Instead of ## use %%% (stands for all |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
150 arguments). |
| 20115 | 151 |
|
20023
c85d4e173cc9
patch 8.2.0567: Vim9: cannot put comments halfway expressions
Bram Moolenaar <Bram@vim.org>
parents:
20015
diff
changeset
|
152 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
153 Vim9 functions ~ |
| 27459 | 154 *E1099* |
| 20241 | 155 A function defined with `:def` is compiled. Execution is many times faster, |
|
24408
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
156 often 10 to 100 times. |
| 20241 | 157 |
| 20552 | 158 Many errors are already found when compiling, before the function is executed. |
| 20241 | 159 The syntax is strict, to enforce code that is easy to read and understand. |
| 160 | |
|
24408
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
161 Compilation is done when any of these is encountered: |
| 23164 | 162 - the first time the function is called |
|
24408
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
163 - when the `:defcompile` command is encountered in the script after the |
| 21991 | 164 function was defined |
| 165 - `:disassemble` is used for the function. | |
| 166 - a function that is compiled calls the function or uses it as a function | |
| 25700 | 167 reference (so that the argument and return types can be checked) |
| 27537 | 168 *E1091* *E1191* |
|
24408
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
169 If compilation fails it is not tried again on the next call, instead this |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
170 error is given: "E1091: Function is not compiled: {name}". |
| 24569 | 171 Compilation will fail when encountering a user command that has not been |
| 172 created yet. In this case you can call `execute()` to invoke it at runtime. > | |
| 173 def MyFunc() | |
| 174 execute('DefinedLater') | |
| 175 enddef | |
| 20552 | 176 |
| 177 `:def` has no options like `:function` does: "range", "abort", "dict" or | |
| 23164 | 178 "closure". A `:def` function always aborts on an error (unless `:silent!` was |
| 26708 | 179 used for the command or the error was caught a `:try` block), does not get a |
| 180 range passed cannot be a "dict" function, and can always be a closure. | |
| 25700 | 181 *vim9-no-dict-function* |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
182 Later classes will be added, which replaces the "dict function" mechanism. |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
183 For now you will need to pass the dictionary explicitly: > |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
184 def DictFunc(d: dict<any>, arg: string) |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
185 echo d[arg] |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
186 enddef |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
187 var d = {item: 'value', func: DictFunc} |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
188 d.func(d, 'item') |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
189 |
| 25836 | 190 You can call a legacy dict function though: > |
| 191 func Legacy() dict | |
| 192 echo self.value | |
| 193 endfunc | |
| 194 def CallLegacy() | |
| 195 var d = {func: Legacy, value: 'text'} | |
| 196 d.func() | |
| 197 enddef | |
| 27537 | 198 < *E1096* *E1174* *E1175* |
| 20241 | 199 The argument types and return type need to be specified. The "any" type can |
| 200 be used, type checking will then be done at runtime, like with legacy | |
| 201 functions. | |
| 27459 | 202 *E1106* |
| 21825 | 203 Arguments are accessed by name, without "a:", just like any other language. |
| 204 There is no "a:" dictionary or "a:000" list. | |
| 27537 | 205 *vim9-variable-arguments* *E1055* *E1160* *E1180* |
| 20241 | 206 Variable arguments are defined as the last argument, with a name and have a |
| 21825 | 207 list type, similar to TypeScript. For example, a list of numbers: > |
| 22171 | 208 def MyFunc(...itemlist: list<number>) |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
209 for item in itemlist |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
210 ... |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
211 |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
212 When a function argument is optional (it has a default value) passing `v:none` |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
213 as the argument results in using the default value. This is useful when you |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
214 want to specify a value for an argument that comes after an argument that |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
215 should use its default value. Example: > |
| 25973 | 216 def MyFunc(one = 'one', last = 'last') |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
217 ... |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
218 enddef |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
219 MyFunc(v:none, 'LAST') # first argument uses default value 'one' |
|
24408
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
220 < |
| 27537 | 221 *vim9-ignored-argument* *E1181* |
|
24408
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
222 The argument "_" (an underscore) can be used to ignore the argument. This is |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
223 most useful in callbacks where you don't need it, but do need to give an |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
224 argument to match the call. E.g. when using map() two arguments are passed, |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
225 the key and the value, to ignore the key: > |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
226 map(myList, (_, v) => v * 2) |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
227 There is no error for using the "_" argument multiple times. No type needs to |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
228 be given. |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
229 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
230 |
| 20241 | 231 Functions and variables are script-local by default ~ |
| 20856 | 232 *vim9-scopes* |
| 20115 | 233 When using `:function` or `:def` to specify a new function at the script level |
|
27634
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
234 in a Vim9 script, the function is local to the script. Like prefixing "s:" in |
|
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
235 legacy script. To define a global function or variable the "g:" prefix must |
|
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
236 be used. For functions in a script that is to be imported and in an autoload |
|
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
237 script "export" needs to be used. > |
|
21550
b0b57d91671c
patch 8.2.1325: Vim9: using Vim9 script for autaload not tested
Bram Moolenaar <Bram@vim.org>
parents:
21516
diff
changeset
|
238 def ThisFunction() # script-local |
| 22171 | 239 def g:ThatFunction() # global |
| 27623 | 240 export def Function() # for import and import autoload |
| 27321 | 241 < *E1058* *E1075* |
|
22494
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
242 When using `:function` or `:def` to specify a nested function inside a `:def` |
| 26438 | 243 function and no namespace was given, this nested function is local to the code |
| 27903 | 244 block it is defined in. It cannot be used in `function()` with a string |
| 245 argument, pass the function reference itself: > | |
| 246 def Outer() | |
| 247 def Inner() | |
| 248 echo 'inner' | |
| 249 enddef | |
| 250 var Fok = function(Inner) # OK | |
| 251 var Fbad = function('Inner') # does not work | |
| 252 | |
| 253 It is not possible to define a script-local function. It is possible to | |
| 254 define a global function by using the "g:" prefix. | |
| 20115 | 255 |
| 256 When referring to a function and no "s:" or "g:" prefix is used, Vim will | |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
257 search for the function: |
| 22565 | 258 - in the function scope, in block scopes |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
259 - in the script scope, possibly imported |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
260 |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
261 Since a script-local function reference can be used without "s:" the name must |
| 24278 | 262 start with an upper case letter even when using the "s:" prefix. In legacy |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
263 script "s:funcref" could be used, because it could not be referred to with |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
264 "funcref". In Vim9 script it can, therefore "s:Funcref" must be used to avoid |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
265 that the name interferes with builtin functions. |
|
27634
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
266 *vim9-s-namespace* |
|
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
267 The use of the "s:" prefix is not supported at the Vim9 script level. All |
|
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
268 functions and variables without a prefix are script-local. |
|
27843
532a0c5de1ec
patch 8.2.4447: Vim9: can still use s:var in a compiled function
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
269 |
|
532a0c5de1ec
patch 8.2.4447: Vim9: can still use s:var in a compiled function
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
270 In :def functions the use of "s:" depends on the script: Script-local |
|
532a0c5de1ec
patch 8.2.4447: Vim9: can still use s:var in a compiled function
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
271 variables and functions in a legacy script do use "s:", while in a Vim9 script |
|
532a0c5de1ec
patch 8.2.4447: Vim9: can still use s:var in a compiled function
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
272 they do not use "s:". This matches what you see in the rest of the file. |
|
532a0c5de1ec
patch 8.2.4447: Vim9: can still use s:var in a compiled function
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
273 |
|
27634
9fe2fed9bb4b
Update runtime files. (closes #9741)
Bram Moolenaar <Bram@vim.org>
parents:
27623
diff
changeset
|
274 In legacy functions the use of "s:" for script items is required, as before. |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
275 |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
276 In all cases the function must be defined before used. That is when it is |
| 22723 | 277 called, when `:defcompile` causes it to be compiled, or when code that calls |
| 278 it is being compiled (to figure out the return type). | |
| 20241 | 279 |
| 21676 | 280 The result is that functions and variables without a namespace can usually be |
| 20241 | 281 found in the script, either defined there or imported. Global functions and |
| 21676 | 282 variables could be defined anywhere (good luck finding out where!). |
| 27459 | 283 *E1102* |
| 21825 | 284 Global functions can still be defined and deleted at nearly any time. In |
| 20317 | 285 Vim9 script script-local functions are defined once when the script is sourced |
| 20552 | 286 and cannot be deleted or replaced. |
| 20115 | 287 |
| 23305 | 288 When compiling a function and a function call is encountered for a function |
| 289 that is not (yet) defined, the |FuncUndefined| autocommand is not triggered. | |
| 290 You can use an autoload function if needed, or call a legacy function and have | |
| 291 |FuncUndefined| triggered there. | |
| 292 | |
| 20115 | 293 |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
294 Reloading a Vim9 script clears functions and variables by default ~ |
| 27537 | 295 *vim9-reload* *E1149* *E1150* |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
296 When loading a legacy Vim script a second time nothing is removed, the |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
297 commands will replace existing variables and functions and create new ones. |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
298 |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
299 When loading a Vim9 script a second time all existing script-local functions |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
300 and variables are deleted, thus you start with a clean slate. This is useful |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
301 if you are developing a plugin and want to try a new version. If you renamed |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
302 something you don't have to worry about the old name still hanging around. |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
303 |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
304 If you do want to keep items, use: > |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
305 vim9script noclear |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
306 |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
307 You want to use this in scripts that use a `finish` command to bail out at |
| 27804 | 308 some point when loaded again. E.g. when a buffer local option is set to a |
| 309 function, the function does not need to be defined more than once: > | |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
310 vim9script noclear |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
311 setlocal completefunc=SomeFunc |
| 27804 | 312 if exists('*SomeFunc') |
| 27623 | 313 finish |
| 314 endif | |
| 27804 | 315 def SomeFunc() |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
316 .... |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
317 |
|
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
318 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
319 Variable declarations with :var, :final and :const ~ |
|
28002
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
320 *vim9-declaration* *:var* *E1079* |
| 27459 | 321 *E1017* *E1020* *E1054* *E1087* *E1108* *E1124* |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
322 Local variables need to be declared with `:var`. Local constants need to be |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
323 declared with `:final` or `:const`. We refer to both as "variables" in this |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
324 section. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
325 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
326 Variables can be local to a script, function or code block: > |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
327 vim9script |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
328 var script_var = 123 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
329 def SomeFunc() |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
330 var func_var = script_var |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
331 if cond |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
332 var block_var = func_var |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
333 ... |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
334 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
335 The variables are only visible in the block where they are defined and nested |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
336 blocks. Once the block ends the variable is no longer accessible: > |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
337 if cond |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
338 var inner = 5 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
339 else |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
340 var inner = 0 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
341 endif |
| 22171 | 342 echo inner # Error! |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
343 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
344 The declaration must be done earlier: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
345 var inner: number |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
346 if cond |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
347 inner = 5 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
348 else |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
349 inner = 0 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
350 endif |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
351 echo inner |
| 27459 | 352 < *E1025* *E1128* |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
353 To intentionally hide a variable from code that follows, a block can be |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
354 used: > |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
355 { |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
356 var temp = 'temp' |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
357 ... |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
358 } |
| 22171 | 359 echo temp # Error! |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
360 |
| 25402 | 361 This is especially useful in a user command: > |
| 362 | |
| 363 command -range Rename { | |
| 25619 | 364 var save = @a |
| 365 @a = 'some expression' | |
| 366 echo 'do something with ' .. @a | |
| 367 @a = save | |
| 368 } | |
| 25402 | 369 |
| 370 And with autocommands: > | |
| 371 | |
| 372 au BufWritePre *.go { | |
| 25619 | 373 var save = winsaveview() |
| 374 silent! exe ':%! some formatting command' | |
| 375 winrestview(save) | |
| 376 } | |
| 25402 | 377 |
| 378 Although using a :def function probably works better. | |
| 27537 | 379 *E1022* *E1103* *E1130* *E1131* *E1133* |
| 380 *E1134* *E1235* | |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
381 Declaring a variable with a type but without an initializer will initialize to |
|
26755
ddaea8dcaff5
patch 8.2.3906: Vim9 help still contains "under development" warnings
Bram Moolenaar <Bram@vim.org>
parents:
26745
diff
changeset
|
382 false (for bool), empty (for string, list, dict, etc.) or zero (for number, |
|
ddaea8dcaff5
patch 8.2.3906: Vim9 help still contains "under development" warnings
Bram Moolenaar <Bram@vim.org>
parents:
26745
diff
changeset
|
383 any, etc.). This matters especially when using the "any" type, the value will |
|
ddaea8dcaff5
patch 8.2.3906: Vim9 help still contains "under development" warnings
Bram Moolenaar <Bram@vim.org>
parents:
26745
diff
changeset
|
384 default to the number zero. |
| 27321 | 385 *E1016* *E1052* *E1066* |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
386 In Vim9 script `:let` cannot be used. An existing variable is assigned to |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
387 without any command. The same for global, window, tab, buffer and Vim |
|
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26755
diff
changeset
|
388 variables, because they are not really declared. Those can also be deleted |
|
21584
d0c76ce48326
patch 8.2.1342: Vim9: accidentally using "t" gives a confusing error
Bram Moolenaar <Bram@vim.org>
parents:
21550
diff
changeset
|
389 with `:unlet`. |
|
28002
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
390 *E1065* |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
391 You cannot use `:va` to declare a variable, it must be written with the full |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
392 name `:var`. Just to make sure it is easy to read. |
| 27537 | 393 *E1178* |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
394 `:lockvar` does not work on local variables. Use `:const` and `:final` |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
395 instead. |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
396 |
| 25619 | 397 The `exists()` and `exists_compiled()` functions do not work on local variables |
| 398 or arguments. | |
| 27537 | 399 *E1006* *E1041* *E1167* *E1168* *E1213* |
| 24024 | 400 Variables, functions and function arguments cannot shadow previously defined |
| 401 or imported variables and functions in the same script file. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
402 Variables may shadow Ex commands, rename the variable if needed. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
403 |
| 24387 | 404 Global variables must be prefixed with "g:", also at the script level. > |
| 19968 | 405 vim9script |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
406 var script_local = 'text' |
| 21499 | 407 g:global = 'value' |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
408 var Funcref = g:ThatFunction |
| 19968 | 409 |
| 27492 | 410 Global functions must be prefixed with "g:": > |
| 24387 | 411 vim9script |
| 412 def g:GlobalFunc(): string | |
| 413 return 'text' | |
| 414 enddef | |
| 27492 | 415 echo g:GlobalFunc() |
| 24387 | 416 The "g:" prefix is not needed for auto-load functions. |
| 417 | |
| 25619 | 418 *vim9-function-defined-later* |
| 419 Although global functions can be called without the "g:" prefix, they must | |
| 420 exist when compiled. By adding the "g:" prefix the function can be defined | |
| 421 later. Example: > | |
| 422 def CallPluginFunc() | |
| 423 if exists('g:loaded_plugin') | |
| 424 g:PluginFunc() | |
| 425 endif | |
| 426 enddef | |
| 427 | |
|
26873
be85735650f7
patch 8.2.3965: Vim9: no easy way to check if Vim9 script is supported
Bram Moolenaar <Bram@vim.org>
parents:
26769
diff
changeset
|
428 If you do it like this, you get an error at compile time that "PluginFunc" |
|
be85735650f7
patch 8.2.3965: Vim9: no easy way to check if Vim9 script is supported
Bram Moolenaar <Bram@vim.org>
parents:
26769
diff
changeset
|
429 does not exist, even when "g:loaded_plugin" does not exist: > |
| 25619 | 430 def CallPluginFunc() |
| 431 if exists('g:loaded_plugin') | |
| 432 PluginFunc() # Error - function not found | |
| 433 endif | |
| 434 enddef | |
| 435 | |
| 436 You can use exists_compiled() to avoid the error, but then the function would | |
| 437 not be called, even when "g:loaded_plugin" is defined later: > | |
| 438 def CallPluginFunc() | |
| 439 if exists_compiled('g:loaded_plugin') | |
| 440 PluginFunc() # Function may never be called | |
| 441 endif | |
| 442 enddef | |
| 443 | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
444 Since `&opt = value` is now assigning a value to option "opt", ":&" cannot be |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
445 used to repeat a `:substitute` command. |
| 24468 | 446 *vim9-unpack-ignore* |
|
24426
78343859f42d
patch 8.2.2753: Vim9: cannot ignore an item in assignment unpack
Bram Moolenaar <Bram@vim.org>
parents:
24408
diff
changeset
|
447 For an unpack assignment the underscore can be used to ignore a list item, |
|
78343859f42d
patch 8.2.2753: Vim9: cannot ignore an item in assignment unpack
Bram Moolenaar <Bram@vim.org>
parents:
24408
diff
changeset
|
448 similar to how a function argument can be ignored: > |
|
78343859f42d
patch 8.2.2753: Vim9: cannot ignore an item in assignment unpack
Bram Moolenaar <Bram@vim.org>
parents:
24408
diff
changeset
|
449 [a, _, c] = theList |
| 24468 | 450 To ignore any remaining items: > |
|
24426
78343859f42d
patch 8.2.2753: Vim9: cannot ignore an item in assignment unpack
Bram Moolenaar <Bram@vim.org>
parents:
24408
diff
changeset
|
451 [a, b; _] = longList |
| 27804 | 452 < *E1163* *E1080* |
|
24426
78343859f42d
patch 8.2.2753: Vim9: cannot ignore an item in assignment unpack
Bram Moolenaar <Bram@vim.org>
parents:
24408
diff
changeset
|
453 Declaring more than one variable at a time, using the unpack notation, is |
|
26346
8be6413a8e27
patch 8.2.3704: Vim9: cannot use a list declaration in a :def function
Bram Moolenaar <Bram@vim.org>
parents:
26304
diff
changeset
|
454 possible. Each variable can have a type or infer it from the value: > |
|
8be6413a8e27
patch 8.2.3704: Vim9: cannot use a list declaration in a :def function
Bram Moolenaar <Bram@vim.org>
parents:
26304
diff
changeset
|
455 var [v1: number, v2] = GetValues() |
|
8be6413a8e27
patch 8.2.3704: Vim9: cannot use a list declaration in a :def function
Bram Moolenaar <Bram@vim.org>
parents:
26304
diff
changeset
|
456 Use this only when there is a list with values, declaring one variable per |
|
8be6413a8e27
patch 8.2.3704: Vim9: cannot use a list declaration in a :def function
Bram Moolenaar <Bram@vim.org>
parents:
26304
diff
changeset
|
457 line is much easier to read and change later. |
|
24426
78343859f42d
patch 8.2.2753: Vim9: cannot ignore an item in assignment unpack
Bram Moolenaar <Bram@vim.org>
parents:
24408
diff
changeset
|
458 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
459 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
460 Constants ~ |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
461 *vim9-const* *vim9-final* |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
462 How constants work varies between languages. Some consider a variable that |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
463 can't be assigned another value a constant. JavaScript is an example. Others |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
464 also make the value immutable, thus when a constant uses a list, the list |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
465 cannot be changed. In Vim9 we can use both. |
| 27321 | 466 *E1021* |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
467 `:const` is used for making both the variable and the value a constant. Use |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
468 this for composite structures that you want to make sure will not be modified. |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
469 Example: > |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
470 const myList = [1, 2] |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
471 myList = [3, 4] # Error! |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
472 myList[0] = 9 # Error! |
| 24024 | 473 myList->add(3) # Error! |
| 27459 | 474 < *:final* *E1125* |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
475 `:final` is used for making only the variable a constant, the value can be |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
476 changed. This is well known from Java. Example: > |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
477 final myList = [1, 2] |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
478 myList = [3, 4] # Error! |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
479 myList[0] = 9 # OK |
| 24024 | 480 myList->add(3) # OK |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
481 |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
482 It is common to write constants as ALL_CAPS, but you don't have to. |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
483 |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
484 The constant only applies to the value itself, not what it refers to. > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
485 final females = ["Mary"] |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
486 const NAMES = [["John", "Peter"], females] |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
487 NAMES[0] = ["Jack"] # Error! |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
488 NAMES[0][0] = "Jack" # Error! |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
489 NAMES[1] = ["Emma"] # Error! |
| 23573 | 490 NAMES[1][0] = "Emma" # OK, now females[0] == "Emma" |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
491 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
492 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
493 Omitting :call and :eval ~ |
| 27537 | 494 *E1190* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
495 Functions can be called without `:call`: > |
| 22171 | 496 writefile(lines, 'file') |
| 19303 | 497 Using `:call` is still possible, but this is discouraged. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
498 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
499 A method call without `eval` is possible, so long as the start is an |
|
24128
fcbb1d4df15b
patch 8.2.2605: Vim9: string index and slice does not include composing chars
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
500 identifier or can't be an Ex command. For a function either "(" or "->" must |
|
fcbb1d4df15b
patch 8.2.2605: Vim9: string index and slice does not include composing chars
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
501 be following, without a line break. Examples: > |
|
21516
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
502 myList->add(123) |
|
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
503 g:myList->add(123) |
|
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
504 [1, 2, 3]->Process() |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
505 {a: 1, b: 2}->Process() |
|
21516
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
506 "foobar"->Process() |
|
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
507 ("foobar")->Process() |
|
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
508 'foobar'->Process() |
|
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
509 ('foobar')->Process() |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
510 |
| 21825 | 511 In the rare case there is ambiguity between a function name and an Ex command, |
| 21676 | 512 prepend ":" to make clear you want to use the Ex command. For example, there |
| 513 is both the `:substitute` command and the `substitute()` function. When the | |
| 514 line starts with `substitute(` this will use the function. Prepend a colon to | |
| 515 use the command instead: > | |
|
19481
c27837cbe922
patch 8.2.0298: Vim9 script: cannot start command with a string constant
Bram Moolenaar <Bram@vim.org>
parents:
19473
diff
changeset
|
516 :substitute(pattern (replacement ( |
|
19473
b09afbebffee
patch 8.2.0294: cannot use Ex command that is also a function name
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
517 |
| 25402 | 518 If the expression starts with "!" this is interpreted as a shell command, not |
| 519 negation of a condition. Thus this is a shell command: > | |
| 520 !shellCommand->something | |
| 25700 | 521 Put the expression in parentheses to use the "!" for negation: > |
| 25402 | 522 (!expression)->Method() |
| 523 | |
|
19556
ff5048b0ccfe
patch 8.2.0335: no completion for :disassemble
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
524 Note that while variables need to be defined before they can be used, |
| 21825 | 525 functions can be called before being defined. This is required to allow |
| 526 for cyclic dependencies between functions. It is slightly less efficient, | |
|
19556
ff5048b0ccfe
patch 8.2.0335: no completion for :disassemble
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
527 since the function has to be looked up by name. And a typo in the function |
|
21516
c7b2ce90c2de
patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
528 name will only be found when the function is called. |
|
19556
ff5048b0ccfe
patch 8.2.0335: no completion for :disassemble
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
529 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
530 |
| 19968 | 531 Omitting function() ~ |
| 532 | |
| 533 A user defined function can be used as a function reference in an expression | |
| 534 without `function()`. The argument types and return type will then be checked. | |
| 535 The function must already have been defined. > | |
| 536 | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
537 var Funcref = MyFunction |
| 19968 | 538 |
| 539 When using `function()` the resulting type is "func", a function with any | |
| 25161 | 540 number of arguments and any return type (including void). The function can be |
| 26708 | 541 defined later if the argument is in quotes. |
| 19968 | 542 |
| 543 | |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
544 Lambda using => instead of -> ~ |
| 24387 | 545 *vim9-lambda* |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
546 In legacy script there can be confusion between using "->" for a method call |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
547 and for a lambda. Also, when a "{" is found the parser needs to figure out if |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
548 it is the start of a lambda or a dictionary, which is now more complicated |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
549 because of the use of argument types. |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
550 |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
551 To avoid these problems Vim9 script uses a different syntax for a lambda, |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
552 which is similar to JavaScript: > |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
553 var Lambda = (arg) => expression |
| 27537 | 554 var Lambda = (arg): type => expression |
| 555 < *E1157* | |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
556 No line break is allowed in the arguments of a lambda up to and including the |
| 25056 | 557 "=>" (so that Vim can tell the difference between an expression in parentheses |
| 24911 | 558 and lambda arguments). This is OK: > |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
559 filter(list, (k, v) => |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
560 v > 0) |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
561 This does not work: > |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
562 filter(list, (k, v) |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
563 => v > 0) |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
564 This also does not work: > |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
565 filter(list, (k, |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
566 v) => v > 0) |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
567 But you can use a backslash to concatenate the lines before parsing: > |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
568 filter(list, (k, |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
569 \ v) |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
570 \ => v > 0) |
| 27537 | 571 < *vim9-lambda-arguments* *E1172* |
|
24408
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
572 In legacy script a lambda could be called with any number of extra arguments, |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
573 there was no way to warn for not using them. In Vim9 script the number of |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
574 arguments must match. If you do want to accept any arguments, or any further |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
575 arguments, use "..._", which makes the function accept |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
576 |vim9-variable-arguments|. Example: > |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
577 var Callback = (..._) => 'anything' |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
578 echo Callback(1, 2, 3) # displays "anything" |
|
96e0b898d5b4
patch 8.2.2744: Vim9: no way to explicitly ignore an argument
Bram Moolenaar <Bram@vim.org>
parents:
24387
diff
changeset
|
579 |
| 27537 | 580 < *inline-function* *E1171* |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
581 Additionally, a lambda can contain statements in {}: > |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
582 var Lambda = (arg) => { |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
583 g:was_called = 'yes' |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
584 return expression |
|
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
585 } |
| 24387 | 586 This can be useful for a timer, for example: > |
| 587 var count = 0 | |
| 588 var timer = timer_start(500, (_) => { | |
| 589 count += 1 | |
| 590 echom 'Handler called ' .. count | |
| 591 }, {repeat: 3}) | |
| 592 | |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
593 The ending "}" must be at the start of a line. It can be followed by other |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
594 characters, e.g.: > |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
595 var d = mapnew(dict, (k, v): string => { |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
596 return 'value' |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
597 }) |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
598 No command can follow the "{", only a comment can be used there. |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
599 |
| 27321 | 600 *command-block* *E1026* |
|
26612
2586659245db
patch 8.2.3835: the inline-function example does not work
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
601 The block can also be used for defining a user command. Inside the block Vim9 |
|
2586659245db
patch 8.2.3835: the inline-function example does not work
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
602 syntax will be used. |
|
2586659245db
patch 8.2.3835: the inline-function example does not work
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
603 |
| 26591 | 604 If the statements include a dictionary, its closing bracket must not be |
| 605 written at the start of a line. Otherwise, it would be parsed as the end of | |
| 606 the block. This does not work: > | |
| 607 command NewCommand { | |
|
26612
2586659245db
patch 8.2.3835: the inline-function example does not work
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
608 g:mydict = { |
| 26591 | 609 'key': 'value', |
| 610 } # ERROR: will be recognized as the end of the block | |
| 611 } | |
| 612 Put the '}' after the last item to avoid this: > | |
| 613 command NewCommand { | |
|
26612
2586659245db
patch 8.2.3835: the inline-function example does not work
Bram Moolenaar <Bram@vim.org>
parents:
26591
diff
changeset
|
614 g:mydict = { |
| 26591 | 615 'key': 'value' } |
| 616 } | |
| 617 | |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
618 Rationale: The "}" cannot be after a command because it would require parsing |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
619 the commands to find it. For consistency with that no command can follow the |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
620 "{". Unfortunately this means using "() => { command }" does not work, line |
|
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
621 breaks are always required. |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
622 |
| 23737 | 623 *vim9-curly* |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
624 To avoid the "{" of a dictionary literal to be recognized as a statement block |
| 24024 | 625 wrap it in parentheses: > |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
626 var Lambda = (arg) => ({key: 42}) |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
627 |
| 23737 | 628 Also when confused with the start of a command block: > |
| 629 ({ | |
| 630 key: value | |
| 631 })->method() | |
| 632 | |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
633 |
|
19999
844c7646f61b
patch 8.2.0555: Vim9: line continuation is not always needed
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
634 Automatic line continuation ~ |
| 27459 | 635 *vim9-line-continuation* *E1097* |
|
19999
844c7646f61b
patch 8.2.0555: Vim9: line continuation is not always needed
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
636 In many cases it is obvious that an expression continues on the next line. In |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
637 those cases there is no need to prefix the line with a backslash (see |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
638 |line-continuation|). For example, when a list spans multiple lines: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
639 var mylist = [ |
|
19999
844c7646f61b
patch 8.2.0555: Vim9: line continuation is not always needed
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
640 'one', |
|
844c7646f61b
patch 8.2.0555: Vim9: line continuation is not always needed
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
641 'two', |
|
844c7646f61b
patch 8.2.0555: Vim9: line continuation is not always needed
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
642 ] |
|
20011
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
643 And when a dict spans multiple lines: > |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
644 var mydict = { |
|
20011
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
645 one: 1, |
|
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
646 two: 2, |
|
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
647 } |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
648 With a function call: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
649 var result = Func( |
|
20011
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
650 arg1, |
|
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
651 arg2 |
|
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
652 ) |
|
628011800942
patch 8.2.0561: Vim9: cannot split function call in multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
19999
diff
changeset
|
653 |
|
20982
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
654 For binary operators in expressions not in [], {} or () a line break is |
|
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
655 possible just before or after the operator. For example: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
656 var text = lead |
|
20982
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
657 .. middle |
|
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
658 .. end |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
659 var total = start + |
| 23573 | 660 end - |
|
20013
bf377a9ffccb
patch 8.2.0562: Vim9: cannot split an expression into multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
20011
diff
changeset
|
661 correction |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
662 var result = positive |
|
20982
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
663 ? PosFunc(arg) |
|
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
664 : NegFunc(arg) |
|
20013
bf377a9ffccb
patch 8.2.0562: Vim9: cannot split an expression into multiple lines
Bram Moolenaar <Bram@vim.org>
parents:
20011
diff
changeset
|
665 |
| 21499 | 666 For a method call using "->" and a member using a dot, a line break is allowed |
| 667 before it: > | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
668 var result = GetBuilder() |
| 20965 | 669 ->BuilderSetWidth(333) |
| 670 ->BuilderSetHeight(777) | |
| 671 ->BuilderBuild() | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
672 var result = MyDict |
| 21499 | 673 .member |
| 20965 | 674 |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
675 For commands that have an argument that is a list of commands, the | character |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
676 at the start of the line indicates line continuation: > |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
677 autocmd BufNewFile *.match if condition |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
678 | echo 'match' |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
679 | endif |
|
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
680 |
| 25973 | 681 Note that this means that in heredoc the first line cannot start with a bar: > |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
682 var lines =<< trim END |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
683 | this doesn't work |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
684 END |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
685 Either use an empty line at the start or do not use heredoc. Or temporarily |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
686 add the "C" flag to 'cpoptions': > |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
687 set cpo+=C |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
688 var lines =<< trim END |
| 25973 | 689 | this works |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
690 END |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
691 set cpo-=C |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
692 If the heredoc is inside a function 'cpoptions' must be set before :def and |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
693 restored after the :enddef. |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
694 |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
695 In places where line continuation with a backslash is still needed, such as |
| 25161 | 696 splitting up a long Ex command, comments can start with '#\ ': > |
| 697 syn region Text | |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
698 \ start='foo' |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
699 #\ comment |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
700 \ end='bar' |
| 25161 | 701 Like with legacy script '"\ ' is used. This is also needed when line |
| 702 continuation is used without a backslash and a line starts with a bar: > | |
| 703 au CursorHold * echom 'BEFORE bar' | |
| 704 #\ some comment | |
| 705 | echom 'AFTER bar' | |
| 706 < | |
| 707 *E1050* | |
|
20982
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
708 To make it possible for the operator at the start of the line to be |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
709 recognized, it is required to put a colon before a range. This example will |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
710 add "start" and print: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
711 var result = start |
|
20982
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
712 + print |
| 21250 | 713 Like this: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
714 var result = start + print |
| 21250 | 715 |
|
20982
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
716 This will assign "start" and print a line: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
717 var result = start |
|
20982
bb49b5090a9c
patch 8.2.1042: Vim9: cannot put an operator on the next line
Bram Moolenaar <Bram@vim.org>
parents:
20965
diff
changeset
|
718 :+ print |
|
19999
844c7646f61b
patch 8.2.0555: Vim9: line continuation is not always needed
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
719 |
| 27321 | 720 After the range an Ex command must follow. Without the colon you can call a |
| 721 function without `:call`, but after a range you do need it: > | |
| 722 MyFunc() | |
| 723 :% call MyFunc() | |
| 724 | |
| 23047 | 725 Note that the colon is not required for the |+cmd| argument: > |
| 726 edit +6 fname | |
| 727 | |
|
20015
c001ee73519a
patch 8.2.0563: Vim9: cannot split a function line
Bram Moolenaar <Bram@vim.org>
parents:
20013
diff
changeset
|
728 It is also possible to split a function header over multiple lines, in between |
|
c001ee73519a
patch 8.2.0563: Vim9: cannot split a function line
Bram Moolenaar <Bram@vim.org>
parents:
20013
diff
changeset
|
729 arguments: > |
|
c001ee73519a
patch 8.2.0563: Vim9: cannot split a function line
Bram Moolenaar <Bram@vim.org>
parents:
20013
diff
changeset
|
730 def MyFunc( |
|
c001ee73519a
patch 8.2.0563: Vim9: cannot split a function line
Bram Moolenaar <Bram@vim.org>
parents:
20013
diff
changeset
|
731 text: string, |
|
c001ee73519a
patch 8.2.0563: Vim9: cannot split a function line
Bram Moolenaar <Bram@vim.org>
parents:
20013
diff
changeset
|
732 separator = '-' |
|
c001ee73519a
patch 8.2.0563: Vim9: cannot split a function line
Bram Moolenaar <Bram@vim.org>
parents:
20013
diff
changeset
|
733 ): string |
|
c001ee73519a
patch 8.2.0563: Vim9: cannot split a function line
Bram Moolenaar <Bram@vim.org>
parents:
20013
diff
changeset
|
734 |
| 23305 | 735 Since a continuation line cannot be easily recognized the parsing of commands |
|
23318
c76240efdf02
patch 8.2.2204: Vim9: using -> both for method and lambda is confusing
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
736 has been made stricter. E.g., because of the error in the first line, the |
| 23305 | 737 second line is seen as a separate command: > |
| 738 popup_create(some invalid expression, { | |
| 739 exit_cb: Func}) | |
| 740 Now "exit_cb: Func})" is actually a valid command: save any changes to the | |
| 741 file "_cb: Func})" and exit. To avoid this kind of mistake in Vim9 script | |
| 742 there must be white space between most command names and the argument. | |
| 27459 | 743 *E1144* |
| 23305 | 744 |
| 23666 | 745 However, the argument of a command that is a command won't be recognized. For |
| 746 example, after "windo echo expr" a line break inside "expr" will not be seen. | |
| 747 | |
| 23305 | 748 |
| 21250 | 749 Notes: |
| 750 - "enddef" cannot be used at the start of a continuation line, it ends the | |
| 751 current function. | |
| 752 - No line break is allowed in the LHS of an assignment. Specifically when | |
| 753 unpacking a list |:let-unpack|. This is OK: > | |
| 22171 | 754 [var1, var2] = |
| 21250 | 755 Func() |
| 756 < This does not work: > | |
| 22171 | 757 [var1, |
| 21250 | 758 var2] = |
| 759 Func() | |
| 760 - No line break is allowed in between arguments of an `:echo`, `:execute` and | |
| 761 similar commands. This is OK: > | |
| 22171 | 762 echo [1, |
| 21250 | 763 2] [3, |
| 764 4] | |
| 765 < This does not work: > | |
| 22171 | 766 echo [1, 2] |
| 21250 | 767 [3, 4] |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
768 - In some cases it is difficult for Vim to parse a command, especially when |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
769 commands are used as an argument to another command, such as `windo`. In |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
770 those cases the line continuation with a backslash has to be used. |
|
19999
844c7646f61b
patch 8.2.0555: Vim9: line continuation is not always needed
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
771 |
| 24569 | 772 |
| 773 White space ~ | |
| 27537 | 774 *E1004* *E1068* *E1069* *E1074* *E1127* *E1202* |
| 24569 | 775 Vim9 script enforces proper use of white space. This is no longer allowed: > |
| 776 var name=234 # Error! | |
| 777 var name= 234 # Error! | |
| 778 var name =234 # Error! | |
| 779 There must be white space before and after the "=": > | |
| 780 var name = 234 # OK | |
| 781 White space must also be put before the # that starts a comment after a | |
| 782 command: > | |
| 783 var name = 234# Error! | |
| 784 var name = 234 # OK | |
| 785 | |
| 786 White space is required around most operators. | |
| 787 | |
| 788 White space is required in a sublist (list slice) around the ":", except at | |
| 789 the start and end: > | |
| 790 otherlist = mylist[v : count] # v:count has a different meaning | |
| 791 otherlist = mylist[:] # make a copy of the List | |
| 792 otherlist = mylist[v :] | |
| 793 otherlist = mylist[: v] | |
| 794 | |
| 795 White space is not allowed: | |
| 796 - Between a function name and the "(": > | |
| 797 Func (arg) # Error! | |
| 798 Func | |
| 799 \ (arg) # Error! | |
| 800 Func | |
| 801 (arg) # Error! | |
| 802 Func(arg) # OK | |
| 803 Func( | |
| 804 arg) # OK | |
| 805 Func( | |
| 806 arg # OK | |
| 807 ) | |
| 27537 | 808 < *E1205* |
| 25700 | 809 White space is not allowed in a `:set` command between the option name and a |
| 810 following "&", "!", "<", "=", "+=", "-=" or "^=". | |
| 25402 | 811 |
| 24569 | 812 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
813 No curly braces expansion ~ |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
814 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
815 |curly-braces-names| cannot be used. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
816 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
817 |
| 27537 | 818 Command modifiers are not ignored ~ |
| 819 *E1176* | |
| 820 Using a command modifier for a command that does not use it gives an error. | |
| 821 | |
| 822 | |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
823 Dictionary literals ~ |
| 27321 | 824 *vim9-literal-dict* *E1014* |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
825 Traditionally Vim has supported dictionary literals with a {} syntax: > |
|
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
826 let dict = {'key': value} |
|
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
827 |
|
23088
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
828 Later it became clear that using a simple text key is very common, thus |
|
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
829 literal dictionaries were introduced in a backwards compatible way: > |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
830 let dict = #{key: value} |
|
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
831 |
|
23088
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
832 However, this #{} syntax is unlike any existing language. As it turns out |
|
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
833 that using a literal key is much more common than using an expression, and |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
834 considering that JavaScript uses this syntax, using the {} form for dictionary |
|
23088
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
835 literals is considered a much more useful syntax. In Vim9 script the {} form |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
836 uses literal keys: > |
| 23666 | 837 var dict = {key: value} |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
838 |
|
23088
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
839 This works for alphanumeric characters, underscore and dash. If you want to |
|
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
840 use another character, use a single or double quoted string: > |
| 23666 | 841 var dict = {'key with space': value} |
| 842 var dict = {"key\twith\ttabs": value} | |
| 843 var dict = {'': value} # empty key | |
| 27459 | 844 < *E1139* |
|
23088
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
845 In case the key needs to be an expression, square brackets can be used, just |
|
285cde4b8d0e
patch 8.2.2090: Vim9: dict does not accept a key in quotes
Bram Moolenaar <Bram@vim.org>
parents:
23047
diff
changeset
|
846 like in JavaScript: > |
| 23666 | 847 var dict = {["key" .. nr]: value} |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
848 |
|
23827
7e0d8f1cae7d
patch 8.2.2455: Vim9: key type for literal dict and indexing is inconsistent
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
849 The key type can be string, number, bool or float. Other types result in an |
|
7e0d8f1cae7d
patch 8.2.2455: Vim9: key type for literal dict and indexing is inconsistent
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
850 error. A number can be given with and without the []: > |
|
7e0d8f1cae7d
patch 8.2.2455: Vim9: key type for literal dict and indexing is inconsistent
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
851 var dict = {123: 'without', [456]: 'with'} |
|
7e0d8f1cae7d
patch 8.2.2455: Vim9: key type for literal dict and indexing is inconsistent
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
852 echo dict |
|
7e0d8f1cae7d
patch 8.2.2455: Vim9: key type for literal dict and indexing is inconsistent
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
853 {'456': 'with', '123': 'without'} |
|
7e0d8f1cae7d
patch 8.2.2455: Vim9: key type for literal dict and indexing is inconsistent
Bram Moolenaar <Bram@vim.org>
parents:
23737
diff
changeset
|
854 |
|
22936
00b0275ffe7f
patch 8.2.2015: Vim9: literal dict #{} is not like any other language
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
855 |
|
23978
54b2aa1f0d42
patch 8.2.2531: Vim9: the :k command is obscure
Bram Moolenaar <Bram@vim.org>
parents:
23974
diff
changeset
|
856 No :xit, :t, :k, :append, :change or :insert ~ |
| 27459 | 857 *E1100* |
|
21584
d0c76ce48326
patch 8.2.1342: Vim9: accidentally using "t" gives a confusing error
Bram Moolenaar <Bram@vim.org>
parents:
21550
diff
changeset
|
858 These commands are too easily confused with local variable names. |
|
d0c76ce48326
patch 8.2.1342: Vim9: accidentally using "t" gives a confusing error
Bram Moolenaar <Bram@vim.org>
parents:
21550
diff
changeset
|
859 Instead of `:x` or `:xit` you can use `:exit`. |
|
d0c76ce48326
patch 8.2.1342: Vim9: accidentally using "t" gives a confusing error
Bram Moolenaar <Bram@vim.org>
parents:
21550
diff
changeset
|
860 Instead of `:t` you can use `:copy`. |
|
23978
54b2aa1f0d42
patch 8.2.2531: Vim9: the :k command is obscure
Bram Moolenaar <Bram@vim.org>
parents:
23974
diff
changeset
|
861 Instead of `:k` you can use `:mark`. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
862 |
| 19303 | 863 |
| 864 Comparators ~ | |
| 865 | |
| 866 The 'ignorecase' option is not used for comparators that use strings. | |
| 27804 | 867 Thus "=~" works like "=~#". |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
868 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
869 |
| 24569 | 870 Abort after error ~ |
| 871 | |
| 872 In legacy script, when an error is encountered, Vim continues to execute | |
| 873 following lines. This can lead to a long sequence of errors and need to type | |
| 874 CTRL-C to stop it. In Vim9 script execution of commands stops at the first | |
| 875 error. Example: > | |
| 876 vim9script | |
| 877 var x = does-not-exist | |
| 878 echo 'not executed' | |
| 879 | |
| 880 | |
| 23666 | 881 For loop ~ |
| 27537 | 882 *E1254* |
| 26438 | 883 The loop variable must not be declared yet: > |
| 26304 | 884 var i = 1 |
| 885 for i in [1, 2, 3] # Error! | |
| 886 | |
| 26438 | 887 It is possible to use a global variable though: > |
| 888 g:i = 1 | |
| 889 for g:i in [1, 2, 3] | |
| 890 echo g:i | |
| 891 endfor | |
| 892 | |
| 23666 | 893 Legacy Vim script has some tricks to make a for loop over a list handle |
| 894 deleting items at the current or previous item. In Vim9 script it just uses | |
| 895 the index, if items are deleted then items in the list will be skipped. | |
| 896 Example legacy script: > | |
| 897 let l = [1, 2, 3, 4] | |
| 898 for i in l | |
| 899 echo i | |
| 900 call remove(l, index(l, i)) | |
| 901 endfor | |
| 902 Would echo: | |
| 903 1 | |
| 904 2 | |
| 905 3 | |
| 906 4 | |
| 907 In compiled Vim9 script you get: | |
| 908 1 | |
| 909 3 | |
| 910 Generally, you should not change the list that is iterated over. Make a copy | |
| 911 first if needed. | |
| 912 | |
| 913 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
914 Conditions and expressions ~ |
| 27321 | 915 *vim9-boolean* |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
916 Conditions and expressions are mostly working like they do in other languages. |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
917 Some values are different from legacy Vim script: |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
918 value legacy Vim script Vim9 script ~ |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
919 0 falsy falsy |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
920 1 truthy truthy |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
921 99 truthy Error! |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
922 "0" falsy Error! |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
923 "99" truthy Error! |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
924 "text" falsy Error! |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
925 |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
926 For the "??" operator and when using "!" then there is no error, every value |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
927 is either falsy or truthy. This is mostly like JavaScript, except that an |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
928 empty list and dict is falsy: |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
929 |
|
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
930 type truthy when ~ |
| 23466 | 931 bool true, v:true or 1 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
932 number non-zero |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
933 float non-zero |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
934 string non-empty |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
935 blob non-empty |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
936 list non-empty (different from JavaScript) |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
937 dictionary non-empty (different from JavaScript) |
| 19968 | 938 func when there is a function name |
| 23466 | 939 special true or v:true |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
940 job when not NULL |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
941 channel when not NULL |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
942 class when not NULL |
| 23466 | 943 object when not NULL (TODO: when isTrue() returns true) |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
944 |
|
22494
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
945 The boolean operators "||" and "&&" expect the values to be boolean, zero or |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
946 one: > |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
947 1 || false == true |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
948 0 || 1 == true |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
949 0 || false == false |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
950 1 && true == true |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
951 0 && 1 == false |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
952 8 || 0 Error! |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
953 'yes' && 0 Error! |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
954 [] || 99 Error! |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
955 |
|
22494
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
956 When using "!" for inverting, there is no error for using any type and the |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
957 result is a boolean. "!!" can be used to turn any value into boolean: > |
| 23573 | 958 !'yes' == false |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
959 !![] == false |
| 23573 | 960 !![1, 2, 3] == true |
|
22494
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
961 |
|
4c21f7f6f9e3
patch 8.2.1795: Vim9: operators && and || have a confusing result
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
962 When using "`.."` for string concatenation arguments of simple types are |
|
22500
ef8a3177edc1
patch 8.2.1798: Vim9: trinary operator condition is too permissive
Bram Moolenaar <Bram@vim.org>
parents:
22494
diff
changeset
|
963 always converted to string: > |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
964 'hello ' .. 123 == 'hello 123' |
| 23466 | 965 'hello ' .. v:true == 'hello true' |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
966 |
|
26769
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26755
diff
changeset
|
967 Simple types are Number, Float, Special and Bool. For other types |string()| |
|
30972227ac8d
patch 8.2.3913: help for expressions does not mention Vim9 syntax
Bram Moolenaar <Bram@vim.org>
parents:
26755
diff
changeset
|
968 should be used. |
| 27321 | 969 *false* *true* *null* *E1034* |
|
28002
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
970 In Vim9 script one can use the following predefined values: > |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
971 true |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
972 false |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
973 null |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
974 null_blob |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
975 null_channel |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
976 null_dict |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
977 null_function |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
978 null_job |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
979 null_list |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
980 null_partial |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
981 null_string |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
982 `true` is the same as `v:true`, `false` the same as `v:false`, `null` the same |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
983 as `v:null`. |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
984 |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
985 While `null` has the type "special", the other "null_" types have the type |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
986 indicated by their name. Quite often a null value is handled the same as an |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
987 empty value, but not always. The values can be useful to clear a script-local |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
988 variable, since they cannot be deleted with `:unlet`. E.g.: > |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
989 var theJob = job_start(...) |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
990 # let the job do its work |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
991 theJob = null_job |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
992 |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
993 The values can also be useful as the default value for an argument: > |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
994 def MyFunc(b: blob = null_blob) |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
995 if b == null_blob |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
996 # b argument was not given |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
997 |
| 28141 | 998 It is possible to compare `null` with any value, this will not give a type |
| 999 error. However, comparing `null` with a number, float or bool will always | |
| 1000 result in `false`. This is different from legacy script, where comparing | |
| 1001 `null` with zero or `false` would return `true`. | |
| 1002 | |
|
28002
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
1003 When converting a boolean to a string `false` and `true` are used, not |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
1004 `v:false` and `v:true` like in legacy script. `v:none` has no `none` |
|
1012048eed26
patch 8.2.4526: Vim9: cannot set variables to a null value
Bram Moolenaar <Bram@vim.org>
parents:
27903
diff
changeset
|
1005 replacement, it has no equivalent in other languages. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1006 |
|
24128
fcbb1d4df15b
patch 8.2.2605: Vim9: string index and slice does not include composing chars
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1007 Indexing a string with [idx] or taking a slice with [idx : idx] uses character |
|
fcbb1d4df15b
patch 8.2.2605: Vim9: string index and slice does not include composing chars
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1008 indexes instead of byte indexes. Composing characters are included. |
|
fcbb1d4df15b
patch 8.2.2605: Vim9: string index and slice does not include composing chars
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1009 Example: > |
| 21825 | 1010 echo 'bár'[1] |
| 1011 In legacy script this results in the character 0xc3 (an illegal byte), in Vim9 | |
| 1012 script this results in the string 'á'. | |
| 23573 | 1013 A negative index is counting from the end, "[-1]" is the last character. |
| 23666 | 1014 To exclude the last character use |slice()|. |
|
24272
cabed216cc2f
patch 8.2.2677: Vim9: cannot use only some of the default arguments
Bram Moolenaar <Bram@vim.org>
parents:
24150
diff
changeset
|
1015 To count composing characters separately use |strcharpart()|. |
| 23573 | 1016 If the index is out of range then an empty string results. |
| 1017 | |
| 1018 In legacy script "++var" and "--var" would be silently accepted and have no | |
| 1019 effect. This is an error in Vim9 script. | |
| 1020 | |
| 1021 Numbers starting with zero are not considered to be octal, only numbers | |
| 1022 starting with "0o" are octal: "0o744". |scriptversion-4| | |
| 21825 | 1023 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1024 |
| 21093 | 1025 What to watch out for ~ |
| 1026 *vim9-gotchas* | |
| 1027 Vim9 was designed to be closer to often used programming languages, but at the | |
| 1028 same time tries to support the legacy Vim commands. Some compromises had to | |
| 1029 be made. Here is a summary of what might be unexpected. | |
| 1030 | |
| 1031 Ex command ranges need to be prefixed with a colon. > | |
| 23666 | 1032 -> legacy Vim: shifts the previous line to the right |
| 1033 ->func() Vim9: method call in a continuation line | |
| 1034 :-> Vim9: shifts the previous line to the right | |
| 21093 | 1035 |
| 23666 | 1036 %s/a/b legacy Vim: substitute on all lines |
| 21093 | 1037 x = alongname |
| 23666 | 1038 % another Vim9: modulo operator in a continuation line |
| 1039 :%s/a/b Vim9: substitute on all lines | |
| 1040 't legacy Vim: jump to mark t | |
| 1041 'text'->func() Vim9: method call | |
| 1042 :'t Vim9: jump to mark t | |
| 21093 | 1043 |
| 21676 | 1044 Some Ex commands can be confused with assignments in Vim9 script: > |
| 23666 | 1045 g:name = value # assignment |
|
25939
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1046 :g:pattern:cmd # :global command |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1047 |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1048 To avoid confusion between a `:global` or `:substitute` command and an |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1049 expression or assignment, a few separators cannot be used when these commands |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1050 are abbreviated to a single character: ':', '-' and '.'. > |
| 23666 | 1051 g:pattern:cmd # invalid command - ERROR |
|
25939
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1052 s:pattern:repl # invalid command - ERROR |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1053 g-pattern-cmd # invalid command - ERROR |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1054 s-pattern-repl # invalid command - ERROR |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1055 g.pattern.cmd # invalid command - ERROR |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1056 s.pattern.repl # invalid command - ERROR |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1057 |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1058 Also, there cannot be a space between the command and the separator: > |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1059 g /pattern/cmd # invalid command - ERROR |
|
377a7686a52f
patch 8.2.3503: Vim9: using g:pat:cmd is confusing
Bram Moolenaar <Bram@vim.org>
parents:
25836
diff
changeset
|
1060 s /pattern/repl # invalid command - ERROR |
| 21676 | 1061 |
| 21093 | 1062 Functions defined with `:def` compile the whole function. Legacy functions |
| 1063 can bail out, and the following lines are not parsed: > | |
| 1064 func Maybe() | |
| 1065 if !has('feature') | |
| 1066 return | |
| 1067 endif | |
| 1068 use-feature | |
| 1069 endfunc | |
| 1070 Vim9 functions are compiled as a whole: > | |
| 1071 def Maybe() | |
| 1072 if !has('feature') | |
| 1073 return | |
| 1074 endif | |
| 23573 | 1075 use-feature # May give a compilation error |
| 21093 | 1076 enddef |
| 1077 For a workaround, split it in two functions: > | |
| 1078 func Maybe() | |
| 1079 if has('feature') | |
| 23666 | 1080 call MaybeInner() |
| 21093 | 1081 endif |
| 1082 endfunc | |
| 1083 if has('feature') | |
| 1084 def MaybeInner() | |
| 1085 use-feature | |
| 1086 enddef | |
| 1087 endif | |
| 22171 | 1088 Or put the unsupported code inside an `if` with a constant expression that |
| 21991 | 1089 evaluates to false: > |
| 1090 def Maybe() | |
| 1091 if has('feature') | |
| 1092 use-feature | |
| 1093 endif | |
| 1094 enddef | |
| 25619 | 1095 The `exists_compiled()` function can also be used for this. |
| 1096 *vim9-user-command* | |
| 23666 | 1097 Another side effect of compiling a function is that the presence of a user |
| 23573 | 1098 command is checked at compile time. If the user command is defined later an |
| 1099 error will result. This works: > | |
| 1100 command -nargs=1 MyCommand echom <q-args> | |
| 1101 def Works() | |
| 1102 MyCommand 123 | |
| 1103 enddef | |
| 1104 This will give an error for "MyCommand" not being defined: > | |
| 1105 def Works() | |
| 1106 command -nargs=1 MyCommand echom <q-args> | |
| 1107 MyCommand 123 | |
| 1108 enddef | |
| 1109 A workaround is to invoke the command indirectly with `:execute`: > | |
| 1110 def Works() | |
| 1111 command -nargs=1 MyCommand echom <q-args> | |
| 1112 execute 'MyCommand 123' | |
| 1113 enddef | |
| 1114 | |
| 21991 | 1115 Note that for unrecognized commands there is no check for "|" and a following |
| 1116 command. This will give an error for missing `endif`: > | |
| 1117 def Maybe() | |
| 1118 if has('feature') | use-feature | endif | |
| 1119 enddef | |
| 21093 | 1120 |
| 23305 | 1121 Other differences ~ |
| 1122 | |
| 1123 Patterns are used like 'magic' is set, unless explicitly overruled. | |
| 1124 The 'edcompatible' option value is not used. | |
| 1125 The 'gdefault' option value is not used. | |
| 1126 | |
| 24387 | 1127 You may also find this wiki useful. It was written by an early adopter of |
| 24103 | 1128 Vim9 script: https://github.com/lacygoill/wiki/blob/master/vim/vim9.md |
| 23305 | 1129 |
| 25056 | 1130 *:++* *:--* |
| 1131 The ++ and -- commands have been added. They are very similar to adding or | |
| 1132 subtracting one: > | |
| 1133 ++var | |
| 1134 var += 1 | |
| 1135 --var | |
| 1136 var -= 1 | |
| 1137 | |
| 1138 Using ++var or --var in an expression is not supported yet. | |
| 1139 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1140 ============================================================================== |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1141 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1142 3. New style functions *fast-functions* |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1143 |
| 27321 | 1144 *:def* *E1028* |
| 21825 | 1145 :def[!] {name}([arguments])[: {return-type}] |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1146 Define a new function by the name {name}. The body of |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1147 the function follows in the next lines, until the |
| 27321 | 1148 matching `:enddef`. *E1073* |
| 1149 *E1011* | |
| 1150 The {name} must be less than 100 bytes long. | |
| 1151 *E1003* *E1027* *E1056* *E1059* | |
| 1152 The type of value used with `:return` must match | |
| 1153 {return-type}. When {return-type} is omitted or is | |
| 1154 "void" the function is not expected to return | |
| 1155 anything. | |
| 27459 | 1156 *E1077* *E1123* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1157 {arguments} is a sequence of zero or more argument |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1158 declarations. There are three forms: |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1159 {name}: {type} |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1160 {name} = {value} |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1161 {name}: {type} = {value} |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1162 The first form is a mandatory argument, the caller |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1163 must always provide them. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1164 The second and third form are optional arguments. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1165 When the caller omits an argument the {value} is used. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1166 |
| 20856 | 1167 The function will be compiled into instructions when |
| 21499 | 1168 called, or when `:disassemble` or `:defcompile` is |
| 1169 used. Syntax and type errors will be produced at that | |
| 1170 time. | |
| 20856 | 1171 |
| 21499 | 1172 It is possible to nest `:def` inside another `:def` or |
| 1173 `:function` up to about 50 levels deep. | |
| 27459 | 1174 *E1117* |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1175 [!] is used as with `:function`. Note that |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1176 script-local functions cannot be deleted or redefined |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1177 later in Vim9 script. They can only be removed by |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1178 reloading the same script. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1179 |
| 27537 | 1180 *:enddef* *E1057* *E1152* *E1173* |
| 21499 | 1181 :enddef End of a function defined with `:def`. It should be on |
| 1182 a line by its own. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1183 |
| 24387 | 1184 You may also find this wiki useful. It was written by an early adopter of |
|
24128
fcbb1d4df15b
patch 8.2.2605: Vim9: string index and slice does not include composing chars
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1185 Vim9 script: https://github.com/lacygoill/wiki/blob/master/vim/vim9.md |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1186 |
|
19473
b09afbebffee
patch 8.2.0294: cannot use Ex command that is also a function name
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
1187 If the script the function is defined in is Vim9 script, then script-local |
|
b09afbebffee
patch 8.2.0294: cannot use Ex command that is also a function name
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
1188 variables can be accessed without the "s:" prefix. They must be defined |
| 20856 | 1189 before the function is compiled. If the script the function is defined in is |
| 1190 legacy script, then script-local variables must be accessed with the "s:" | |
| 24387 | 1191 prefix if they do not exist at the time of compiling. |
|
19473
b09afbebffee
patch 8.2.0294: cannot use Ex command that is also a function name
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
1192 |
| 20552 | 1193 *:defc* *:defcompile* |
| 1194 :defc[ompile] Compile functions defined in the current script that | |
| 1195 were not compiled yet. | |
| 1196 This will report errors found during the compilation. | |
|
19473
b09afbebffee
patch 8.2.0294: cannot use Ex command that is also a function name
Bram Moolenaar <Bram@vim.org>
parents:
19404
diff
changeset
|
1197 |
| 19404 | 1198 *:disa* *:disassemble* |
| 1199 :disa[ssemble] {func} Show the instructions generated for {func}. | |
| 27321 | 1200 This is for debugging and testing. *E1061* |
|
19556
ff5048b0ccfe
patch 8.2.0335: no completion for :disassemble
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
1201 Note that for command line completion of {func} you |
|
ff5048b0ccfe
patch 8.2.0335: no completion for :disassemble
Bram Moolenaar <Bram@vim.org>
parents:
19523
diff
changeset
|
1202 can prepend "s:" to find script-local functions. |
| 19404 | 1203 |
| 24911 | 1204 :disa[ssemble] profile {func} |
| 1205 Like `:disassemble` but with the instructions used for | |
| 23737 | 1206 profiling. |
| 1207 | |
| 24911 | 1208 :disa[ssemble] debug {func} |
| 1209 Like `:disassemble` but with the instructions used for | |
| 1210 debugging. | |
| 1211 | |
| 21250 | 1212 Limitations ~ |
| 1213 | |
| 1214 Local variables will not be visible to string evaluation. For example: > | |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
1215 def MapList(): list<string> |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1216 var list = ['aa', 'bb', 'cc', 'dd'] |
| 21250 | 1217 return range(1, 2)->map('list[v:val]') |
| 1218 enddef | |
| 1219 | |
| 1220 The map argument is a string expression, which is evaluated without the | |
| 1221 function scope. Instead, use a lambda: > | |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
1222 def MapList(): list<string> |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1223 var list = ['aa', 'bb', 'cc', 'dd'] |
| 25973 | 1224 return range(1, 2)->map((_, v) => list[v]) |
| 21250 | 1225 enddef |
| 1226 | |
|
26358
80b555c4aed0
patch 8.2.3710: Vim9: backtick expression expanded for :global
Bram Moolenaar <Bram@vim.org>
parents:
26346
diff
changeset
|
1227 For commands that are not compiled, such as `:edit`, backtick expansion can be |
|
80b555c4aed0
patch 8.2.3710: Vim9: backtick expression expanded for :global
Bram Moolenaar <Bram@vim.org>
parents:
26346
diff
changeset
|
1228 used and it can use the local scope. Example: > |
|
23358
b3142fc0a414
patch 8.2.2222: Vim9: cannot keep script variables when reloading
Bram Moolenaar <Bram@vim.org>
parents:
23318
diff
changeset
|
1229 def Replace() |
|
26358
80b555c4aed0
patch 8.2.3710: Vim9: backtick expression expanded for :global
Bram Moolenaar <Bram@vim.org>
parents:
26346
diff
changeset
|
1230 var fname = 'blah.txt' |
|
80b555c4aed0
patch 8.2.3710: Vim9: backtick expression expanded for :global
Bram Moolenaar <Bram@vim.org>
parents:
26346
diff
changeset
|
1231 edit `=fname` |
| 25402 | 1232 enddef |
| 1233 | |
| 24278 | 1234 Closures defined in a loop will share the same context. For example: > |
| 1235 var flist: list<func> | |
| 25402 | 1236 for i in range(5) |
| 24278 | 1237 var inloop = i |
| 1238 flist[i] = () => inloop | |
| 1239 endfor | |
| 25402 | 1240 echo range(5)->map((i, _) => flist[i]()) |
| 1241 # Result: [4, 4, 4, 4, 4] | |
| 28141 | 1242 < *E1271* |
| 1243 A closure must be compiled in the context that it is defined in, so that | |
| 1244 variables in that context can be found. This mostly happens correctly, except | |
| 1245 when a function is marked for debugging with `breakadd` after it was compiled. | |
| 1246 Make sure the define the breakpoint before compiling the outerh function. | |
| 24278 | 1247 |
| 1248 The "inloop" variable will exist only once, all closures put in the list refer | |
| 25402 | 1249 to the same instance, which in the end will have the value 4. This is |
| 1250 efficient, also when looping many times. If you do want a separate context | |
| 1251 for each closure call a function to define it: > | |
| 1252 def GetClosure(i: number): func | |
| 1253 var infunc = i | |
| 1254 return () => infunc | |
| 24278 | 1255 enddef |
| 1256 | |
| 1257 var flist: list<func> | |
| 25402 | 1258 for i in range(5) |
| 1259 flist[i] = GetClosure(i) | |
| 24278 | 1260 endfor |
| 25402 | 1261 echo range(5)->map((i, _) => flist[i]()) |
| 1262 # Result: [0, 1, 2, 3, 4] | |
| 24278 | 1263 |
| 27537 | 1264 In some situations, especially when calling a Vim9 closure from legacy |
| 1265 context, the evaluation will fail. *E1248* | |
| 1266 | |
| 1267 | |
| 1268 Converting a function from legacy to Vim9 ~ | |
| 1269 *convert_legacy_function_to_vim9* | |
| 1270 These are the most changes that need to be made to convert a legacy function | |
| 1271 to a Vim9 function: | |
| 1272 | |
| 1273 - Change `func` or `function` to `def`. | |
| 1274 - Change `endfunc` or `endfunction` to `enddef`. | |
| 1275 - Add types to the function arguments. | |
| 1276 - If the function returns something, add the return type. | |
| 1277 - Change comments to start with # instead of ". | |
| 1278 | |
| 1279 For example, a legacy function: > | |
| 1280 func MyFunc(text) | |
| 1281 " function body | |
| 1282 endfunc | |
| 1283 < Becomes: > | |
| 1284 def MyFunc(text: string): number | |
| 1285 # function body | |
| 1286 enddef | |
| 1287 | |
| 1288 - Remove "a:" used for arguments. E.g.: > | |
| 1289 return len(a:text) | |
| 1290 < Becomes: > | |
| 1291 return len(text) | |
| 1292 | |
| 1293 - Change `let` used to declare a variable to `var`. | |
| 1294 - Remove `let` used to assign a value to a variable. This is for local | |
| 1295 variables already declared and b: w: g: and t: variables. | |
| 1296 | |
| 1297 For example, legacy function: > | |
| 1298 let lnum = 1 | |
| 1299 let lnum += 3 | |
| 1300 let b:result = 42 | |
| 1301 < Becomes: > | |
| 1302 var lnum = 1 | |
| 1303 lnum += 3 | |
| 1304 b:result = 42 | |
| 1305 | |
| 1306 - Insert white space in expressions where needed. | |
| 1307 - Change "." used for concatenation to "..". | |
| 1308 | |
| 1309 For example, legacy function: > | |
| 1310 echo line(1).line(2) | |
| 1311 < Becomes: > | |
| 1312 echo line(1) .. line(2) | |
| 1313 | |
| 1314 - line continuation does not always require a backslash: > | |
| 1315 echo ['one', | |
| 1316 \ 'two', | |
| 1317 \ 'three' | |
| 1318 \ ] | |
| 1319 < Becomes: > | |
| 1320 echo ['one', | |
| 1321 'two', | |
| 1322 'three' | |
| 1323 ] | |
| 1324 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1325 ============================================================================== |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1326 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1327 4. Types *vim9-types* |
| 27321 | 1328 *E1008* *E1009* *E1010* *E1012* |
| 1329 *E1013* *E1029* *E1030* | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1330 The following builtin types are supported: |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1331 bool |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1332 number |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1333 float |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1334 string |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1335 blob |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1336 list<{type}> |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1337 dict<{type}> |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1338 job |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1339 channel |
| 19646 | 1340 func |
| 19968 | 1341 func: {type} |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1342 func({type}, ...) |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1343 func({type}, ...): {type} |
| 27321 | 1344 void |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1345 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1346 Not supported yet: |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1347 tuple<a: {type}, b: {type}, ...> |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1348 |
| 25161 | 1349 These types can be used in declarations, but no simple value will actually |
| 27321 | 1350 have the "void" type. Trying to use a void (e.g. a function without a |
| 27537 | 1351 return value) results in error *E1031* *E1186* . |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1352 |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1353 There is no array type, use list<{type}> instead. For a list constant an |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1354 efficient implementation is used that avoids allocating lot of small pieces of |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1355 memory. |
| 27321 | 1356 *E1005* *E1007* |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1357 A partial and function can be declared in more or less specific ways: |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1358 func any kind of function reference, no type |
| 19968 | 1359 checking for arguments or return value |
| 25161 | 1360 func: void any number and type of arguments, no return |
| 1361 value | |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1362 func: {type} any number and type of arguments with specific |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1363 return type |
| 25161 | 1364 |
| 1365 func() function with no argument, does not return a | |
| 1366 value | |
| 1367 func(): void same | |
| 1368 func(): {type} function with no argument and return type | |
| 1369 | |
| 19968 | 1370 func({type}) function with argument type, does not return |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1371 a value |
| 19968 | 1372 func({type}): {type} function with argument type and return type |
| 1373 func(?{type}) function with type of optional argument, does | |
| 1374 not return a value | |
| 1375 func(...{type}) function with type of variable number of | |
| 1376 arguments, does not return a value | |
| 1377 func({type}, ?{type}, ...{type}): {type} | |
| 1378 function with: | |
| 1379 - type of mandatory argument | |
| 1380 - type of optional argument | |
| 1381 - type of variable number of arguments | |
| 1382 - return type | |
|
19904
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1383 |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1384 If the return type is "void" the function does not return a value. |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1385 |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1386 The reference can also be a |Partial|, in which case it stores extra arguments |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1387 and/or a dictionary, which are not visible to the caller. Since they are |
|
bd4f91762d0f
patch 8.2.0508: Vim9: func and partial types not done yet
Bram Moolenaar <Bram@vim.org>
parents:
19646
diff
changeset
|
1388 called in the same way the declaration is the same. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1389 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1390 Custom types can be defined with `:type`: > |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1391 :type MyList list<string> |
|
21715
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1392 Custom types must start with a capital letter, to avoid name clashes with |
|
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1393 builtin types added later, similarly to user functions. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1394 {not implemented yet} |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1395 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1396 And classes and interfaces can be used as types: > |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1397 :class MyClass |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1398 :var mine: MyClass |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1399 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1400 :interface MyInterface |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1401 :var mine: MyInterface |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1402 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1403 :class MyTemplate<Targ> |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1404 :var mine: MyTemplate<number> |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1405 :var mine: MyTemplate<string> |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1406 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1407 :class MyInterface<Targ> |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1408 :var mine: MyInterface<number> |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1409 :var mine: MyInterface<string> |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1410 {not implemented yet} |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1411 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1412 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1413 Variable types and type casting ~ |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1414 *variable-types* |
|
21717
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1415 Variables declared in Vim9 script or in a `:def` function have a type, either |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1416 specified explicitly or inferred from the initialization. |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1417 |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1418 Global, buffer, window and tab page variables do not have a specific type, the |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1419 value can be changed at any time, possibly changing the type. Therefore, in |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1420 compiled code the "any" type is assumed. |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1421 |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1422 This can be a problem when the "any" type is undesired and the actual type is |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1423 expected to always be the same. For example, when declaring a list: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1424 var l: list<number> = [1, g:two] |
| 23305 | 1425 At compile time Vim doesn't know the type of "g:two" and the expression type |
| 1426 becomes list<any>. An instruction is generated to check the list type before | |
| 1427 doing the assignment, which is a bit inefficient. | |
| 27459 | 1428 *type-casting* *E1104* |
| 23305 | 1429 To avoid this, use a type cast: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1430 var l: list<number> = [1, <number>g:two] |
| 23305 | 1431 The compiled code will then only check that "g:two" is a number and give an |
| 1432 error if it isn't. This is called type casting. | |
|
21717
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1433 |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1434 The syntax of a type cast is: "<" {type} ">". There cannot be white space |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1435 after the "<" or before the ">" (to avoid them being confused with |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1436 smaller-than and bigger-than operators). |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1437 |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1438 The semantics is that, if needed, a runtime type check is performed. The |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1439 value is not actually changed. If you need to change the type, e.g. to change |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1440 it to a string, use the |string()| function. Or use |str2nr()| to convert a |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1441 string to a number. |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1442 |
|
ef3b31d510d2
patch 8.2.1408: Vim9: type casting not supported
Bram Moolenaar <Bram@vim.org>
parents:
21715
diff
changeset
|
1443 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1444 Type inference ~ |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1445 *type-inference* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1446 In general: Whenever the type is clear it can be omitted. For example, when |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1447 declaring a variable and giving it a value: > |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1448 var name = 0 # infers number type |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1449 var name = 'hello' # infers string type |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1450 |
|
21715
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1451 The type of a list and dictionary comes from the common type of the values. |
|
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1452 If the values all have the same type, that type is used for the list or |
|
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1453 dictionary. If there is a mix of types, the "any" type is used. > |
|
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1454 [1, 2, 3] list<number> |
|
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1455 ['a', 'b', 'c'] list<string> |
|
571832713efa
patch 8.2.1407: Vim9: type of list and dict only depends on first item
Bram Moolenaar <Bram@vim.org>
parents:
21676
diff
changeset
|
1456 [1, 'x', 3] list<any> |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1457 |
| 25161 | 1458 The common type of function references, if they do not all have the same |
| 1459 number of arguments, uses "(...)" to indicate the number of arguments is not | |
| 1460 specified. For example: > | |
| 1461 def Foo(x: bool) | |
| 1462 enddef | |
| 1463 def Bar(x: bool, y: bool) | |
| 1464 enddef | |
| 1465 var funclist = [Foo, Bar] | |
| 1466 echo funclist->typename() | |
| 1467 Results in: | |
| 1468 list<func(...)> | |
| 1469 | |
| 24387 | 1470 For script-local variables in Vim9 script the type is checked, also when the |
| 1471 variable was declared in a legacy function. | |
| 1472 | |
| 27623 | 1473 When a type has been declared this is attached to a List or Dictionary. When |
| 27459 | 1474 later some expression attempts to change the type an error will be given: > |
| 1475 var ll: list<number> = [1, 2, 3] | |
| 27492 | 1476 ll->extend(['x']) # Error, 'x' is not a number |
| 27459 | 1477 |
| 27623 | 1478 If the type is not declared then it is allowed to change: > |
| 27492 | 1479 [1, 2, 3]->extend(['x']) # result: [1, 2, 3, 'x'] |
| 27459 | 1480 |
| 27623 | 1481 For a variable declaration an inferred type matters: > |
| 1482 var ll = [1, 2, 3] | |
| 1483 ll->extend(['x']) # Error, 'x' is not a number | |
| 1484 That is because the declaration looks like a list of numbers, thus is | |
| 1485 equivalent to: > | |
| 1486 var ll: list<number> = [1, 2, 3] | |
| 1487 If you do want a more permissive list you need to declare the type: > | |
| 1488 var ll: list<any = [1, 2, 3] | |
| 1489 ll->extend(['x']) # OK | |
| 1490 | |
| 21991 | 1491 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1492 Stricter type checking ~ |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1493 *type-checking* |
| 21991 | 1494 In legacy Vim script, where a number was expected, a string would be |
| 1495 automatically converted to a number. This was convenient for an actual number | |
| 24387 | 1496 such as "123", but leads to unexpected problems (and no error message) if the |
| 21991 | 1497 string doesn't start with a number. Quite often this leads to hard-to-find |
| 27804 | 1498 bugs. e.g.: > |
| 1499 echo 123 == '123' | |
| 1500 < 1 ~ | |
| 1501 With an accidental space: > | |
| 1502 echo 123 == ' 123' | |
| 1503 < 0 ~ | |
| 27537 | 1504 *E1206* *E1210* *E1212* |
| 21991 | 1505 In Vim9 script this has been made stricter. In most places it works just as |
| 27804 | 1506 before if the value used matches the expected type. There will sometimes be |
| 22171 | 1507 an error, thus breaking backwards compatibility. For example: |
| 21991 | 1508 - Using a number other than 0 or 1 where a boolean is expected. *E1023* |
| 25161 | 1509 - Using a string value when setting a number option. |
| 27459 | 1510 - Using a number where a string is expected. *E1024* *E1105* |
| 21991 | 1511 |
| 25973 | 1512 One consequence is that the item type of a list or dict given to |map()| must |
| 27804 | 1513 not change, if the type was declared. This will give an error in Vim9 |
| 1514 script: > | |
| 1515 var mylist: list<number> = [1, 2, 3] | |
| 1516 echo map(mylist, (i, v) => 'item ' .. i) | |
| 1517 < E1012: Type mismatch; expected number but got string in map() ~ | |
| 25161 | 1518 |
| 27804 | 1519 Instead use |mapnew()|, it creates a new list: > |
| 1520 var mylist: list<number> = [1, 2, 3] | |
| 1521 echo mapnew(mylist, (i, v) => 'item ' .. i) | |
| 1522 < ['item 0', 'item 1', 'item 2'] ~ | |
| 1523 | |
| 1524 If the item type was not declared or determined to be "any" it can change to a | |
| 1525 more specific type. E.g. when a list of mixed types gets changed to a list of | |
| 1526 strings: > | |
| 25161 | 1527 var mylist = [1, 2.0, '3'] |
| 1528 # typename(mylist) == "list<any>" | |
| 1529 map(mylist, (i, v) => 'item ' .. i) | |
| 1530 # typename(mylist) == "list<string>", no error | |
| 27804 | 1531 |
| 1532 There is a subtle difference between using a list constant directly and | |
|
27843
532a0c5de1ec
patch 8.2.4447: Vim9: can still use s:var in a compiled function
Bram Moolenaar <Bram@vim.org>
parents:
27804
diff
changeset
|
1533 through a variable declaration. Because of type inference, when using a list |
| 27804 | 1534 constant to initialize a variable, this also sets the declared type: > |
| 1535 var mylist = [1, 2, 3] | |
| 1536 # typename(mylist) == "list<number>" | |
| 1537 echo map(mylist, (i, v) => 'item ' .. i) # Error! | |
| 1538 | |
| 1539 When using the list constant directly, the type is not declared and is allowed | |
| 1540 to change: > | |
| 1541 echo map([1, 2, 3], (i, v) => 'item ' .. i) # OK | |
| 1542 | |
| 1543 The reasoning behind this is that when a type is declared and the list is | |
| 1544 passed around and changed, the declaration must always hold. So that you can | |
| 1545 rely on the type to match the declared type. For a constant this is not | |
| 1546 needed. | |
| 1547 | |
| 1548 *E1158* | |
| 24024 | 1549 Same for |extend()|, use |extendnew()| instead, and for |flatten()|, use |
| 27804 | 1550 |flattennew()| instead. Since |flatten()| is intended to always change the |
| 1551 type, it can not be used in Vim9 script. | |
| 1552 | |
| 27537 | 1553 *E1211* *E1217* *E1218* *E1219* *E1220* *E1221* |
| 1554 *E1222* *E1223* *E1224* *E1225* *E1226* *E1227* | |
| 1555 *E1228* *E1238* *E1250* *E1251* *E1252* *E1253* | |
| 1556 *E1256* | |
| 1557 Types are checked for most builtin functions to make it easier to spot | |
| 1558 mistakes. | |
| 23573 | 1559 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1560 ============================================================================== |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1561 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1562 5. Namespace, Import and Export |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1563 *vim9script* *vim9-export* *vim9-import* |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1564 |
| 27162 | 1565 A Vim9 script can be written to be imported. This means that some items are |
| 1566 intentionally exported, made available to other scripts. When the exporting | |
| 1567 script is imported in another script, these exported items can then be used in | |
| 1568 that script. All the other items remain script-local in the exporting script | |
| 1569 and cannot be accessed by the importing script. | |
| 27036 | 1570 |
| 1571 This mechanism exists for writing a script that can be sourced (imported) by | |
| 1572 other scripts, while making sure these other scripts only have access to what | |
| 1573 you want them to. This also avoids using the global namespace, which has a | |
| 1574 risc of name collisions. For example when you have two plugins with similar | |
| 1575 functionality. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1576 |
| 27162 | 1577 You can cheat by using the global namespace explicitly. That should be done |
| 1578 only for things that really are global. | |
| 21991 | 1579 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1580 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1581 Namespace ~ |
|
23392
517fca70e084
patch 8.2.2239: Vim9: concatenating lines with backslash is inconvenient
Bram Moolenaar <Bram@vim.org>
parents:
23360
diff
changeset
|
1582 *vim9-namespace* |
| 19303 | 1583 To recognize a file that can be imported the `vim9script` statement must |
|
23974
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1584 appear as the first statement in the file (see |vim9-mix| for an exception). |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1585 It tells Vim to interpret the script in its own namespace, instead of the |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1586 global namespace. If a file starts with: > |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1587 vim9script |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1588 var myvar = 'yes' |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1589 Then "myvar" will only exist in this file. While without `vim9script` it would |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1590 be available as `g:myvar` from any other script and function. |
| 27459 | 1591 *E1101* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1592 The variables at the file level are very much like the script-local "s:" |
| 20115 | 1593 variables in legacy Vim script, but the "s:" is omitted. And they cannot be |
| 1594 deleted. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1595 |
| 20115 | 1596 In Vim9 script the global "g:" namespace can still be used as before. And the |
| 1597 "w:", "b:" and "t:" namespaces. These have in common that variables are not | |
| 1598 declared and they can be deleted. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1599 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1600 A side effect of `:vim9script` is that the 'cpoptions' option is set to the |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1601 Vim default value, like with: > |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1602 :set cpo&vim |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1603 One of the effects is that |line-continuation| is always enabled. |
|
24150
4919f2d8d7fd
patch 8.2.2616: Vim9: if 'cpo' is change in Vim9 script it may be restored
Bram Moolenaar <Bram@vim.org>
parents:
24128
diff
changeset
|
1604 The original value of 'cpoptions' is restored at the end of the script, while |
|
4919f2d8d7fd
patch 8.2.2616: Vim9: if 'cpo' is change in Vim9 script it may be restored
Bram Moolenaar <Bram@vim.org>
parents:
24128
diff
changeset
|
1605 flags added or removed in the script are also added to or removed from the |
|
4919f2d8d7fd
patch 8.2.2616: Vim9: if 'cpo' is change in Vim9 script it may be restored
Bram Moolenaar <Bram@vim.org>
parents:
24128
diff
changeset
|
1606 original value to get the same effect. The order of flags may change. |
|
26745
dcd1c244e332
patch 8.2.3901: Vim9: Cannot set 'cpo' in main .vimrc if using Vim9 script
Bram Moolenaar <Bram@vim.org>
parents:
26708
diff
changeset
|
1607 In the |vimrc| file sourced on startup this does not happen. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1608 |
|
23974
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1609 *vim9-mix* |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1610 There is one way to use both legacy and Vim9 syntax in one script file: > |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1611 " comments may go here |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1612 if !has('vim9script') |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1613 " legacy script commands go here |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1614 finish |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1615 endif |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1616 vim9script |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1617 # Vim9 script commands go here |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1618 This allows for writing a script that takes advantage of the Vim9 script |
| 24024 | 1619 syntax if possible, but will also work on a Vim version without it. |
|
23974
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1620 |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1621 This can only work in two ways: |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1622 1. The "if" statement evaluates to false, the commands up to `endif` are |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1623 skipped and `vim9script` is then the first command actually executed. |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1624 2. The "if" statement evaluates to true, the commands up to `endif` are |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1625 executed and `finish` bails out before reaching `vim9script`. |
|
d4f7e4138544
patch 8.2.2529: Vim9: Not possible to use legacy and Vim9 script in one file
Bram Moolenaar <Bram@vim.org>
parents:
23938
diff
changeset
|
1626 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1627 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1628 Export ~ |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1629 *:export* *:exp* |
| 21499 | 1630 Exporting an item can be written as: > |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1631 export const EXPORTED_CONST = 1234 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1632 export var someValue = ... |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1633 export final someValue = ... |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1634 export const someValue = ... |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1635 export def MyFunc() ... |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1636 export class MyClass ... |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1637 export interface MyClass ... |
| 27321 | 1638 < *E1043* *E1044* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1639 As this suggests, only constants, variables, `:def` functions and classes can |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1640 be exported. {not implemented yet: class, interface} |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1641 |
| 20856 | 1642 *E1042* |
| 1643 `:export` can only be used in Vim9 script, at the script level. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1644 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1645 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1646 Import ~ |
| 27537 | 1647 *:import* *:imp* *E1094* *E1047* *E1262* |
| 1648 *E1048* *E1049* *E1053* *E1071* *E1236* | |
|
26980
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1649 The exported items can be imported in another Vim9 script: > |
|
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1650 import "myscript.vim" |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1651 |
|
26980
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1652 This makes each item available as "myscript.item". |
| 27537 | 1653 *:import-as* *E1257* *E1261* |
|
26980
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1654 In case the name is long or ambiguous, another name can be specified: > |
| 27036 | 1655 import "thatscript.vim" as that |
| 27537 | 1656 < *E1060* *E1258* *E1259* *E1260* |
| 27036 | 1657 Then you can use "that.EXPORTED_CONST", "that.someValue", etc. You are free |
| 1658 to choose the name "that". Use something that will be recognized as referring | |
| 27459 | 1659 to the imported script. Avoid command names, command modifiers and builtin |
| 1660 function names, because the name will shadow them. | |
| 1661 If the name starts with a capital letter it can also shadow global user | |
| 1662 commands and functions. Also, you cannot use the name for something else in | |
| 1663 the script, such as a function or variable name. | |
|
26980
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1664 |
| 27036 | 1665 In case the dot in the name is undesired, a local reference can be made for a |
| 1666 function: > | |
| 1667 var LongFunc = that.LongFuncName | |
|
26980
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1668 |
|
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1669 This also works for constants: > |
| 27036 | 1670 const MAXLEN = that.MAX_LEN_OF_NAME |
|
26980
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1671 |
| 27036 | 1672 This does not work for variables, since the value would be copied once and |
| 1673 when changing the variable the copy will change, not the original variable. | |
| 1674 You will need to use the full name, with the dot. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1675 |
| 27321 | 1676 The full syntax of the command is: |
| 1677 import {filename} [as {name}] | |
| 1678 Where {filename} is an expression that must evaluate to a string. Without the | |
| 1679 "as {name}" part it must end in ".vim". {name} must consist of letters, | |
| 1680 digits and '_', like |internal-variables|. | |
| 1681 | |
| 22171 | 1682 `:import` can also be used in legacy Vim script. The imported items still |
| 1683 become script-local, even when the "s:" prefix is not given. | |
| 1684 | |
|
25282
9bce044c7643
patch 8.2.3178: Vim9: the file name of an :import cannot be an expression
Bram Moolenaar <Bram@vim.org>
parents:
25161
diff
changeset
|
1685 `:import` can not be used in a function. Imported items are intended to exist |
|
9bce044c7643
patch 8.2.3178: Vim9: the file name of an :import cannot be an expression
Bram Moolenaar <Bram@vim.org>
parents:
25161
diff
changeset
|
1686 at the script level and only imported once. |
|
9bce044c7643
patch 8.2.3178: Vim9: the file name of an :import cannot be an expression
Bram Moolenaar <Bram@vim.org>
parents:
25161
diff
changeset
|
1687 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1688 The script name after `import` can be: |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1689 - A relative path, starting "." or "..". This finds a file relative to the |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1690 location of the script file itself. This is useful to split up a large |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1691 plugin into several files. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1692 - An absolute path, starting with "/" on Unix or "D:/" on MS-Windows. This |
| 22723 | 1693 will rarely be used. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1694 - A path not being relative or absolute. This will be found in the |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1695 "import" subdirectories of 'runtimepath' entries. The name will usually be |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1696 longer and unique, to avoid loading the wrong file. |
| 25619 | 1697 Note that "after/import" is not used. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1698 |
| 27036 | 1699 If the name does not end in ".vim" then the use of "as name" is required. |
| 1700 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1701 Once a vim9 script file has been imported, the result is cached and used the |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1702 next time the same script is imported. It will not be read again. |
|
26980
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1703 |
|
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1704 It is not allowed to import the same script twice, also when using two |
|
8796f1384750
patch 8.2.4019: Vim9: import mechanism is too complicated
Bram Moolenaar <Bram@vim.org>
parents:
26873
diff
changeset
|
1705 different "as" names. |
| 27036 | 1706 |
| 1707 When using the imported name the dot and the item name must be in the same | |
| 1708 line, there can be no line break: > | |
| 1709 echo that. | |
| 1710 name # Error! | |
| 1711 echo that | |
| 1712 .name # Error! | |
| 1713 < *:import-cycle* | |
| 27537 | 1714 The `import` commands are executed when encountered. If script A imports |
| 1715 script B, and B (directly or indirectly) imports A, this will be skipped over. | |
| 1716 At this point items in A after "import B" will not have been processed and | |
| 1717 defined yet. Therefore cyclic imports can exist and not result in an error | |
| 1718 directly, but may result in an error for items in A after "import B" not being | |
| 1719 defined. This does not apply to autoload imports, see the next section. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1720 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1721 |
| 27162 | 1722 Importing an autoload script ~ |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1723 *vim9-autoload* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1724 For optimal startup speed, loading scripts should be postponed until they are |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1725 actually needed. Using the autoload mechanism is recommended: |
| 27537 | 1726 *E1264* |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1727 1. In the plugin define user commands, functions and/or mappings that refer to |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1728 items imported from an autoload script. > |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1729 import autoload 'for/search.vim' |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1730 command -nargs=1 SearchForStuff search.Stuff(<f-args>) |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1731 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1732 < This goes in .../plugin/anyname.vim. "anyname.vim" can be freely chosen. |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1733 The "SearchForStuff" command is now available to the user. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1734 |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1735 The "autoload" argument to `:import` means that the script is not loaded |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1736 until one of the items is actually used. The script will be found under |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1737 the "autoload" directory in 'runtimepath' instead of the "import" |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1738 directory. |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1739 |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1740 2. In the autoload script put the bulk of the code. > |
|
27215
5b54f413d132
patch 8.2.4136: Vim9: the "autoload" argument of ":vim9script" is not useful
Bram Moolenaar <Bram@vim.org>
parents:
27162
diff
changeset
|
1741 vim9script |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1742 export def Stuff(arg: string) |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1743 ... |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1744 |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1745 < This goes in .../autoload/for/search.vim. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1746 |
|
27215
5b54f413d132
patch 8.2.4136: Vim9: the "autoload" argument of ":vim9script" is not useful
Bram Moolenaar <Bram@vim.org>
parents:
27162
diff
changeset
|
1747 Putting the "search.vim" script under the "/autoload/for/" directory has |
|
5b54f413d132
patch 8.2.4136: Vim9: the "autoload" argument of ":vim9script" is not useful
Bram Moolenaar <Bram@vim.org>
parents:
27162
diff
changeset
|
1748 the effect that "for#search#" will be prefixed to every exported item. The |
|
5b54f413d132
patch 8.2.4136: Vim9: the "autoload" argument of ":vim9script" is not useful
Bram Moolenaar <Bram@vim.org>
parents:
27162
diff
changeset
|
1749 prefix is obtained from the file name, as you would to manually in a |
|
5b54f413d132
patch 8.2.4136: Vim9: the "autoload" argument of ":vim9script" is not useful
Bram Moolenaar <Bram@vim.org>
parents:
27162
diff
changeset
|
1750 legacy autoload script. Thus the exported function can be found with |
|
5b54f413d132
patch 8.2.4136: Vim9: the "autoload" argument of ":vim9script" is not useful
Bram Moolenaar <Bram@vim.org>
parents:
27162
diff
changeset
|
1751 "for#search#Stuff", but you would normally use `import autoload` and not |
| 28141 | 1752 use the prefix (which has the side effect of loading the autoload script |
| 1753 when compiling a function that encounters this name). | |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1754 |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1755 You can split up the functionality and import other scripts from the |
|
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1756 autoload script as you like. This way you can share code between plugins. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1757 |
| 27162 | 1758 For defining a mapping that uses the imported autoload script the special key |
| 1759 |<ScriptCmd>| is useful. It allows for a command in a mapping to use the | |
| 1760 script context of where the mapping was defined. | |
| 1761 | |
|
21771
fcf978444298
patch 8.2.1435: Vim9: always converting to string for ".." leads to mistakes
Bram Moolenaar <Bram@vim.org>
parents:
21717
diff
changeset
|
1762 When compiling a `:def` function and a function in an autoload script is |
|
fcf978444298
patch 8.2.1435: Vim9: always converting to string for ".." leads to mistakes
Bram Moolenaar <Bram@vim.org>
parents:
21717
diff
changeset
|
1763 encountered, the script is not loaded until the `:def` function is called. |
|
27043
15f40772e10a
patch 8.2.4050: Vim9: need to prefix every item in an autoload script
Bram Moolenaar <Bram@vim.org>
parents:
27036
diff
changeset
|
1764 This also means you get any errors only at runtime, since the argument and |
| 28141 | 1765 return types are not known yet. If you would use the name with '#' characters |
| 1766 then the autoload script IS loaded. | |
| 1767 | |
| 1768 Be careful to not refer to an item in an autoload script that does trigger | |
| 1769 loading it unintentionally. For example, when setting an option that takes a | |
| 1770 function name, make sure to use a string, not a function reference: > | |
| 1771 import autoload 'qftf.vim' | |
| 1772 &quickfixtextfunc = 'qftf.Func' # autoload script NOT loaded | |
| 1773 &quickfixtextfunc = qftf.Func # autoload script IS loaded | |
| 1774 On the other hand, it can be useful to load the script early, at a time when | |
| 1775 any errors should be given. | |
|
21771
fcf978444298
patch 8.2.1435: Vim9: always converting to string for ".." leads to mistakes
Bram Moolenaar <Bram@vim.org>
parents:
21717
diff
changeset
|
1776 |
| 27162 | 1777 For testing the |test_override()| function can be used to have the |
| 1778 `import autoload` load the script right away, so that the items and types can | |
| 1779 be checked without waiting for them to be actually used: > | |
| 1780 test_override('autoload', 1) | |
| 1781 Reset it later with: > | |
| 1782 test_override('autoload', 0) | |
| 1783 Or: > | |
| 1784 test_override('ALL', 0) | |
| 1785 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1786 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1787 Import in legacy Vim script ~ |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1788 |
| 20856 | 1789 If an `import` statement is used in legacy Vim script, the script-local "s:" |
| 27162 | 1790 namespace will be used for the imported items, even when "s:" is not |
| 1791 specified. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1792 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1793 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1794 ============================================================================== |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1795 |
| 22328 | 1796 6. Future work: classes *vim9-classes* |
| 1797 | |
| 1798 Above "class" was mentioned a few times, but it has not been implemented yet. | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1799 Most of Vim9 script can be created without this functionality, and since |
| 22328 | 1800 implementing classes is going to be a lot of work, it is left for the future. |
| 1801 For now we'll just make sure classes can be added later. | |
| 1802 | |
| 1803 Thoughts: | |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1804 - `class` / `endclass`, the whole class must be in one file |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1805 - Class names are always CamelCase (to avoid a name clash with builtin types) |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1806 - A single constructor called "constructor" |
| 22328 | 1807 - Single inheritance with `class ThisClass extends BaseClass` |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1808 - `abstract class` (class with incomplete implementation) |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1809 - `interface` / `endinterface` (abstract class without any implementation) |
| 22328 | 1810 - `class SomeClass implements SomeInterface` |
| 1811 - Generics for class: `class <Tkey, Tentry>` | |
| 1812 - Generics for function: `def <Tkey> GetLast(key: Tkey)` | |
| 1813 | |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1814 Again, much of this is from TypeScript with a slightly different syntax. |
| 22328 | 1815 |
| 1816 Some things that look like good additions: | |
| 1817 - Use a class as an interface (like Dart) | |
| 1818 - Extend a class with methods, using an import (like Dart) | |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1819 - Mixins |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1820 - For testing: Mock mechanism |
| 22328 | 1821 |
| 1822 An important class that will be provided is "Promise". Since Vim is single | |
| 1823 threaded, connecting asynchronous operations is a natural way of allowing | |
| 1824 plugins to do their work without blocking the user. It's a uniform way to | |
| 1825 invoke callbacks and handle timeouts and errors. | |
| 1826 | |
| 28010 | 1827 Some commands have already been reserved: |
| 1828 *:class* | |
| 1829 *:endclass* | |
| 1830 *:abstract* | |
| 1831 *:enum* | |
| 1832 *:endenum* | |
| 1833 *:interface* | |
| 1834 *:endinterface* | |
| 1835 *:static* | |
| 1836 *:type* | |
| 1837 | |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1838 Some examples: > |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1839 |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1840 abstract class Person |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1841 static const prefix = 'xxx' |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1842 var name: string |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1843 |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1844 def constructor(name: string) |
| 25402 | 1845 this.name = name |
|
24888
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1846 enddef |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1847 |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1848 def display(): void |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1849 echo name |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1850 enddef |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1851 |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1852 abstract def find(string): Person |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1853 endclass |
|
b6ac4ed5e2d2
patch 8.2.2982: Vim9: future commands are not reserved yet
Bram Moolenaar <Bram@vim.org>
parents:
24751
diff
changeset
|
1854 |
| 22328 | 1855 ============================================================================== |
| 1856 | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1857 9. Rationale *vim9-rationale* |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1858 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1859 The :def command ~ |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1860 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1861 Plugin writers have asked for much faster Vim script. Investigations have |
| 19303 | 1862 shown that keeping the existing semantics of function calls make this close to |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1863 impossible, because of the overhead involved with calling a function, setting |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1864 up the local function scope and executing lines. There are many details that |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1865 need to be handled, such as error messages and exceptions. The need to create |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1866 a dictionary for a: and l: scopes, the a:000 list and several others add too |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1867 much overhead that cannot be avoided. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1868 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1869 Therefore the `:def` method to define a new-style function had to be added, |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1870 which allows for a function with different semantics. Most things still work |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1871 as before, but some parts do not. A new way to define a function was |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1872 considered the best way to separate the legacy style code from Vim9 style code. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1873 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1874 Using "def" to define a function comes from Python. Other languages use |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1875 "function" which clashes with legacy Vim script. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1876 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1877 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1878 Type checking ~ |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1879 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1880 When compiling lines of Vim commands into instructions as much as possible |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1881 should be done at compile time. Postponing it to runtime makes the execution |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1882 slower and means mistakes are found only later. For example, when |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1883 encountering the "+" character and compiling this into a generic add |
| 23666 | 1884 instruction, at runtime the instruction would have to inspect the type of the |
| 1885 arguments and decide what kind of addition to do. And when the type is | |
| 1886 dictionary throw an error. If the types are known to be numbers then an "add | |
| 1887 number" instruction can be used, which is faster. The error can be given at | |
| 1888 compile time, no error handling is needed at runtime, since adding two numbers | |
| 1889 cannot fail. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1890 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1891 The syntax for types, using <type> for compound types, is similar to Java. It |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1892 is easy to understand and widely used. The type names are what were used in |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1893 Vim before, with some additions such as "void" and "bool". |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1894 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1895 |
| 22328 | 1896 Removing clutter and weirdness ~ |
| 20856 | 1897 |
| 22328 | 1898 Once decided that `:def` functions have different syntax than legacy functions, |
| 1899 we are free to add improvements to make the code more familiar for users who | |
| 1900 know popular programming languages. In other words: remove weird things that | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1901 only Vim does. |
| 22328 | 1902 |
| 1903 We can also remove clutter, mainly things that were done to make Vim script | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1904 backwards compatible with the good old Vi commands. |
| 20856 | 1905 |
| 22328 | 1906 Examples: |
| 1907 - Drop `:call` for calling a function and `:eval` for manipulating data. | |
| 1908 - Drop using a leading backslash for line continuation, automatically figure | |
| 1909 out where an expression ends. | |
| 20856 | 1910 |
| 22328 | 1911 However, this does require that some things need to change: |
| 1912 - Comments start with # instead of ", to avoid confusing them with strings. | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1913 This is good anyway, it is known from several popular languages. |
| 22328 | 1914 - Ex command ranges need to be prefixed with a colon, to avoid confusion with |
| 1915 expressions (single quote can be a string or a mark, "/" can be divide or a | |
| 1916 search command, etc.). | |
| 1917 | |
| 1918 Goal is to limit the differences. A good criteria is that when the old syntax | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1919 is accidentally used you are very likely to get an error message. |
| 20856 | 1920 |
| 1921 | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1922 Syntax and semantics from popular languages ~ |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1923 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1924 Script writers have complained that the Vim script syntax is unexpectedly |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1925 different from what they are used to. To reduce this complaint popular |
| 20856 | 1926 languages are used as an example. At the same time, we do not want to abandon |
| 1927 the well-known parts of legacy Vim script. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1928 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1929 For many things TypeScript is followed. It's a recent language that is |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1930 gaining popularity and has similarities with Vim script. It also has a |
| 22328 | 1931 mix of static typing (a variable always has a known value type) and dynamic |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1932 typing (a variable can have different types, this changes at runtime). Since |
| 22328 | 1933 legacy Vim script is dynamically typed and a lot of existing functionality |
| 1934 (esp. builtin functions) depends on that, while static typing allows for much | |
| 1935 faster execution, we need to have this mix in Vim9 script. | |
| 1936 | |
| 22171 | 1937 There is no intention to completely match TypeScript syntax and semantics. We |
| 1938 just want to take those parts that we can use for Vim and we expect Vim users | |
| 22328 | 1939 will be happy with. TypeScript is a complex language with its own history, |
| 1940 advantages and disadvantages. To get an idea of the disadvantages read the | |
| 1941 book: "JavaScript: The Good Parts". Or find the article "TypeScript: the good | |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1942 parts" and read the "Things to avoid" section. |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1943 |
| 22328 | 1944 People familiar with other languages (Java, Python, etc.) will also find |
| 1945 things in TypeScript that they do not like or do not understand. We'll try to | |
| 1946 avoid those things. | |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1947 |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1948 Specific items from TypeScript we avoid: |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1949 - Overloading "+", using it both for addition and string concatenation. This |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1950 goes against legacy Vim script and often leads to mistakes. For that reason |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1951 we will keep using ".." for string concatenation. Lua also uses ".." this |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1952 way. And it allows for conversion to string for more values. |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1953 - TypeScript can use an expression like "99 || 'yes'" in a condition, but |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1954 cannot assign the value to a boolean. That is inconsistent and can be |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1955 annoying. Vim recognizes an expression with && or || and allows using the |
|
26755
ddaea8dcaff5
patch 8.2.3906: Vim9 help still contains "under development" warnings
Bram Moolenaar <Bram@vim.org>
parents:
26745
diff
changeset
|
1956 result as a bool. The |falsy-operator| was added for the mechanism to use a |
|
ddaea8dcaff5
patch 8.2.3906: Vim9 help still contains "under development" warnings
Bram Moolenaar <Bram@vim.org>
parents:
26745
diff
changeset
|
1957 default value. |
|
22272
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1958 - TypeScript considers an empty string as Falsy, but an empty list or dict as |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1959 Truthy. That is inconsistent. In Vim an empty list and dict are also |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1960 Falsy. |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1961 - TypeScript has various "Readonly" types, which have limited usefulness, |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1962 since a type cast can remove the immutable nature. Vim locks the value, |
|
eb1f5f618c75
patch 8.2.1685: Vim9: cannot declare a constant value
Bram Moolenaar <Bram@vim.org>
parents:
22171
diff
changeset
|
1963 which is more flexible, but is only checked at runtime. |
| 27459 | 1964 - TypeScript has a complicated "import" statement that does not match how the |
| 1965 Vim import mechanism works. A much simpler mechanism is used instead, which | |
| 1966 matches that the imported script is only sourced once. | |
| 22171 | 1967 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
1968 |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1969 Declarations ~ |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1970 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1971 Legacy Vim script uses `:let` for every assignment, while in Vim9 declarations |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1972 are used. That is different, thus it's good to use a different command: |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1973 `:var`. This is used in many languages. The semantics might be slightly |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1974 different, but it's easily recognized as a declaration. |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1975 |
| 23047 | 1976 Using `:const` for constants is common, but the semantics varies. Some |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1977 languages only make the variable immutable, others also make the value |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1978 immutable. Since "final" is well known from Java for only making the variable |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1979 immutable we decided to use that. And then `:const` can be used for making |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1980 both immutable. This was also used in legacy Vim script and the meaning is |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1981 almost the same. |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1982 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1983 What we end up with is very similar to Dart: > |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1984 :var name # mutable variable and value |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1985 :final name # immutable variable, mutable value |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1986 :const name # immutable variable and value |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1987 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1988 Since legacy and Vim9 script will be mixed and global variables will be |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1989 shared, optional type checking is desirable. Also, type inference will avoid |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1990 the need for specifying the type in many cases. The TypeScript syntax fits |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1991 best for adding types to declarations: > |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1992 var name: string # string type is specified |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1993 ... |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1994 name = 'John' |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1995 const greeting = 'hello' # string type is inferred |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1996 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1997 This is how we put types in a declaration: > |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1998 var mylist: list<string> |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
1999 final mylist: list<string> = ['foo'] |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2000 def Func(arg1: number, arg2: string): bool |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2001 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2002 Two alternatives were considered: |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2003 1. Put the type before the name, like Dart: > |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2004 var list<string> mylist |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2005 final list<string> mylist = ['foo'] |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2006 def Func(number arg1, string arg2) bool |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2007 2. Put the type after the variable name, but do not use a colon, like Go: > |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2008 var mylist list<string> |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2009 final mylist list<string> = ['foo'] |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2010 def Func(arg1 number, arg2 string) bool |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2011 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2012 The first is more familiar for anyone used to C or Java. The second one |
| 22565 | 2013 doesn't really have an advantage over the first, so let's discard the second. |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2014 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2015 Since we use type inference the type can be left out when it can be inferred |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2016 from the value. This means that after `var` we don't know if a type or a name |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2017 follows. That makes parsing harder, not only for Vim but also for humans. |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2018 Also, it will not be allowed to use a variable name that could be a type name, |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2019 using `var string string` is too confusing. |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2020 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2021 The chosen syntax, using a colon to separate the name from the type, adds |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2022 punctuation, but it actually makes it easier to recognize the parts of a |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2023 declaration. |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2024 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2025 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2026 Expressions ~ |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2027 |
| 22565 | 2028 Expression evaluation was already close to what other languages are doing. |
| 2029 Some details are unexpected and can be improved. For example a boolean | |
| 2030 condition would accept a string, convert it to a number and check if the | |
| 2031 number is non-zero. This is unexpected and often leads to mistakes, since | |
| 2032 text not starting with a number would be converted to zero, which is | |
| 22723 | 2033 considered false. Thus using a string for a condition would often not give an |
| 2034 error and be considered false. That is confusing. | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2035 |
| 23047 | 2036 In Vim9 type checking is stricter to avoid mistakes. Where a condition is |
| 22565 | 2037 used, e.g. with the `:if` command and the `||` operator, only boolean-like |
| 2038 values are accepted: | |
| 2039 true: `true`, `v:true`, `1`, `0 < 9` | |
| 2040 false: `false`, `v:false`, `0`, `0 > 9` | |
| 2041 Note that the number zero is false and the number one is true. This is more | |
| 22723 | 2042 permissive than most other languages. It was done because many builtin |
| 22565 | 2043 functions return these values. |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2044 |
| 22565 | 2045 If you have any type of value and want to use it as a boolean, use the `!!` |
| 2046 operator: | |
| 24751 | 2047 true: `!!'text'`, `!![99]`, `!!{'x': 1}`, `!!99` |
| 22565 | 2048 false: `!!''`, `!![]`, `!!{}` |
| 2049 | |
| 2050 From a language like JavaScript we have this handy construct: > | |
| 2051 GetName() || 'unknown' | |
| 2052 However, this conflicts with only allowing a boolean for a condition. | |
| 2053 Therefore the "??" operator was added: > | |
| 2054 GetName() ?? 'unknown' | |
| 2055 Here you can explicitly express your intention to use the value as-is and not | |
| 2056 result in a boolean. This is called the |falsy-operator|. | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2057 |
|
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2058 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2059 Import and Export ~ |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2060 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2061 A problem of legacy Vim script is that by default all functions and variables |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2062 are global. It is possible to make them script-local, but then they are not |
| 22171 | 2063 available in other scripts. This defies the concept of a package that only |
| 2064 exports selected items and keeps the rest local. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2065 |
| 21825 | 2066 In Vim9 script a mechanism very similar to the JavaScript import and export |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2067 mechanism is supported. It is a variant to the existing `:source` command |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2068 that works like one would expect: |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2069 - Instead of making everything global by default, everything is script-local, |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2070 unless exported. |
| 22171 | 2071 - When importing a script the symbols that are imported are explicitly listed, |
| 2072 avoiding name conflicts and failures if functionality is added later. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2073 - The mechanism allows for writing a big, long script with a very clear API: |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2074 the exported function(s) and class(es). |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2075 - By using relative paths loading can be much faster for an import inside of a |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2076 package, no need to search many directories. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2077 - Once an import has been used, it can be cached and loading it again can be |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2078 avoided. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2079 - The Vim-specific use of "s:" to make things script-local can be dropped. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2080 |
| 20856 | 2081 When sourcing a Vim9 script from a legacy script, only the items defined |
| 2082 globally can be used, not the exported items. Alternatives considered: | |
| 2083 - All the exported items become available as script-local items. This makes | |
| 22171 | 2084 it uncontrollable what items get defined and likely soon leads to trouble. |
| 20856 | 2085 - Use the exported items and make them global. Disadvantage is that it's then |
| 2086 not possible to avoid name clashes in the global namespace. | |
| 2087 - Completely disallow sourcing a Vim9 script, require using `:import`. That | |
| 2088 makes it difficult to use scripts for testing, or sourcing them from the | |
| 2089 command line to try them out. | |
| 22171 | 2090 Note that you can also use `:import` in legacy Vim script, see above. |
| 20856 | 2091 |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2092 |
| 22328 | 2093 Compiling functions early ~ |
| 2094 | |
| 2095 Functions are compiled when called or when `:defcompile` is used. Why not | |
| 2096 compile them early, so that syntax and type errors are reported early? | |
| 2097 | |
| 2098 The functions can't be compiled right away when encountered, because there may | |
| 2099 be forward references to functions defined later. Consider defining functions | |
| 2100 A, B and C, where A calls B, B calls C, and C calls A again. It's impossible | |
| 2101 to reorder the functions to avoid forward references. | |
| 2102 | |
| 2103 An alternative would be to first scan through the file to locate items and | |
| 2104 figure out their type, so that forward references are found, and only then | |
| 2105 execute the script and compile the functions. This means the script has to be | |
| 2106 parsed twice, which is slower, and some conditions at the script level, such | |
| 2107 as checking if a feature is supported, are hard to use. An attempt was made | |
| 2108 to see if it works, but it turned out to be impossible to make work nicely. | |
| 2109 | |
| 2110 It would be possible to compile all the functions at the end of the script. | |
| 2111 The drawback is that if a function never gets called, the overhead of | |
| 2112 compiling it counts anyway. Since startup speed is very important, in most | |
| 2113 cases it's better to do it later and accept that syntax and type errors are | |
| 2114 only reported then. In case these errors should be found early, e.g. when | |
| 2115 testing, the `:defcompile` command will help out. | |
| 2116 | |
| 2117 | |
|
22391
a9fb7efa31d6
patch 8.2.1744: Vim9: using ":const!" is weird
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
2118 Why not use an embedded language? ~ |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2119 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2120 Vim supports interfaces to Perl, Python, Lua, Tcl and a few others. But |
| 22328 | 2121 these interfaces have never become widely used, for various reasons. When |
| 2122 Vim9 was designed a decision was made to make these interfaces lower priority | |
| 2123 and concentrate on Vim script. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2124 |
| 22328 | 2125 Still, plugin writers may find other languages more familiar, want to use |
| 2126 existing libraries or see a performance benefit. We encourage plugin authors | |
| 2127 to write code in any language and run it as an external tool, using jobs and | |
| 2128 channels. We can try to make this easier somehow. | |
| 2129 | |
| 2130 Using an external tool also has disadvantages. An alternative is to convert | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2131 the tool into Vim script. For that to be possible without too much |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2132 translation, and keeping the code fast at the same time, the constructs of the |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2133 tool need to be supported. Since most languages support classes the lack of |
| 22171 | 2134 support for classes in Vim is then a problem. |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2135 |
| 22328 | 2136 |
| 2137 Classes ~ | |
| 2138 | |
| 2139 Vim supports a kind-of object oriented programming by adding methods to a | |
| 2140 dictionary. With some care this can be made to work, but it does not look | |
| 2141 like real classes. On top of that, it's quite slow, because of the use of | |
| 2142 dictionaries. | |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2143 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2144 The support of classes in Vim9 script is a "minimal common functionality" of |
| 22171 | 2145 class support in most languages. It works much like Java, which is the most |
|
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2146 popular programming language. |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2147 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2148 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2149 |
|
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
diff
changeset
|
2150 vim:tw=78:ts=8:noet:ft=help:norl: |