endbasic-core 0.13.0

The EndBASIC programming language - core
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
# Test: Elaborate execution flow

## Source

```basic
a = 10

SUB foo
    a = 20
    OUT "Inside", a
END SUB

OUT "Before", a
foo
OUT "After", a
```

## Disassembly

```asm
0000:   LOADI       R64, 10             ; 1:5
0001:   JUMP        9                   ; 3:5

;; FOO (BEGIN)
0002:   LOADI       R64, 20             ; 4:9
0003:   LOADI       R66, 0              ; 5:9
0004:   LOADI       R65, 291            ; 5:9
0005:   MOVE        R68, R64            ; 5:19
0006:   LOADI       R67, 258            ; 5:19
0007:   UPCALL      0, R65              ; 5:5, OUT
0008:   RETURN                          ; 6:1
;; FOO (END)

0009:   LOADI       R66, 1              ; 8:5
0010:   LOADI       R65, 291            ; 8:5
0011:   MOVE        R68, R64            ; 8:15
0012:   LOADI       R67, 258            ; 8:15
0013:   UPCALL      0, R65              ; 8:1, OUT
0014:   CALL        R65, 2              ; 9:1, FOO
0015:   LOADI       R66, 2              ; 10:5
0016:   LOADI       R65, 291            ; 10:5
0017:   MOVE        R68, R64            ; 10:14
0018:   LOADI       R67, 258            ; 10:14
0019:   UPCALL      0, R65              ; 10:1, OUT
0020:   EOF                             ; 0:0
```

## Output

```plain
0=Before$ , 1=10%
0=Inside$ , 1=20%
0=After$ , 1=10%
```

# Test: Subroutine call requires jumping backwards

## Source

```basic
SUB first
    OUT "first"
END SUB

SUB second
    first
END SUB

second
```

## Disassembly

```asm
0000:   JUMP        5                   ; 1:5

;; FIRST (BEGIN)
0001:   LOADI       R65, 0              ; 2:9
0002:   LOADI       R64, 259            ; 2:9
0003:   UPCALL      0, R64              ; 2:5, OUT
0004:   RETURN                          ; 3:1
;; FIRST (END)

0005:   JUMP        8                   ; 5:5

;; SECOND (BEGIN)
0006:   CALL        R64, 1              ; 6:5, FIRST
0007:   RETURN                          ; 7:1
;; SECOND (END)

0008:   CALL        R64, 6              ; 9:1, SECOND
0009:   EOF                             ; 0:0
```

## Output

```plain
0=first$
```

# Test: Annotation not allowed in subroutine call

## Source

```basic
OUT$ 3
```

## Compilation errors

```plain
1:1: Type annotation not allowed in OUT$
```

# Test: Local variables

## Source

```basic
SUB modify_2
    var = 2
    OUT "Inside modify_2", var
END SUB

SUB modify_1
    var = 1
    OUT "Before modify_2", var
    modify_2
    OUT "After modify_2", var
END SUB

var = 0
OUT "Before modify_1", var
modify_1
OUT "After modify_1", var
```

## Disassembly

```asm
0000:   JUMP        8                   ; 1:5

;; MODIFY_2 (BEGIN)
0001:   LOADI       R64, 2              ; 2:11
0002:   LOADI       R66, 0              ; 3:9
0003:   LOADI       R65, 291            ; 3:9
0004:   MOVE        R68, R64            ; 3:28
0005:   LOADI       R67, 258            ; 3:28
0006:   UPCALL      0, R65              ; 3:5, OUT
0007:   RETURN                          ; 4:1
;; MODIFY_2 (END)

0008:   JUMP        22                  ; 6:5

;; MODIFY_1 (BEGIN)
0009:   LOADI       R64, 1              ; 7:11
0010:   LOADI       R66, 1              ; 8:9
0011:   LOADI       R65, 291            ; 8:9
0012:   MOVE        R68, R64            ; 8:28
0013:   LOADI       R67, 258            ; 8:28
0014:   UPCALL      0, R65              ; 8:5, OUT
0015:   CALL        R65, 1              ; 9:5, MODIFY_2
0016:   LOADI       R66, 2              ; 10:9
0017:   LOADI       R65, 291            ; 10:9
0018:   MOVE        R68, R64            ; 10:27
0019:   LOADI       R67, 258            ; 10:27
0020:   UPCALL      0, R65              ; 10:5, OUT
0021:   RETURN                          ; 11:1
;; MODIFY_1 (END)

0022:   LOADI       R64, 0              ; 13:7
0023:   LOADI       R66, 3              ; 14:5
0024:   LOADI       R65, 291            ; 14:5
0025:   MOVE        R68, R64            ; 14:24
0026:   LOADI       R67, 258            ; 14:24
0027:   UPCALL      0, R65              ; 14:1, OUT
0028:   CALL        R65, 9              ; 15:1, MODIFY_1
0029:   LOADI       R66, 4              ; 16:5
0030:   LOADI       R65, 291            ; 16:5
0031:   MOVE        R68, R64            ; 16:23
0032:   LOADI       R67, 258            ; 16:23
0033:   UPCALL      0, R65              ; 16:1, OUT
0034:   EOF                             ; 0:0
```

