blob: 40516509cb7e176cba1fd30a6d1de751e3388628 [file] [log] [blame]
" Test various aspects of the Vim9 script language.
source check.vim
source term_util.vim
source view_util.vim
source vim9.vim
source screendump.vim
func Test_def_basic()
def SomeFunc(): string
return 'yes'
enddef
call SomeFunc()->assert_equal('yes')
endfunc
def ReturnString(): string
return 'string'
enddef
def ReturnNumber(): number
return 123
enddef
let g:notNumber = 'string'
def ReturnGlobal(): number
return g:notNumber
enddef
def Test_return_something()
ReturnString()->assert_equal('string')
ReturnNumber()->assert_equal(123)
assert_fails('ReturnGlobal()', 'E1012: Type mismatch; expected number but got string', '', 1, 'ReturnGlobal')
enddef
def Test_missing_return()
CheckDefFailure(['def Missing(): number',
' if g:cond',
' echo "no return"',
' else',
' return 0',
' endif'
'enddef'], 'E1027:')
CheckDefFailure(['def Missing(): number',
' if g:cond',
' return 1',
' else',
' echo "no return"',
' endif'
'enddef'], 'E1027:')
CheckDefFailure(['def Missing(): number',
' if g:cond',
' return 1',
' else',
' return 2',
' endif'
' return 3'
'enddef'], 'E1095:')
enddef
let s:nothing = 0
def ReturnNothing()
s:nothing = 1
if true
return
endif
s:nothing = 2
enddef
def Test_return_nothing()
ReturnNothing()
s:nothing->assert_equal(1)
enddef
func Increment()
let g:counter += 1
endfunc
def Test_call_ufunc_count()
g:counter = 1
Increment()
Increment()
Increment()
# works with and without :call
g:counter->assert_equal(4)
eval g:counter->assert_equal(4)
unlet g:counter
enddef
def MyVarargs(arg: string, ...rest: list<string>): string
let res = arg
for s in rest
res ..= ',' .. s
endfor
return res
enddef
def Test_call_varargs()
MyVarargs('one')->assert_equal('one')
MyVarargs('one', 'two')->assert_equal('one,two')
MyVarargs('one', 'two', 'three')->assert_equal('one,two,three')
enddef
def MyDefaultArgs(name = 'string'): string
return name
enddef
def MyDefaultSecond(name: string, second: bool = true): string
return second ? name : 'none'
enddef
def Test_call_default_args()
MyDefaultArgs()->assert_equal('string')
MyDefaultArgs('one')->assert_equal('one')
assert_fails('MyDefaultArgs("one", "two")', 'E118:', '', 3, 'Test_call_default_args')
MyDefaultSecond('test')->assert_equal('test')
MyDefaultSecond('test', true)->assert_equal('test')
MyDefaultSecond('test', false)->assert_equal('none')
CheckScriptFailure(['def Func(arg: number = asdf)', 'enddef', 'defcompile'], 'E1001:')
CheckScriptFailure(['def Func(arg: number = "text")', 'enddef', 'defcompile'], 'E1013: Argument 1: type mismatch, expected number but got string')
enddef
def Test_nested_function()
def Nested(arg: string): string
return 'nested ' .. arg
enddef
Nested('function')->assert_equal('nested function')
CheckDefFailure(['def Nested()', 'enddef', 'Nested(66)'], 'E118:')
CheckDefFailure(['def Nested(arg: string)', 'enddef', 'Nested()'], 'E119:')
CheckDefFailure(['func Nested()', 'endfunc'], 'E1086:')
CheckDefFailure(['def s:Nested()', 'enddef'], 'E1075:')
CheckDefFailure(['def b:Nested()', 'enddef'], 'E1075:')
CheckDefFailure([
'def Outer()',
' def Inner()',
' # comment',
' enddef',
' def Inner()',
' enddef',
'enddef'], 'E1073:')
CheckDefFailure([
'def Outer()',
' def Inner()',
' # comment',
' enddef',
' def! Inner()',
' enddef',
'enddef'], 'E1117:')
enddef
func Test_call_default_args_from_func()
call MyDefaultArgs()->assert_equal('string')
call MyDefaultArgs('one')->assert_equal('one')
call assert_fails('call MyDefaultArgs("one", "two")', 'E118:', '', 3, 'Test_call_default_args_from_func')
endfunc
def Test_nested_global_function()
let lines =<< trim END
vim9script
def Outer()
def g:Inner(): string
return 'inner'
enddef
enddef
defcompile
Outer()
g:Inner()->assert_equal('inner')
delfunc g:Inner
Outer()
g:Inner()->assert_equal('inner')
delfunc g:Inner
Outer()
g:Inner()->assert_equal('inner')
delfunc g:Inner
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def Outer()
def g:Inner(): string
return 'inner'
enddef
enddef
defcompile
Outer()
Outer()
END
CheckScriptFailure(lines, "E122:")
lines =<< trim END
vim9script
def Func()
echo 'script'
enddef
def Outer()
def Func()
echo 'inner'
enddef
enddef
defcompile
END
CheckScriptFailure(lines, "E1073:")
enddef
def Test_global_local_function()
let lines =<< trim END
vim9script
def g:Func(): string
return 'global'
enddef
def Func(): string
return 'local'
enddef
g:Func()->assert_equal('global')
Func()->assert_equal('local')
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def g:Funcy()
echo 'funcy'
enddef
s:Funcy()
END
CheckScriptFailure(lines, 'E117:')
enddef
def Test_local_function_shadows_global()
let lines =<< trim END
vim9script
def g:Gfunc(): string
return 'global'
enddef
def AnotherFunc(): number
let Gfunc = function('len')
return Gfunc('testing')
enddef
g:Gfunc()->assert_equal('global')
AnotherFunc()->assert_equal(7)
delfunc g:Gfunc
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def g:Func(): string
return 'global'
enddef
def AnotherFunc()
g:Func = function('len')
enddef
AnotherFunc()
END
CheckScriptFailure(lines, 'E705:')
delfunc g:Func
enddef
func TakesOneArg(arg)
echo a:arg
endfunc
def Test_call_wrong_args()
CheckDefFailure(['TakesOneArg()'], 'E119:')
CheckDefFailure(['TakesOneArg(11, 22)'], 'E118:')
CheckDefFailure(['bufnr(xxx)'], 'E1001:')
CheckScriptFailure(['def Func(Ref: func(s: string))'], 'E475:')
let lines =<< trim END
vim9script
def Func(s: string)
echo s
enddef
Func([])
END
CheckScriptFailure(lines, 'E1013: Argument 1: type mismatch, expected string but got list<unknown>', 5)
lines =<< trim END
vim9script
def FuncOne(nr: number)
echo nr
enddef
def FuncTwo()
FuncOne()
enddef
defcompile
END
writefile(lines, 'Xscript')
let didCatch = false
try
source Xscript
catch
assert_match('E119: Not enough arguments for function: <SNR>\d\+_FuncOne', v:exception)
assert_match('Xscript\[8\]..function <SNR>\d\+_FuncTwo, line 1', v:throwpoint)
didCatch = true
endtry
assert_true(didCatch)
lines =<< trim END
vim9script
def FuncOne(nr: number)
echo nr
enddef
def FuncTwo()
FuncOne(1, 2)
enddef
defcompile
END
writefile(lines, 'Xscript')
didCatch = false
try
source Xscript
catch
assert_match('E118: Too many arguments for function: <SNR>\d\+_FuncOne', v:exception)
assert_match('Xscript\[8\]..function <SNR>\d\+_FuncTwo, line 1', v:throwpoint)
didCatch = true
endtry
assert_true(didCatch)
delete('Xscript')
enddef
" Default arg and varargs
def MyDefVarargs(one: string, two = 'foo', ...rest: list<string>): string
let res = one .. ',' .. two
for s in rest
res ..= ',' .. s
endfor
return res
enddef
def Test_call_def_varargs()
assert_fails('MyDefVarargs()', 'E119:', '', 1, 'Test_call_def_varargs')
MyDefVarargs('one')->assert_equal('one,foo')
MyDefVarargs('one', 'two')->assert_equal('one,two')
MyDefVarargs('one', 'two', 'three')->assert_equal('one,two,three')
CheckDefFailure(['MyDefVarargs("one", 22)'],
'E1013: Argument 2: type mismatch, expected string but got number')
CheckDefFailure(['MyDefVarargs("one", "two", 123)'],
'E1013: Argument 3: type mismatch, expected string but got number')
let lines =<< trim END
vim9script
def Func(...l: list<string>)
echo l
enddef
Func('a', 'b', 'c')
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def Func(...l: list<string>)
echo l
enddef
Func()
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def Func(...l: any)
echo l
enddef
Func(0)
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def Func(...l: list<string>)
echo l
enddef
Func(1, 2, 3)
END
CheckScriptFailure(lines, 'E1013: Argument 1: type mismatch')
lines =<< trim END
vim9script
def Func(...l: list<string>)
echo l
enddef
Func('a', 9)
END
CheckScriptFailure(lines, 'E1013: Argument 2: type mismatch')
lines =<< trim END
vim9script
def Func(...l: list<string>)
echo l
enddef
Func(1, 'a')
END
CheckScriptFailure(lines, 'E1013: Argument 1: type mismatch')
enddef
def Test_call_call()
let l = [3, 2, 1]
call('reverse', [l])
l->assert_equal([1, 2, 3])
enddef
let s:value = ''
def FuncOneDefArg(opt = 'text')
s:value = opt
enddef
def FuncTwoDefArg(nr = 123, opt = 'text'): string
return nr .. opt
enddef
def FuncVarargs(...arg: list<string>): string
return join(arg, ',')
enddef
def Test_func_type_varargs()
let RefDefArg: func(?string)
RefDefArg = FuncOneDefArg
RefDefArg()
s:value->assert_equal('text')
RefDefArg('some')
s:value->assert_equal('some')
let RefDef2Arg: func(?number, ?string): string
RefDef2Arg = FuncTwoDefArg
RefDef2Arg()->assert_equal('123text')
RefDef2Arg(99)->assert_equal('99text')
RefDef2Arg(77, 'some')->assert_equal('77some')
CheckDefFailure(['let RefWrong: func(string?)'], 'E1010:')
CheckDefFailure(['let RefWrong: func(?string, string)'], 'E1007:')
let RefVarargs: func(...list<string>): string
RefVarargs = FuncVarargs
RefVarargs()->assert_equal('')
RefVarargs('one')->assert_equal('one')
RefVarargs('one', 'two')->assert_equal('one,two')
CheckDefFailure(['let RefWrong: func(...list<string>, string)'], 'E110:')
CheckDefFailure(['let RefWrong: func(...list<string>, ?string)'], 'E110:')
enddef
" Only varargs
def MyVarargsOnly(...args: list<string>): string
return join(args, ',')
enddef
def Test_call_varargs_only()
MyVarargsOnly()->assert_equal('')
MyVarargsOnly('one')->assert_equal('one')
MyVarargsOnly('one', 'two')->assert_equal('one,two')
CheckDefFailure(['MyVarargsOnly(1)'], 'E1013: Argument 1: type mismatch, expected string but got number')
CheckDefFailure(['MyVarargsOnly("one", 2)'], 'E1013: Argument 2: type mismatch, expected string but got number')
enddef
def Test_using_var_as_arg()
writefile(['def Func(x: number)', 'let x = 234', 'enddef', 'defcompile'], 'Xdef')
assert_fails('so Xdef', 'E1006:', '', 1, 'Func')
delete('Xdef')
enddef
def DictArg(arg: dict<string>)
arg['key'] = 'value'
enddef
def ListArg(arg: list<string>)
arg[0] = 'value'
enddef
def Test_assign_to_argument()
# works for dict and list
let d: dict<string> = {}
DictArg(d)
d['key']->assert_equal('value')
let l: list<string> = []
ListArg(l)
l[0]->assert_equal('value')
CheckScriptFailure(['def Func(arg: number)', 'arg = 3', 'enddef', 'defcompile'], 'E1090:')
enddef
" These argument names are reserved in legacy functions.
def WithReservedNames(firstline: string, lastline: string): string
return firstline .. lastline
enddef
def Test_argument_names()
assert_equal('OK', WithReservedNames('O', 'K'))
enddef
def Test_call_func_defined_later()
g:DefinedLater('one')->assert_equal('one')
assert_fails('NotDefined("one")', 'E117:', '', 2, 'Test_call_func_defined_later')
enddef
func DefinedLater(arg)
return a:arg
endfunc
def Test_call_funcref()
g:SomeFunc('abc')->assert_equal(3)
assert_fails('NotAFunc()', 'E117:', '', 2, 'Test_call_funcref') # comment after call
assert_fails('g:NotAFunc()', 'E117:', '', 3, 'Test_call_funcref')
let lines =<< trim END
vim9script
def RetNumber(): number
return 123
enddef
let Funcref: func: number = function('RetNumber')
Funcref()->assert_equal(123)
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def RetNumber(): number
return 123
enddef
def Bar(F: func: number): number
return F()
enddef
let Funcref = function('RetNumber')
Bar(Funcref)->assert_equal(123)
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def UseNumber(nr: number)
echo nr
enddef
let Funcref: func(number) = function('UseNumber')
Funcref(123)
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def UseNumber(nr: number)
echo nr
enddef
let Funcref: func(string) = function('UseNumber')
END
CheckScriptFailure(lines, 'E1012: Type mismatch; expected func(string) but got func(number)')
lines =<< trim END
vim9script
def EchoNr(nr = 34)
g:echo = nr
enddef
let Funcref: func(?number) = function('EchoNr')
Funcref()
g:echo->assert_equal(34)
Funcref(123)
g:echo->assert_equal(123)
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def EchoList(...l: list<number>)
g:echo = l
enddef
let Funcref: func(...list<number>) = function('EchoList')
Funcref()
g:echo->assert_equal([])
Funcref(1, 2, 3)
g:echo->assert_equal([1, 2, 3])
END
CheckScriptSuccess(lines)
lines =<< trim END
vim9script
def OptAndVar(nr: number, opt = 12, ...l: list<number>): number
g:optarg = opt
g:listarg = l
return nr
enddef
let Funcref: func(number, ?number, ...list<number>): number = function('OptAndVar')
Funcref(10)->assert_equal(10)
g:optarg->assert_equal(12)
g:listarg->assert_equal([])
Funcref(11, 22)->assert_equal(11)
g:optarg->assert_equal(22)
g:listarg->assert_equal([])
Funcref(17, 18, 1, 2, 3)->assert_equal(17)
g:optarg->assert_equal(18)
g:listarg->assert_equal([1, 2, 3])
END
CheckScriptSuccess(lines)
enddef
let SomeFunc = function('len')
let NotAFunc = 'text'
def CombineFuncrefTypes()
# same arguments, different return type
let Ref1: func(bool): string
let Ref2: func(bool): number
let Ref3: func(bool): any
Ref3 = g:cond ? Ref1 : Ref2
# different number of arguments
let Refa1: func(bool): number
let Refa2: func(bool, number): number
let Refa3: func: number
Refa3 = g:cond ? Refa1 : Refa2
# different argument types
let Refb1: func(bool, string): number
let Refb2: func(string, number): number
let Refb3: func(any, any): number
Refb3 = g:cond ? Refb1 : Refb2
enddef
def FuncWithForwardCall()
return g:DefinedEvenLater("yes")
enddef
def DefinedEvenLater(arg: string): string
return arg
enddef
def Test_error_in_nested_function()
# Error in called function requires unwinding the call stack.
assert_fails('FuncWithForwardCall()', 'E1096:', '', 1, 'FuncWithForwardCall')
enddef
def Test_return_type_wrong()
CheckScriptFailure([
'def Func(): number',
'return "a"',
'enddef',
'defcompile'], 'expected number but got string')
CheckScriptFailure([
'def Func(): string',
'return 1',
'enddef',
'defcompile'], 'expected string but got number')
CheckScriptFailure([
'def Func(): void',
'return "a"',
'enddef',
'defcompile'],
'E1096: Returning a value in a function without a return type')
CheckScriptFailure([
'def Func()',
'return "a"',
'enddef',
'defcompile'],
'E1096: Returning a value in a function without a return type')
CheckScriptFailure([
'def Func(): number',
'return',
'enddef',
'defcompile'], 'E1003:')
CheckScriptFailure(['def Func(): list', 'return []', 'enddef'], 'E1008:')
CheckScriptFailure(['def Func(): dict', 'return {}', 'enddef'], 'E1008:')
CheckScriptFailure(['def Func()', 'return 1'], 'E1057:')
CheckScriptFailure([
'vim9script',
'def FuncB()',
' return 123',
'enddef',
'def FuncA()',
' FuncB()',
'enddef',
'defcompile'], 'E1096:')
enddef
def Test_arg_type_wrong()
CheckScriptFailure(['def Func3(items: list)', 'echo "a"', 'enddef'], 'E1008: Missing <type>')
CheckScriptFailure(['def Func4(...)', 'echo "a"', 'enddef'], 'E1055: Missing name after ...')
CheckScriptFailure(['def Func5(items:string)', 'echo "a"'], 'E1069:')
CheckScriptFailure(['def Func5(items)', 'echo "a"'], 'E1077:')
enddef
def Test_vim9script_call()
let lines =<< trim END
vim9script
let var = ''
def MyFunc(arg: string)
var = arg
enddef
MyFunc('foobar')
var->assert_equal('foobar')
let str = 'barfoo'
str->MyFunc()
var->assert_equal('barfoo')
g:value = 'value'
g:value->MyFunc()
var->assert_equal('value')
let listvar = []
def ListFunc(arg: list<number>)
listvar = arg
enddef
[1, 2, 3]->ListFunc()
listvar->assert_equal([1, 2, 3])
let dictvar = {}
def DictFunc(arg: dict<number>)
dictvar = arg
enddef
{'a': 1, 'b': 2}->DictFunc()
dictvar->assert_equal(#{a: 1, b: 2})
def CompiledDict()
{'a': 3, 'b': 4}->DictFunc()
enddef
CompiledDict()
dictvar->assert_equal(#{a: 3, b: 4})
#{a: 3, b: 4}->DictFunc()
dictvar->assert_equal(#{a: 3, b: 4})
('text')->MyFunc()
var->assert_equal('text')
("some")->MyFunc()
var->assert_equal('some')
# line starting with single quote is not a mark
# line starting with double quote can be a method call
'asdfasdf'->MyFunc()
var->assert_equal('asdfasdf')
"xyz"->MyFunc()
var->assert_equal('xyz')
def UseString()
'xyork'->MyFunc()
enddef
UseString()
var->assert_equal('xyork')
def UseString2()
"knife"->MyFunc()
enddef
UseString2()
var->assert_equal('knife')
# prepending a colon makes it a mark
new
setline(1, ['aaa', 'bbb', 'ccc'])
normal! 3Gmt1G
:'t
getcurpos()[1]->assert_equal(3)
bwipe!
MyFunc(
'continued'
)
assert_equal('continued',
var
)
call MyFunc(
'more'
..
'lines'
)
assert_equal(
'morelines',
var)
END
writefile(lines, 'Xcall.vim')
source Xcall.vim
delete('Xcall.vim')
enddef
def Test_vim9script_call_fail_decl()
let lines =<< trim END
vim9script
let var = ''
def MyFunc(arg: string)
let var = 123
enddef
defcompile
END
CheckScriptFailure(lines, 'E1054:')
enddef
def Test_vim9script_call_fail_type()
let lines =<< trim END
vim9script
def MyFunc(arg: string)
echo arg
enddef
MyFunc(1234)
END
CheckScriptFailure(lines, 'E1013: Argument 1: type mismatch, expected string but got number')
enddef
def Test_vim9script_call_fail_const()
let lines =<< trim END
vim9script
const var = ''
def MyFunc(arg: string)
var = 'asdf'
enddef
defcompile
END
writefile(lines, 'Xcall_const.vim')
assert_fails('source Xcall_const.vim', 'E46:', '', 1, 'MyFunc')
delete('Xcall_const.vim')
enddef
" Test that inside :function a Python function can be defined, :def is not
" recognized.
func Test_function_python()
CheckFeature python3
let py = 'python3'
execute py "<< EOF"
def do_something():
return 1
EOF
endfunc
def Test_delfunc()
let lines =<< trim END
vim9script
def g:GoneSoon()
echo 'hello'
enddef
def CallGoneSoon()
GoneSoon()
enddef
defcompile
delfunc g:GoneSoon
CallGoneSoon()
END
writefile(lines, 'XToDelFunc')
assert_fails('so XToDelFunc', 'E933:', '', 1, 'CallGoneSoon')
assert_fails('so XToDelFunc', 'E933:', '', 1, 'CallGoneSoon')
delete('XToDelFunc')
enddef
def Test_redef_failure()
writefile(['def Func0(): string', 'return "Func0"', 'enddef'], 'Xdef')
so Xdef
writefile(['def Func1(): string', 'return "Func1"', 'enddef'], 'Xdef')
so Xdef
writefile(['def! Func0(): string', 'enddef', 'defcompile'], 'Xdef')
assert_fails('so Xdef', 'E1027:', '', 1, 'Func0')
writefile(['def Func2(): string', 'return "Func2"', 'enddef'], 'Xdef')
so Xdef
delete('Xdef')
g:Func0()->assert_equal(0)
g:Func1()->assert_equal('Func1')
g:Func2()->assert_equal('Func2')
delfunc! Func0
delfunc! Func1
delfunc! Func2
enddef
def Test_vim9script_func()
let lines =<< trim END
vim9script
func Func(arg)
echo a:arg
endfunc
Func('text')
END
writefile(lines, 'XVim9Func')
so XVim9Func
delete('XVim9Func')
enddef
" Test for internal functions returning different types
func Test_InternalFuncRetType()
let lines =<< trim END
def RetFloat(): float
return ceil(1.456)
enddef
def RetListAny(): list<any>
return items({'k': 'v'})
enddef
def RetListString(): list<string>
return split('a:b:c', ':')
enddef
def RetListDictAny(): list<dict<any>>
return getbufinfo()
enddef
def RetDictNumber(): dict<number>
return wordcount()
enddef
def RetDictString(): dict<string>
return environ()
enddef
END
call writefile(lines, 'Xscript')
source Xscript
call RetFloat()->assert_equal(2.0)
call RetListAny()->assert_equal([['k', 'v']])
call RetListString()->assert_equal(['a', 'b', 'c'])
call RetListDictAny()->assert_notequal([])
call RetDictNumber()->assert_notequal({})
call RetDictString()->assert_notequal({})
call delete('Xscript')
endfunc
" Test for passing too many or too few arguments to internal functions
func Test_internalfunc_arg_error()
let l =<< trim END
def! FArgErr(): float
return ceil(1.1, 2)
enddef
defcompile
END
call writefile(l, 'Xinvalidarg')
call assert_fails('so Xinvalidarg', 'E118:', '', 1, 'FArgErr')
let l =<< trim END
def! FArgErr(): float
return ceil()
enddef
defcompile
END
call writefile(l, 'Xinvalidarg')
call assert_fails('so Xinvalidarg', 'E119:', '', 1, 'FArgErr')
call delete('Xinvalidarg')
endfunc
let s:funcResult = 0
def FuncNoArgNoRet()
s:funcResult = 11
enddef
def FuncNoArgRetNumber(): number
s:funcResult = 22
return 1234
enddef
def FuncNoArgRetString(): string
s:funcResult = 45
return 'text'
enddef
def FuncOneArgNoRet(arg: number)
s:funcResult = arg
enddef
def FuncOneArgRetNumber(arg: number): number
s:funcResult = arg
return arg
enddef
def FuncTwoArgNoRet(one: bool, two: number)
s:funcResult = two
enddef
def FuncOneArgRetString(arg: string): string
return arg
enddef
def FuncOneArgRetAny(arg: any): any
return arg
enddef
def Test_func_type()
let Ref1: func()
s:funcResult = 0
Ref1 = FuncNoArgNoRet
Ref1()
s:funcResult->assert_equal(11)
let Ref2: func
s:funcResult = 0
Ref2 = FuncNoArgNoRet
Ref2()
s:funcResult->assert_equal(11)
s:funcResult = 0
Ref2 = FuncOneArgNoRet
Ref2(12)
s:funcResult->assert_equal(12)
s:funcResult = 0
Ref2 = FuncNoArgRetNumber
Ref2()->assert_equal(1234)
s:funcResult->assert_equal(22)
s:funcResult = 0
Ref2 = FuncOneArgRetNumber
Ref2(13)->assert_equal(13)
s:funcResult->assert_equal(13)
enddef
def Test_repeat_return_type()
let res = 0
for n in repeat([1], 3)
res += n
endfor
res->assert_equal(3)
res = 0
for n in add([1, 2], 3)
res += n
endfor
res->assert_equal(6)
enddef
def Test_argv_return_type()
next fileone filetwo
let res = ''
for name in argv()
res ..= name
endfor
res->assert_equal('fileonefiletwo')
enddef
def Test_func_type_part()
let RefVoid: func: void
RefVoid = FuncNoArgNoRet
RefVoid = FuncOneArgNoRet
CheckDefFailure(['let RefVoid: func: void', 'RefVoid = FuncNoArgRetNumber'], 'E1012: Type mismatch; expected func(...) but got func(): number')
CheckDefFailure(['let RefVoid: func: void', 'RefVoid = FuncNoArgRetString'], 'E1012: Type mismatch; expected func(...) but got func(): string')
let RefAny: func(): any
RefAny = FuncNoArgRetNumber
RefAny = FuncNoArgRetString
CheckDefFailure(['let RefAny: func(): any', 'RefAny = FuncNoArgNoRet'], 'E1012: Type mismatch; expected func(): any but got func()')
CheckDefFailure(['let RefAny: func(): any', 'RefAny = FuncOneArgNoRet'], 'E1012: Type mismatch; expected func(): any but got func(number)')
let RefNr: func: number
RefNr = FuncNoArgRetNumber
RefNr = FuncOneArgRetNumber
CheckDefFailure(['let RefNr: func: number', 'RefNr = FuncNoArgNoRet'], 'E1012: Type mismatch; expected func(...): number but got func()')
CheckDefFailure(['let RefNr: func: number', 'RefNr = FuncNoArgRetString'], 'E1012: Type mismatch; expected func(...): number but got func(): string')
let RefStr: func: string
RefStr = FuncNoArgRetString
RefStr = FuncOneArgRetString
CheckDefFailure(['let RefStr: func: string', 'RefStr = FuncNoArgNoRet'], 'E1012: Type mismatch; expected func(...): string but got func()')
CheckDefFailure(['let RefStr: func: string', 'RefStr = FuncNoArgRetNumber'], 'E1012: Type mismatch; expected func(...): string but got func(): number')
enddef
def Test_func_type_fails()
CheckDefFailure(['let ref1: func()'], 'E704:')
CheckDefFailure(['let Ref1: func()', 'Ref1 = FuncNoArgRetNumber'], 'E1012: Type mismatch; expected func() but got func(): number')
CheckDefFailure(['let Ref1: func()', 'Ref1 = FuncOneArgNoRet'], 'E1012: Type mismatch; expected func() but got func(number)')
CheckDefFailure(['let Ref1: func()', 'Ref1 = FuncOneArgRetNumber'], 'E1012: Type mismatch; expected func() but got func(number): number')
CheckDefFailure(['let Ref1: func(bool)', 'Ref1 = FuncTwoArgNoRet'], 'E1012: Type mismatch; expected func(bool) but got func(bool, number)')
CheckDefFailure(['let Ref1: func(?bool)', 'Ref1 = FuncTwoArgNoRet'], 'E1012: Type mismatch; expected func(?bool) but got func(bool, number)')
CheckDefFailure(['let Ref1: func(...bool)', 'Ref1 = FuncTwoArgNoRet'], 'E1012: Type mismatch; expected func(...bool) but got func(bool, number)')
CheckDefFailure(['let RefWrong: func(string ,number)'], 'E1068:')
CheckDefFailure(['let RefWrong: func(string,number)'], 'E1069:')
CheckDefFailure(['let RefWrong: func(bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool)'], 'E1005:')
CheckDefFailure(['let RefWrong: func(bool):string'], 'E1069:')
enddef
def Test_func_return_type()
let nr: number
nr = FuncNoArgRetNumber()
nr->assert_equal(1234)
nr = FuncOneArgRetAny(122)
nr->assert_equal(122)
let str: string
str = FuncOneArgRetAny('yes')
str->assert_equal('yes')
CheckDefFailure(['let str: string', 'str = FuncNoArgRetNumber()'], 'E1012: Type mismatch; expected string but got number')
enddef
def MultiLine(
arg1: string,
arg2 = 1234,
...rest: list<string>
): string
return arg1 .. arg2 .. join(rest, '-')
enddef
def MultiLineComment(
arg1: string, # comment
arg2 = 1234, # comment
...rest: list<string> # comment
): string # comment
return arg1 .. arg2 .. join(rest, '-')
enddef
def Test_multiline()
MultiLine('text')->assert_equal('text1234')
MultiLine('text', 777)->assert_equal('text777')
MultiLine('text', 777, 'one')->assert_equal('text777one')
MultiLine('text', 777, 'one', 'two')->assert_equal('text777one-two')
enddef
func Test_multiline_not_vim9()
call MultiLine('text')->assert_equal('text1234')
call MultiLine('text', 777)->assert_equal('text777')
call MultiLine('text', 777, 'one')->assert_equal('text777one')
call MultiLine('text', 777, 'one', 'two')->assert_equal('text777one-two')
endfunc
" When using CheckScriptFailure() for the below test, E1010 is generated instead
" of E1056.
func Test_E1056_1059()
let caught_1056 = 0
try
def F():
return 1
enddef
catch /E1056:/
let caught_1056 = 1
endtry
eval caught_1056->assert_equal(1)
let caught_1059 = 0
try
def F5(items : list)
echo 'a'
enddef
catch /E1059:/
let caught_1059 = 1
endtry
eval caught_1059->assert_equal(1)
endfunc
func DelMe()
echo 'DelMe'
endfunc
def Test_error_reporting()
# comment lines at the start of the function
let lines =<< trim END
" comment
def Func()
# comment
# comment
invalid
enddef
defcompile
END
writefile(lines, 'Xdef')
try
source Xdef
assert_report('should have failed')
catch /E476:/
v:exception->assert_match('Invalid command: invalid')
v:throwpoint->assert_match(', line 3$')
endtry
# comment lines after the start of the function
lines =<< trim END
" comment
def Func()
let x = 1234
# comment
# comment
invalid
enddef
defcompile
END
writefile(lines, 'Xdef')
try
source Xdef
assert_report('should have failed')
catch /E476:/
v:exception->assert_match('Invalid command: invalid')
v:throwpoint->assert_match(', line 4$')
endtry
lines =<< trim END
vim9script
def Func()
let db = #{foo: 1, bar: 2}
# comment
let x = db.asdf
enddef
defcompile
Func()
END
writefile(lines, 'Xdef')
try
source Xdef
assert_report('should have failed')
catch /E716:/
v:throwpoint->assert_match('_Func, line 3$')
endtry
delete('Xdef')
enddef
def Test_deleted_function()
CheckDefExecFailure([
'let RefMe: func = function("g:DelMe")',
'delfunc g:DelMe',
'echo RefMe()'], 'E117:')
enddef
def Test_unknown_function()
CheckDefExecFailure([
'let Ref: func = function("NotExist")',
'delfunc g:NotExist'], 'E700:')
enddef
def RefFunc(Ref: func(string): string): string
return Ref('more')
enddef
def Test_closure_simple()
let local = 'some '
RefFunc({s -> local .. s})->assert_equal('some more')
enddef
def MakeRef()
let local = 'some '
g:Ref = {s -> local .. s}
enddef
def Test_closure_ref_after_return()
MakeRef()
g:Ref('thing')->assert_equal('some thing')
unlet g:Ref
enddef
def MakeTwoRefs()
let local = ['some']
g:Extend = {s -> local->add(s)}
g:Read = {-> local}
enddef
def Test_closure_two_refs()
MakeTwoRefs()
join(g:Read(), ' ')->assert_equal('some')
g:Extend('more')
join(g:Read(), ' ')->assert_equal('some more')
g:Extend('even')
join(g:Read(), ' ')->assert_equal('some more even')
unlet g:Extend
unlet g:Read
enddef
def ReadRef(Ref: func(): list<string>): string
return join(Ref(), ' ')
enddef
def ExtendRef(Ref: func(string): list<string>, add: string)
Ref(add)
enddef
def Test_closure_two_indirect_refs()
MakeTwoRefs()
ReadRef(g:Read)->assert_equal('some')
ExtendRef(g:Extend, 'more')
ReadRef(g:Read)->assert_equal('some more')
ExtendRef(g:Extend, 'even')
ReadRef(g:Read)->assert_equal('some more even')
unlet g:Extend
unlet g:Read
enddef
def MakeArgRefs(theArg: string)
let local = 'loc_val'
g:UseArg = {s -> theArg .. '/' .. local .. '/' .. s}
enddef
def MakeArgRefsVarargs(theArg: string, ...rest: list<string>)
let local = 'the_loc'
g:UseVararg = {s -> theArg .. '/' .. local .. '/' .. s .. '/' .. join(rest)}
enddef
def Test_closure_using_argument()
MakeArgRefs('arg_val')
g:UseArg('call_val')->assert_equal('arg_val/loc_val/call_val')
MakeArgRefsVarargs('arg_val', 'one', 'two')
g:UseVararg('call_val')->assert_equal('arg_val/the_loc/call_val/one two')
unlet g:UseArg
unlet g:UseVararg
enddef
def MakeGetAndAppendRefs()
let local = 'a'
def Append(arg: string)
local ..= arg
enddef
g:Append = Append
def Get(): string
return local
enddef
g:Get = Get
enddef
def Test_closure_append_get()
MakeGetAndAppendRefs()
g:Get()->assert_equal('a')
g:Append('-b')
g:Get()->assert_equal('a-b')
g:Append('-c')
g:Get()->assert_equal('a-b-c')
unlet g:Append
unlet g:Get
enddef
def Test_nested_closure()
let local = 'text'
def Closure(arg: string): string
return local .. arg
enddef
Closure('!!!')->assert_equal('text!!!')
enddef
func GetResult(Ref)
return a:Ref('some')
endfunc
def Test_call_closure_not_compiled()
let text = 'text'
g:Ref = {s -> s .. text}
GetResult(g:Ref)->assert_equal('sometext')
enddef
def Test_double_closure_fails()
let lines =<< trim END
vim9script
def Func()
let var = 0
for i in range(2)
timer_start(0, {-> var})
endfor
enddef
Func()
END
CheckScriptFailure(lines, 'Multiple closures not supported yet')
enddef
def Test_sort_return_type()
let res: list<number>
res = [1, 2, 3]->sort()
enddef
def Test_sort_argument()
let res = ['b', 'a', 'c']->sort('i')
res->assert_equal(['a', 'b', 'c'])
enddef
def Test_getqflist_return_type()
let l = getqflist()
l->assert_equal([])
let d = getqflist(#{items: 0})
d->assert_equal(#{items: []})
enddef
def Test_getloclist_return_type()
let l = getloclist(1)
l->assert_equal([])
let d = getloclist(1, #{items: 0})
d->assert_equal(#{items: []})
enddef
def Test_copy_return_type()
let l = copy([1, 2, 3])
let res = 0
for n in l
res += n
endfor
res->assert_equal(6)
let dl = deepcopy([1, 2, 3])
res = 0
for n in dl
res += n
endfor
res->assert_equal(6)
dl = deepcopy([1, 2, 3], true)
enddef
def Test_extend_return_type()
let l = extend([1, 2], [3])
let res = 0
for n in l
res += n
endfor
res->assert_equal(6)
enddef
def Test_garbagecollect()
garbagecollect(true)
enddef
def Test_insert_return_type()
let l = insert([2, 1], 3)
let res = 0
for n in l
res += n
endfor
res->assert_equal(6)
enddef
def Test_keys_return_type()
const var: list<string> = #{a: 1, b: 2}->keys()
var->assert_equal(['a', 'b'])
enddef
def Test_reverse_return_type()
let l = reverse([1, 2, 3])
let res = 0
for n in l
res += n
endfor
res->assert_equal(6)
enddef
def Test_remove_return_type()
let l = remove(#{one: [1, 2], two: [3, 4]}, 'one')
let res = 0
for n in l
res += n
endfor
res->assert_equal(3)
enddef
def Test_filter_return_type()
let l = filter([1, 2, 3], {-> 1})
let res = 0
for n in l
res += n
endfor
res->assert_equal(6)
enddef
def Test_bufnr()
let buf = bufnr()
bufnr('%')->assert_equal(buf)
buf = bufnr('Xdummy', true)
buf->assert_notequal(-1)
exe 'bwipe! ' .. buf
enddef
def Test_col()
new
setline(1, 'asdf')
col([1, '$'])->assert_equal(5)
enddef
def Test_char2nr()
char2nr('あ', true)->assert_equal(12354)
enddef
def Test_getreg_return_type()
let s1: string = getreg('"')
let s2: string = getreg('"', 1)
let s3: list<string> = getreg('"', 1, 1)
enddef
def Wrong_dict_key_type(items: list<number>): list<number>
return filter(items, {_, val -> get({val: 1}, 'x')})
enddef
def Test_wrong_dict_key_type()
assert_fails('Wrong_dict_key_type([1, 2, 3])', 'E1012:')
enddef
def Line_continuation_in_def(dir: string = ''): string
let path: string = empty(dir)
\ ? 'empty'
\ : 'full'
return path
enddef
def Test_line_continuation_in_def()
Line_continuation_in_def('.')->assert_equal('full')
enddef
def Line_continuation_in_lambda(): list<string>
let x = range(97, 100)
->map({_, v -> nr2char(v)
->toupper()})
->reverse()
return x
enddef
def Test_line_continuation_in_lambda()
Line_continuation_in_lambda()->assert_equal(['D', 'C', 'B', 'A'])
enddef
func Test_silent_echo()
CheckScreendump
let lines =<< trim END
vim9script
def EchoNothing()
silent echo ''
enddef
defcompile
END
call writefile(lines, 'XTest_silent_echo')
" Check that the balloon shows up after a mouse move
let buf = RunVimInTerminal('-S XTest_silent_echo', {'rows': 6})
call term_sendkeys(buf, ":abc")
call VerifyScreenDump(buf, 'Test_vim9_silent_echo', {})
" clean up
call StopVimInTerminal(buf)
call delete('XTest_silent_echo')
endfunc
""""""" builtin functions that behave differently in Vim9
def Test_bufname()
split SomeFile
bufname('%')->assert_equal('SomeFile')
edit OtherFile
bufname('#')->assert_equal('SomeFile')
close
enddef
def Test_bufwinid()
let origwin = win_getid()
below split SomeFile
let SomeFileID = win_getid()
below split OtherFile
below split SomeFile
bufwinid('SomeFile')->assert_equal(SomeFileID)
win_gotoid(origwin)
only
bwipe SomeFile
bwipe OtherFile
enddef
def Test_count()
count('ABC ABC ABC', 'b', true)->assert_equal(3)
count('ABC ABC ABC', 'b', false)->assert_equal(0)
enddef
def Test_expand()
split SomeFile
expand('%', true, true)->assert_equal(['SomeFile'])
close
enddef
def Test_getbufinfo()
let bufinfo = getbufinfo(bufnr())
getbufinfo('%')->assert_equal(bufinfo)
edit Xtestfile1
hide edit Xtestfile2
hide enew
getbufinfo(#{bufloaded: true, buflisted: true, bufmodified: false})
->len()->assert_equal(3)
bwipe Xtestfile1 Xtestfile2
enddef
def Test_getbufline()
e SomeFile
let buf = bufnr()
e #
let lines = ['aaa', 'bbb', 'ccc']
setbufline(buf, 1, lines)
getbufline('#', 1, '$')->assert_equal(lines)
bwipe!
enddef
def Test_getchangelist()
new
setline(1, 'some text')
let changelist = bufnr()->getchangelist()
getchangelist('%')->assert_equal(changelist)
bwipe!
enddef
def Test_getchar()
while getchar(0)
endwhile
getchar(true)->assert_equal(0)
enddef
def Test_getcompletion()
set wildignore=*.vim,*~
let l = getcompletion('run', 'file', true)
l->assert_equal([])
set wildignore&
enddef
def Test_getreg()
let lines = ['aaa', 'bbb', 'ccc']
setreg('a', lines)
getreg('a', true, true)->assert_equal(lines)
enddef
def Test_glob()
glob('runtest.vim', true, true, true)->assert_equal(['runtest.vim'])
enddef
def Test_globpath()
globpath('.', 'runtest.vim', true, true, true)->assert_equal(['./runtest.vim'])
enddef
def Test_has()
has('eval', true)->assert_equal(1)
enddef
def Test_hasmapto()
hasmapto('foobar', 'i', true)->assert_equal(0)
iabbrev foo foobar
hasmapto('foobar', 'i', true)->assert_equal(1)
iunabbrev foo
enddef
def Test_index()
index(['a', 'b', 'a', 'B'], 'b', 2, true)->assert_equal(3)
enddef
def Test_list2str_str2list_utf8()
let s = "\u3042\u3044"
let l = [0x3042, 0x3044]
str2list(s, true)->assert_equal(l)
list2str(l, true)->assert_equal(s)
enddef
def SID(): number
return expand('<SID>')
->matchstr('<SNR>\zs\d\+\ze_$')
->str2nr()
enddef
def Test_maparg()
let lnum = str2nr(expand('<sflnum>'))
map foo bar
maparg('foo', '', false, true)->assert_equal(#{
lnum: lnum + 1,
script: 0,
mode: ' ',
silent: 0,
noremap: 0,
lhs: 'foo',
lhsraw: 'foo',
nowait: 0,
expr: 0,
sid: SID(),
rhs: 'bar',
buffer: 0})
unmap foo
enddef
def Test_mapcheck()
iabbrev foo foobar
mapcheck('foo', 'i', true)->assert_equal('foobar')
iunabbrev foo
enddef
def Test_nr2char()
nr2char(97, true)->assert_equal('a')
enddef
def Test_readdir()
eval expand('sautest')->readdir({e -> e[0] !=# '.'})
eval expand('sautest')->readdirex({e -> e.name[0] !=# '.'})
enddef
def Test_search()
new
setline(1, ['foo', 'bar'])
let val = 0
# skip expr returns boolean
search('bar', 'W', 0, 0, {-> val == 1})->assert_equal(2)
:1
search('bar', 'W', 0, 0, {-> val == 0})->assert_equal(0)
# skip expr returns number, only 0 and 1 are accepted
:1
search('bar', 'W', 0, 0, {-> 0})->assert_equal(2)
:1
search('bar', 'W', 0, 0, {-> 1})->assert_equal(0)
assert_fails("search('bar', '', 0, 0, {-> -1})", 'E1023:')
assert_fails("search('bar', '', 0, 0, {-> -1})", 'E1023:')
enddef
def Test_searchcount()
new
setline(1, "foo bar")
:/foo
searchcount(#{recompute: true})
->assert_equal(#{
exact_match: 1,
current: 1,
total: 1,
maxcount: 99,
incomplete: 0})
bwipe!
enddef
def Test_searchdecl()
searchdecl('blah', true, true)->assert_equal(1)
enddef
def Test_setbufvar()
setbufvar(bufnr('%'), '&syntax', 'vim')
&syntax->assert_equal('vim')
setbufvar(bufnr('%'), '&ts', 16)
&ts->assert_equal(16)
settabwinvar(1, 1, '&syntax', 'vam')
&syntax->assert_equal('vam')
settabwinvar(1, 1, '&ts', 15)
&ts->assert_equal(15)
setlocal ts=8
setbufvar('%', 'myvar', 123)
getbufvar('%', 'myvar')->assert_equal(123)
enddef
def Test_setloclist()
let items = [#{filename: '/tmp/file', lnum: 1, valid: true}]
let what = #{items: items}
setqflist([], ' ', what)
setloclist(0, [], ' ', what)
enddef
def Test_setreg()
setreg('a', ['aaa', 'bbb', 'ccc'])
let reginfo = getreginfo('a')
setreg('a', reginfo)
getreginfo('a')->assert_equal(reginfo)
enddef
def Test_spellsuggest()
if !has('spell')
MissingFeature 'spell'
else
spellsuggest('marrch', 1, true)->assert_equal(['March'])
endif
enddef
def Test_split()
split(' aa bb ', '\W\+', true)->assert_equal(['', 'aa', 'bb', ''])
enddef
def Test_str2nr()
str2nr("1'000'000", 10, true)->assert_equal(1000000)
enddef
def Test_strchars()
strchars("A\u20dd", true)->assert_equal(1)
enddef
def Test_submatch()
let pat = 'A\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)'
let Rep = {-> range(10)->map({_, v -> submatch(v, true)})->string()}
let actual = substitute('A123456789', pat, Rep, '')
let expected = "[['A123456789'], ['1'], ['2'], ['3'], ['4'], ['5'], ['6'], ['7'], ['8'], ['9']]"
actual->assert_equal(expected)
enddef
def Test_synID()
new
setline(1, "text")
synID(1, 1, true)->assert_equal(0)
bwipe!
enddef
def Test_term_gettty()
if !has('terminal')
MissingFeature 'terminal'
else
let buf = Run_shell_in_terminal({})
term_gettty(buf, true)->assert_notequal('')
StopShellInTerminal(buf)
endif
enddef
def Test_term_start()
if !has('terminal')
MissingFeature 'terminal'
else
botright new
let winnr = winnr()
term_start(&shell, #{curwin: true})
winnr()->assert_equal(winnr)
bwipe!
endif
enddef
def Test_timer_paused()
let id = timer_start(50, {-> 0})
timer_pause(id, true)
let info = timer_info(id)
info[0]['paused']->assert_equal(1)
timer_stop(id)
enddef
def Test_win_splitmove()
split
win_splitmove(1, 2, #{vertical: true, rightbelow: true})
close
enddef
""""""" end of builtin functions
def Fibonacci(n: number): number
if n < 2
return n
else
return Fibonacci(n - 1) + Fibonacci(n - 2)
endif
enddef
def Test_recursive_call()
Fibonacci(20)->assert_equal(6765)
enddef
def TreeWalk(dir: string): list<any>
return readdir(dir)->map({_, val ->
fnamemodify(dir .. '/' .. val, ':p')->isdirectory()
? {val: TreeWalk(dir .. '/' .. val)}
: val
})
enddef
def Test_closure_in_map()
mkdir('XclosureDir/tdir', 'p')
writefile(['111'], 'XclosureDir/file1')
writefile(['222'], 'XclosureDir/file2')
writefile(['333'], 'XclosureDir/tdir/file3')
TreeWalk('XclosureDir')->assert_equal(['file1', 'file2', {'tdir': ['file3']}])
delete('XclosureDir', 'rf')
enddef
def Test_partial_call()
let Xsetlist = function('setloclist', [0])
Xsetlist([], ' ', {'title': 'test'})
getloclist(0, {'title': 1})->assert_equal({'title': 'test'})
Xsetlist = function('setloclist', [0, [], ' '])
Xsetlist({'title': 'test'})
getloclist(0, {'title': 1})->assert_equal({'title': 'test'})
Xsetlist = function('setqflist')
Xsetlist([], ' ', {'title': 'test'})
getqflist({'title': 1})->assert_equal({'title': 'test'})
Xsetlist = function('setqflist', [[], ' '])
Xsetlist({'title': 'test'})
getqflist({'title': 1})->assert_equal({'title': 'test'})
enddef
def Test_cmd_modifier()
tab echo '0'
CheckDefFailure(['5tab echo 3'], 'E16:')
enddef
def Test_restore_modifiers()
# check that when compiling a :def function command modifiers are not messed
# up.
let lines =<< trim END
vim9script
set eventignore=
autocmd QuickFixCmdPost * copen
def AutocmdsDisabled()
eval 0
enddef
func Func()
noautocmd call s:AutocmdsDisabled()
let g:ei_after = &eventignore
endfunc
Func()
END
CheckScriptSuccess(lines)
g:ei_after->assert_equal('')
enddef
def StackTop()
eval 1
eval 2
# call not on fourth line
StackBot()
enddef
def StackBot()
# throw an error
eval [][0]
enddef
def Test_callstack_def()
try
StackTop()
catch
v:throwpoint->assert_match('Test_callstack_def\[2\]..StackTop\[4\]..StackBot, line 2')
endtry
enddef
" vim: ts=8 sw=2 sts=2 expandtab tw=80 fdm=marker