2021-10-21 22:41:34 +00:00
|
|
|
package prog8tests
|
|
|
|
|
2021-11-08 14:50:29 +00:00
|
|
|
import io.kotest.assertions.withClue
|
2021-11-07 23:16:58 +00:00
|
|
|
import io.kotest.core.spec.style.FunSpec
|
2021-11-08 14:50:29 +00:00
|
|
|
import io.kotest.matchers.shouldBe
|
|
|
|
import io.kotest.matchers.shouldNotBe
|
|
|
|
import io.kotest.matchers.string.shouldContain
|
|
|
|
import io.kotest.matchers.types.instanceOf
|
2021-10-21 22:41:34 +00:00
|
|
|
import prog8.ast.base.DataType
|
2022-02-05 02:50:54 +00:00
|
|
|
import prog8.ast.expressions.BinaryExpression
|
|
|
|
import prog8.ast.expressions.DirectMemoryRead
|
|
|
|
import prog8.ast.expressions.IdentifierReference
|
2022-02-10 23:21:40 +00:00
|
|
|
import prog8.ast.expressions.NumericLiteral
|
2021-10-24 18:57:10 +00:00
|
|
|
import prog8.ast.statements.*
|
2021-12-28 13:23:36 +00:00
|
|
|
import prog8.codegen.target.C64Target
|
2021-10-21 23:25:26 +00:00
|
|
|
import prog8tests.helpers.ErrorReporterForTests
|
2021-10-21 22:41:34 +00:00
|
|
|
import prog8tests.helpers.compileText
|
|
|
|
|
|
|
|
|
2021-11-07 23:16:58 +00:00
|
|
|
class TestSubroutines: FunSpec({
|
2021-10-21 22:41:34 +00:00
|
|
|
|
2021-11-07 23:16:58 +00:00
|
|
|
test("stringParameter") {
|
2021-10-21 22:41:34 +00:00
|
|
|
val text = """
|
|
|
|
main {
|
|
|
|
sub start() {
|
2021-10-24 18:57:10 +00:00
|
|
|
str text = "test"
|
|
|
|
|
|
|
|
asmfunc("text")
|
|
|
|
asmfunc(text)
|
|
|
|
asmfunc($2000)
|
|
|
|
func("text")
|
|
|
|
func(text)
|
|
|
|
func($2000)
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
|
2021-10-24 18:57:10 +00:00
|
|
|
asmsub asmfunc(str thing @AY) {
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
|
2021-10-24 18:57:10 +00:00
|
|
|
sub func(str thing) {
|
|
|
|
uword t2 = thing as uword
|
|
|
|
asmfunc(thing)
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
2022-03-07 20:41:12 +00:00
|
|
|
val result = compileText(C64Target(), false, text, writeAssembly = false)!!
|
2021-10-29 22:25:34 +00:00
|
|
|
val module = result.program.toplevelModule
|
2021-10-24 18:57:10 +00:00
|
|
|
val mainBlock = module.statements.single() as Block
|
|
|
|
val asmfunc = mainBlock.statements.filterIsInstance<Subroutine>().single { it.name=="asmfunc"}
|
|
|
|
val func = mainBlock.statements.filterIsInstance<Subroutine>().single { it.name=="func"}
|
2021-11-08 14:50:29 +00:00
|
|
|
asmfunc.isAsmSubroutine shouldBe true
|
|
|
|
asmfunc.statements.isEmpty() shouldBe true
|
|
|
|
func.isAsmSubroutine shouldBe false
|
2021-12-07 22:21:49 +00:00
|
|
|
withClue("str param for subroutines should be changed into UWORD") {
|
|
|
|
asmfunc.parameters.single().type shouldBe DataType.UWORD
|
2021-11-24 00:41:04 +00:00
|
|
|
func.parameters.single().type shouldBe DataType.UWORD
|
|
|
|
func.statements.size shouldBe 4
|
|
|
|
val paramvar = func.statements[0] as VarDecl
|
|
|
|
paramvar.name shouldBe "thing"
|
|
|
|
paramvar.datatype shouldBe DataType.UWORD
|
|
|
|
}
|
2021-10-31 23:24:15 +00:00
|
|
|
val assign = func.statements[2] as Assignment
|
2021-11-08 14:50:29 +00:00
|
|
|
assign.target.identifier!!.nameInSource shouldBe listOf("t2")
|
2021-11-24 00:41:04 +00:00
|
|
|
withClue("str param in function body should have been transformed into just uword assignment") {
|
|
|
|
assign.value shouldBe instanceOf<IdentifierReference>()
|
2021-11-08 14:50:29 +00:00
|
|
|
}
|
2021-10-31 23:24:15 +00:00
|
|
|
val call = func.statements[3] as FunctionCallStatement
|
2021-11-08 14:50:29 +00:00
|
|
|
call.target.nameInSource.single() shouldBe "asmfunc"
|
|
|
|
withClue("str param in function body should not be transformed by normal compiler steps") {
|
|
|
|
call.args.single() shouldBe instanceOf<IdentifierReference>()
|
|
|
|
}
|
|
|
|
(call.args.single() as IdentifierReference).nameInSource.single() shouldBe "thing"
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
|
2021-11-07 23:16:58 +00:00
|
|
|
test("stringParameterAsmGen") {
|
2021-10-21 22:41:34 +00:00
|
|
|
val text = """
|
|
|
|
main {
|
|
|
|
sub start() {
|
|
|
|
str text = "test"
|
|
|
|
|
|
|
|
asmfunc("text")
|
|
|
|
asmfunc(text)
|
|
|
|
asmfunc($2000)
|
|
|
|
func("text")
|
|
|
|
func(text)
|
|
|
|
func($2000)
|
2022-02-06 03:29:36 +00:00
|
|
|
emptysub()
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
asmsub asmfunc(str thing @AY) {
|
|
|
|
}
|
|
|
|
|
|
|
|
sub func(str thing) {
|
2021-10-24 18:57:10 +00:00
|
|
|
uword t2 = thing as uword
|
|
|
|
asmfunc(thing)
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
2022-02-06 03:29:36 +00:00
|
|
|
|
|
|
|
sub emptysub() {
|
|
|
|
}
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
"""
|
2022-03-07 20:41:12 +00:00
|
|
|
val result = compileText(C64Target(), false, text, writeAssembly = true)!!
|
2021-10-29 22:25:34 +00:00
|
|
|
val module = result.program.toplevelModule
|
2021-10-21 22:41:34 +00:00
|
|
|
val mainBlock = module.statements.single() as Block
|
|
|
|
val asmfunc = mainBlock.statements.filterIsInstance<Subroutine>().single { it.name=="asmfunc"}
|
|
|
|
val func = mainBlock.statements.filterIsInstance<Subroutine>().single { it.name=="func"}
|
2022-02-06 03:29:36 +00:00
|
|
|
val emptysub = mainBlock.statements.filterIsInstance<Subroutine>().single { it.name=="emptysub"}
|
2021-11-08 14:50:29 +00:00
|
|
|
asmfunc.isAsmSubroutine shouldBe true
|
2022-02-06 03:29:36 +00:00
|
|
|
asmfunc.statements.single() shouldBe instanceOf<InlineAssembly>()
|
|
|
|
(asmfunc.statements.single() as InlineAssembly).assembly.trim() shouldBe "rts"
|
|
|
|
asmfunc.amountOfRtsInAsm() shouldBe 1
|
2021-11-08 14:50:29 +00:00
|
|
|
func.isAsmSubroutine shouldBe false
|
2021-12-07 22:21:49 +00:00
|
|
|
withClue("str param should have been changed to uword") {
|
|
|
|
asmfunc.parameters.single().type shouldBe DataType.UWORD
|
2021-11-08 14:50:29 +00:00
|
|
|
func.parameters.single().type shouldBe DataType.UWORD
|
|
|
|
}
|
|
|
|
|
|
|
|
func.statements.size shouldBe 5
|
|
|
|
func.statements[4] shouldBe instanceOf<Return>()
|
2021-10-24 18:57:10 +00:00
|
|
|
val paramvar = func.statements[0] as VarDecl
|
2021-11-08 14:50:29 +00:00
|
|
|
paramvar.name shouldBe "thing"
|
|
|
|
withClue("pre-asmgen should have changed str to uword type") {
|
|
|
|
paramvar.datatype shouldBe DataType.UWORD
|
|
|
|
}
|
2021-10-31 23:24:15 +00:00
|
|
|
val assign = func.statements[2] as Assignment
|
2021-11-08 14:50:29 +00:00
|
|
|
assign.target.identifier!!.nameInSource shouldBe listOf("t2")
|
|
|
|
withClue("str param in function body should be treated as plain uword before asmgen") {
|
|
|
|
assign.value shouldBe instanceOf<IdentifierReference>()
|
|
|
|
}
|
|
|
|
(assign.value as IdentifierReference).nameInSource.single() shouldBe "thing"
|
2021-10-31 23:24:15 +00:00
|
|
|
val call = func.statements[3] as FunctionCallStatement
|
2021-11-08 14:50:29 +00:00
|
|
|
call.target.nameInSource.single() shouldBe "asmfunc"
|
|
|
|
withClue("str param in function body should be treated as plain uword and not been transformed") {
|
|
|
|
call.args.single() shouldBe instanceOf<IdentifierReference>()
|
|
|
|
}
|
|
|
|
(call.args.single() as IdentifierReference).nameInSource.single() shouldBe "thing"
|
2022-02-06 03:29:36 +00:00
|
|
|
|
|
|
|
emptysub.statements.size shouldBe 1
|
|
|
|
emptysub.statements.single() shouldBe instanceOf<Return>()
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
|
2021-12-07 22:21:49 +00:00
|
|
|
test("ubyte[] array parameters") {
|
2021-10-25 21:01:07 +00:00
|
|
|
val text = """
|
|
|
|
main {
|
|
|
|
sub start() {
|
2021-12-07 22:21:49 +00:00
|
|
|
ubyte[] array = [1,2,3]
|
|
|
|
|
|
|
|
asmfunc(array)
|
|
|
|
asmfunc($2000)
|
|
|
|
asmfunc("zzzz")
|
|
|
|
func(array)
|
|
|
|
func($2000)
|
|
|
|
func("zzzz")
|
2021-10-25 21:01:07 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
asmsub asmfunc(ubyte[] thing @AY) {
|
|
|
|
}
|
|
|
|
|
2021-12-07 22:21:49 +00:00
|
|
|
sub func(ubyte[] thing) {
|
2021-10-25 21:01:07 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
2022-03-07 20:41:12 +00:00
|
|
|
val result = compileText(C64Target(), false, text, writeAssembly = false)!!
|
2021-12-07 22:21:49 +00:00
|
|
|
val module = result.program.toplevelModule
|
|
|
|
val mainBlock = module.statements.single() as Block
|
|
|
|
val asmfunc = mainBlock.statements.filterIsInstance<Subroutine>().single { it.name=="asmfunc"}
|
|
|
|
val func = mainBlock.statements.filterIsInstance<Subroutine>().single { it.name=="func"}
|
|
|
|
withClue("ubyte array param should have been replaced by UWORD pointer") {
|
|
|
|
asmfunc.parameters.single().type shouldBe DataType.UWORD
|
|
|
|
func.parameters.single().type shouldBe DataType.UWORD
|
|
|
|
}
|
2021-10-25 21:01:07 +00:00
|
|
|
}
|
|
|
|
|
2021-12-07 22:21:49 +00:00
|
|
|
test("not ubyte[] array parameters not allowed") {
|
2021-10-21 22:41:34 +00:00
|
|
|
val text = """
|
|
|
|
main {
|
|
|
|
sub start() {
|
|
|
|
}
|
|
|
|
|
2021-12-07 22:21:49 +00:00
|
|
|
asmsub func1(uword[] thing @AY) {
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
2021-12-07 22:21:49 +00:00
|
|
|
|
|
|
|
sub func(byte[] thing) {
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
2021-12-07 22:21:49 +00:00
|
|
|
val errors = ErrorReporterForTests()
|
2022-03-07 20:41:12 +00:00
|
|
|
compileText(C64Target(), false, text, writeAssembly = false, errors=errors) shouldBe null
|
2021-12-07 22:21:49 +00:00
|
|
|
errors.errors.size shouldBe 2
|
|
|
|
errors.errors[0] shouldContain "pass-by-reference type can't be used"
|
|
|
|
errors.errors[1] shouldContain "pass-by-reference type can't be used"
|
2021-10-21 22:41:34 +00:00
|
|
|
}
|
2021-11-02 23:47:22 +00:00
|
|
|
|
2021-11-23 21:36:28 +00:00
|
|
|
test("uword param and normal varindexed as array work as DirectMemoryRead") {
|
2021-11-02 23:47:22 +00:00
|
|
|
val text="""
|
|
|
|
main {
|
|
|
|
sub thing(uword rr) {
|
2021-11-17 23:17:22 +00:00
|
|
|
ubyte @shared xx = rr[1] ; should still work as var initializer that will be rewritten
|
|
|
|
ubyte @shared yy
|
2021-11-02 23:47:22 +00:00
|
|
|
yy = rr[2]
|
2021-11-17 23:17:22 +00:00
|
|
|
uword @shared other
|
2021-11-02 23:47:22 +00:00
|
|
|
ubyte zz = other[3]
|
|
|
|
}
|
|
|
|
|
|
|
|
sub start() {
|
|
|
|
ubyte[] array=[1,2,3]
|
|
|
|
thing(array)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
2022-03-07 20:41:12 +00:00
|
|
|
val result = compileText(C64Target(), false, text, writeAssembly = true)!!
|
2021-11-02 23:47:22 +00:00
|
|
|
val module = result.program.toplevelModule
|
|
|
|
val block = module.statements.single() as Block
|
|
|
|
val thing = block.statements.filterIsInstance<Subroutine>().single {it.name=="thing"}
|
2021-11-08 14:50:29 +00:00
|
|
|
block.name shouldBe "main"
|
2021-12-25 22:30:09 +00:00
|
|
|
thing.statements.size shouldBe 10 // rr paramdecl, xx, xx assign, yy decl, yy assign, other, other assign 0, zz, zz assign, return
|
2021-11-02 23:47:22 +00:00
|
|
|
val xx = thing.statements[1] as VarDecl
|
2021-11-08 14:50:29 +00:00
|
|
|
withClue("vardecl init values must have been moved to separate assignments") {
|
|
|
|
xx.value shouldBe null
|
|
|
|
}
|
2021-11-02 23:47:22 +00:00
|
|
|
val assignXX = thing.statements[2] as Assignment
|
2021-12-25 22:30:09 +00:00
|
|
|
val assignYY = thing.statements[4] as Assignment
|
|
|
|
val assignZZ = thing.statements[8] as Assignment
|
2021-11-08 14:50:29 +00:00
|
|
|
assignXX.target.identifier!!.nameInSource shouldBe listOf("xx")
|
|
|
|
assignYY.target.identifier!!.nameInSource shouldBe listOf("yy")
|
|
|
|
assignZZ.target.identifier!!.nameInSource shouldBe listOf("zz")
|
2021-11-02 23:47:22 +00:00
|
|
|
val valueXXexpr = (assignXX.value as DirectMemoryRead).addressExpression as BinaryExpression
|
|
|
|
val valueYYexpr = (assignYY.value as DirectMemoryRead).addressExpression as BinaryExpression
|
|
|
|
val valueZZexpr = (assignZZ.value as DirectMemoryRead).addressExpression as BinaryExpression
|
2021-11-08 14:50:29 +00:00
|
|
|
(valueXXexpr.left as IdentifierReference).nameInSource shouldBe listOf("rr")
|
|
|
|
(valueYYexpr.left as IdentifierReference).nameInSource shouldBe listOf("rr")
|
|
|
|
(valueZZexpr.left as IdentifierReference).nameInSource shouldBe listOf("other")
|
2022-02-10 23:21:40 +00:00
|
|
|
(valueXXexpr.right as NumericLiteral).number.toInt() shouldBe 1
|
|
|
|
(valueYYexpr.right as NumericLiteral).number.toInt() shouldBe 2
|
|
|
|
(valueZZexpr.right as NumericLiteral).number.toInt() shouldBe 3
|
2021-11-02 23:47:22 +00:00
|
|
|
}
|
|
|
|
|
2021-11-23 21:36:28 +00:00
|
|
|
test("uword param and normal varindexed as array work as MemoryWrite") {
|
2021-11-02 23:47:22 +00:00
|
|
|
val text="""
|
|
|
|
main {
|
|
|
|
sub thing(uword rr) {
|
|
|
|
rr[10] = 42
|
|
|
|
}
|
|
|
|
|
|
|
|
sub start() {
|
|
|
|
ubyte[] array=[1,2,3]
|
|
|
|
thing(array)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
2022-03-07 20:41:12 +00:00
|
|
|
val result = compileText(C64Target(), false, text, writeAssembly = true)!!
|
2021-11-02 23:47:22 +00:00
|
|
|
val module = result.program.toplevelModule
|
|
|
|
val block = module.statements.single() as Block
|
|
|
|
val thing = block.statements.filterIsInstance<Subroutine>().single {it.name=="thing"}
|
2021-11-08 14:50:29 +00:00
|
|
|
block.name shouldBe "main"
|
|
|
|
thing.statements.size shouldBe 3 // "rr, rr assign, return void"
|
2021-11-02 23:47:22 +00:00
|
|
|
val assignRR = thing.statements[1] as Assignment
|
2022-02-10 23:21:40 +00:00
|
|
|
(assignRR.value as NumericLiteral).number.toInt() shouldBe 42
|
2021-11-02 23:47:22 +00:00
|
|
|
val memwrite = assignRR.target.memoryAddress
|
2021-11-08 14:50:29 +00:00
|
|
|
memwrite shouldNotBe null
|
|
|
|
val addressExpr = memwrite!!.addressExpression as BinaryExpression
|
|
|
|
(addressExpr.left as IdentifierReference).nameInSource shouldBe listOf("rr")
|
|
|
|
addressExpr.operator shouldBe "+"
|
2022-02-10 23:21:40 +00:00
|
|
|
(addressExpr.right as NumericLiteral).number.toInt() shouldBe 10
|
2021-11-02 23:47:22 +00:00
|
|
|
}
|
2021-12-01 20:44:03 +00:00
|
|
|
|
|
|
|
test("invalid number of args check on normal subroutine") {
|
|
|
|
val text="""
|
|
|
|
main {
|
|
|
|
sub thing(ubyte a1, ubyte a2) {
|
|
|
|
}
|
|
|
|
|
|
|
|
sub start() {
|
|
|
|
thing(1)
|
|
|
|
thing(1,2)
|
|
|
|
thing(1,2,3)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
|
|
|
val errors = ErrorReporterForTests()
|
2022-03-07 20:41:12 +00:00
|
|
|
compileText(C64Target(), false, text, writeAssembly = false, errors=errors) shouldBe null
|
2021-12-01 20:44:03 +00:00
|
|
|
errors.errors.size shouldBe 2
|
2022-02-27 15:27:02 +00:00
|
|
|
errors.errors[0] shouldContain "7:25: invalid number of arguments"
|
|
|
|
errors.errors[1] shouldContain "9:25: invalid number of arguments"
|
2021-12-01 20:44:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
test("invalid number of args check on asm subroutine") {
|
|
|
|
val text="""
|
|
|
|
main {
|
|
|
|
asmsub thing(ubyte a1 @A, ubyte a2 @Y) {
|
|
|
|
}
|
|
|
|
|
|
|
|
sub start() {
|
|
|
|
thing(1)
|
|
|
|
thing(1,2)
|
|
|
|
thing(1,2,3)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
|
|
|
val errors = ErrorReporterForTests()
|
2022-03-07 20:41:12 +00:00
|
|
|
compileText(C64Target(), false, text, writeAssembly = false, errors=errors) shouldBe null
|
2021-12-01 20:44:03 +00:00
|
|
|
errors.errors.size shouldBe 2
|
2022-02-27 15:27:02 +00:00
|
|
|
errors.errors[0] shouldContain "7:25: invalid number of arguments"
|
|
|
|
errors.errors[1] shouldContain "9:25: invalid number of arguments"
|
2021-12-01 20:44:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
test("invalid number of args check on call to label and builtin func") {
|
|
|
|
val text="""
|
|
|
|
main {
|
|
|
|
label:
|
|
|
|
sub start() {
|
|
|
|
label()
|
|
|
|
label(1)
|
|
|
|
void rnd()
|
|
|
|
void rnd(1)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
|
|
|
val errors = ErrorReporterForTests()
|
2022-03-07 20:41:12 +00:00
|
|
|
compileText(C64Target(), false, text, writeAssembly = false, errors=errors) shouldBe null
|
2021-12-01 20:44:03 +00:00
|
|
|
errors.errors.size shouldBe 2
|
|
|
|
errors.errors[0] shouldContain "cannot use arguments"
|
|
|
|
errors.errors[1] shouldContain "invalid number of arguments"
|
|
|
|
}
|
2021-12-07 20:07:16 +00:00
|
|
|
|
|
|
|
test("fallthrough prevented") {
|
|
|
|
val text = """
|
|
|
|
main {
|
|
|
|
sub start() {
|
2021-12-15 23:56:51 +00:00
|
|
|
func(1, 2, 3)
|
2021-12-07 20:07:16 +00:00
|
|
|
|
2021-12-15 23:56:51 +00:00
|
|
|
sub func(ubyte a, ubyte b, ubyte c) {
|
2021-12-07 20:07:16 +00:00
|
|
|
a++
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
"""
|
2022-03-07 20:41:12 +00:00
|
|
|
val result = compileText(C64Target(), false, text, writeAssembly = true)!!
|
2021-12-07 20:07:16 +00:00
|
|
|
val stmts = result.program.entrypoint.statements
|
|
|
|
|
|
|
|
stmts.last() shouldBe instanceOf<Subroutine>()
|
|
|
|
stmts.dropLast(1).last() shouldBe instanceOf<Return>() // this prevents the fallthrough
|
2021-12-28 00:55:13 +00:00
|
|
|
stmts.dropLast(2).last() shouldBe instanceOf<GoSub>()
|
2021-12-07 20:07:16 +00:00
|
|
|
}
|
2021-11-07 23:16:58 +00:00
|
|
|
})
|