## Output

```plain
0=Before modify_1$ , 1=0%
0=Before modify_2$ , 1=1%
0=Inside modify_2$ , 1=2%
0=After modify_2$ , 1=1%
0=After modify_1$ , 1=0%
```

# Test: Local is not global

## Source

```basic
SUB set_local
    local_var = 8
END SUB

set_local
OUT local_var
```

## Compilation errors

```plain
6:5: Undefined symbol local_var
```

# Test: Calling a command as a function with arguments

## Source

```basic
x = OUT(1)
```

## Compilation errors

```plain
1:5: OUT is not an array nor a function
```

# Test: Using a command as an argless function

## Source

```basic
x = OUT
```

## Compilation errors

```plain
1:5: OUT is not an array nor a function
```

# Test: Sub name conflicts with existing global variable

## Source

```basic
DIM SHARED g AS INTEGER
SUB g
END SUB
```

## Compilation errors

```plain
2:5: Cannot redefine g
```

# Test: Sub name conflicts with existing global array

## Source

```basic
DIM SHARED g(3) AS INTEGER
SUB g
END SUB
```

## Compilation errors

```plain
2:5: Cannot redefine g
```

# Test: Early sub exit

## Source

```basic
SUB maybe_exit(i%)
    OUT 1
    IF i > 2 THEN EXIT SUB
    OUT 2
END SUB

FOR i = 0 TO 5
    maybe_exit(i)
NEXT
```

## Disassembly

```asm
0000:   JUMP        13                  ; 1:5

;; MAYBE_EXIT (BEGIN)
0001:   LOADI       R66, 1              ; 2:9
0002:   LOADI       R65, 258            ; 2:9
0003:   UPCALL      0, R65              ; 2:5, OUT
0004:   MOVE        R65, R64            ; 3:8
0005:   LOADI       R66, 2              ; 3:12
0006:   CMPGTI      R65, R65, R66       ; 3:10
0007:   JMPF        R65, 9              ; 3:8
0008:   JUMP        12                  ; 3:19
0009:   LOADI       R66, 2              ; 4:9
0010:   LOADI       R65, 258            ; 4:9
0011:   UPCALL      0, R65              ; 4:5, OUT
0012:   RETURN                          ; 5:1
;; MAYBE_EXIT (END)

0013:   LOADI       R64, 0              ; 7:9
0014:   MOVE        R65, R64            ; 7:5
0015:   LOADI       R66, 5              ; 7:14
0016:   CMPLEI      R65, R65, R66       ; 7:11
0017:   JMPF        R65, 25             ; 7:5
0018:   MOVE        R65, R64            ; 8:16
0019:   CALL        R65, 1              ; 8:5, MAYBE_EXIT
0020:   MOVE        R65, R64            ; 7:5
0021:   LOADI       R66, 1              ; 7:1
0022:   ADDI        R65, R65, R66       ; 7:11
0023:   MOVE        R64, R65            ; 7:5
0024:   JUMP        14                  ; 7:5
0025:   EOF                             ; 0:0
```

## Output

```plain
0=1%
0=2%
0=1%
0=2%
0=1%
0=2%
0=1%
0=1%
0=1%
```

# Test: EXIT SUB outside SUB

## Source

```basic
SUB a
END SUB
EXIT SUB
```

## Compilation errors

```plain
3:1: EXIT SUB outside of SUB
```

# Test: EXIT FUNCTION in SUB

## Source

```basic
SUB a
    EXIT FUNCTION
END SUB
```

## Compilation errors

