Merge pull request #963 from boriel-basic/fix/strange_array_behavior

Fix/strange array behavior

Author: boriel

src/arch/z80/backend/generic.py

@@ -272,12 +272,13 @@ def _larrd(ins: Quad):
     if not isinstance(bounds, list) or len(bounds) not in (0, 2):
         raise InvalidIC(ins, "Bounds list length must be 0 or 2, not %s" % ins[5])
 
-    if bounds:
+    have_bounds = bounds and any(x != "0" for x in bounds)
+    if have_bounds:
         output.extend(
             [
-                "ld hl, %s" % bounds[1],
+                "ld hl, %s" % bounds[1],  # UBOUND Table PTR
                 "push hl",
-                "ld hl, %s" % bounds[0],
+                "ld hl, %s" % bounds[0],  # LBOUND Table PTR
                 "push hl",
             ]
         )
@@ -297,12 +298,12 @@ def _larrd(ins: Quad):
     )
 
     if must_initialize:
-        if not bounds:
+        if not have_bounds:
             output.append(runtime_call(RuntimeLabel.ALLOC_INITIALIZED_LOCAL_ARRAY))
         else:
             output.append(runtime_call(RuntimeLabel.ALLOC_INITIALIZED_LOCAL_ARRAY_WITH_BOUNDS))
     else:
-        if not bounds:
+        if not have_bounds:
             output.append(runtime_call(RuntimeLabel.ALLOC_LOCAL_ARRAY))
         else:
             output.append(runtime_call(RuntimeLabel.ALLOC_LOCAL_ARRAY_WITH_BOUNDS))

src/arch/z80/visitor/function_translator.py

@@ -55,22 +55,22 @@ def visit_FUNCTION(self, node):
                 # if self.O_LEVEL > 1:
                 #    return
 
+            if local_var.class_ == CLASS.const or local_var.scope == SCOPE.parameter:
+                continue
+
             if local_var.class_ == CLASS.array and local_var.scope == SCOPE.local:
-                bound_ptrs = []  # Bound tables pointers (empty if not used)
                 lbound_label = local_var.mangled + ".__LBOUND__"
                 ubound_label = local_var.mangled + ".__UBOUND__"
+                lbound_needed = not local_var.is_zero_based and local_var.is_dynamically_accessed
 
-                if local_var.lbound_used or local_var.ubound_used:
-                    bound_ptrs = ["0", "0"]  # NULL by default
-                    if local_var.lbound_used:
-                        bound_ptrs[0] = lbound_label
-                    if local_var.ubound_used:
-                        bound_ptrs[1] = ubound_label
+                bound_ptrs = [lbound_label if lbound_needed else "0", "0"]
+                if local_var.ubound_used:
+                    bound_ptrs[1] = ubound_label
 
-                if bound_ptrs:
+                if bound_ptrs != ["0", "0"]:
                     OPTIONS["__DEFINES"].value["__ZXB_USE_LOCAL_ARRAY_WITH_BOUNDS__"] = ""
 
-                if local_var.lbound_used:
+                if lbound_needed:
                     l = ["%04X" % bound.lower for bound in local_var.bounds]
                     bound_tables.append(LabelledData(lbound_label, l))
 
@@ -89,8 +89,7 @@ def visit_FUNCTION(self, node):
                 if local_var.default_value is not None:
                     r.extend(self.array_default_value(local_var.type_, local_var.default_value))
                 self.ic_larrd(local_var.offset, q, local_var.size, r, bound_ptrs)  # Initializes array bounds
