added clobbered registers for customasm-toolbox extension

Author: timbslr

.customasm.json

@@ -1,3 +1,42 @@
 {
-  "ruleDefinitions": ["./asm/rules.asm"]
+  "ruleDefinitions": ["./asm/rules.asm"],
+  "showClobberedRegisters": true,
+  "clobberedRegisterInstructions": [
+    {
+      "mnemonic": "call",
+      "clobberedRegisters": ["TMP"]
+    },
+    {
+      "mnemonic": "ret",
+      "clobberedRegisters": ["A", "TMP"]
+    },
+    {
+      "mnemonic": "decm",
+      "clobberedRegisters": ["A", "TMP"]
+    },
+    {
+      "mnemonic": "incm",
+      "clobberedRegisters": ["A", "TMP"]
+    },
+    {
+      "mnemonic": "jmpind",
+      "clobberedRegisters": ["A", "TMP"]
+    },
+    {
+      "mnemonic": "ldo",
+      "clobberedRegisters": ["A", "TMP"]
+    },
+    {
+      "mnemonic": "ldsprel",
+      "clobberedRegisters": ["A", "TMP"]
+    },
+    {
+      "mnemonic": "sto",
+      "clobberedRegisters": ["A", "TMP"]
+    },
+    {
+      "mnemonic": "stsprel",
+      "clobberedRegisters": ["A", "TMP"]
+    }
+  ]
 }

docs/src/Instruction/Instruction.ts

@@ -66,7 +66,7 @@ export default abstract class Instruction {
 
   abstract getExecutedInstructions(): REALInstruction[];
 
-  abstract getModifiedRegisters(): Set<string>; //TODO X-Register not showing up? (see e.g. clobbered registers for incm)
+  abstract getModifiedRegisters(): Set<string>;
 
   getClobberedRegisters() {
     const nonClobberedRegisters = ["PC_L", "PC_H", "MAR_L", "MAR_H", "IR", "SP_L", "SP_H", "F", "7SD", "<reg>", "<regd>", "BUF"];

docs/src/Instruction/PSEUDOInstruction.ts

@@ -25,6 +25,7 @@ export default class PSEUDOInstruction extends Instruction {
     for (const mappedInstruction of this.getMappedInstructions()) {
       let match;
       let mappedInstructionString = mappedInstruction.instanceString();
+      mappedInstructionString = mappedInstructionString.replaceAll("nextInstructionAddress", ""); //prevents "call" from including "A" as modified
       while ((match = REGISTER_REGEX.exec(mappedInstructionString))) {
         const register = match[1];
         modifiedRegisters.add(register);

docs/src/Instruction/REALInstruction.ts

@@ -45,6 +45,10 @@ export default class REALInstruction extends Instruction {
           if ((match = /IE_(.*)|li (\w+),/.exec(controlString))) {
             modifiedRegisters.add(match[1]);
           }
+
+          if (controlString.includes("RST_TMP")) {
+            modifiedRegisters.add("TMP");
+          }
         }
       }
     }

docs/src/PageLoader/loadInstructionDetails.ts

@@ -12,6 +12,15 @@ async function createAndFillTables() {
   const descriptionElements = await getDescriptions(sortedInstructions.map((instruction) => instruction.getMnemonic()));
 
   for (const instruction of sortedInstructions) {
+    // print clobbered registers for the entry in .customasm.json
+    /* if (instruction.getClobberedRegisters().size > 0) {
+      console.log(
+        `{ "mnemonic": "${instruction.getMnemonic()}", "clobberedRegisters": [${Array.from(instruction.getClobberedRegisters())
+          .map((reg) => `"${reg}"`)
+          .join(", ")}] },`,
+      );
+    } */
+
     const instructionDetailSection = createHTMLInstructionDetailSection(
       instruction,
       descriptionElements.get(instruction.getMnemonic()) as HTMLElement,