Merge pull request #28 from cormacj/template-work

Updates for user-defined labels

Author: cormacj

CHANGELOG.md

@@ -1,3 +1,4 @@
 2025-03-07:  (0.75)
 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.

README.md

@@ -202,8 +202,7 @@ This is used by adding `--labels LABELSFILE` to the command line.
 
 A label file allows external calls, such as BIOS entry points, to be defined and used in disassembled code. I've included `amstrad-labels.txt` in this repository as an example and for convenience.
 
-The disassembler tracks what labels have been used during disassembly and will only add the labels that were used to the final disassembly.
-
+You can also add custom code labels in this file, such as those for RSX jump points.
 
 This is defined as follows:
 

z80-disassembler.py

@@ -90,7 +90,7 @@ class Pointer(NamedTuple):
 str_sizes = {}
 style = "asm"
 hexstyle = "0x"
-myversion = "0.80"
+myversion = "0.85"
 
 
 #--- Debugging functions ---
@@ -321,11 +321,19 @@ def load_labels(filename):
                     if len(parsed)==3:
                         lname=parsed[0]
                         addr=to_number(parsed[2])
-                        # [0] = labelname
-                        # [1] = number of times it's called
-                        if lname[0]!=";":
+                        # print(lname,hex(addr))
+                        # print("code=",hex(min(code)),hex(max(code)))
+                        if lname[0]!=";" and is_in_code(addr):
+                            # print("in code",hex(addr))
+                            # update_label_name(addr,"C")
+                            code[addr][2]=lname
+                            code[addr][3]=lname #Overwrite string defs
+                            template_labels[addr]=lname #and template label
+                            # print("Lookup:",lookup_label(addr))
+                        elif lname[0]!=";":
                             extern_labels[addr].append(lname)
                             extern_labels[addr].append(0)
+                            # print(hex(addr),is_in_code(addr))
     except OSError:
         print("Error: Could not open labels file:", filename)
         sys.exit(1)
@@ -625,8 +633,8 @@ def validate_arguments(argslist):
     explainlevel=to_number(args.explainlevel)
     stay_in_code=args.stay_in_code
 
-    if args.labelsfile:
-        load_labels(args.labelsfile)
+    # if args.labelsfile:
+    #     load_labels(args.labelsfile)
 
     if args.assembler=="z80asm":
         args.labeltype=2
@@ -1146,6 +1154,7 @@ def findstring(memstart, memend):
 end = endaddress
 findstring(start, end)
 
+
 # dump_code_array("Post pass 2",0xd8dc)
 # for data_area in id_sort:
 #     print(hex(data_area))
@@ -1372,6 +1381,9 @@ def findstring(memstart, memend):
         code[loop][1]="D"
 # Print the used external EQUs (with nice formatting)
 # First find the longest label
+if args.labelsfile:
+    load_labels(args.labelsfile)
+
 maxlen=0
 for loop in extern_labels:
     debug(f'{extern_labels[loop][0]} called {extern_labels[loop][1]} times')
@@ -1409,11 +1421,11 @@ def findstring(memstart, memend):
         if (program_counter in template_labels):
             labelname=template_labels[program_counter]
             # if labelname[0]=="0":
-            #     print("1 used")
+            # print("1 used")
         else:
             labelname=lookup_label(program_counter,1)
             # if labelname[0]=="0":
-            #     print("2 used")
+            # print("2 used")
 
         if code[program_counter][1]=="C":
             stats_c_labels=stats_c_labels+1
@@ -1435,6 +1447,7 @@ def findstring(memstart, memend):
                 for tmp in labels[program_counter]:
                     tmp_str=tmp_str+f'{hexstyle}{tmp:X} '
             do_write(tmp_str)
+
         else:
             do_write(
                 ";----------------------------------------------------------------------------"
@@ -1713,6 +1726,7 @@ def findstring(memstart, memend):
                 this_opcode = b.op.name
                 if len(z80.disasm(b).split(",")) > 1:  # conditional jumps and calls
                     this_opcode = z80.disasm(b).split(",")[0] + ","
+                # print("jp:",hex(jump_addr),lookup_label(jump_addr))
                 tmp = f"{this_opcode} " + lookup_label(jump_addr)
                 code_output(
                     program_counter,