blob: ef9ef5562d38d732bbe86b8e4ca5d9b88f5f54c5 [file] [log] [blame]
Bram Moolenaar00b28d62022-12-08 15:32:33 +00001" Test Vim9 classes
2
3source check.vim
4import './vim9.vim' as v9
5
6def Test_class_basic()
7 var lines =<< trim END
8 class NotWorking
9 endclass
10 END
11 v9.CheckScriptFailure(lines, 'E1316:')
12
13 lines =<< trim END
14 vim9script
15 class notWorking
16 endclass
17 END
18 v9.CheckScriptFailure(lines, 'E1314:')
19
20 lines =<< trim END
21 vim9script
22 class Not@working
23 endclass
24 END
25 v9.CheckScriptFailure(lines, 'E1315:')
26
27 lines =<< trim END
28 vim9script
29 abstract noclass Something
30 endclass
31 END
32 v9.CheckScriptFailure(lines, 'E475:')
33
34 lines =<< trim END
35 vim9script
36 abstract classy Something
37 endclass
38 END
39 v9.CheckScriptFailure(lines, 'E475:')
40
41 lines =<< trim END
42 vim9script
43 class Something
44 endcl
45 END
46 v9.CheckScriptFailure(lines, 'E1065:')
47
48 lines =<< trim END
49 vim9script
50 class Something
51 endclass school's out
52 END
53 v9.CheckScriptFailure(lines, 'E488:')
54
55 lines =<< trim END
56 vim9script
57 class Something
58 endclass | echo 'done'
59 END
60 v9.CheckScriptFailure(lines, 'E488:')
61
62 lines =<< trim END
63 vim9script
64 class Something
65 this
66 endclass
67 END
68 v9.CheckScriptFailure(lines, 'E1317:')
69
70 lines =<< trim END
71 vim9script
72 class Something
73 this.
74 endclass
75 END
76 v9.CheckScriptFailure(lines, 'E1317:')
77
78 lines =<< trim END
79 vim9script
80 class Something
81 this .count
82 endclass
83 END
84 v9.CheckScriptFailure(lines, 'E1317:')
85
86 lines =<< trim END
87 vim9script
88 class Something
89 this. count
90 endclass
91 END
92 v9.CheckScriptFailure(lines, 'E1317:')
93
94 lines =<< trim END
95 vim9script
96 class Something
97 this.count: number
98 that.count
99 endclass
100 END
101 v9.CheckScriptFailure(lines, 'E1318: Not a valid command in a class: that.count')
102
103 lines =<< trim END
104 vim9script
105 class Something
106 this.count
107 endclass
108 END
109 v9.CheckScriptFailure(lines, 'E1022:')
110
111 lines =<< trim END
112 vim9script
113 class Something
Bram Moolenaarf54cedd2022-12-23 17:56:27 +0000114 def new()
115 this.state = 0
116 enddef
117 endclass
118 var obj = Something.new()
119 END
120 v9.CheckScriptFailure(lines, 'E1089:')
121
122 lines =<< trim END
123 vim9script
124 class Something
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000125 this.count : number
126 endclass
127 END
128 v9.CheckScriptFailure(lines, 'E1059:')
129
130 lines =<< trim END
131 vim9script
132 class Something
133 this.count:number
134 endclass
135 END
136 v9.CheckScriptFailure(lines, 'E1069:')
137
138 lines =<< trim END
139 vim9script
140
141 class TextPosition
142 this.lnum: number
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +0000143 this.col: number
Bram Moolenaarffdaca92022-12-09 21:41:48 +0000144
Bram Moolenaar418b5472022-12-20 13:38:22 +0000145 # make a nicely formatted string
Bram Moolenaarffdaca92022-12-09 21:41:48 +0000146 def ToString(): string
147 return $'({this.lnum}, {this.col})'
148 enddef
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000149 endclass
150
Bram Moolenaard28d7b92022-12-08 20:42:00 +0000151 # use the automatically generated new() method
152 var pos = TextPosition.new(2, 12)
153 assert_equal(2, pos.lnum)
154 assert_equal(12, pos.col)
Bram Moolenaarffdaca92022-12-09 21:41:48 +0000155
156 # call an object method
157 assert_equal('(2, 12)', pos.ToString())
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000158 END
159 v9.CheckScriptSuccess(lines)
160enddef
161
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +0000162def Test_class_member_initializer()
163 var lines =<< trim END
164 vim9script
165
166 class TextPosition
167 this.lnum: number = 1
168 this.col: number = 1
169
Bram Moolenaar418b5472022-12-20 13:38:22 +0000170 # constructor with only the line number
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +0000171 def new(lnum: number)
172 this.lnum = lnum
173 enddef
174 endclass
175
176 var pos = TextPosition.new(3)
177 assert_equal(3, pos.lnum)
178 assert_equal(1, pos.col)
179
180 var instr = execute('disassemble TextPosition.new')
181 assert_match('new\_s*' ..
Bram Moolenaar3ea8a1b2022-12-10 19:03:51 +0000182 '0 NEW TextPosition size \d\+\_s*' ..
Bram Moolenaar7ce7daf2022-12-10 18:42:12 +0000183 '\d PUSHNR 1\_s*' ..
184 '\d STORE_THIS 0\_s*' ..
185 '\d PUSHNR 1\_s*' ..
186 '\d STORE_THIS 1\_s*' ..
187 'this.lnum = lnum\_s*' ..
188 '\d LOAD arg\[-1]\_s*' ..
189 '\d PUSHNR 0\_s*' ..
190 '\d LOAD $0\_s*' ..
191 '\d\+ STOREINDEX object\_s*' ..
192 '\d\+ RETURN object.*',
193 instr)
194 END
195 v9.CheckScriptSuccess(lines)
196enddef
197
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000198def Test_class_default_new()
199 var lines =<< trim END
200 vim9script
201
202 class TextPosition
203 this.lnum: number = 1
204 this.col: number = 1
205 endclass
206
207 var pos = TextPosition.new()
208 assert_equal(1, pos.lnum)
209 assert_equal(1, pos.col)
210
211 pos = TextPosition.new(v:none, v:none)
212 assert_equal(1, pos.lnum)
213 assert_equal(1, pos.col)
214
215 pos = TextPosition.new(3, 22)
216 assert_equal(3, pos.lnum)
217 assert_equal(22, pos.col)
218
219 pos = TextPosition.new(v:none, 33)
220 assert_equal(1, pos.lnum)
221 assert_equal(33, pos.col)
222 END
223 v9.CheckScriptSuccess(lines)
224
225 lines =<< trim END
226 vim9script
227 class Person
228 this.name: string
229 this.age: number = 42
230 this.education: string = "unknown"
231
232 def new(this.name, this.age = v:none, this.education = v:none)
233 enddef
234 endclass
235
236 var piet = Person.new("Piet")
237 assert_equal("Piet", piet.name)
238 assert_equal(42, piet.age)
239 assert_equal("unknown", piet.education)
240
241 var chris = Person.new("Chris", 4, "none")
242 assert_equal("Chris", chris.name)
243 assert_equal(4, chris.age)
244 assert_equal("none", chris.education)
245 END
246 v9.CheckScriptSuccess(lines)
Bram Moolenaar74e12742022-12-13 21:14:28 +0000247
248 lines =<< trim END
249 vim9script
250 class Person
251 this.name: string
252 this.age: number = 42
253 this.education: string = "unknown"
254
255 def new(this.name, this.age = v:none, this.education = v:none)
256 enddef
257 endclass
258
259 var missing = Person.new()
260 END
261 v9.CheckScriptFailure(lines, 'E119:')
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000262enddef
263
Bram Moolenaar74e12742022-12-13 21:14:28 +0000264def Test_class_object_member_inits()
265 var lines =<< trim END
266 vim9script
267 class TextPosition
268 this.lnum: number
269 this.col = 1
270 this.addcol: number = 2
271 endclass
272
273 var pos = TextPosition.new()
274 assert_equal(0, pos.lnum)
275 assert_equal(1, pos.col)
276 assert_equal(2, pos.addcol)
277 END
278 v9.CheckScriptSuccess(lines)
279
280 lines =<< trim END
281 vim9script
282 class TextPosition
283 this.lnum
284 this.col = 1
285 endclass
286 END
287 v9.CheckScriptFailure(lines, 'E1022:')
288
289 lines =<< trim END
290 vim9script
291 class TextPosition
292 this.lnum = v:none
293 this.col = 1
294 endclass
295 END
296 v9.CheckScriptFailure(lines, 'E1330:')
297enddef
298
Bram Moolenaar3d473ee2022-12-14 20:59:32 +0000299def Test_class_object_member_access()
300 var lines =<< trim END
301 vim9script
302 class Triple
303 this._one = 1
304 this.two = 2
305 public this.three = 3
306
307 def GetOne(): number
308 return this._one
309 enddef
310 endclass
311
312 var trip = Triple.new()
313 assert_equal(1, trip.GetOne())
314 assert_equal(2, trip.two)
315 assert_equal(3, trip.three)
316 assert_fails('echo trip._one', 'E1333')
317
318 assert_fails('trip._one = 11', 'E1333')
319 assert_fails('trip.two = 22', 'E1335')
320 trip.three = 33
321 assert_equal(33, trip.three)
Bram Moolenaard505d172022-12-18 21:42:55 +0000322
323 assert_fails('trip.four = 4', 'E1334')
324 END
325 v9.CheckScriptSuccess(lines)
Bram Moolenaar590162c2022-12-24 21:24:06 +0000326
327 lines =<< trim END
328 vim9script
329
330 class MyCar
331 this.make: string
Bram Moolenaar574950d2023-01-03 19:08:50 +0000332 this.age = 5
Bram Moolenaar590162c2022-12-24 21:24:06 +0000333
334 def new(make_arg: string)
335 this.make = make_arg
336 enddef
337
338 def GetMake(): string
339 return $"make = {this.make}"
340 enddef
Bram Moolenaar574950d2023-01-03 19:08:50 +0000341 def GetAge(): number
342 return this.age
343 enddef
Bram Moolenaar590162c2022-12-24 21:24:06 +0000344 endclass
345
346 var c = MyCar.new("abc")
347 assert_equal('make = abc', c.GetMake())
348
349 c = MyCar.new("def")
350 assert_equal('make = def', c.GetMake())
351
352 var c2 = MyCar.new("123")
353 assert_equal('make = 123', c2.GetMake())
Bram Moolenaar574950d2023-01-03 19:08:50 +0000354
355 def CheckCar()
356 assert_equal("make = def", c.GetMake())
357 assert_equal(5, c.GetAge())
358 enddef
359 CheckCar()
Bram Moolenaar590162c2022-12-24 21:24:06 +0000360 END
361 v9.CheckScriptSuccess(lines)
Bram Moolenaar6ef54712022-12-25 19:31:36 +0000362
363 lines =<< trim END
364 vim9script
365
366 class MyCar
367 this.make: string
368
369 def new(make_arg: string)
370 this.make = make_arg
371 enddef
372 endclass
373
374 var c = MyCar.new("abc")
375 var c = MyCar.new("def")
376 END
377 v9.CheckScriptFailure(lines, 'E1041:')
Bram Moolenaard505d172022-12-18 21:42:55 +0000378enddef
379
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +0000380def Test_class_object_compare()
381 var class_lines =<< trim END
382 vim9script
383 class Item
384 this.nr = 0
385 this.name = 'xx'
386 endclass
387 END
388
389 # used at the script level and in a compiled function
390 var test_lines =<< trim END
391 var i1 = Item.new()
392 assert_equal(i1, i1)
393 assert_true(i1 is i1)
394 var i2 = Item.new()
395 assert_equal(i1, i2)
396 assert_false(i1 is i2)
397 var i3 = Item.new(0, 'xx')
398 assert_equal(i1, i3)
399
400 var io1 = Item.new(1, 'xx')
401 assert_notequal(i1, io1)
402 var io2 = Item.new(0, 'yy')
403 assert_notequal(i1, io2)
404 END
405
406 v9.CheckScriptSuccess(class_lines + test_lines)
Bram Moolenaar46ab9252023-01-03 14:01:21 +0000407 v9.CheckScriptSuccess(
408 class_lines + ['def Test()'] + test_lines + ['enddef', 'Test()'])
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +0000409
410 for op in ['>', '>=', '<', '<=', '=~', '!~']
411 var op_lines = [
412 'var i1 = Item.new()',
413 'var i2 = Item.new()',
414 'echo i1 ' .. op .. ' i2',
415 ]
416 v9.CheckScriptFailure(class_lines + op_lines, 'E1153: Invalid operation for object')
Bram Moolenaar46ab9252023-01-03 14:01:21 +0000417 v9.CheckScriptFailure(class_lines
418 + ['def Test()'] + op_lines + ['enddef', 'Test()'], 'E1153: Invalid operation for object')
Bram Moolenaarbcf31ec2023-01-02 20:32:24 +0000419 endfor
420enddef
421
Bram Moolenaar6acf7572023-01-01 19:53:30 +0000422def Test_class_member()
423 # check access rules
Bram Moolenaard505d172022-12-18 21:42:55 +0000424 var lines =<< trim END
425 vim9script
426 class TextPos
427 this.lnum = 1
428 this.col = 1
429 static counter = 0
Bram Moolenaar9f2d97e2022-12-31 19:01:02 +0000430 static _secret = 7
431 public static anybody = 42
Bram Moolenaard505d172022-12-18 21:42:55 +0000432
Bram Moolenaar6bafdd42023-01-01 12:58:33 +0000433 static def AddToCounter(nr: number)
Bram Moolenaard505d172022-12-18 21:42:55 +0000434 counter += nr
435 enddef
436 endclass
437
438 assert_equal(0, TextPos.counter)
439 TextPos.AddToCounter(3)
440 assert_equal(3, TextPos.counter)
Bram Moolenaarf54cedd2022-12-23 17:56:27 +0000441 assert_fails('echo TextPos.noSuchMember', 'E1338:')
Bram Moolenaar3259ff32023-01-04 18:54:09 +0000442
443 def GetCounter(): number
444 return TextPos.counter
445 enddef
446 assert_equal(3, GetCounter())
Bram Moolenaard505d172022-12-18 21:42:55 +0000447
Bram Moolenaarf54cedd2022-12-23 17:56:27 +0000448 assert_fails('TextPos.noSuchMember = 2', 'E1337:')
Bram Moolenaar9f2d97e2022-12-31 19:01:02 +0000449 assert_fails('TextPos.counter = 5', 'E1335:')
450 assert_fails('TextPos.counter += 5', 'E1335:')
451
452 assert_fails('echo TextPos._secret', 'E1333:')
453 assert_fails('TextPos._secret = 8', 'E1333:')
454
455 assert_equal(42, TextPos.anybody)
456 TextPos.anybody = 12
457 assert_equal(12, TextPos.anybody)
458 TextPos.anybody += 5
459 assert_equal(17, TextPos.anybody)
Bram Moolenaar3d473ee2022-12-14 20:59:32 +0000460 END
461 v9.CheckScriptSuccess(lines)
Bram Moolenaar6acf7572023-01-01 19:53:30 +0000462
463 # check shadowing
464 lines =<< trim END
465 vim9script
466
467 class Some
468 static count = 0
469 def Method(count: number)
470 echo count
471 enddef
472 endclass
473
474 var s = Some.new()
475 s.Method(7)
476 END
477 v9.CheckScriptFailure(lines, 'E1340: Argument already declared in the class: count')
478
479 lines =<< trim END
480 vim9script
481
482 class Some
483 static count = 0
484 def Method(arg: number)
485 var count = 3
486 echo arg count
487 enddef
488 endclass
489
490 var s = Some.new()
491 s.Method(7)
492 END
493 v9.CheckScriptFailure(lines, 'E1341: Variable already declared in the class: count')
Bram Moolenaar3d473ee2022-12-14 20:59:32 +0000494enddef
495
Bram Moolenaarcf760d52023-01-05 13:16:04 +0000496func Test_class_garbagecollect()
497 let lines =<< trim END
498 vim9script
499
500 class Point
501 this.p = [2, 3]
502 static pl = ['a', 'b']
503 static pd = {a: 'a', b: 'b'}
504 endclass
505
506 echo Point.pl Point.pd
507 call test_garbagecollect_now()
508 echo Point.pl Point.pd
509 END
510 call v9.CheckScriptSuccess(lines)
511endfunc
512
Bram Moolenaar6bafdd42023-01-01 12:58:33 +0000513def Test_class_function()
514 var lines =<< trim END
515 vim9script
516 class Value
517 this.value = 0
518 static objects = 0
519
520 def new(v: number)
521 this.value = v
522 ++objects
523 enddef
524
525 static def GetCount(): number
526 return objects
527 enddef
528 endclass
529
530 assert_equal(0, Value.GetCount())
531 var v1 = Value.new(2)
532 assert_equal(1, Value.GetCount())
533 var v2 = Value.new(7)
534 assert_equal(2, Value.GetCount())
535 END
536 v9.CheckScriptSuccess(lines)
537enddef
538
Bram Moolenaar91c9d6d2022-12-14 17:30:37 +0000539def Test_class_object_to_string()
540 var lines =<< trim END
541 vim9script
542 class TextPosition
543 this.lnum = 1
544 this.col = 22
545 endclass
546
547 assert_equal("class TextPosition", string(TextPosition))
548
549 var pos = TextPosition.new()
550 assert_equal("object of TextPosition {lnum: 1, col: 22}", string(pos))
551 END
552 v9.CheckScriptSuccess(lines)
553enddef
Bram Moolenaar74e12742022-12-13 21:14:28 +0000554
Bram Moolenaar554d0312023-01-05 19:59:18 +0000555def Test_interface_basics()
556 var lines =<< trim END
557 vim9script
558 interface Something
559 this.value: string
560 static count: number
561 def GetCount(): number
562 endinterface
563 END
564 v9.CheckScriptSuccess(lines)
565
566 lines =<< trim END
567 interface SomethingWrong
568 static count = 7
569 endinterface
570 END
571 v9.CheckScriptFailure(lines, 'E1342:')
572
573 lines =<< trim END
574 vim9script
575
576 interface Some
577 static count: number
578 def Method(count: number)
579 endinterface
580 END
581 # TODO: this should give an error for "count" shadowing
582 v9.CheckScriptSuccess(lines)
583
584 lines =<< trim END
585 vim9script
586 interface somethingWrong
587 static count = 7
588 endinterface
589 END
590 v9.CheckScriptFailure(lines, 'E1343: Interface name must start with an uppercase letter: somethingWrong')
591
592 lines =<< trim END
593 vim9script
594 interface SomethingWrong
595 this.value: string
596 static count = 7
597 def GetCount(): number
598 endinterface
599 END
600 v9.CheckScriptFailure(lines, 'E1344:')
601
602 lines =<< trim END
603 vim9script
604 interface SomethingWrong
605 this.value: string
606 static count: number
607 def GetCount(): number
608 return 5
609 enddef
610 endinterface
611 END
612 v9.CheckScriptFailure(lines, 'E1345: Not a valid command in an interface: return 5')
613enddef
614
Bram Moolenaar94674f22023-01-06 18:42:20 +0000615def Test_class_implements_interface()
616 var lines =<< trim END
617 vim9script
618
619 interface Some
620 static count: number
621 def Method(nr: number)
622 endinterface
623
624 class SomeImpl implements Some
625 static count: number
626 def Method(nr: number)
627 echo nr
628 enddef
629 endclass
Bram Moolenaardf8f9472023-01-07 14:51:03 +0000630
631 interface Another
632 this.member: string
633 endinterface
634
635 class SomeImpl implements Some, Another
636 this.member = 'abc'
637 static count: number
638 def Method(nr: number)
639 echo nr
640 enddef
641 endclass
642
Bram Moolenaar94674f22023-01-06 18:42:20 +0000643 END
644 v9.CheckScriptSuccess(lines)
645
646 lines =<< trim END
647 vim9script
648
649 interface Some
650 static counter: number
Bram Moolenaardf8f9472023-01-07 14:51:03 +0000651 endinterface
652
653 class SomeImpl implements Some implements Some
654 static count: number
655 endclass
656 END
657 v9.CheckScriptFailure(lines, 'E1350:')
658
659 lines =<< trim END
660 vim9script
661
662 interface Some
663 static counter: number
664 endinterface
665
666 class SomeImpl implements Some, Some
667 static count: number
668 endclass
669 END
670 v9.CheckScriptFailure(lines, 'E1351: Duplicate interface after "implements": Some')
671
672 lines =<< trim END
673 vim9script
674
675 interface Some
676 static counter: number
Bram Moolenaar94674f22023-01-06 18:42:20 +0000677 def Method(nr: number)
678 endinterface
679
680 class SomeImpl implements Some
681 static count: number
682 def Method(nr: number)
683 echo nr
684 enddef
685 endclass
686 END
687 v9.CheckScriptFailure(lines, 'E1348: Member "counter" of interface "Some" not implemented')
688
689 lines =<< trim END
690 vim9script
691
692 interface Some
693 static count: number
694 def Methods(nr: number)
695 endinterface
696
697 class SomeImpl implements Some
698 static count: number
699 def Method(nr: number)
700 echo nr
701 enddef
702 endclass
703 END
704 v9.CheckScriptFailure(lines, 'E1349: Function "Methods" of interface "Some" not implemented')
705enddef
706
Bram Moolenaareca2c5f2023-01-07 12:08:41 +0000707def Test_class_used_as_type()
708 var lines =<< trim END
709 vim9script
710
711 class Point
712 this.x = 0
713 this.y = 0
714 endclass
715
716 var p: Point
717 p = Point.new(2, 33)
718 assert_equal(2, p.x)
719 assert_equal(33, p.y)
720 END
721 v9.CheckScriptSuccess(lines)
722
723 lines =<< trim END
724 vim9script
725
726 interface HasX
727 this.x: number
728 endinterface
729
730 class Point implements HasX
731 this.x = 0
732 this.y = 0
733 endclass
734
735 var p: Point
736 p = Point.new(2, 33)
737 var hx = p
738 assert_equal(2, hx.x)
739 END
740 v9.CheckScriptSuccess(lines)
741
742 lines =<< trim END
743 vim9script
744
745 class Point
746 this.x = 0
747 this.y = 0
748 endclass
749
750 var p: Point
751 p = 'text'
752 END
753 v9.CheckScriptFailure(lines, 'E1012: Type mismatch; expected object but got string')
754enddef
755
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000756
757" vim: ts=8 sw=2 sts=2 expandtab tw=80 fdm=marker