Added exception dialog to show the complete parse/build exception.

Author: timrid

CHANGELOG.md

@@ -13,6 +13,7 @@ Enhanced ConstructEditor:
 - Implemented "Copy" / Ctrl+C (#18)
 - Added "Copy path to clipboard" button in the context menu (#18)
 - Fixed a bug, when a struct has multiple times the same `Enum` construct. Then the metadata (eg. byte position) of the last parsed enum value is used for all enum values.
+- Added exception dialog to show the complete parse/build exception.
 
 Enhanced HexEditor:
 - fix crash when selecting or extending selection before the beginning of the hex editor using the shift LEFT and UP arrow keys (#20)

construct_editor/core/construct_editor.py

@@ -30,15 +30,15 @@ def reload(self):
         """
 
     @abc.abstractmethod
-    def show_parse_error_message(self, msg: t.Optional[str]):
+    def show_parse_error_message(self, msg: t.Optional[str], ex: t.Optional[Exception]):
         """
         Show an parse error message to the user.
 
         This has to be implemented by the derived class.
         """
 
     @abc.abstractmethod
-    def show_build_error_message(self, msg: t.Optional[str]):
+    def show_build_error_message(self, msg: t.Optional[str], ex: t.Optional[Exception]):
         """
         Show an build error message to the user.
 
@@ -118,8 +118,8 @@ def change_construct(self, constr: cs.Construct) -> None:
         Change the construct format, that is used for building/parsing.
         """
         # reset error messages
-        self.show_build_error_message(None)
-        self.show_parse_error_message(None)
+        self.show_build_error_message(None, None)
+        self.show_parse_error_message(None, None)
 
         # add root name, is none is available
         if constr.name is None:
@@ -149,10 +149,10 @@ def parse(self, binary: bytes, **contextkw: t.Any):
         """
         try:
             self._model.root_obj = self._construct.parse(binary, **contextkw)
-            self.show_parse_error_message(None)
+            self.show_parse_error_message(None, None)
         except Exception as e:
             self.show_parse_error_message(
-                f"Error while parsing binary data: {type(e).__name__}\n{str(e)}"
+                f"Error while parsing binary data: {type(e).__name__}\n{str(e)}", e
             )
             self._model.root_obj = None
 
@@ -166,10 +166,10 @@ def build(self, **contextkw: t.Any) -> bytes:
         """
         try:
             binary = self._construct.build(self._model.root_obj, **contextkw)
-            self.show_build_error_message(None)
+            self.show_build_error_message(None, None)
         except Exception as e:
             self.show_build_error_message(
-                f"Error while building binary data: {type(e).__name__}\n{str(e)}"
+                f"Error while building binary data: {type(e).__name__}\n{str(e)}", e
             )
             raise e
 

construct_editor/main.py

@@ -1,5 +1,4 @@
 import sys
-import traceback
 import typing as t
 from pathlib import Path
 from types import TracebackType
@@ -45,6 +44,10 @@
 import construct_editor.gallery.test_tflagsenum
 import construct_editor.gallery.test_timestamp
 from construct_editor.wx_widgets import WxConstructHexEditor
+from construct_editor.wx_widgets.wx_exception_dialog import (
+    ExceptionInfo,
+    WxExceptionDialog,
+)
 
 
 class ConstructGalleryFrame(wx.Frame):
@@ -75,7 +78,9 @@ def on_uncaught_exception(
         :param string `trace`: the traceback header, if any (otherwise, it prints the
         standard Python header: ``Traceback (most recent call last)``.
         """
-        dial = ExceptionDialog(None, etype, value, trace)
+        dial = WxExceptionDialog(
+            None, "Uncaught Exception...", ExceptionInfo(etype, value, trace)
+        )
         dial.ShowModal()
 
 
@@ -396,73 +401,6 @@ def on_load_binary_file_clicked(self, event):
 )
 
 
-class ExceptionDialog(wx.Dialog):
-    def __init__(
-        self,
-        parent,
-        etype: t.Type[BaseException],
-        value: BaseException,
-        trace: TracebackType,
-    ):
-        wx.Dialog.__init__(
-            self,
-            parent,
-            id=wx.ID_ANY,
-            title="Uncaught Exception...",
-            pos=wx.DefaultPosition,
-            size=wx.Size(800, 600),
-            style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER,
-        )
-
-        self._init_gui()
-
-        self.exception_txt.SetValue(
-            "".join(traceback.format_exception_only(etype, value))
-        )
-        self.traceback_txt.SetValue("".join(traceback.format_tb(trace)))
-
-    def _init_gui(self):
-        self.SetSizeHints(wx.DefaultSize, wx.DefaultSize)
-
-        sizer = wx.BoxSizer(wx.VERTICAL)
-
-        self.ok_btn = wx.Button(
-            self, wx.ID_ANY, "OK", wx.DefaultPosition, wx.DefaultSize, 0
-        )
-        sizer.Add(self.ok_btn, 0, wx.ALL | wx.EXPAND, 5)
-
-        self.exception_txt = wx.TextCtrl(
-            self,
-            wx.ID_ANY,
-            wx.EmptyString,
-            wx.DefaultPosition,
-            wx.Size(-1, -1),
-            wx.TE_MULTILINE | wx.TE_READONLY,
-        )
-        sizer.Add(self.exception_txt, 1, wx.ALL | wx.EXPAND, 5)
-
-        self.traceback_txt = wx.TextCtrl(
-            self,
-            wx.ID_ANY,
-            wx.EmptyString,
-            wx.DefaultPosition,
-            wx.Size(-1, -1),
-            wx.TE_MULTILINE | wx.TE_READONLY,
-        )
-        sizer.Add(self.traceback_txt, 2, wx.ALL | wx.EXPAND, 5)
-
-        self.SetSizer(sizer)
-        self.Layout()
-
-        self.Centre(wx.BOTH)
-
-        # Connect Events
-        self.ok_btn.Bind(wx.EVT_BUTTON, self.on_ok_clicked)
-
-    def on_ok_clicked(self, event):
-        self.Close()
-
-
 def main():
     if sys.platform == "win32":
         # Windows Icon fix: https://stackoverflow.com/a/1552105

construct_editor/wx_widgets/wx_construct_editor.py

@@ -17,6 +17,7 @@
     create_obj_editor,
     create_obj_renderer_helper,
 )
+from construct_editor.wx_widgets.wx_exception_dialog import WxExceptionDialog
 
 
 @dataclasses.dataclass
@@ -306,9 +307,21 @@ def _init_gui(self):
 
         # Create InfoBars
         self._parse_error_info_bar = wx.InfoBar(self)
+        btn_id = wx.NewIdRef()
+        self._parse_error_info_bar.AddButton(btn_id, "Exception Infos")
+        self._parse_error_info_bar.Bind(
+            wx.EVT_BUTTON, self._parse_error_info_bar_btn_clicked, id=btn_id
+        )
+        self._parse_error_ex: t.Optional[Exception] = None
         vsizer.Add(self._parse_error_info_bar, 0, wx.EXPAND)
 
         self._build_error_info_bar = wx.InfoBar(self)
+        btn_id = wx.NewIdRef()
+        self._build_error_info_bar.AddButton(btn_id, "Exception Infos")
+        self._build_error_info_bar.Bind(
+            wx.EVT_BUTTON, self._build_error_info_bar_btn_clicked, id=btn_id
+        )
+        self._build_error_ex: t.Optional[Exception] = None
         vsizer.Add(self._build_error_info_bar, 0, wx.EXPAND)
 
         # create status bar
@@ -373,22 +386,24 @@ def reload(self):
         finally:
             self.Thaw()
 
-    def show_parse_error_message(self, msg: t.Optional[str]):
+    def show_parse_error_message(self, msg: t.Optional[str], ex: t.Optional[Exception]):
         """
         Show an message to the user.
         """
         if msg is None:
             self._parse_error_info_bar.Dismiss()
         else:
+            self._parse_error_ex = ex
             self._parse_error_info_bar.ShowMessage(msg, wx.ICON_WARNING)
 
-    def show_build_error_message(self, msg: t.Optional[str]):
+    def show_build_error_message(self, msg: t.Optional[str], ex: t.Optional[Exception]):
         """
         Show an build error message to the user.
         """
         if msg is None:
             self._build_error_info_bar.Dismiss()
         else:
+            self._build_error_ex = ex
             self._build_error_info_bar.ShowMessage(msg, wx.ICON_WARNING)
 
     def show_status(self, path_info: str, bytes_info: str):
@@ -664,3 +679,17 @@ def _get_from_clipboard(self):
         wx.TheClipboard.Close()
         txt: str = clipboard.GetText()
         return txt
+
+    def _parse_error_info_bar_btn_clicked(self, event):
+        if self._parse_error_ex is None:
+            return
+
+        dial = WxExceptionDialog(None, "Parse error", self._parse_error_ex)
+        dial.ShowModal()
+
+    def _build_error_info_bar_btn_clicked(self, event):
+        if self._build_error_ex is None:
+            return
+
+        dial = WxExceptionDialog(None, "Build error", self._build_error_ex)
+        dial.ShowModal()

construct_editor/wx_widgets/wx_exception_dialog.py

@@ -0,0 +1,93 @@
+import dataclasses
+import traceback
+import typing as t
+from types import TracebackType
+
+import wx
+
+
+@dataclasses.dataclass
+class ExceptionInfo:
+    etype: t.Type[BaseException]
+    value: BaseException
+    trace: t.Optional[TracebackType]
+
+
+class WxExceptionDialog(wx.Dialog):
+    def __init__(
+        self, parent, title: str, exception: t.Union[ExceptionInfo, BaseException]
+    ):
+        wx.Dialog.__init__(
+            self,
+            parent,
+            id=wx.ID_ANY,
+            title=title,
+            pos=wx.DefaultPosition,
+            size=wx.Size(800, 600),
+            style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER,
+        )
+
+        self._init_gui()
+
+        if isinstance(exception, ExceptionInfo):
+            exception_info = exception
+        else:
+            exception_info = ExceptionInfo(
+                type(exception), exception, exception.__traceback__
+            )
+
+        self.exception_txt.SetValue(
+            "".join(
+                traceback.format_exception_only(
+                    exception_info.etype, exception_info.value
+                )
+            )
+        )
+
+        if exception_info.trace is None:
+            self.traceback_txt.SetValue("")
+        else:
+            self.traceback_txt.SetValue(
+                "".join(traceback.format_tb(exception_info.trace))
+            )
+
+    def _init_gui(self):
+        self.SetSizeHints(wx.DefaultSize, wx.DefaultSize)
+
+        sizer = wx.BoxSizer(wx.VERTICAL)
+
+        self.ok_btn = wx.Button(
+            self, wx.ID_ANY, "OK", wx.DefaultPosition, wx.DefaultSize, 0
+        )
+        sizer.Add(self.ok_btn, 0, wx.ALL | wx.EXPAND, 5)
+
+        self.exception_txt = wx.TextCtrl(
+            self,
+            wx.ID_ANY,
+            wx.EmptyString,
+            wx.DefaultPosition,
+            wx.Size(-1, -1),
+            wx.TE_MULTILINE | wx.TE_READONLY,
+        )
+        sizer.Add(self.exception_txt, 1, wx.ALL | wx.EXPAND, 5)
+
+        self.traceback_txt = wx.TextCtrl(
+            self,
+            wx.ID_ANY,
+            wx.EmptyString,
+            wx.DefaultPosition,
+            wx.Size(-1, -1),
+            wx.TE_MULTILINE | wx.TE_READONLY,
+        )
+        sizer.Add(self.traceback_txt, 2, wx.ALL | wx.EXPAND, 5)
+
+        self.SetSizer(sizer)
+        self.Layout()
+
+        self.Centre(wx.BOTH)
+
+        # Connect Events
+        self.ok_btn.Bind(wx.EVT_BUTTON, self.on_ok_clicked)
+
+    def on_ok_clicked(self, event):
+        self.Close()