Apple-2-SW/prog8
1
0
Fork 0
mirror of https://github.com/irmen/prog8.git synced 2024-11-26 11:49:22 +00:00
Code Issues Projects Releases Wiki Activity

working on unit tests for symbol scope bug

Browse Source
This commit is contained in:
Irmen de Jong 2021-06-03 01:42:11 +02:00
parent 53b20ba625
commit 3a2498401d
3 changed files with 69 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
compiler/test/AsmgenTests.kt
View File

@ -2,8 +2,8 @@ package prog8tests
import org.hamcrest.MatcherAssert.assertThat import org.hamcrest.MatcherAssert.assertThat
import org.hamcrest.Matchers.equalTo import org.hamcrest.Matchers.equalTo
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.Disabled import org.junit.jupiter.api.Disabled
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.TestInstance import org.junit.jupiter.api.TestInstance
import prog8.ast.IBuiltinFunctions import prog8.ast.IBuiltinFunctions
import prog8.ast.IMemSizer import prog8.ast.IMemSizer
@ -33,34 +33,40 @@ class TestAsmGen6502 {
private fun createTestProgram(): Program { private fun createTestProgram(): Program {
/* /*
block1 { main {
sub test () { label_outside:
uword var_in_sub = 1234 uword var_outside
uword var2_in_sub
label_in_sub: sub start () {
var2_in_sub = var_in_sub uword localvar = 1234
var2_in_sub = &label_in_sub uword tgt
locallabel:
tgt = localvar
tgt = &locallabel
tgt = &var_outside
tgt = &label_outside
} }
} }
*/ */
val varInSub = VarDecl(VarDeclType.VAR, DataType.UWORD, ZeropageWish.DONTCARE, null, "var_in_sub", NumericLiteralValue.optimalInteger(1234, Position.DUMMY), false, false, false, Position.DUMMY) val varInSub = VarDecl(VarDeclType.VAR, DataType.UWORD, ZeropageWish.DONTCARE, null, "localvar", NumericLiteralValue.optimalInteger(1234, Position.DUMMY), false, false, false, Position.DUMMY)
val var2InSub = VarDecl(VarDeclType.VAR, DataType.UWORD, ZeropageWish.DONTCARE, null, "var2_in_sub", null, false, false, false, Position.DUMMY) val var2InSub = VarDecl(VarDeclType.VAR, DataType.UWORD, ZeropageWish.DONTCARE, null, "tgt", null, false, false, false, Position.DUMMY)
val labelInSub = Label("label_in_sub", Position.DUMMY) val labelInSub = Label("locallabel", Position.DUMMY)
val tgt = AssignTarget(IdentifierReference(listOf("var2_in_sub"), Position.DUMMY), null, null, Position.DUMMY) val tgt = AssignTarget(IdentifierReference(listOf("tgt"), Position.DUMMY), null, null, Position.DUMMY)
val assign1 = Assignment(tgt, IdentifierReference(listOf("var_in_sub"), Position.DUMMY), Position.DUMMY) val assign1 = Assignment(tgt, IdentifierReference(listOf("localvar"), Position.DUMMY), Position.DUMMY)
val assign2 = Assignment(tgt, AddressOf(IdentifierReference(listOf("label_in_sub"), Position.DUMMY), Position.DUMMY), Position.DUMMY) val assign2 = Assignment(tgt, AddressOf(IdentifierReference(listOf("locallabel"), Position.DUMMY), Position.DUMMY), Position.DUMMY)
val assign3 = Assignment(tgt, AddressOf(IdentifierReference(listOf("var_outside"), Position.DUMMY), Position.DUMMY), Position.DUMMY)
val assign4 = Assignment(tgt, AddressOf(IdentifierReference(listOf("label_outside"), Position.DUMMY), Position.DUMMY), Position.DUMMY)
val statements = mutableListOf(varInSub, var2InSub, labelInSub, assign1, assign2) val statements = mutableListOf(varInSub, var2InSub, labelInSub, assign1, assign2, assign3, assign4)
val subroutine = Subroutine("test", emptyList(), emptyList(), emptyList(), emptyList(), emptySet(), null, false, false, statements, Position.DUMMY) val subroutine = Subroutine("start", emptyList(), emptyList(), emptyList(), emptyList(), emptySet(), null, false, false, statements, Position.DUMMY)
val block1 = Block("block1", null, mutableListOf(subroutine), false, Position.DUMMY) val labelInBlock = Label("label_outside", Position.DUMMY)
val varInBlock = VarDecl(VarDeclType.VAR, DataType.UWORD, ZeropageWish.DONTCARE, null, "var_outside", null, false, false, false, Position.DUMMY)
val block = Block("main", null, mutableListOf(labelInBlock, varInBlock, subroutine), false, Position.DUMMY)
val block2 = Block("block2", null, mutableListOf(), false, Position.DUMMY) val module = Module("test", mutableListOf(block), Position.DUMMY, false, Path.of(""))
val module = Module("test", mutableListOf(block1, block2), Position.DUMMY, false, Path.of(""))
module.linkParents(ParentSentinel) module.linkParents(ParentSentinel)
val program = Program("test", mutableListOf(module), DummyFunctions(), DummyMemsizer()) val program = Program("test", mutableListOf(module), DummyFunctions(), DummyMemsizer())
return program return program
@ -90,35 +96,58 @@ label_in_sub:
assertThat(asmgen.asmVariableName(listOf("a", "b", "name")), equalTo("a.b.name")) assertThat(asmgen.asmVariableName(listOf("a", "b", "name")), equalTo("a.b.name"))
} }
/*
main {
label_outside:
uword var_outside
sub start () {
uword localvar = 1234
uword tgt
locallabel:
tgt = localvar
tgt = &locallabel
tgt = &var_outside
tgt = &label_outside
}
}
*/
@Test @Test
@Disabled("TODO") // TODO
fun testSymbolNameFromVarIdentifier() { fun testSymbolNameFromVarIdentifier() {
val program = createTestProgram() val program = createTestProgram()
val asmgen = createTestAsmGen(program) val asmgen = createTestAsmGen(program)
val sub = program.entrypoint()
val varIdent = IdentifierReference(listOf("variable"), Position.DUMMY) // local variable
assertThat(asmgen.asmSymbolName(varIdent), equalTo("variable")) val localvarIdent = sub.statements.filterIsInstance<Assignment>().first { it.value is IdentifierReference }.value as IdentifierReference
assertThat(asmgen.asmVariableName(varIdent), equalTo("variable")) assertThat(asmgen.asmSymbolName(localvarIdent), equalTo("localvar"))
assertThat(asmgen.asmVariableName(localvarIdent), equalTo("localvar"))
// TODO also do a scoped reference // variable from outer scope (note that for Variables, no scoping prefixes are required,
// val scopedVarIdent = IdentifierReference(listOf("scope", "variable"), Position.DUMMY) // because they're not outputted as locally scoped symbols for the assembler
// assertThat(asmgen.asmSymbolName(scopedVarIdent), equalTo("scope.variable")) val scopedVarIdent = (sub.statements.filterIsInstance<Assignment>().first { (it.value as? AddressOf)?.identifier?.nameInSource==listOf("var_outside") }.value as AddressOf).identifier
// assertThat(asmgen.asmVariableName(scopedVarIdent), equalTo("scope.variable")) assertThat(asmgen.asmSymbolName(scopedVarIdent), equalTo("var_outside"))
assertThat(asmgen.asmVariableName(scopedVarIdent), equalTo("var_outside"))
} }
@Test @Test
@Disabled("TODO") // TODO @Disabled("fails until bug is fixed")
fun testSymbolNameFromLabelIdentifier() { fun testSymbolNameFromLabelIdentifier() {
val program = createTestProgram() val program = createTestProgram()
val asmgen = createTestAsmGen(program) val asmgen = createTestAsmGen(program)
val sub = program.entrypoint()
val labelIdent = IdentifierReference(listOf("label"), Position.DUMMY) // local label
assertThat(asmgen.asmSymbolName(labelIdent), equalTo("_label")) val localLabelIdent = (sub.statements.filterIsInstance<Assignment>().first { (it.value as? AddressOf)?.identifier?.nameInSource==listOf("locallabel") }.value as AddressOf).identifier
assertThat(asmgen.asmVariableName(labelIdent), equalTo("_label")) assertThat(asmgen.asmSymbolName(localLabelIdent), equalTo("_locallabel"))
assertThat("as a variable it uses different naming rules (no underscore prefix)", asmgen.asmVariableName(localLabelIdent), equalTo("locallabel"))
// TODO also do a scoped reference // label from outer scope needs sope prefixes because it is outputted as a locally scoped symbol for the assembler
// val scopedLabelIdent = IdentifierReference(listOf("scope", "label"), Position.DUMMY) // TODO fix this; these both fail now!
// assertThat(asmgen.asmSymbolName(scopedLabelIdent), equalTo("scope._label")) val scopedLabelIdent = (sub.statements.filterIsInstance<Assignment>().first { (it.value as? AddressOf)?.identifier?.nameInSource==listOf("label_outside") }.value as AddressOf).identifier
// assertThat(asmgen.asmVariableName(scopedLabelIdent), equalTo("scope._label")) assertThat(asmgen.asmSymbolName(scopedLabelIdent), equalTo("main._label_outside"))
assertThat("as a variable it uses different naming rules (no underscore prefix)", asmgen.asmVariableName(scopedLabelIdent), equalTo("main.label_outside"))
} }
} }

4
docs/source/todo.rst
View File

@ -2,8 +2,8 @@
TODO TODO
==== ====
- fix asm symbol name scoping bug and complete the unit tests for this - fix asm symbol name scoping bug and complete the unit tests for this (testSymbolNameFromLabelIdentifier)
- add or document example for %asminclude and %asmbinary on how to refer to its contents via label or w/e - add example in documentation for %asminclude and %asmbinary on how to refer to its contents via label or w/e
- test all examples (including imgviewer, assembler and petaxian) before release of the new version - test all examples (including imgviewer, assembler and petaxian) before release of the new version

2
examples/test.p8
View File

@ -1,5 +1,5 @@
%import textio %import textio
%zeropage basicsafe %zeropage dontuse
; TODO FIX ASM SYMBOL NAME SCOPING BUGS ; TODO FIX ASM SYMBOL NAME SCOPING BUGS
; TODO make unit tests for this ; TODO make unit tests for this