```plain
2:5: EXIT FUNCTION outside of FUNCTION
```

# Test: Recursive subroutine

## Source

```basic
DIM SHARED counter AS INTEGER
SUB count_down(prefix$)
    OUT prefix; counter
    IF counter > 1 THEN
        counter = counter - 1
        count_down prefix
    END IF
END SUB
counter = 3
count_down "counter is"
```

## Disassembly

```asm
0000:   LOADI       R0, 0               ; 1:12
0001:   JUMP        18                  ; 2:5

;; COUNT_DOWN (BEGIN)
0002:   MOVE        R66, R64            ; 3:9
0003:   LOADI       R65, 275            ; 3:9
0004:   MOVE        R68, R0             ; 3:17
0005:   LOADI       R67, 258            ; 3:17
0006:   UPCALL      0, R65              ; 3:5, OUT
0007:   MOVE        R65, R0             ; 4:8
0008:   LOADI       R66, 1              ; 4:18
0009:   CMPGTI      R65, R65, R66       ; 4:16
0010:   JMPF        R65, 17             ; 4:8
0011:   MOVE        R65, R0             ; 5:19
0012:   LOADI       R66, 1              ; 5:29
0013:   SUBI        R65, R65, R66       ; 5:27
0014:   MOVE        R0, R65             ; 5:9
0015:   MOVE        R65, R64            ; 6:20
0016:   CALL        R65, 2              ; 6:9, COUNT_DOWN
0017:   RETURN                          ; 8:1
;; COUNT_DOWN (END)

0018:   LOADI       R0, 3               ; 9:11
0019:   LOADI       R64, 0              ; 10:12
0020:   CALL        R64, 2              ; 10:1, COUNT_DOWN
0021:   EOF                             ; 0:0
```

## Output

```plain
0=counter is$ ; 1=3%
0=counter is$ ; 1=2%
0=counter is$ ; 1=1%
```

# Test: Function and subroutine call one another

## Source

```basic
DIM SHARED value AS INTEGER

DECLARE SUB bump_value(n%)

FUNCTION count_value(n%)
    value = value + 1
    IF n = 0 THEN
        count_value = value
    ELSE
        bump_value(n - 1)
        count_value = value
    END IF
END FUNCTION

SUB bump_value(n%)
    value = value + 10
    value = count_value(n)
END SUB

OUT count_value(2)
OUT value
```

## Disassembly

```asm
0000:   LOADI       R0, 0               ; 1:12
0001:   JUMP        21                  ; 5:10

;; COUNT_VALUE (BEGIN)
0002:   LOADI       R64, 0              ; 5:10
0003:   MOVE        R66, R0             ; 6:13
0004:   LOADI       R67, 1              ; 6:21
0005:   ADDI        R66, R66, R67       ; 6:19
0006:   MOVE        R0, R66             ; 6:5
0007:   MOVE        R66, R65            ; 7:8
0008:   LOADI       R67, 0              ; 7:12
0009:   CMPEQI      R66, R66, R67       ; 7:10
0010:   JMPF        R66, 13             ; 7:8
0011:   MOVE        R64, R0             ; 8:23
0012:   JUMP        20                  ; 7:8
0013:   LOADI       R66, 1              ; 9:5
0014:   JMPF        R66, 20             ; 9:5
0015:   MOVE        R66, R65            ; 10:20
0016:   LOADI       R67, 1              ; 10:24
0017:   SUBI        R66, R66, R67       ; 10:22
0018:   CALL        R66, 22             ; 10:9, BUMP_VALUE
0019:   MOVE        R64, R0             ; 11:23
0020:   RETURN                          ; 13:1
;; COUNT_VALUE (END)

0021:   JUMP        30                  ; 15:5

;; BUMP_VALUE (BEGIN)
0022:   MOVE        R65, R0             ; 16:13
0023:   LOADI       R66, 10             ; 16:21
0024:   ADDI        R65, R65, R66       ; 16:19
0025:   MOVE        R0, R65             ; 16:5
0026:   MOVE        R66, R64            ; 17:25
0027:   CALL        R65, 2              ; 17:13, COUNT_VALUE
0028:   MOVE        R0, R65             ; 17:13
0029:   RETURN                          ; 18:1
;; BUMP_VALUE (END)

0030:   LOADI       R67, 2              ; 20:17
0031:   CALL        R66, 2              ; 20:5, COUNT_VALUE
0032:   MOVE        R65, R66            ; 20:5
0033:   LOADI       R64, 258            ; 20:5
0034:   UPCALL      0, R64              ; 20:1, OUT
0035:   MOVE        R65, R0             ; 21:5
0036:   LOADI       R64, 258            ; 21:5
0037:   UPCALL      0, R64              ; 21:1, OUT
0038:   EOF                             ; 0:0
```

