feat: enhance output formatting and add replace method for instruction fetching

Author: AbhiTheModder

smalig/cli/app.py

@@ -53,9 +53,9 @@ def app(file_path, target, json, out, exact_match) -> None:
         return
     if out:
         with open(out, "w") as f:
-            f.write(str(result))
+            f.write(str(result.replace("plain")))
     else:
-        print(result)
+        print(result.replace())
     return
 
 

smalig/grammar.yaml

@@ -27,7 +27,7 @@
   args_info: ""
   short_desc: "No operation"
   long_desc: "Does nothing, Waste cycles."
-  note: 'Data-bearing pseudo-instructions are tagged with this opcode, in which case the high-order byte of the opcode unit indicates the nature of the data. See "packed-switch-payload Format", "sparse-switch-payload Format", and "fill-array-data-payload Format".'
+  note: "Data-bearing pseudo-instructions are tagged with this opcode, in which case the high-order byte of the opcode unit indicates the nature of the data. See `packed-switch-payload Format`, `sparse-switch-payload Format`, and `fill-array-data-payload Format`."
   example: "0000 - nop"
   example_desc: "Does nothing, Waste cycles"
 
@@ -399,7 +399,7 @@
   args_info: "A: reference-bearing register (8 bits), B: type index (16 bits)"
   short_desc: "Throw a ClassCastException if the reference in the given register cannot be cast to the indicated type."
   long_desc: "Check that the object referenced by vAA is an instance of the class resolved by type@BBBB. If it is not, throw a ClassCastException."
-  note: "Since 'A' must always be a reference (and not a primitive value), this will necessarily fail at runtime (that is, it will throw an exception) if 'B' refers to a primitive type."
+  note: "Since $A$ must always be a reference (and not a primitive value), this will necessarily fail at runtime (that is, it will throw an exception) if $B$ refers to a primitive type."
   example: "1F04 0100 - check-cast v4, Test3 #type@0001"
   example_desc: "Checks whether the object reference in v4 can be cast to type@0001 (entry #1 in the type id table) and throws a ClassCastException if it cannot."
 
@@ -411,7 +411,7 @@
   args_info: "A: destination register (4 bits), B: reference-bearing register (4 bits), C: type index (16 bits)"
   short_desc: "Store in the given destination register 1 if the indicated reference is an instance of the given type, or 0 if not."
   long_desc: "Check whether the object referenced by vB is an instance of the class resolved by type@CCCC. If it is, the value 1 is stored in vA; otherwise, the value 0 is stored in vA."
-  note: "Since 'B' must always be a reference (and not a primitive value), this will always result in 0 being stored if C refers to a primitive type. In short, This will always result in 0 if the type is primitive."
+  note: "Since $B$ must always be a reference (and not a primitive value), this will always result in 0 being stored if C refers to a primitive type. In short, This will always result in 0 if the type is primitive."
   example: "2040 0100 - instance-of v0, v4, type@0001"
   example_desc: "Checks whether the object reference in v4 is an instance of type@0001 (entry #1 in the type id table) and stores the result in v0."
 

smalig/utils/__init__.py

@@ -38,6 +38,9 @@ def __init__(self, instructions: list[dict], target: str, exact_match: bool = Tr
         )
 
     def __str__(self):
+        """
+        Returns the result in a human-readable format.
+        """
         if isinstance(self.result, dict):
             if not self.result:
                 results = f"No instruction found for {self.target}!"
@@ -93,6 +96,7 @@ def __str__(self):
         return results
 
     def __repr__(self):
+        """Return a string representation of the InstructionFetch object."""
         return (
             f"InstructionFetch(instructions={self.instructions}, "
             f"target={self.target}, name={self.name}, "
@@ -104,6 +108,7 @@ def __repr__(self):
         )
 
     def fetch(self) -> dict:
+        """Fetch the instruction from the instruction set."""
         for instruction in self.instructions:
             if instruction["opcode"] == self.target:
                 return instruction
@@ -113,20 +118,55 @@ def fetch(self) -> dict:
         return {}
 
     def fetch_fuzzy(self) -> list[dict]:
+        """Fetch the instruction from the instruction set using fuzzy matching."""
         results = []
         for instruction in self.instructions:
             if self.target.lower() in instruction["name"].lower():
                 results.append(instruction)
         return results
 
     def fetch_opcode(self) -> dict:
+        """Fetch the instruction from the instruction set using the opcode."""
         for instruction in self.instructions:
             if instruction["opcode"] == self.target:
                 return instruction
         return {}
 
     def fetch_inst(self) -> dict:
+        """Fetch the instruction from the instruction set using the name."""
         for instruction in self.instructions:
             if instruction["name"] == self.target:
                 return instruction
         return {}
+
+    def replace(self, type: str = "ansi"):
+        """
+        Replace $ and ` symbols with given type.
+        type: str = "ansi" -> "ansi" or "html" or "markdown" or "md" or "plain"
+        """
+        if type in ["html", "markdown", "md"]:
+            result = self.__str__()
+            while result.find("$") != -1:
+                result = result.replace("$", "<span style='color: #ff0;'>", 1)
+                result = result.replace("$", "</span>", 1)
+            while result.find("`") != -1:
+                result = result.replace("`", "<code>", 1)
+                result = result.replace("`", "</code>", 1)
+        elif type == "plain":
+            result = self.__str__()
+            while result.find("$") != -1:
+                result = result.replace("$", "", 1)
+            while result.find("`") != -1:
+                result = result.replace("`", "", 1)
+        else:
+            NC = "\033[0m"  # No Color
+            YELLOW = "\033[0;33m"
+            BLUE = "\033[3;34m"
+            result = self.__str__()
+            while result.find("$") != -1:
+                result = result.replace("$", YELLOW, 1)
+                result = result.replace("$", NC, 1)
+            while result.find("`") != -1:
+                result = result.replace("`", BLUE, 1)
+                result = result.replace("`", NC, 1)
+        return result