Merge pull request #31 from cormacj/bugfixing

Bugfixing

Author: cormacj

CHANGELOG.md

@@ -2,3 +2,4 @@
 2025-03-05: First official release (0.75)
 2025-03-21: Bump to v0.80 - Add support for external labels, such as BIOS calls. Improved code detection methods.
 2025-06-13: Bump to v0.85 - Add the ability to define user-defined labels to the labels file. Increased error handling, more informational messages.
+2025-06-18: Bump to v0.87 - Corrected issues with string detection where strings weren't being properly decoded.

z80-disassembler.py

@@ -90,7 +90,7 @@ class Pointer(NamedTuple):
 str_sizes = {}
 style = "asm"
 hexstyle = "0x"
-myversion = "0.85"
+myversion = "0.87"
 
 
 #--- Debugging functions ---
@@ -188,25 +188,44 @@ def process_hextype(hexaddr):
         return hexaddr.replace("0x","#")
     return hexaddr
 
-def build_strings_from_binary_data(binary_data):
-    strings = []
-    current_string = []
+# def build_strings_from_binary_data(binary_data):
+#     strings = []
+#     current_string = []
+#
+#     for byte in binary_data:
+#         if is_alphanumeric(byte):
+#             current_string.append(chr(byte))
+#         elif is_terminator(byte):
+#             if current_string:
+#                 current_string.append(decode_terminator(byte))
+#                 strings.append(''.join(current_string))
+#                 current_string = []
+#
+#     # Append the last string if it exists
+#     if current_string:
+#         strings.append(''.join(current_string))
+#
+#     # return strings
+#     return (''.join(strings))
 
-    for byte in binary_data:
-        if is_alphanumeric(byte):
-            current_string.append(chr(byte))
-        elif is_terminator(byte):
-            if current_string:
-                current_string.append(decode_terminator(byte))
-                strings.append(''.join(current_string))
-                current_string = []
 
-    # Append the last string if it exists
-    if current_string:
-        strings.append(''.join(current_string))
+def build_strings_from_binary_data(binary_data, min_length=3):
+    """
+    Searches binary data for ASCII strings of at least min_length and returns a list of found strings.
 
-    # return strings
-    return (''.join(strings))
+    Args:
+        binary_data (bytes): The binary data to search.
+        min_length (int): The minimum length of ASCII string to find. Default is 4.
+
+    Returns:
+        list[str]: List of ASCII strings found in the binary data.
+    """
+    # Regular expression to match runs of printable ASCII characters
+    # print(f"\n{len(binary_data)}")
+    pattern = rb'[\x20-\x7E]{%d,}' % min_length
+    matches = re.findall(pattern, binary_data)
+    # Decode bytes to string, ignoring errors
+    return [m.decode('ascii', errors='ignore') for m in matches]
 
 def print_progress_bar(iteration, total, prefix='', suffix='', decimals=1, length=50, fill='█', print_end="\r"):
     """
@@ -812,6 +831,7 @@ def lookup_label(addr, prettyprint=""):
     Returns:
         Formatted String
     """
+    global extern_labels
     if not is_in_code(addr):
         debug("-->Not in code")
         if addr in extern_labels:
@@ -1198,6 +1218,13 @@ def findstring(memstart, memend):
 code_snapshot = bytearray(8)
 loc = 0
 
+if args.labelsfile:
+    print(f"Loading labels file: {args.labelsfile}... ",end="")
+    load_labels(args.labelsfile)
+    print("Done!",end="")
+    if args.quiet:
+        print("\n")
+
 # dump_code_array()
 if args.templatefile is not None:
     print(f"Loading template file: {args.templatefile}...",end="")
@@ -1332,27 +1359,22 @@ def findstring(memstart, memend):
 # Print the used external EQUs (with nice formatting)
 # First find the longest label
 
-if args.labelsfile:
-    print(f"Loading labels file: {args.labelsfile}... ",end="")
-    load_labels(args.labelsfile)
-    print("Done!",end="")
-    if args.quiet:
-        print("\n")
-
 maxlen=0
 for loop in extern_labels:
     debug(f'{extern_labels[loop][0]} called {extern_labels[loop][1]} times')
     if extern_labels[loop][1]>0:
         if len(extern_labels[loop][0])>maxlen:
             maxlen=len(extern_labels[loop][0])
