✨ Add interactive stack trace

pros/cli/terminal.py

@@ -30,6 +30,8 @@ def terminal_cli():
               help='Specify 2 ports for the "share" backend. The default option deterministically selects ports '
                    'based on the serial port name')
 @click.option('--banner/--no-banner', 'request_banner', default=True)
+@click.option('--raw-stack-trace', is_flag=True, default=True, help='Display stack traces as raw data. By default, the terminal will attempt to parse stack traces')
+@click.option('--stack-trace-file', type=str, default=None, help='Output stack traces to a file')
 @click.option('--output', nargs = 1, type=str, is_eager = True, help='Redirect terminal output to a file', default=None)
 
 def terminal(port: str, backend: str, **kwargs):
@@ -83,7 +85,29 @@ def terminal(port: str, backend: str, **kwargs):
         device = devices.RawStreamDevice(ser)
     else:
         device = devices.vex.V5UserDevice(ser)
-    term = Terminal(device, request_banner=kwargs.pop('request_banner', True))
+    term = Terminal(device, request_banner=kwargs.pop('request_banner', True), auto_stack_trace=(kwargs.pop('raw_stack_trace', False) or kwargs.pop('raw', False)), stack_trace_file=kwargs.pop('stack_trace_file', None))
+
+    class TerminalOutput(object):
+        def __init__(self, file):
+            self.terminal = sys.stdout
+            self.log = open(file, 'a')
+        def write(self, data):
+            self.terminal.write(data)
+            self.log.write(data) 
+        def flush(self):
+            pass
+        def end(self):
+            self.log.close()
+
+    output = None
+    if kwargs.get('output', None):
+        output_file = kwargs['output']
+        output = TerminalOutput(f'{output_file}')
+        term.console.output = output
+        sys.stdout = output
+        logger(__name__).info(f'Redirecting Terminal Output to File: {output_file}')
+    else:
+        sys.stdout = sys.__stdout__
 
     class TerminalOutput(object):
         def __init__(self, file):

pros/serial/terminal/terminal.py

@@ -1,11 +1,13 @@
 import codecs
 import os
 import signal
+import subprocess
 import sys
 import threading
 
 import colorama
 
+
 from pros.common.utils import logger
 from pros.serial import decode_bytes_to_str
 from pros.serial.devices import StreamDevice
@@ -165,12 +167,14 @@ def cleanup(self):
         'Sorry no implementation for your platform ({})'
         ' available.'.format(sys.platform))
 
-
 class Terminal(object):
     """This class is loosely based off of the pyserial miniterm"""
+    beginStackTrace = False
+    stackTraceFile = None
 
     def __init__(self, port_instance: StreamDevice, transformations=(),
-                 output_raw: bool = False, request_banner: bool = True):
+                 output_raw: bool = False, request_banner: bool = True, 
+                 auto_stack_trace: bool = True, stack_trace_file: str = None):
         self.device = port_instance
         self.device.subscribe(b'sout')
         self.device.subscribe(b'serr')
@@ -183,6 +187,8 @@ def __init__(self, port_instance: StreamDevice, transformations=(),
         self.output_raw = output_raw
         self.request_banner = request_banner
         self.no_sigint = True  # SIGINT flag
+        self.convert_stack_traces = auto_stack_trace
+        self.stack_trace_file = stack_trace_file
         signal.signal(signal.SIGINT, self.catch_sigint)  # SIGINT handler
         self.console = Console()
         self.console.output = colorama.AnsiToWin32(self.console.output).stream
@@ -224,7 +230,43 @@ def reader(self):
                 if data[0] == b'sout':
                     text = decode_bytes_to_str(data[1])
                 elif data[0] == b'serr':
-                    text = '{}{}{}'.format(colorama.Fore.RED, decode_bytes_to_str(data[1]), colorama.Style.RESET_ALL)
+                    #print(len(text))
+                    addr = "0x" + decode_bytes_to_str(data[1])[:7]
+                    if self.beginStackTrace and addr.isalnum() and addr[3] != 'x' and self.convert_stack_traces:
+                        def getTrace(s, path):
+                            if not os.path.exists(path):
+                                return ''
+                            temp = subprocess.Popen(['addr2line', '-faps', '-e', path, s],
+                                stdout=subprocess.PIPE).communicate()[0].decode('utf-8')
+                            if (temp.find('?') != -1):
+                                return ''
+                            else:
+                                return temp[12: len(temp) - 2]
+                        trace = ' : {}{}{}'.format(
+                            getTrace(addr, "bin/hot.package.elf"),
+                            getTrace(addr, "bin/cold.package.elf"),
+                            getTrace(addr, "bin/monolith.elf"))
+                        text = '{}{}{}{}{}{}'.format(colorama.Fore.RED, decode_bytes_to_str(data[1]), colorama.Style.RESET_ALL, colorama.Fore.WHITE, trace, colorama.Style.RESET_ALL)
+                        if(self.stack_trace_file): 
+                            file.write(addr + trace + '\n')
+                    else:
+                        text = '{}{}{}'.format(colorama.Fore.RED, decode_bytes_to_str(data[1]), colorama.Style.RESET_ALL)
+
+                    if "BEGIN STACK TRACE" in text:
+                        self.beginStackTrace = True
+                        if(self.convert_stack_traces):
+                            text = '{}{}{}'.format(colorama.Fore.YELLOW, "BEGINNING STACK TRACE\n--------------------------------\n\n", colorama.Style.RESET_ALL)
+                        if(self.stack_trace_file):
+                            file = open(self.stack_trace_file, "w")
+
+                    if "END OF TRACE" in text:
+                        self.beginStackTrace = False
+                        if(self.convert_stack_traces):
+                            text = '{}{}{}'.format(colorama.Fore.YELLOW, "\n--------------------------------\nEND OF STACK TRACE\n\n", colorama.Style.RESET_ALL)
+                        if(self.stack_trace_file):
+                            file.close()
+                            file = None
+
                 elif data[0] == b'kdbg':
                     text = '{}\n\nKERNEL DEBUG:\t{}{}\n'.format(colorama.Back.GREEN + colorama.Style.BRIGHT,
                                                                 decode_bytes_to_str(data[1]),