-            elif local_var.class_ == CLASS.const or local_var.scope == SCOPE.parameter:
-                continue
+
             else:  # Local vars always defaults to 0, so if 0 we do nothing
                 if (
                     local_var.token != "FUNCTION"
@@ -119,6 +118,7 @@ def visit_FUNCTION(self, node):
                 if local_var.type_ == self.TYPE(TYPE.string):
                     if local_var.class_ == CLASS.const or local_var.token == "FUNCTION":
                         continue
+
                     # Only if it's string we free it
                     if local_var.class_ != CLASS.array:  # Ok just free it
                         if scope == SCOPE.local or (scope == SCOPE.parameter and not local_var.byref):

src/arch/z80/visitor/translator.py

@@ -25,7 +25,10 @@
 from src.symbols.id_ import ref
 from src.symbols.type_ import Type
 
-__all__ = ("Translator",)
+__all__ = (
+    "LabelledData",
+    "Translator",
+)
 
 LabelledData = namedtuple("LabelledData", ("label", "data"))
 

src/arch/z80/visitor/var_translator.py

@@ -46,11 +46,11 @@ def visit_ARRAYDECL(self, node):
 
         lbound_label = entry.mangled + ".__LBOUND__"
         ubound_label = entry.mangled + ".__UBOUND__"
-
-        is_zero_based_array = all(bound.lower == 0 for bound in node.bounds)
         bound_ptrs = ["0", "0"]  # NULL by default
-        if entry.lbound_used or not is_zero_based_array:
+
+        if not entry.is_zero_based and entry.is_dynamically_accessed:
             bound_ptrs[0] = lbound_label
+
         if entry.ubound_used or OPTIONS.array_check:
             bound_ptrs[1] = ubound_label
 

src/lib/arch/zx48k/runtime/array/arrayalloc.asm

@@ -41,7 +41,7 @@ __ALLOC_LOCAL_ARRAY:
 ; ---------------------------------------------------------------------
 ; __ALLOC_INITIALIZED_LOCAL_ARRAY
 ;  Allocates an array element area in the heap, and clears it filling it
-;  with 0 bytes
+;  with data whose pointer (PTR) is in the stack
 ;
 ; Parameters
 ;  HL = Offset to be added to IX => HL = IX + HL
@@ -99,12 +99,15 @@ __ALLOC_LOCAL_ARRAY_WITH_BOUNDS2:
     ld (hl), e
     inc hl
     ld (hl), d
-    pop de
+    pop de   ;; PTR to ubound table
+    push bc  ;; puts ret address back
+    ld a, d
+    or e
+    ret z    ;; if PTR for UBound is 0, it's not used
     inc hl
     ld (hl), e
     inc hl
     ld (hl), d
-    push bc
     ret
 
 

src/lib/arch/zx48k/runtime/bound.asm

@@ -70,6 +70,10 @@ __CONT:
     ld h, (hl)
     ld l, a         ; LD HL, (HL) => Origin of L/U Bound table
 
+    ; for LBound only, HL = 0x0000 (NULL) if the array is all 0-based
+    or h
+    ret z           ; Should never happen for UBound
+
     add hl, de      ; hl += OFFSET __LBOUND._xxxx
     ld e, (hl)      ; de = (hl)
     inc hl

src/lib/arch/zxnext/runtime/array/arrayalloc.asm

@@ -41,7 +41,7 @@ __ALLOC_LOCAL_ARRAY:
 ; ---------------------------------------------------------------------
 ; __ALLOC_INITIALIZED_LOCAL_ARRAY
 ;  Allocates an array element area in the heap, and clears it filling it
-;  with 0 bytes
+;  with data whose pointer (PTR) is in the stack
 ;
 ; Parameters
 ;  HL = Offset to be added to IX => HL = IX + HL
@@ -99,12 +99,15 @@ __ALLOC_LOCAL_ARRAY_WITH_BOUNDS2:
     ld (hl), e
     inc hl
     ld (hl), d
-    pop de
+    pop de   ;; PTR to ubound table
+    push bc  ;; puts ret address back
+    ld a, d
+    or e
+    ret z    ;; if PTR for UBound is 0, it's not used
     inc hl
     ld (hl), e
     inc hl
     ld (hl), d
-    push bc
     ret
 
 

src/symbols/arrayaccess.py

@@ -35,6 +35,7 @@ class SymbolARRAYACCESS(SymbolCALL):
     def __init__(self, entry, arglist: SymbolARGLIST, lineno: int, filename: str):
         super().__init__(entry, arglist, lineno, filename)
         assert all(gl.BOUND_TYPE == x.type_.type_ for x in arglist), "Invalid type for array index"
+        self.entry.ref.is_dynamically_accessed = True
 
     @property
     def entry(self):
@@ -90,6 +91,12 @@ def offset(self) -> int | None:
         offset *= self.type_.size
         return offset
 
+    @cached_property
+    def is_constant(self) -> bool:
+        """Whether this array access is constant.
+        e.g. A(1) is constant. A(i) is not."""
+        return self.offset is None
+
     @classmethod
     def make_node(cls, id_: str, arglist: SymbolARGLIST, lineno: int, filename: str) -> Optional["SymbolARRAYACCESS"]:
         """Creates an array access. A(x1, x2, ..., xn)"""

src/symbols/id_/_id.py

@@ -40,11 +40,7 @@ class SymbolID(SymbolIdABC):
         "declared",
         "filename",
         "has_address",
-        "lineno",
-        "mangled",
-        "name",
         "original_name",
-        "scope",
         "scope_ref",
     )
 

src/symbols/id_/interface.py

@@ -6,7 +6,7 @@
 
 
 class SymbolIdABC(Symbol, ABC):
-    __slots__ = ()
+    __slots__ = "lineno", "mangled", "name", "scope"
 
     scope: SCOPE
     name: str