-        # print(f'{extern_labels[loop][0]} equ {hex(loop)}')
 
 do_write("; Define labels for external calls")
-# Now print the labels.
+
+# Now print the labels, but only those that were called.
 for loop in extern_labels:
+    # print(f'{extern_labels[loop][0]} called {extern_labels[loop][1]} times')
     if extern_labels[loop][1]>0:
         do_write(f'{extern_labels[loop][0].ljust(maxlen)} equ {hex(loop)}')
 do_write("\n\n")
+
 # Print the org statement
 program_counter=min(code)
 if args.style == "asm":
@@ -1472,7 +1494,7 @@ def findstring(memstart, memend):
                     # print("-->", hex(program_counter),b,a)
                     code_output(orig,f'DEFB {a}',list_address,f'{addcomment}{hexstyle}{orig:x} to {hexstyle}{orig+len(a)-2:x}')
                     # print(f'Bump 2 {hex(program_counter)}-->{hex(program_counter+len(a)-2)}')
-                    program_counter += 1 #len(a)-1
+                    program_counter += len(a)-1
                     # program_counter=program_counter+len(b)
                     # str_locations[program_counter]
                 else:
@@ -1510,19 +1532,20 @@ def findstring(memstart, memend):
                 cnt=program_counter
             result=build_strings_from_binary_data(tmp_array)
             # print("-->",result)
+            # print(f"{len(result)}")
             # result=result.replace('"', '",34,"').replace("\\", '", 0x5c, "')
             # print("---->",result,code[src_array_index][1],---code[src_array_index][2],"\n")
             # program_counter=program_counter+len(result)
             str_len=len(result)
-            result=result.replace('"', '",34,"').replace("\\", '", 0x5c, "')
             # print("-->",result,(identified(program_counter) == "S"),is_terminator(code[program_counter][0]))
             # dump_code_array("-- term -->",program_counter,)
             # print("-->",result)
             #--------------------------------
             #FIXME: Something in here is breaking labels after a string, probably one of the increments
             # So its adding code area to the string if the string isn't terminated, but the area is marked as code.
             # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-            if result!="":
+            if str_len>0:
+                result=result[0].replace('"', '",34,"').replace("\\", '", 0x5c, "')
                 # if  0xf77b < program_counter < 0xf79c:
                 #     print("----> 1-",hex(program_counter),identified(program_counter))
                 # program_counter=program_counter+str_len
@@ -1532,17 +1555,21 @@ def findstring(memstart, memend):
                     else:
                         addcomment=""
 
-                    code_output(program_counter,f'DEFB "{result}{decode_terminator(code[program_counter+str_len][0])}',list_address,f'{addcomment}{hexstyle}{program_counter:x} to {hexstyle}{(program_counter+str_len+1):x}')
+                    code_output(program_counter,f'DEFB "{result}{decode_terminator(code[program_counter+str_len][0])}',list_address,f'{addcomment}{hexstyle}{program_counter:x} to {hexstyle}{(program_counter+str_len):x}')
                     # Bump for terminator
                     # print(f'Bump 4 {hex(program_counter)}-->{hex(program_counter+str_len)}')
-                    program_counter +=str_len+1
+                    program_counter +=len(result)+1
                 else:
                     #Probably never called, but better safe etc etc
                     code_output(program_counter,f'DEFB "{result}"',list_address)
             elif (identified(program_counter) == "S") and (code[program_counter][0]>0x80) and not is_terminator(code[program_counter][0]):
                 # if  0xf77b < program_counter < 0xf79c:
                 #     print("----> 2 -",hex(program_counter),identified(program_counter))
-                result=result+decode_terminator(code[program_counter][0]).replace('",',"")
+                #Issue #30: This is part of the issue, but not sure why yet.
+                # result=result+decode_terminator(code[program_counter][0]).replace('",',"")
+
+                result=hex(code[program_counter][0])
+
                 code_output(program_counter-str_len,f'DEFB {result}',list_address)
                 # print(f'Bump 5 {hex(program_counter)}-->{hex(program_counter+1)}')
                 program_counter +=1 #str_len