Milestone 0.4.2 - minor update elf parser supports structure, enums and unions

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pyx2cscope"
-version = "0.4.1"
+version = "0.4.2"
 description = "python implementation of X2Cscope"
 authors = [
   "Yash Agarwal <[email protected]>",

pyx2cscope/__init__.py

@@ -1,11 +1,11 @@
 """This module contains the pyx2cscope package.
 
-Version: 0.4.1
+Version: 0.4.2
 """
 
 import logging
 
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 
 def set_logger(

pyx2cscope/examples/demo.py

@@ -13,6 +13,6 @@
 
 x2cscope.request_scope_data()
 
-while(1):
+while True:
     if x2cscope.is_scope_data_ready():
         print(x2cscope.get_scope_channel_data())

pyx2cscope/variable/variable.py

@@ -37,6 +37,8 @@ class VariableInfo:
         name (str): The name of the variable.
         type (str): The data type of the variable.
         byte_size (int): The size of the variable in bytes.
+        bit_size (int): bit_size of variable if size is less than a byte (e.g.: union type)
+        bit_offset (int): bit_offset of variable if size is less than a byte (e.g.: union type)
         address (int): The memory address of the variable.
         array_size (int): The size of the array if the variable is an array, default is 0.
         valid_values (dict): enum type of valid values
@@ -45,6 +47,8 @@ class VariableInfo:
     name: str
     type: str
     byte_size: int
+    bit_size: int
+    bit_offset: int
     address: int
     array_size: int
     valid_values: Dict[str, int]

pyx2cscope/variable/variable_factory.py

@@ -188,7 +188,6 @@ def get_variable(self, name: str) -> Variable | None:
         """
         try:
             variable_info = self.parser.get_var_info(name)
-
             return self.get_variable_raw(variable_info)
         except Exception as e:
             logging.error(f"Error while getting variable '{name}' : {str(e)}")
@@ -233,15 +232,18 @@ def get_variable_raw(self, var_info: VariableInfo) -> Variable:
             "unsigned int": VariableUint16,
             "unsigned long": VariableUint32,
             "unsigned long long": VariableUint64,
-            "enum anonymousenum": VariableEnum,
+            "enum": VariableEnum,
         }
 
         try:
 
             var_type: str = var_info.type.lower().replace("_", "")
-            if var_type == "enum anonymousenum":
-                return type_factory[var_type](self.l_net, var_info.address, var_info.array_size, var_info.name, var_info.valid_values)
-            return type_factory[var_type](self.l_net, var_info.address, var_info.array_size, var_info.name)
+            params = [self.l_net, var_info.address, var_info.array_size, var_info.name]
+            if "enum" in var_type:
+                var_type = "enum"
+                params.append(var_info.valid_values)
+
+            return type_factory[var_type](*params)
         except IndexError:
             raise ValueError(
                 f"Type {var_type} not found. Cannot select the right variable representation."

tests/test_parser.py

@@ -54,14 +54,28 @@ def test_array_variable_32(self, mocker, array_size_test=255):
         assert variable.is_array() == True, "variable should be an array"
         assert len(variable) == array_size_test, "array has wrong length"
 
-    def test_variable_dspic33ak(self, mocker, array_size_test=4900):
+    def test_union_variable_16(self, mocker):
+        """Given a valid 32 bit elf file, check if an array variable is read correctly."""
+        fake_serial(mocker, 16)
+        x2c_scope = X2CScope(port="COM14", elf_file=self.elf_file_16)
+        variable_lo = x2c_scope.get_variable("motor.vqFiltered.state.x16.lo")
+        variable_hi = x2c_scope.get_variable("motor.vqFiltered.state.x16.hi")
+        variable_union = x2c_scope.get_variable("motor.vqFiltered.state.x32")
+        assert variable_lo is not None, "variable name not found"
+        assert variable_hi is not None, "variable name not found"
+        assert variable_union is not None, "variable name not found"
+        assert variable_lo.address == variable_union.address, "variable union should have the same address as segment"
+        assert variable_hi.address == variable_union.address + 2, "variable high should have address + 2"
+
+    def test_variable_dspic33ak(self, mocker, array_size_test=4900, address=22122):
         """Given a valid dspic33ak elf file, check if an array variable is read correctly."""
         fake_serial(mocker, 32)
         x2c_scope = X2CScope(port="COM14")
         x2c_scope.import_variables(self.elf_file_dspic33ak)
         variable = x2c_scope.get_variable("measureInputs.current.Ia")
         assert variable is not None, "variable name not found"
         assert variable.is_array() == False, "variable should be an array"
+        assert variable.address == address, "variable has wrong address, check offset calculation"
         # test array
         variable_array = x2c_scope.get_variable("X2C_BUFFER")
         assert variable_array is not None, "variable name not found"
@@ -77,6 +91,31 @@ def test_nested_array_variable_32(self, mocker, array_size_test=3):
         assert variable.is_array() == True, "variable should be an array"
         assert len(variable) == array_size_test, "array has wrong length"
 
+    def test_variable_enum_32(self, mocker, size6=6, size3=3):
+        """Given a valid dspic33ck elf file, check if an enum variable is read correctly."""
+        fake_serial(mocker, 32)
+        x2c_scope = X2CScope(port="COM14", elf_file=self.elf_file_32)
+        # test simple variable enum
+        variable = x2c_scope.get_variable("nextGlobalState")
+        assert variable is not None, "variable name not found"
+        assert variable.is_array() == False, "variable should not be an array"
+        assert len(variable.enum_list) == size6, "enum size should be 6"
+        # test nested enum inside a structure
+        variable = x2c_scope.get_variable("mcFoc_State_mds.FocState")
+        assert variable is not None, "variable name not found"
+        assert variable.is_array() == False, "variable should not be an array"
+        assert len(variable.enum_list) == size3, "enum size should be 3"
+
+    def test_variable_enum_16(self, mocker, size6=6):
+        """Given a valid dspic33ck elf file, check if an enum variable is read correctly."""
+        fake_serial(mocker, 32)
+        x2c_scope = X2CScope(port="COM14", elf_file=self.elf_file_16)
+        # test nested enum inside a structure
+        variable = x2c_scope.get_variable("motor.apiData.motorStatus")
+        assert variable is not None, "variable name not found"
+        assert variable.is_array() == False, "variable should not be an array"
+        assert len(variable.enum_list) == size6, "enum size should be 3"
+
     def test_variable_export_import(self, mocker):
         """Given a valid 32 bit elf file, check if export and import functions for variables are working."""
         fake_serial(mocker, 32)