Add debug symbols, improve debugger, fix bugs

2 files changed, 99 insertions, 19 deletions

diff --git a/atk16_emu/cli.py b/atk16_emu/cli.py
index 824fbbf..fcea56b 100644
--- a/atk16_emu/cli.py
+++ b/atk16_emu/cli.py
@@ -39,13 +39,10 @@ def main():
     print_help()
     sys.exit(1)
 
-  def load_rom_image_from_path(path: str) -> bytearray:
-    with open(path, "rb") as f:
-      return bytearray(f.read())
-
-  rom_image = load_rom_image_from_path(options.rom_image_path)
-
   if not options.debugger_enabled:
+    with open(options.rom_image_path, "rb") as f:
+      rom_image = bytearray(f.read())
+
     machine = Machine()
     machine.load_rom_image(rom_image)
     machine.reset()
@@ -58,7 +55,7 @@ def main():
 
   else:
     debugger = Debugger()
-    debugger.load_rom_image(rom_image)
+    debugger.load_rom_image(options.rom_image_path)
     debugger.activate()
 
 if __name__ == "__main__":
diff --git a/atk16_emu/debugger.py b/atk16_emu/debugger.py
index 3d8f131..a1fd470 100644
--- a/atk16_emu/debugger.py
+++ b/atk16_emu/debugger.py
@@ -1,5 +1,13 @@
 from getch import getche
 from .emu import Machine
+from dataclasses import dataclass
+
+@dataclass
+class DbgAddrInfo:
+  src_info: str
+  text: str
+  original_text: str
+  labels: list[str]
 
 class Debugger:
   def __init__(self):
@@ -8,12 +16,50 @@ class Debugger:
     self.machine = Machine()
     self.machine.reset()
     self.machine.run()
+    self.dbg_addr_info: dict[int, DbgAddrInfo] = {}
+
+  def load_rom_image(self, rom_image_path: str) -> None:
+    self.rom_image_path = rom_image_path
+    with open(rom_image_path, "rb") as f:
+      self.rom_image = bytearray(f.read())
+
+    self.machine.load_rom_image(self.rom_image)
+
+    print(f"Loaded ROM image from \"{rom_image_path}\".")
+
+    dbg_symbols_path = rom_image_path + ".dbg"
+    try:
+      with open(dbg_symbols_path, "r") as f:
+        dbg_file_lines = f.readlines()
+    except FileNotFoundError:
+      print(f"Note: debug symbols file \"{dbg_symbols_path}\" not found.")
+      return
+
+    self.dbg_addr_info = {}
+    self.dbg_text_col_width = 0
+    self.dbg_original_text_col_width = 0
+    for line in dbg_file_lines:
+      addr, src_info, text, original_text, *labels_ = line.split(";")
+      addr = int(addr, 16)
+
+      if len(text) > self.dbg_text_col_width:
+        self.dbg_text_col_width = len(text)
 
-  def load_rom_image(self, rom_image: bytearray) -> None:
-    self.rom_image = rom_image
-    self.machine.load_rom_image(rom_image)
+      if len(original_text) > self.dbg_original_text_col_width:
+        self.dbg_original_text_col_width = len(original_text)
 
-    print("Loaded rom image.")
+      labels = []
+      for label in labels_:
+        label = label.strip()
+        if label != "":
+          labels.append(label)
+
+      self.dbg_addr_info[addr] = DbgAddrInfo(
+        src_info=src_info,
+        text=text,
+        original_text=original_text,
+        labels=labels,
+      )
 
   def print_pc_context(self):
     print("=== Program context")
@@ -23,9 +69,16 @@ class Debugger:
         continue
 
       if i == 0:
-        print(f"> 0x{addr:>04x}: 0x{self.machine.mem_read(addr):>04x}")
+        print(f"> 0x{addr:>04x}: 0x{self.machine.mem_read(addr):>04x}", end="")
+      else:
+        print(f"  0x{addr:>04x}: 0x{self.machine.mem_read(addr):>04x}", end="")
+
+      if addr in self.dbg_addr_info:
+        dbg_info = self.dbg_addr_info[addr]
+        labels: str = f"[{' '.join(dbg_info.labels)}] " if len(dbg_info.labels) > 0 else ""
+        print(f"  {dbg_info.text:<{self.dbg_text_col_width}} {dbg_info.original_text:<{self.dbg_original_text_col_width}} {labels}({dbg_info.src_info})")
       else:
-        print(f"  0x{addr:>04x}: 0x{self.machine.mem_read(addr):>04x}")
+        print()
 
     print()
 
@@ -42,13 +95,32 @@ class Debugger:
 
       if cmd == "q":
         break
+
       elif cmd == "?":
         self.print_help()
+
+      elif cmd == "l":
+        load_path = input(f"Path to rom image [default: {self.rom_image_path}]: ")
+        if load_path.strip() == "":
+          load_path = self.rom_image_path
+
+        self.load_rom_image(load_path)
+
+        self.machine.reset()
+        self.machine.run()
+        print("Machine reset.")
+
       elif cmd == "r":
         while self.machine.running:
           self.machine.step()
           if self.machine.pc.value in self.breakpoints:
-            print(f"Breakpoint hit at 0x{self.machine.pc.value:>04x}")
+            for addr in self.breakpoints:
+              if addr in self.dbg_addr_info and len(self.dbg_addr_info[addr].labels) > 0:
+                label_suffix = f" [{' '.join(self.dbg_addr_info[addr].labels)}]"
+              else:
+                label_suffix = ""
+
+            print(f"Breakpoint hit at 0x{self.machine.pc.value:>04x}{label_suffix}")
             break
 
         if not self.machine.running:
@@ -57,13 +129,21 @@ class Debugger:
       elif cmd == "b":
         print("Set breakpoints:")
         for addr in self.breakpoints:
-          print(f"  0x{addr:>04x}")
+          if addr in self.dbg_addr_info and len(self.dbg_addr_info[addr].labels) > 0:
+            label_suffix = f" [{' '.join(self.dbg_addr_info[addr].labels)}]"
+          else:
+            label_suffix = ""
+          print(f"  0x{addr:>04x}{label_suffix}")
         if len(self.breakpoints) == 0:
           print("<no breakpoints>")
         print()
 
         try:
-          addr = eval(input("Breakpoint address: "), {})
+          env: dict[str, int] = {}
+          for addr in self.dbg_addr_info:
+            for label in self.dbg_addr_info[addr].labels:
+              env[label] = addr
+          addr = eval(input("Breakpoint address: "), env)
         except:
           print("Cancelled")
           continue
@@ -75,21 +155,23 @@ class Debugger:
           print(f"Removed breakpoint at 0x{addr:>04x}")
         else:
           self.breakpoints.add(addr)
+
       elif cmd == "n":
         if not self.machine.running:
           print("Machine halted.")
           continue
-
         self.machine.step()
-
         if not self.machine.running:
           print("Machine halted.")
+
       elif cmd == "s":
         self.machine.print_state_summary()
+
       elif cmd == "0":
         self.machine.reset()
         self.machine.run()
         print("Machine reset.")
+
       else:
         print(f"Unknown command: {cmd}")
 
@@ -100,7 +182,8 @@ class Debugger:
     print("  b     step backward")
     print("  b     set or remove breakpoint")
     print("  s     show state summary")
-    print("  0     reset the machine state")
+    print("  0     reset machine state")
+    print("  l     load ROM image and reset machine state")
     print("  q     quit")
     print("  ?     show this help")
     print()