## Output

```plain
0=23%
0=23%
```

# Test: Calling a subroutine as a function is an error

## Source

```basic
SUB f
END SUB
OUT f
```

## Compilation errors

```plain
3:5: f is not an array nor a function
```

# Test: Sub redefines existing function

## Source

```basic
FUNCTION foo
END FUNCTION

SUB foo
END SUB
```

## Compilation errors

```plain
4:5: Cannot redefine foo
```

# Test: Sub redefines existing sub

## Source

```basic
SUB foo
END SUB

SUB foo
END SUB
```

## Compilation errors

```plain
4:5: Cannot redefine foo
```

# Test: Sub nesting within a sub

## Source

```basic
SUB foo
    SUB bar
    END SUB
END SUB
```

## Compilation errors

```plain
2:5: Cannot nest FUNCTION or SUB definitions
```

# Test: Sub nesting within a function

## Source

```basic
FUNCTION foo
    SUB bar
    END SUB
END FUNCTION
```

## Compilation errors

```plain
2:5: Cannot nest FUNCTION or SUB definitions
```

# Test: Sub declarations

## Source

```basic
DECLARE SUB foo
DECLARE SUB bar(a AS STRING)
```

## Disassembly

```asm
0000:   EOF                             ; 0:0
```

# Test: Sub declarations match definition

## Source

```basic
DECLARE SUB foo

SUB foo
END SUB

DECLARE SUB foo
```

## Disassembly

```asm
0000:   JUMP        2                   ; 3:5

;; FOO (BEGIN)
0001:   RETURN                          ; 4:1
;; FOO (END)

0002:   EOF                             ; 0:0
```

# Test: Sub declarations must be top-level

## Source

```basic

SUB foo
    SUB FUNCTION bar
END SUB
```

## Compilation errors

```plain
3:5: Cannot nest FUNCTION or SUB definitions
```

# Test: Sub pre-declaration does not match pre-definition

## Source

```basic
DECLARE SUB foo

SUB foo(a AS STRING)
END SUB
```

## Compilation errors

```plain
3:5: Cannot redefine foo
```

# Test: Sub post-declaration does not match definition

## Source

```basic
SUB foo
END SUB

DECLARE SUB foo(a AS STRING)
```

## Compilation errors

```plain
4:13: Cannot redefine foo
```

# Test: Sub declarations do not match

## Source

```basic
DECLARE SUB foo
DECLARE SUB foo(a as STRING)
```

## Compilation errors

```plain
2:13: Cannot redefine foo
```

# Test: Sub redeclared as function

## Source

```basic
DECLARE SUB foo
DECLARE FUNCTION foo
```

## Compilation errors

```plain
2:18: Cannot redefine foo%
```

# Test: Deep recursive subroutine with parameter

## Source

```basic
SUB recurse(n%)
    IF n > 0 THEN
        recurse n - 1
    END IF
END SUB

recurse 1000
OUT 123
```

## Disassembly

```asm
0000:   JUMP        10                  ; 1:5

;; RECURSE (BEGIN)
0001:   MOVE        R65, R64            ; 2:8
0002:   LOADI       R66, 0              ; 2:12
0003:   CMPGTI      R65, R65, R66       ; 2:10
0004:   JMPF        R65, 9              ; 2:8
0005:   MOVE        R65, R64            ; 3:17
0006:   LOADI       R66, 1              ; 3:21
0007:   SUBI        R65, R65, R66       ; 3:19
0008:   CALL        R65, 1              ; 3:9, RECURSE
0009:   RETURN                          ; 5:1
;; RECURSE (END)

0010:   LOADI       R64, 1000           ; 7:9
0011:   CALL        R64, 1              ; 7:1, RECURSE
0012:   LOADI       R65, 123            ; 8:5
0013:   LOADI       R64, 258            ; 8:5
0014:   UPCALL      0, R64              ; 8:1, OUT
0015:   EOF                             ; 0:0
```

## Output

```plain
0=123%
```