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.

Author: timrid

CHANGELOG.md

@@ -12,6 +12,7 @@ Enhanced ConstructEditor:
 - Show full tooltip of the "name" column, which when fields are too long is shown with ellipses. (#18)
 - 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.
 
 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/preprocessor.py

@@ -5,6 +5,7 @@
 
 import construct as cs
 import construct_typed as cst
+import wrapt
 
 
 class GuiMetaData(t.TypedDict):
@@ -15,64 +16,46 @@ class GuiMetaData(t.TypedDict):
     child_gui_metadata: t.Optional["GuiMetaData"]
 
 
-class IntWithGuiMetadata(int):
-    pass
-
+class ObjProxyWithGuiMetaData(wrapt.ObjectProxy):
+    __slots__ = "__construct_editor_metadata__"
 
-class FloatWithGuiMetadata(float):
-    pass
+    def __init__(self, wrapped: t.Any, gui_metadata: GuiMetaData):
+        super(ObjProxyWithGuiMetaData, self).__init__(wrapped)
+        wrapt.ObjectProxy.__setattr__(
+            self, "__construct_editor_metadata__", gui_metadata
+        )
 
 
 class BytesWithGuiMetadata(bytes):
     pass
 
 
-class BytearrayWithGuiMetadata(bytearray):
-    pass
-
-
-class StrWithGuiMetadata(str):
-    pass
-
-
-class NoneWithGuiMetadata:
-    pass
-
-
 def get_gui_metadata(obj: t.Any) -> t.Optional[GuiMetaData]:
     """Get the GUI metadata if they are available"""
     try:
-        return obj.__gui_metadata  # type: ignore
+        return getattr(obj, "__construct_editor_metadata__")
     except Exception:
         return None
 
 
 def add_gui_metadata(obj: t.Any, gui_metadata: GuiMetaData) -> t.Any:
-    """Append the private field "__gui_metadata" to an object"""
-    obj_type = type(obj)
-    if (obj_type is int) or (obj_type is bool):
-        obj = IntWithGuiMetadata(obj)
-        obj.__gui_metadata = gui_metadata
-    elif obj_type is float:
-        obj = FloatWithGuiMetadata(obj)
-        obj.__gui_metadata = gui_metadata
-    elif obj_type is bytes:
+    """
+    Append gui_metadata to an object.
+
+    With immutable types like str, bytes, int, ... it is not possible to add
+    metadata to a type dynammically. With other types like enums it is possible,
+    but enums are singleton, so that the metadata of objects is overwritten by
+    the next object with the same value.
+
+    Because auf this for any object an proxy object is created, so that the
+    metadata can be added to this proxy object.
+    """
+    if isinstance(obj, bytes):
+        # bytes has to be a subtype of bytes or the `stream_write` will raise an error...
         obj = BytesWithGuiMetadata(obj)
-        obj.__gui_metadata = gui_metadata
-    elif obj_type is bytearray:
-        obj = BytearrayWithGuiMetadata(obj)
-        obj.__gui_metadata = gui_metadata
-    elif obj_type is str:
-        obj = StrWithGuiMetadata(obj)
-        obj.__gui_metadata = gui_metadata
-    elif obj is None:
-        obj = NoneWithGuiMetadata()
-        obj.__gui_metadata = gui_metadata
+        obj.__construct_editor_metadata__ = gui_metadata
     else:
-        try:
-            obj.__gui_metadata = gui_metadata  # type: ignore
-        except AttributeError:
-            raise ValueError(f"add_gui_metadata dont work with type of {type(obj)}")
+        obj = ObjProxyWithGuiMetaData(obj, gui_metadata)
     return obj
 
 

construct_editor/gallery/test_tflagsenum.py

@@ -81,6 +81,7 @@ class FlagsEnumTest(cst.DataclassMixin):
     permissions: Permission = cst.csfield(cst.TFlagsEnum(cs.Int8ul, Permission))
     days: Day = cst.csfield(cst.TFlagsEnum(cs.Int8ul, Day))
     long_list: LongList = cst.csfield(cst.TFlagsEnum(cs.Int64ul, LongList))
+    days2: Day = cst.csfield(cst.TFlagsEnum(cs.Int8ul, Day))
 
 
 constr = cst.DataclassStruct(FlagsEnumTest)
@@ -93,21 +94,24 @@ class FlagsEnumTest(cst.DataclassMixin):
                 permissions=Permission.R | Permission.W,
                 days=Day.Monday | Day.Sunday,
                 long_list=LongList.Entry49 | LongList.Entry50,
+                days2=Day.Monday | Day.Sunday,
             )
         ),
         "1": constr.build(
             FlagsEnumTest(
                 permissions=Permission.R,
                 days=Day.Monday,
                 long_list=LongList.Entry0,
+                days2=Day.Monday,
             )
         ),
         "Zeros": constr.build(
             FlagsEnumTest(
                 permissions=Permission(0),
                 days=Day(0),
                 long_list=LongList(0),
+                days2=Day(0),
             )
         ),
     },
-)
+)

construct_editor/wx_widgets/wx_obj_view.py

@@ -257,8 +257,6 @@ def __init__(self, parent, settings: ObjViewSettings_Timestamp):
         if not isinstance(self.entry.obj, arrow.Arrow):
             return
 
-        self.obj_type = type(self.entry.obj)
-
         # Obj
         hsizer = wx.BoxSizer(wx.HORIZONTAL)
         dt = self.entry.obj.datetime
@@ -312,7 +310,7 @@ def __init__(self, parent, settings: ObjViewSettings_Timestamp):
     def get_new_obj(self) -> t.Any:
         date: wx.DateTime = self.date_picker.GetValue()
         time: wx.DateTime = self.time_picker.GetValue()
-        new_obj = self.obj_type(
+        new_obj = arrow.Arrow(
             year=date.year,
             month=date.month + 1,  # in wx.adc.DatePickerCtrl the month start with 0
             day=date.day,

setup.py

@@ -33,7 +33,8 @@
         "construct==2.10.68",
         "construct-typing==0.5.4",
         "wxPython>=4.1.1",
-        "arrow>=1.0.0"
+        "arrow>=1.0.0",
+        "wrapt>=1.14.0"
     ],
     keywords=[
         "gui",