vim: runtime/doc/vim9.txt annotate

annotate runtime/doc/vim9.txt @ 23047:29c5f168c6fd

Update runtime files Commit: https://github.com/vim/vim/commit/23515b4ef7580af8b9d3b964a558ab2007cacda5 Author: Bram Moolenaar <Bram@vim.org> Date: Sun Nov 29 14:36:24 2020 +0100 Update runtime files

author	Bram Moolenaar <Bram@vim.org>
date	Sun, 29 Nov 2020 14:45:04 +0100
parents	e7c125224b1a
children	285cde4b8d0e

rev	line source
23047 29c5f168c6fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22958 diff changeset	1 vim9.txt For Vim version 8.2. Last change: 2020 Nov 25
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
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	7 THIS IS STILL UNDER DEVELOPMENT - ANYTHING CAN BREAK - ANYTHING CAN CHANGE
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	8
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	9 Vim9 script commands and expressions. vim9
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	10
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	11 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	12 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	13
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	14 THIS IS STILL UNDER DEVELOPMENT - ANYTHING CAN BREAK - ANYTHING CAN CHANGE
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	15
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	16
21676 1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	17 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	18 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	19 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	20 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	21 5. Namespace, Import and Export \|vim9script\|
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	22 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	23
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	24 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	25
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	26 ==============================================================================
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	27
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	28 1. What is Vim9 script? vim9-script
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	29
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	30 THIS IS STILL UNDER DEVELOPMENT - ANYTHING CAN BREAK - ANYTHING CAN CHANGE
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	31
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	32 Vim script has been growing over time, while preserving backwards
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	33 compatibility. That means bad choices from the past often can't be changed
20965 59f93c2d2551 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	34 and compatibility with Vi restricts possible solutions. Execution is quite
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	35 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	36
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	37 The main goal of Vim9 script is to drastically improve performance. This is
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	38 accomplished by compiling commands into instructions that can be efficiently
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	39 executed. An increase in execution speed of 10 to 100 times can be expected.
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	40
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	41 A secondary goal is to avoid Vim-specific constructs and get closer to
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	42 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	43
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	44 The performance improvements can only be achieved by not being 100% backwards
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	45 compatible. For example, making function arguments available in the
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	46 "a:" dictionary adds quite a lot of overhead. In a Vim9 function this
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	47 dictionary is not available. Other differences are more subtle, such as how
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	48 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	49
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	50 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	51 - 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	52 - a script file where the first command is `vim9script`
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	53 - an autocommand defined in the context of the above
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	54
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	55 When using `:function` in a Vim9 script file the legacy syntax is used.
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	56 However, this can be confusing and is therefore discouraged.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	57
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	58 Vim9 script and legacy Vim script can be mixed. There is no requirement to
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	59 rewrite old scripts, they keep working as before. You may want to use a few
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	60 `: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	61
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	62 ==============================================================================
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	63
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	64 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	65
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	66 THIS IS STILL UNDER DEVELOPMENT - ANYTHING CAN BREAK - ANYTHING CAN CHANGE
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	67
22441 a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	68 Overview ~
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	69
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	70 Brief summary of the differences you will most often encounter when using Vim9
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	71 script and `:def` functions; details are below:
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	72 - Comments start with #, not ": >
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	73 echo "hello" # comment
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	74 - Using a backslash for line continuation is hardly ever needed: >
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	75 echo "hello "
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	76 .. yourName
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	77 .. ", how are you?"
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	78 - White space is required in many places.
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	79 - Assign values without `:let`, declare variables with `:var`: >
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	80 var count = 0
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	81 count += 3
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	82 - Constants can be declared with `:final` and `:const`: >
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	83 final matches = [] # add matches
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	84 const names = ['Betty', 'Peter'] # cannot be changed
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	85 - `:final` cannot be used as an abbreviation of `:finally`.
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	86 - Variables and functions are script-local by default.
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	87 - Functions are declared with argument types and return type: >
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	88 def CallMe(count: number, message: string): bool
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	89 - Call functions without `:call`: >
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	90 writefile(['done'], 'file.txt')
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	91 - You cannot use `:xit`, `:t`, `:append`, `:change`, `:insert` or curly-braces
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	92 names.
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	93 - A range before a command must be prefixed with a colon: >
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	94 :%s/this/that
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	95
a3bb84cd0f59 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22391 diff changeset	96
20023 c85d4e173cc9 patch 8.2.0567: Vim9: cannot put comments halfway expressions Bram Moolenaar <Bram@vim.org> parents: 20015 diff changeset	97 Comments starting with # ~
c85d4e173cc9 patch 8.2.0567: Vim9: cannot put comments halfway expressions Bram Moolenaar <Bram@vim.org> parents: 20015 diff changeset	98
21353 fb8c8fcb7b60 patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing Bram Moolenaar <Bram@vim.org> parents: 21250 diff changeset	99 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	100 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	101 # declarations
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	102 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	103
21353 fb8c8fcb7b60 patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing Bram Moolenaar <Bram@vim.org> parents: 21250 diff changeset	104 The reason is that a double quote can also be the start of a string. In many
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	105 places, especially halfway through an expression with a line break, it's hard
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	106 to tell what the meaning is, since both a string and a comment can be followed
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	107 by arbitrary text. To avoid confusion only # comments are recognized. This
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	108 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	109
fb8c8fcb7b60 patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing Bram Moolenaar <Bram@vim.org> parents: 21250 diff changeset	110 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	111 `:number` for that. >
21516 c7b2ce90c2de patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	112 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	113
fb8c8fcb7b60 patch 8.2.1227: Vim9: allowing both quoted and # comments is confusing Bram Moolenaar <Bram@vim.org> parents: 21250 diff changeset	114 To improve readability there must be a space between a command and the #
22936 00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	115 that starts a comment.
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	116
20023 c85d4e173cc9 patch 8.2.0567: Vim9: cannot put comments halfway expressions Bram Moolenaar <Bram@vim.org> parents: 20015 diff changeset	117
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	118 Vim9 functions ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	119
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	120 A function defined with `:def` is compiled. Execution is many times faster,
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	121 often 10x to 100x times.
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	122
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	123 Many errors are already found when compiling, before the function is executed.
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	124 The syntax is strict, to enforce code that is easy to read and understand.
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	125
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	126 Compilation is done when:
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	127 - the function is first called
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	128 - when the `:defcompile` command is encountered in the script where the
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	129 function was defined
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	130 - `:disassemble` is used for the function.
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	131 - a function that is compiled calls the function or uses it as a function
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	132 reference
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	133
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	134 `:def` has no options like `:function` does: "range", "abort", "dict" or
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	135 "closure". A `:def` function always aborts on an error, does not get a range
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	136 passed and cannot be a "dict" function.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	137
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	138 The argument types and return type need to be specified. The "any" type can
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	139 be used, type checking will then be done at runtime, like with legacy
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	140 functions.
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	141
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	142 Arguments are accessed by name, without "a:", just like any other language.
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	143 There is no "a:" dictionary or "a:000" list.
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	144
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	145 Variable arguments are defined as the last argument, with a name and have a
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	146 list type, similar to TypeScript. For example, a list of numbers: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	147 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	148 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	149 ...
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	150
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	151
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	152 Functions and variables are script-local by default ~
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	153 vim9-scopes
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	154 When using `:function` or `:def` to specify a new function at the script level
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	155 in a Vim9 script, the function is local to the script, as if "s:" was
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	156 prefixed. Using the "s:" prefix is optional. To define a global function or
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	157 variable the "g:" prefix must be used. For functions in an autoload script
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	158 the "name#" prefix is sufficient. >
21550 b0b57d91671c patch 8.2.1325: Vim9: using Vim9 script for autaload not tested Bram Moolenaar <Bram@vim.org> parents: 21516 diff changeset	159 def ThisFunction() # script-local
b0b57d91671c patch 8.2.1325: Vim9: using Vim9 script for autaload not tested Bram Moolenaar <Bram@vim.org> parents: 21516 diff changeset	160 def s:ThisFunction() # script-local
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	161 def g:ThatFunction() # global
21550 b0b57d91671c patch 8.2.1325: Vim9: using Vim9 script for autaload not tested Bram Moolenaar <Bram@vim.org> parents: 21516 diff changeset	162 def scriptname#function() # autoload
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	163
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	164 When using `:function` or `:def` to specify a nested function inside a `:def`
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	165 function, this nested function is local to the code block it is defined in.
22565 17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	166 In a `:def` function it is not possible to define a script-local function. It
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	167 is possible to define a global function by using the "g:" prefix.
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	168
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	169 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	170 search for the function:
22565 17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	171 - 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	172 - 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	173 - in the list of global functions
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	174 However, it is recommended to always use "g:" to refer to a global function
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	175 for clarity.
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	176
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	177 In all cases the function must be defined before used. That is when it is
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22565 diff changeset	178 called, when `:defcompile` causes it to be compiled, or when code that calls
5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22565 diff changeset	179 it is being compiled (to figure out the return type).
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	180
21676 1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	181 The result is that functions and variables without a namespace can usually be
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	182 found in the script, either defined there or imported. Global functions and
21676 1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	183 variables could be defined anywhere (good luck finding out where!).
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	184
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	185 Global functions can still be defined and deleted at nearly any time. In
20317 2334bf788e8a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20241 diff changeset	186 Vim9 script script-local functions are defined once when the script is sourced
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	187 and cannot be deleted or replaced.
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	188
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	189
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	190 Variable declarations with :var, :final and :const ~
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	191 vim9-declaration :var
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	192 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	193 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	194 section.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	195
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	196 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	197 vim9script
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	198 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	199 def SomeFunc()
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	200 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	201 if cond
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	202 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	203 ...
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	204
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	205 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	206 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	207 if cond
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	208 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	209 else
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	210 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	211 endif
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	212 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	213
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	214 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	215 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	216 if cond
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	217 inner = 5
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	218 else
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	219 inner = 0
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	220 endif
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	221 echo inner
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	222
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	223 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	224 used: >
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	225 {
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	226 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	227 ...
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	228 }
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	229 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	230
22272 eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	231 Declaring a variable with a type but without an initializer will initialize to
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	232 zero, false or empty.
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	233
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	234 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	235 without any command. The same for global, window, tab, buffer and Vim
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	236 variables, because they are not really declared. They 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	237 with `:unlet`.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	238
21676 1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	239 Variables and functions cannot shadow previously defined or imported variables
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	240 and functions.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	241 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	242
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	243 Global variables and user defined functions must be prefixed with "g:", also
56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20115 diff changeset	244 at the script level. >
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	245 vim9script
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	246 var script_local = 'text'
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	247 g:global = 'value'
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	248 var Funcref = g:ThatFunction
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	249
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	250 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	251 used to repeat a `:substitute` command.
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	252
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	253
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	254 Constants ~
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	255 vim9-const vim9-final
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	256 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	257 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	258 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	259 cannot be changed. In Vim9 we can use both.
22272 eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	260
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	261 `: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	262 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	263 Example: >
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	264 const myList = [1, 2]
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	265 myList = [3, 4] # Error!
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	266 myList[0] = 9 # Error!
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	267 muList->add(3) # Error!
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	268 < :final
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	269 `: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	270 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	271 final myList = [1, 2]
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	272 myList = [3, 4] # Error!
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	273 myList[0] = 9 # OK
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	274 muList->add(3) # OK
22272 eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	275
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	276 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	277
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	278 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	279 final females = ["Mary"]
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	280 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	281 NAMES[0] = ["Jack"] # Error!
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	282 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	283 NAMES[1] = ["Emma"] # Error!
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	284 Names[1][0] = "Emma" # OK, now females[0] == "Emma"
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	285
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	286 < E1092
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	287 Declaring more than one variable at a time, using the unpack notation, is
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	288 currently not supported: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	289 var [v1, v2] = GetValues() # Error!
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	290 That is because the type needs to be inferred from the list item type, which
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	291 isn't that easy.
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	292
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	293
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	294 Omitting :call and :eval ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	295
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	296 Functions can be called without `:call`: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	297 writefile(lines, 'file')
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	298 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	299
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	300 A method call without `eval` is possible, so long as the start is an
21516 c7b2ce90c2de patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	301 identifier or can't be an Ex command. Examples: >
c7b2ce90c2de patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	302 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	303 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	304 [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	305 {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	306 "foobar"->Process()
c7b2ce90c2de patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	307 ("foobar")->Process()
c7b2ce90c2de patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	308 'foobar'->Process()
c7b2ce90c2de patch 8.2.1308: Vim9: accidentally using "x" causes Vim to exit Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	309 ('foobar')->Process()
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	310
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	311 In the rare case there is ambiguity between a function name and an Ex command,
21676 1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	312 prepend ":" to make clear you want to use the Ex command. For example, there
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	313 is both the `:substitute` command and the `substitute()` function. When the
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	314 line starts with `substitute(` this will use the function. Prepend a colon to
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	315 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	316 :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	317
19556 ff5048b0ccfe patch 8.2.0335: no completion for :disassemble Bram Moolenaar <Bram@vim.org> parents: 19523 diff changeset	318 Note that while variables need to be defined before they can be used,
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	319 functions can be called before being defined. This is required to allow
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	320 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	321 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	322 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	323
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	324
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	325 Omitting function() ~
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	326
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	327 A user defined function can be used as a function reference in an expression
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	328 without `function()`. The argument types and return type will then be checked.
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	329 The function must already have been defined. >
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	330
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	331 var Funcref = MyFunction
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	332
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	333 When using `function()` the resulting type is "func", a function with any
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	334 number of arguments and any return type. The function can be defined later.
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	335
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	336
19999 844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	337 Automatic line continuation ~
844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	338
844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	339 In many cases it is obvious that an expression continues on the next line. In
21676 1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	340 those cases there is no need to prefix the line with a backslash
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	341 \|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	342 var mylist = [
19999 844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	343 'one',
844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	344 'two',
844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	345 ]
20011 628011800942 patch 8.2.0561: Vim9: cannot split function call in multiple lines Bram Moolenaar <Bram@vim.org> parents: 19999 diff changeset	346 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	347 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	348 one: 1,
628011800942 patch 8.2.0561: Vim9: cannot split function call in multiple lines Bram Moolenaar <Bram@vim.org> parents: 19999 diff changeset	349 two: 2,
628011800942 patch 8.2.0561: Vim9: cannot split function call in multiple lines Bram Moolenaar <Bram@vim.org> parents: 19999 diff changeset	350 }
628011800942 patch 8.2.0561: Vim9: cannot split function call in multiple lines Bram Moolenaar <Bram@vim.org> parents: 19999 diff changeset	351 Function call: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	352 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	353 arg1,
628011800942 patch 8.2.0561: Vim9: cannot split function call in multiple lines Bram Moolenaar <Bram@vim.org> parents: 19999 diff changeset	354 arg2
628011800942 patch 8.2.0561: Vim9: cannot split function call in multiple lines Bram Moolenaar <Bram@vim.org> parents: 19999 diff changeset	355 )
628011800942 patch 8.2.0561: Vim9: cannot split function call in multiple lines Bram Moolenaar <Bram@vim.org> parents: 19999 diff changeset	356
20982 bb49b5090a9c patch 8.2.1042: Vim9: cannot put an operator on the next line Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	357 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	358 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	359 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	360 .. middle
bb49b5090a9c patch 8.2.1042: Vim9: cannot put an operator on the next line Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	361 .. end
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	362 var total = start +
20013 bf377a9ffccb patch 8.2.0562: Vim9: cannot split an expression into multiple lines Bram Moolenaar <Bram@vim.org> parents: 20011 diff changeset	363 end -
bf377a9ffccb patch 8.2.0562: Vim9: cannot split an expression into multiple lines Bram Moolenaar <Bram@vim.org> parents: 20011 diff changeset	364 correction
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	365 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	366 ? 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	367 : 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	368
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	369 For a method call using "->" and a member using a dot, a line break is allowed
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	370 before it: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	371 var result = GetBuilder()
20965 59f93c2d2551 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	372 ->BuilderSetWidth(333)
59f93c2d2551 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	373 ->BuilderSetHeight(777)
59f93c2d2551 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	374 ->BuilderBuild()
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	375 var result = MyDict
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	376 .member
20965 59f93c2d2551 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	377
20982 bb49b5090a9c patch 8.2.1042: Vim9: cannot put an operator on the next line Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	378 < E1050
bb49b5090a9c patch 8.2.1042: Vim9: cannot put an operator on the next line Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	379 To make it possible for the operator at the start of the line to be
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	380 recognized, it is required to put a colon before a range. This will add
20982 bb49b5090a9c patch 8.2.1042: Vim9: cannot put an operator on the next line Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	381 "start" and print: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	382 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	383 + print
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	384 Like this: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	385 var result = start + print
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	386
20982 bb49b5090a9c patch 8.2.1042: Vim9: cannot put an operator on the next line Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	387 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	388 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	389 :+ print
19999 844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	390
23047 29c5f168c6fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22958 diff changeset	391 Note that the colon is not required for the \|+cmd\| argument: >
29c5f168c6fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22958 diff changeset	392 edit +6 fname
29c5f168c6fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22958 diff changeset	393
20015 c001ee73519a patch 8.2.0563: Vim9: cannot split a function line Bram Moolenaar <Bram@vim.org> parents: 20013 diff changeset	394 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	395 arguments: >
c001ee73519a patch 8.2.0563: Vim9: cannot split a function line Bram Moolenaar <Bram@vim.org> parents: 20013 diff changeset	396 def MyFunc(
c001ee73519a patch 8.2.0563: Vim9: cannot split a function line Bram Moolenaar <Bram@vim.org> parents: 20013 diff changeset	397 text: string,
c001ee73519a patch 8.2.0563: Vim9: cannot split a function line Bram Moolenaar <Bram@vim.org> parents: 20013 diff changeset	398 separator = '-'
c001ee73519a patch 8.2.0563: Vim9: cannot split a function line Bram Moolenaar <Bram@vim.org> parents: 20013 diff changeset	399 ): string
c001ee73519a patch 8.2.0563: Vim9: cannot split a function line Bram Moolenaar <Bram@vim.org> parents: 20013 diff changeset	400
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	401 Notes:
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	402 - "enddef" cannot be used at the start of a continuation line, it ends the
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	403 current function.
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	404 - No line break is allowed in the LHS of an assignment. Specifically when
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	405 unpacking a list \|:let-unpack\|. This is OK: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	406 [var1, var2] =
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	407 Func()
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	408 < This does not work: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	409 [var1,
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	410 var2] =
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	411 Func()
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	412 - No line break is allowed in between arguments of an `:echo`, `:execute` and
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	413 similar commands. This is OK: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	414 echo [1,
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	415 2] [3,
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	416 4]
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	417 < This does not work: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	418 echo [1, 2]
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	419 [3, 4]
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	420 - No line break is allowed in the arguments of a lambda, between the "{" and
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	421 "->". This is OK: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	422 filter(list, {k, v ->
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	423 v > 0})
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	424 < This does not work: >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	425 filter(list, {k,
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	426 v -> v > 0})
20982 bb49b5090a9c patch 8.2.1042: Vim9: cannot put an operator on the next line Bram Moolenaar <Bram@vim.org> parents: 20965 diff changeset	427
19999 844c7646f61b patch 8.2.0555: Vim9: line continuation is not always needed Bram Moolenaar <Bram@vim.org> parents: 19968 diff changeset	428
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	429 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	430
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	431 \|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	432
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	433
22936 00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	434 Dictionary literals ~
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	435
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	436 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	437 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	438
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	439 Later it became clear that using a simple key name is very common, thus
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	440 literally dictionaries were introduced in a backwards compatible way: >
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	441 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	442
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	443 However, this #{} syntax is unlike any existing language. As it appears that
22958 e7c125224b1a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22936 diff changeset	444 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	445 considering that JavaScript uses this syntax, using the {} form for dictionary
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	446 literals was considered a much more useful syntax. In Vim9 script the {} form
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	447 uses literal keys: >
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	448 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	449
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	450 In case an expression needs to be used for the key, square brackets can be
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	451 used, just like in JavaScript: >
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	452 let dict = {["key" .. nr]: value}
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	453
00b0275ffe7f patch 8.2.2015: Vim9: literal dict #{} is not like any other language Bram Moolenaar <Bram@vim.org> parents: 22723 diff changeset	454
21584 d0c76ce48326 patch 8.2.1342: Vim9: accidentally using "t" gives a confusing error Bram Moolenaar <Bram@vim.org> parents: 21550 diff changeset	455 No :xit, :t, :append, :change or :insert ~
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	456
21584 d0c76ce48326 patch 8.2.1342: Vim9: accidentally using "t" gives a confusing error Bram Moolenaar <Bram@vim.org> parents: 21550 diff changeset	457 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	458 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	459 Instead of `:t` you can use `:copy`.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	460
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	461
51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	462 Comparators ~
51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	463
51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	464 The 'ignorecase' option is not used for comparators that use strings.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	465
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	466
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	467 White space ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	468
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	469 Vim9 script enforces proper use of white space. This is no longer allowed: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	470 var name=234 # Error!
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	471 var name= 234 # Error!
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	472 var name =234 # Error!
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	473 There must be white space before and after the "=": >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	474 var name = 234 # OK
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	475 White space must also be put before the # that starts a comment after a
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	476 command: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	477 var name = 234# Error!
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	478 var name = 234 # OK
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	479
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	480 White space is required around most operators.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	481
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	482 White space is not allowed:
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	483 - Between a function name and the "(": >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	484 call Func (arg) # Error!
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	485 call Func
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	486 \ (arg) # Error!
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	487 call Func(arg) # OK
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	488 call Func(
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	489 \ arg) # OK
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	490 call Func(
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	491 \ arg # OK
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	492 \ )
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	493
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	494
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	495 Conditions and expressions ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	496
22500 ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	497 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	498 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	499 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	500 0 falsy falsy
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	501 1 truthy truthy
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	502 99 truthy Error!
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	503 "0" falsy Error!
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	504 "99" truthy Error!
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	505 "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	506
22500 ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	507 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	508 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	509 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	510
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	511 type truthy when ~
22272 eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	512 bool 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	513 number non-zero
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	514 float non-zero
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	515 string non-empty
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	516 blob non-empty
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	517 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	518 dictionary non-empty (different from JavaScript)
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	519 func when there is a function name
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	520 special v:true
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	521 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	522 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	523 class when not NULL
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	524 object when not NULL (TODO: when isTrue() returns v:true)
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	525
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	526 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	527 one: >
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	528 1 \|\| false == true
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	529 0 \|\| 1 == true
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	530 0 \|\| false == false
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	531 1 && true == true
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	532 0 && 1 == false
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	533 8 \|\| 0 Error!
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	534 'yes' && 0 Error!
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	535 [] \|\| 99 Error!
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	536
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	537 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	538 result is a boolean. "!!" can be used to turn any value into boolean: >
22494 4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	539 !'yes' == false
22500 ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	540 !![] == false
ef8a3177edc1 patch 8.2.1798: Vim9: trinary operator condition is too permissive Bram Moolenaar <Bram@vim.org> parents: 22494 diff changeset	541 !![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	542
4c21f7f6f9e3 patch 8.2.1795: Vim9: operators && and \|\| have a confusing result Bram Moolenaar <Bram@vim.org> parents: 22441 diff changeset	543 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	544 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	545 'hello ' .. 123 == 'hello 123'
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	546 'hello ' .. v:true == 'hello v:true'
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	547
21771 fcf978444298 patch 8.2.1435: Vim9: always converting to string for ".." leads to mistakes Bram Moolenaar <Bram@vim.org> parents: 21717 diff changeset	548 Simple types are string, float, special and bool. For other types \|string()\|
fcf978444298 patch 8.2.1435: Vim9: always converting to string for ".." leads to mistakes Bram Moolenaar <Bram@vim.org> parents: 21717 diff changeset	549 can be used.
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	550 false true
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	551 In Vim9 script one can use "true" for v:true and "false" for v:false.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	552
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	553 Indexing a string with [idx] or [idx, idx] uses character indexes instead of
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	554 byte indexes. Example: >
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	555 echo 'bár'[1]
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	556 In legacy script this results in the character 0xc3 (an illegal byte), in Vim9
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	557 script this results in the string 'á'.
0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	558
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	559
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	560 What to watch out for ~
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	561 vim9-gotchas
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	562 Vim9 was designed to be closer to often used programming languages, but at the
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	563 same time tries to support the legacy Vim commands. Some compromises had to
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	564 be made. Here is a summary of what might be unexpected.
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	565
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	566 Ex command ranges need to be prefixed with a colon. >
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	567 -> # legacy Vim: shifts the previous line to the right
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	568 ->func() # Vim9: method call in continuation line
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	569 :-> # Vim9: shifts the previous line to the right
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	570
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	571 %s/a/b # legacy Vim: substitute on all lines
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	572 x = alongname
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	573 % another # Vim9: line continuation without a backslash
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	574 :%s/a/b # Vim9: substitute on all lines
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	575 'text'->func() # Vim9: method call
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	576 :'t # legacy Vim: jump to mark m
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	577
21676 1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	578 Some Ex commands can be confused with assignments in Vim9 script: >
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	579 g:name = value # assignment
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	580 g:pattern:cmd # invalid command - ERROR
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	581 :g:pattern:cmd # :global command
1b345fb68ae3 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21584 diff changeset	582
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	583 Functions defined with `:def` compile the whole function. Legacy functions
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	584 can bail out, and the following lines are not parsed: >
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	585 func Maybe()
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	586 if !has('feature')
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	587 return
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	588 endif
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	589 use-feature
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	590 endfunc
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	591 Vim9 functions are compiled as a whole: >
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	592 def Maybe()
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	593 if !has('feature')
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	594 return
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	595 endif
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	596 use-feature # May give compilation error
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	597 enddef
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	598 For a workaround, split it in two functions: >
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	599 func Maybe()
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	600 if has('feature')
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	601 call MaybyInner()
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	602 endif
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	603 endfunc
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	604 if has('feature')
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	605 def MaybeInner()
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	606 use-feature
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	607 enddef
99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	608 endif
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	609 Or put the unsupported code inside an `if` with a constant expression that
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	610 evaluates to false: >
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	611 def Maybe()
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	612 if has('feature')
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	613 use-feature
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	614 endif
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	615 enddef
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	616 Note that for unrecognized commands there is no check for "\|" and a following
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	617 command. This will give an error for missing `endif`: >
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	618 def Maybe()
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	619 if has('feature') \| use-feature \| endif
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	620 enddef
21093 99a602b27e0e Runtime file updates Bram Moolenaar <Bram@vim.org> parents: 20982 diff changeset	621
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	622 ==============================================================================
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	623
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	624 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	625
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	626 THIS IS STILL UNDER DEVELOPMENT - ANYTHING CAN BREAK - ANYTHING CAN CHANGE
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	627
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	628 :def
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	629 :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	630 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	631 the function follows in the next lines, until the
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	632 matching `:enddef`.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	633
19904 bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	634 When {return-type} is omitted or is "void" the
bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	635 function is not expected to return anything.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	636
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	637 {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	638 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	639 {name}: {type}
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	640 {name} = {value}
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	641 {name}: {type} = {value}
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	642 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	643 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	644 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	645 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	646
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	647 The function will be compiled into instructions when
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	648 called, or when `:disassemble` or `:defcompile` is
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	649 used. Syntax and type errors will be produced at that
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	650 time.
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	651
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	652 It is possible to nest `:def` inside another `:def` or
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	653 `:function` up to about 50 levels deep.
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	654
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	655 [!] 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	656 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	657 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	658 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	659
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	660 :enddef
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	661 :enddef End of a function defined with `:def`. It should be on
3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	662 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	663
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	664
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	665 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	666 variables can be accessed without the "s:" prefix. They must be defined
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	667 before the function is compiled. If the script the function is defined in is
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	668 legacy script, then script-local variables must be accessed with the "s:"
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	669 prefix and they do not need to exist (they can be deleted any time).
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	670
20552 74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	671 :defc :defcompile
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	672 :defc[ompile] Compile functions defined in the current script that
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	673 were not compiled yet.
74e3316c1d5a Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20379 diff changeset	674 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	675
19404 7be3663e2f2b Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19303 diff changeset	676 :disa :disassemble
7be3663e2f2b Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19303 diff changeset	677 :disa[ssemble] {func} Show the instructions generated for {func}.
7be3663e2f2b Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19303 diff changeset	678 This is for debugging and testing.
19556 ff5048b0ccfe patch 8.2.0335: no completion for :disassemble Bram Moolenaar <Bram@vim.org> parents: 19523 diff changeset	679 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	680 can prepend "s:" to find script-local functions.
19404 7be3663e2f2b Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19303 diff changeset	681
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	682 Limitations ~
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	683
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	684 Local variables will not be visible to string evaluation. For example: >
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	685 def EvalString(): list<string>
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	686 var list = ['aa', 'bb', 'cc', 'dd']
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	687 return range(1, 2)->map('list[v:val]')
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	688 enddef
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	689
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	690 The map argument is a string expression, which is evaluated without the
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	691 function scope. Instead, use a lambda: >
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	692 def EvalString(): list<string>
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	693 var list = ['aa', 'bb', 'cc', 'dd']
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	694 return range(1, 2)->map({ _, v -> list[v] })
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	695 enddef
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	696
21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 21093 diff changeset	697
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	698 ==============================================================================
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	699
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	700 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	701
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	702 THIS IS STILL UNDER DEVELOPMENT - ANYTHING CAN BREAK - ANYTHING CAN CHANGE
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	703
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	704 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	705 bool
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	706 number
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	707 float
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	708 string
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	709 blob
19904 bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	710 list<{type}>
bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	711 dict<{type}>
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	712 job
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	713 channel
19646 847a300aa244 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19574 diff changeset	714 func
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	715 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	716 func({type}, ...)
bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	717 func({type}, ...): {type}
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	718
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	719 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	720 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	721
19904 bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	722 These types can be used in declarations, but no value will have this type:
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	723 {type}\|{type} {not implemented yet}
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	724 void
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	725 any
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	726
19904 bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	727 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	728 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	729 memory.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	730
19904 bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	731 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	732 func any kind of function reference, no type
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	733 checking for arguments or return value
19904 bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	734 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	735 return type
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	736 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	737 a value
19968 1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	738 func({type}): {type} function with argument type and return type
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	739 func(?{type}) function with type of optional argument, does
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	740 not return a value
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	741 func(...{type}) function with type of variable number of
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	742 arguments, does not return a value
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	743 func({type}, ?{type}, ...{type}): {type}
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	744 function with:
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	745 - type of mandatory argument
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	746 - type of optional argument
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	747 - type of variable number of arguments
1908e92b02fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19904 diff changeset	748 - 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	749
bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	750 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	751
bd4f91762d0f patch 8.2.0508: Vim9: func and partial types not done yet Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	752 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	753 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	754 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	755
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	756 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	757 :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	758 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	759 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	760 {not implemented yet}
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	761
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	762 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	763 :class MyClass
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	764 :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	765
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	766 :interface MyInterface
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	767 :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	768
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	769 :class MyTemplate<Targ>
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	770 :var mine: MyTemplate<number>
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	771 :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	772
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	773 :class MyInterface<Targ>
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	774 :var mine: MyInterface<number>
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	775 :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	776 {not implemented yet}
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	777
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	778
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	779 Variable types and type casting ~
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	780 variable-types
21717 ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	781 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	782 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	783
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	784 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	785 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	786 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	787
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	788 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	789 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	790 var l: list<number> = [1, g:two]
21717 ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	791 This will give an error, because "g:two" has type "any". To avoid this, use a
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	792 type cast: >
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	793 var l: list<number> = [1, <number>g:two]
21717 ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	794 < type-casting
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	795 The compiled code will then check that "g:two" is a number at runtime and give
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	796 an error if it isn't. This is called type casting.
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	797
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	798 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	799 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	800 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	801
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	802 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	803 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	804 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	805 string to a number.
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	806
ef3b31d510d2 patch 8.2.1408: Vim9: type casting not supported Bram Moolenaar <Bram@vim.org> parents: 21715 diff changeset	807
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	808 Type inference ~
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	809 type-inference
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	810 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	811 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	812 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	813 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	814
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	815 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	816 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	817 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	818 [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	819 ['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	820 [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	821
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	822
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	823 Stricter type checking ~
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	824 type-checking
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	825 In legacy Vim script, where a number was expected, a string would be
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	826 automatically converted to a number. This was convenient for an actual number
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	827 such as "123", but leads to unexpected problems (but no error message) if the
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	828 string doesn't start with a number. Quite often this leads to hard-to-find
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	829 bugs.
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	830
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	831 In Vim9 script this has been made stricter. In most places it works just as
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	832 before, if the value used matches the expected type. There will sometimes be
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	833 an error, thus breaking backwards compatibility. For example:
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	834 - Using a number other than 0 or 1 where a boolean is expected. E1023
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	835 - Using a string value when setting a number options.
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	836 - Using a number where a string is expected. E1024
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	837
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	838 ==============================================================================
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	839
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	840 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	841 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	842
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	843 THIS IS STILL UNDER DEVELOPMENT - ANYTHING CAN BREAK - ANYTHING CAN CHANGE
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	844
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	845 A Vim9 script can be written to be imported. This means that everything in
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	846 the script is local, unless exported. Those exported items, and only those
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	847 items, can then be imported in another script.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	848
21991 bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	849 You can cheat by using the global namespace explicitly. We will assume here
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	850 that you don't do that.
bbca88cd13d5 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21825 diff changeset	851
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	852
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	853 Namespace ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	854 :vim9script :vim9
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	855 To recognize a file that can be imported the `vim9script` statement must
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	856 appear as the first statement in the file. It tells Vim to interpret the
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	857 script in its own namespace, instead of the global namespace. If a file
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	858 starts with: >
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	859 vim9script
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	860 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	861 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	862 be available as `g:myvar` from any other script and function.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	863
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	864 The variables at the file level are very much like the script-local "s:"
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	865 variables in legacy Vim script, but the "s:" is omitted. And they cannot be
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	866 deleted.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	867
20115 bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	868 In Vim9 script the global "g:" namespace can still be used as before. And the
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	869 "w:", "b:" and "t:" namespaces. These have in common that variables are not
bd021eb62e73 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20023 diff changeset	870 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	871
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	872 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	873 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	874 :set cpo&vim
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	875 One of the effects is that \|line-continuation\| is always enabled.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	876 The original value of 'cpoptions' is restored at the end of the script.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	877
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	878
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	879 Export ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	880 :export :exp
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	881 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	882 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	883 export var someValue = ...
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	884 export final someValue = ...
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	885 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	886 export def MyFunc() ...
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	887 export class MyClass ...
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	888
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	889 As this suggests, only constants, variables, `:def` functions and classes can
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21353 diff changeset	890 be exported. {classes are not implemented yet}
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	891
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	892 E1042
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	893 `: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	894
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	895
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	896 Import ~
20965 59f93c2d2551 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20856 diff changeset	897 :import :imp E1094
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	898 The exported items can be imported individually in another Vim9 script: >
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	899 import EXPORTED_CONST from "thatscript.vim"
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	900 import MyClass from "myclass.vim"
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	901
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	902 To import multiple items at the same time: >
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	903 import {someValue, MyClass} from "thatscript.vim"
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	904
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	905 In case the name is ambiguous, another name can be specified: >
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	906 import MyClass as ThatClass from "myclass.vim"
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	907 import {someValue, MyClass as ThatClass} from "myclass.vim"
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	908
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	909 To import all exported items under a specific identifier: >
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	910 import * as That from 'thatscript.vim'
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	911
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	912 {not implemented yet: using "This as That"}
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	913
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	914 Then you can use "That.EXPORTED_CONST", "That.someValue", etc. You are free
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	915 to choose the name "That", but it is highly recommended to use the name of the
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	916 script file to avoid confusion.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	917
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	918 `:import` can also be used in legacy Vim script. The imported items still
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	919 become script-local, even when the "s:" prefix is not given.
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	920
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	921 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	922 - 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	923 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	924 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	925 - An absolute path, starting with "/" on Unix or "D:/" on MS-Windows. This
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22565 diff changeset	926 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	927 - 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	928 "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	929 longer and unique, to avoid loading the wrong file.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	930
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	931 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	932 next time the same script is imported. It will not be read again.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	933 :import-cycle
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	934 The `import` commands are executed when encountered. If that script (directly
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	935 or indirectly) imports the current script, then items defined after the
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	936 `import` won't be processed yet. Therefore cyclic imports can exist, but may
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	937 result in undefined items.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	938
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	939
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	940 Import in an autoload script ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	941
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	942 For optimal startup speed, loading scripts should be postponed until they are
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	943 actually needed. A recommended mechanism:
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	944
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	945 1. In the plugin define user commands, functions and/or mappings that refer to
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	946 an autoload script. >
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	947 command -nargs=1 SearchForStuff call searchfor#Stuff(<f-args>)
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	948
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	949 < This goes in .../plugin/anyname.vim. "anyname.vim" can be freely chosen.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	950
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	951 2. In the autoload script do the actual work. You can import items from
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	952 other files to split up functionality in appropriate pieces. >
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	953 vim9script
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	954 import FilterFunc from "../import/someother.vim"
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	955 def searchfor#Stuff(arg: string)
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	956 var filtered = FilterFunc(arg)
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	957 ...
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	958 < This goes in .../autoload/searchfor.vim. "searchfor" in the file name
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	959 must be exactly the same as the prefix for the function name, that is how
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	960 Vim finds the file.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	961
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	962 3. Other functionality, possibly shared between plugins, contains the exported
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	963 items and any private items. >
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	964 vim9script
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	965 var localVar = 'local'
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	966 export def FilterFunc(arg: string): string
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	967 ...
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	968 < This goes in .../import/someother.vim.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	969
21771 fcf978444298 patch 8.2.1435: Vim9: always converting to string for ".." leads to mistakes Bram Moolenaar <Bram@vim.org> parents: 21717 diff changeset	970 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	971 encountered, the script is not loaded until the `:def` function is called.
fcf978444298 patch 8.2.1435: Vim9: always converting to string for ".." leads to mistakes Bram Moolenaar <Bram@vim.org> parents: 21717 diff changeset	972
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	973
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	974 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	975
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	976 If an `import` statement is used in legacy Vim script, the script-local "s:"
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	977 namespace will be used for the imported item, even when "s:" is not specified.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	978
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	979
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	980 ==============================================================================
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	981
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	982 6. Future work: classes vim9-classes
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	983
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	984 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	985 Most of Vim9 script can be created without this functionality, and since
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	986 implementing classes is going to be a lot of work, it is left for the future.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	987 For now we'll just make sure classes can be added later.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	988
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	989 Thoughts:
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	990 - `class` / `endclass`, everything in one file
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	991 - Class names are always CamelCase
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	992 - Single constructor
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	993 - Single inheritance with `class ThisClass extends BaseClass`
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	994 - `abstract class`
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	995 - `interface` (Abstract class without any implementation)
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	996 - `class SomeClass implements SomeInterface`
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	997 - Generics for class: `class <Tkey, Tentry>`
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	998 - Generics for function: `def <Tkey> GetLast(key: Tkey)`
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	999
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1000 Again, much of this is from TypeScript.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1001
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1002 Some things that look like good additions:
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1003 - Use a class as an interface (like Dart)
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1004 - Extend a class with methods, using an import (like Dart)
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1005
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1006 An important class that will be provided is "Promise". Since Vim is single
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1007 threaded, connecting asynchronous operations is a natural way of allowing
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1008 plugins to do their work without blocking the user. It's a uniform way to
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1009 invoke callbacks and handle timeouts and errors.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1010
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1011 ==============================================================================
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1012
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1013 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	1014
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1015 The :def command ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1016
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1017 Plugin writers have asked for much faster Vim script. Investigations have
19303 51bc26d4a393 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19181 diff changeset	1018 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	1019 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	1020 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	1021 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	1022 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	1023 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	1024
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1025 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	1026 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	1027 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	1028 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	1029
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1030 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	1031 "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	1032
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1033
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1034 Type checking ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1035
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1036 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	1037 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	1038 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	1039 encountering the "+" character and compiling this into a generic add
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1040 instruction, at execution time the instruction would have to inspect the type
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1041 of the arguments and decide what kind of addition to do. And when the
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1042 type is dictionary throw an error. If the types are known to be numbers then
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1043 an "add number" instruction can be used, which is faster. The error can be
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1044 given at compile time, no error handling is needed at runtime, since adding
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1045 two numbers cannot fail.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1046
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1047 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	1048 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	1049 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	1050
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1051
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1052 Removing clutter and weirdness ~
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1053
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1054 Once decided that `:def` functions have different syntax than legacy functions,
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1055 we are free to add improvements to make the code more familiar for users who
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1056 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	1057 only Vim does.
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1058
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1059 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	1060 backwards compatible with the good old Vi commands.
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1061
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1062 Examples:
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1063 - Drop `:call` for calling a function and `:eval` for manipulating data.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1064 - Drop using a leading backslash for line continuation, automatically figure
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1065 out where an expression ends.
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1066
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1067 However, this does require that some things need to change:
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1068 - 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	1069 This is good anyway, it is known from several popular languages.
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1070 - Ex command ranges need to be prefixed with a colon, to avoid confusion with
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1071 expressions (single quote can be a string or a mark, "/" can be divide or a
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1072 search command, etc.).
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1073
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1074 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	1075 is accidentally used you are very likely to get an error message.
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1076
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1077
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1078 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	1079
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1080 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	1081 different from what they are used to. To reduce this complaint popular
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1082 languages are used as an example. At the same time, we do not want to abandon
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1083 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	1084
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1085 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	1086 gaining popularity and has similarities with Vim script. It also has a
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1087 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	1088 typing (a variable can have different types, this changes at runtime). Since
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1089 legacy Vim script is dynamically typed and a lot of existing functionality
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1090 (esp. builtin functions) depends on that, while static typing allows for much
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1091 faster execution, we need to have this mix in Vim9 script.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1092
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1093 There is no intention to completely match TypeScript syntax and semantics. We
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1094 just want to take those parts that we can use for Vim and we expect Vim users
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1095 will be happy with. TypeScript is a complex language with its own history,
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1096 advantages and disadvantages. To get an idea of the disadvantages read the
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1097 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	1098 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	1099
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1100 People familiar with other languages (Java, Python, etc.) will also find
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1101 things in TypeScript that they do not like or do not understand. We'll try to
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1102 avoid those things.
22272 eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	1103
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	1104 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	1105 - 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	1106 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	1107 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	1108 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	1109 - 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	1110 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	1111 annoying. Vim recognizes an expression with && or \|\| and allows using the
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1112 result as a bool. TODO: to be reconsidered
22272 eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	1113 - 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	1114 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	1115 Falsy.
eb1f5f618c75 patch 8.2.1685: Vim9: cannot declare a constant value Bram Moolenaar <Bram@vim.org> parents: 22171 diff changeset	1116 - 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	1117 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	1118 which is more flexible, but is only checked at runtime.
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1119
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1120
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1121 Declarations ~
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1122
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1123 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	1124 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	1125 `: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	1126 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	1127
23047 29c5f168c6fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22958 diff changeset	1128 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	1129 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	1130 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	1131 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	1132 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	1133 almost the same.
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1134
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1135 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	1136 :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	1137 :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	1138 :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	1139
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1140 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	1141 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	1142 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	1143 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	1144 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	1145 ...
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1146 name = 'John'
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1147 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	1148
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1149 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	1150 var mylist: list<string>
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1151 final mylist: list<string> = ['foo']
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1152 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	1153
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1154 Two alternatives were considered:
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1155 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	1156 var list<string> mylist
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1157 final list<string> mylist = ['foo']
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1158 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	1159 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	1160 var mylist list<string>
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1161 final mylist list<string> = ['foo']
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1162 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	1163
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1164 The first is more familiar for anyone used to C or Java. The second one
22565 17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1165 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	1166
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1167 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	1168 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	1169 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	1170 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	1171 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	1172
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1173 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	1174 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	1175 declaration.
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1176
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1177
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1178 Expressions ~
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1179
22565 17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1180 Expression evaluation was already close to what other languages are doing.
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1181 Some details are unexpected and can be improved. For example a boolean
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1182 condition would accept a string, convert it to a number and check if the
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1183 number is non-zero. This is unexpected and often leads to mistakes, since
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1184 text not starting with a number would be converted to zero, which is
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22565 diff changeset	1185 considered false. Thus using a string for a condition would often not give an
5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22565 diff changeset	1186 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	1187
23047 29c5f168c6fd Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22958 diff changeset	1188 In Vim9 type checking is stricter to avoid mistakes. Where a condition is
22565 17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1189 used, e.g. with the `:if` command and the `\|\|` operator, only boolean-like
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1190 values are accepted:
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1191 true: `true`, `v:true`, `1`, `0 < 9`
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1192 false: `false`, `v:false`, `0`, `0 > 9`
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1193 Note that the number zero is false and the number one is true. This is more
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22565 diff changeset	1194 permissive than most other languages. It was done because many builtin
22565 17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1195 functions return these values.
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1196
22565 17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1197 If you have any type of value and want to use it as a boolean, use the `!!`
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1198 operator:
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1199 true: !`!'text'`, `!![99]`, `!!{'x': 1}`, `!!99`
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1200 false: `!!''`, `!![]`, `!!{}`
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1201
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1202 From a language like JavaScript we have this handy construct: >
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1203 GetName() \|\| 'unknown'
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1204 However, this conflicts with only allowing a boolean for a condition.
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1205 Therefore the "??" operator was added: >
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1206 GetName() ?? 'unknown'
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1207 Here you can explicitly express your intention to use the value as-is and not
17c4178f26ea Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22500 diff changeset	1208 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	1209
a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1210
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1211 Import and Export ~
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1212
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1213 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	1214 are global. It is possible to make them script-local, but then they are not
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1215 available in other scripts. This defies the concept of a package that only
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1216 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	1217
21825 0db0640e16e0 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21771 diff changeset	1218 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	1219 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	1220 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	1221 - 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	1222 unless exported.
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1223 - When importing a script the symbols that are imported are explicitly listed,
d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1224 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	1225 - 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	1226 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	1227 - 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	1228 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	1229 - 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	1230 avoided.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1231 - 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	1232
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1233 When sourcing a Vim9 script from a legacy script, only the items defined
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1234 globally can be used, not the exported items. Alternatives considered:
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1235 - All the exported items become available as script-local items. This makes
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1236 it uncontrollable what items get defined and likely soon leads to trouble.
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1237 - Use the exported items and make them global. Disadvantage is that it's then
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1238 not possible to avoid name clashes in the global namespace.
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1239 - Completely disallow sourcing a Vim9 script, require using `:import`. That
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1240 makes it difficult to use scripts for testing, or sourcing them from the
83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1241 command line to try them out.
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1242 Note that you can also use `:import` in legacy Vim script, see above.
20856 83cfa1ef1bf2 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20552 diff changeset	1243
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1244
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1245 Compiling functions early ~
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1246
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1247 Functions are compiled when called or when `:defcompile` is used. Why not
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1248 compile them early, so that syntax and type errors are reported early?
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1249
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1250 The functions can't be compiled right away when encountered, because there may
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1251 be forward references to functions defined later. Consider defining functions
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1252 A, B and C, where A calls B, B calls C, and C calls A again. It's impossible
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1253 to reorder the functions to avoid forward references.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1254
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1255 An alternative would be to first scan through the file to locate items and
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1256 figure out their type, so that forward references are found, and only then
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1257 execute the script and compile the functions. This means the script has to be
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1258 parsed twice, which is slower, and some conditions at the script level, such
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1259 as checking if a feature is supported, are hard to use. An attempt was made
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1260 to see if it works, but it turned out to be impossible to make work nicely.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1261
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1262 It would be possible to compile all the functions at the end of the script.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1263 The drawback is that if a function never gets called, the overhead of
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1264 compiling it counts anyway. Since startup speed is very important, in most
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1265 cases it's better to do it later and accept that syntax and type errors are
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1266 only reported then. In case these errors should be found early, e.g. when
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1267 testing, the `:defcompile` command will help out.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1268
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1269
22391 a9fb7efa31d6 patch 8.2.1744: Vim9: using ":const!" is weird Bram Moolenaar <Bram@vim.org> parents: 22328 diff changeset	1270 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	1271
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1272 Vim supports interfaces to Perl, Python, Lua, Tcl and a few others. But
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1273 these interfaces have never become widely used, for various reasons. When
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1274 Vim9 was designed a decision was made to make these interfaces lower priority
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1275 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	1276
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1277 Still, plugin writers may find other languages more familiar, want to use
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1278 existing libraries or see a performance benefit. We encourage plugin authors
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1279 to write code in any language and run it as an external tool, using jobs and
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1280 channels. We can try to make this easier somehow.
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1281
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1282 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	1283 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	1284 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	1285 tool need to be supported. Since most languages support classes the lack of
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1286 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	1287
22328 75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1288
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1289 Classes ~
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1290
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1291 Vim supports a kind-of object oriented programming by adding methods to a
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1292 dictionary. With some care this can be made to work, but it does not look
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1293 like real classes. On top of that, it's quite slow, because of the use of
75ff30a78189 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22272 diff changeset	1294 dictionaries.
19181 94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1295
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1296 The support of classes in Vim9 script is a "minimal common functionality" of
22171 d4c7b3e9cd17 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21991 diff changeset	1297 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	1298 popular programming language.
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1299
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1300
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1301
94eda51ba9ba patch 8.2.0149: maintaining a Vim9 branch separately is more work Bram Moolenaar <Bram@vim.org> parents: diff changeset	1302 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/vim9.txt @ 23047:29c5f168c6fd