Merge branch 'main' into feature/beta-2.0-release

Author: fz

common/util.py

@@ -1,9 +1,10 @@
 """Utility functions."""
 
+from argparse import ArgumentTypeError
 import os
+import re
 import shutil
-from argparse import ArgumentTypeError
-from typing import List, Tuple
+from typing import Any, List, Tuple
 
 from lldb import (
     SBAddress,
@@ -57,6 +58,74 @@ def get_frame_range(frame: SBFrame, target: SBTarget) -> Tuple[str, str]:
 
     return start_address, end_address
 
+def clear_page() -> None:
+    """
+    Used to clear the previously printed breakpoint information before
+    printing the next information.
+    """
+    num_lines = shutil.get_terminal_size().lines
+    for _ in range(num_lines):
+        print()
+    print("\033[0;0H")  # Ansi escape code: Set cursor to 0,0 position
+    print("\033[J")  # Ansi escape code: Clear contents from cursor to end of screen
+
+
+def print_line_with_string(
+    string: str,
+    char: GLYPHS = GLYPHS.HORIZONTAL_LINE,
+    line_color: TERM_COLORS = TERM_COLORS.GREY,
+    string_color: TERM_COLORS = TERM_COLORS.BLUE,
+    align: ALIGN = ALIGN.RIGHT,
+) -> None:
+    """Print a line with the provided @string padded with @char"""
+    width = shutil.get_terminal_size().columns
+    if align == ALIGN.RIGHT:
+        l_pad = (width - len(string) - 6) * char.value
+        r_pad = 4 * char.value
+
+    elif align == ALIGN.CENTRE:
+        l_pad = (width - len(string)) * char.value
+        r_pad = 4 * char.value
+
+    elif align == ALIGN.LEFT:
+        l_pad = 4 * char.value
+        r_pad = (width - len(string) - 6) * char.value
+
+    output_line(
+        f"{line_color.value}{l_pad}{TERM_COLORS.ENDC.value} "
+        + f"{string_color.value}{string}{TERM_COLORS.ENDC.value} {line_color.value}{r_pad}{TERM_COLORS.ENDC.value}"
+    )
+
+
+def print_line(
+    char: GLYPHS = GLYPHS.HORIZONTAL_LINE, color: TERM_COLORS = TERM_COLORS.GREY
+) -> None:
+    """Print a line of @char"""
+    output_line(
+        f"{color.value}{shutil.get_terminal_size().columns*char.value}{TERM_COLORS.ENDC.value}"
+    )
+
+
+def print_message(msg_type: MSG_TYPE, message: str) -> None:
+    """Format and print a @message"""
+    info_color = TERM_COLORS.BLUE
+    success_color = TERM_COLORS.GREEN
+    error_color = TERM_COLORS.GREEN
+
+    if msg_type == MSG_TYPE.INFO:
+        output_line(f"{info_color.value}[+]{TERM_COLORS.ENDC.value} {message}")
+    elif msg_type == MSG_TYPE.SUCCESS:
+        output_line(f"{success_color.value}[+]{TERM_COLORS.ENDC.value} {message}")
+    elif msg_type == MSG_TYPE.ERROR:
+        output_line(f"{error_color.value}[+]{TERM_COLORS.ENDC.value} {message}")
+
+
+def print_instruction(line: str, color: TERM_COLORS = TERM_COLORS.ENDC) -> None:
+    """Format and print a line of disassembly returned from LLDB (SBFrame.disassembly)"""
+    loc_0x = line.find("0x")
+    start_idx = loc_0x if loc_0x >= 0 else 0
+    output_line(f"{color.value}{line[start_idx:]}{TERM_COLORS.ENDC.value}")
+
 
 def get_registers(frame: SBFrame, frame_type: str) -> List[SBValue]:
     """