closes #231

Fixes a bug with single quote characters in the name or desc field of a field encoding definition

Author: krcb197

src/peakrdl_python/templates/addrmap_tb.py.jinja

@@ -227,12 +227,12 @@ class {{fq_block_name}}_single_access({{top_node.inst_name}}_TestCase): # type:
                         {% if encoding_entry.rdl_name is none %}
             self.assertIsNone(self.dut.{{'.'.join(get_python_path_segments(node))}}.enum_cls.{{encoding_entry.name | upper}}.rdl_name)
                         {% else %}
-            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.enum_cls.{{encoding_entry.name | upper}}.rdl_name, "{{encoding_entry.rdl_name}}")
+            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.enum_cls.{{encoding_entry.name | upper}}.rdl_name, {{encoding_entry.rdl_name | tojson}})
                         {% endif %}
                         {% if encoding_entry.rdl_desc is none %}
             self.assertIsNone(self.dut.{{'.'.join(get_python_path_segments(node))}}.enum_cls.{{encoding_entry.name | upper}}.rdl_desc)
                         {% else %}
-            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.enum_cls.{{encoding_entry.name | upper}}.rdl_desc, "{{encoding_entry.rdl_desc}}")
+            self.assertEqual(self.dut.{{'.'.join(get_python_path_segments(node))}}.enum_cls.{{encoding_entry.name | upper}}.rdl_desc, {{encoding_entry.rdl_desc | tojson}})
                         {% endif %}
                     {% endif %}
                 {% endfor %}

src/peakrdl_python/templates/field_enums.py.jinja

@@ -37,7 +37,7 @@ from {{ peakrdl_python_lib(depth=lib_depth) }} import SystemRDLEnum, SystemRDLEn
 class {{get_fully_qualified_enum_type(enum_needed)}}_enumcls({% if legacy_enum_type %}IntEnum{% else %}SystemRDLEnum{% endif %}):
 
     {% for value_of_enum_needed in enum_needed -%}
-    {{ value_of_enum_needed.name.upper() }} = {% if legacy_enum_type %}{{ value_of_enum_needed.value }}{% else %}SystemRDLEnumEntry(int_value={{value_of_enum_needed.value}}, name={%- if value_of_enum_needed.rdl_name is not none and not skip_systemrdl_name_and_desc_properties -%}'{{value_of_enum_needed.rdl_name}}'{% else %}None{% endif %}, desc={%- if value_of_enum_needed.rdl_desc is not none and not skip_systemrdl_name_and_desc_properties -%}'{{value_of_enum_needed.rdl_desc}}'{% else %}None{% endif %}){% endif %}  {%- if value_of_enum_needed.rdl_desc is not none %}  # {{ value_of_enum_needed.rdl_desc }} {%- endif %}
+    {{ value_of_enum_needed.name.upper() }} = {% if legacy_enum_type %}{{ value_of_enum_needed.value }}{% else %}SystemRDLEnumEntry(int_value={{value_of_enum_needed.value}}, name={%- if value_of_enum_needed.rdl_name is not none and not skip_systemrdl_name_and_desc_properties -%}{{value_of_enum_needed.rdl_name | tojson}}{% else %}None{% endif %}, desc={%- if value_of_enum_needed.rdl_desc is not none and not skip_systemrdl_name_and_desc_properties -%}{{value_of_enum_needed.rdl_desc | tojson}}{% else %}None{% endif %}){% endif %}  {%- if value_of_enum_needed.rdl_desc is not none %}  # {{ value_of_enum_needed.rdl_desc }} {%- endif %}
     {% endfor %}
 {% endfor -%}
 

tests/testcases/name_desc_stress_test.rdl

@@ -0,0 +1,23 @@
+/*
+This test was introduced as part of #231 to check stressful cases for the system rdl name and
+description
+*/
+addrmap name_desc_stress_test {
+    name = "This addrmap name has a single quote in it ' ";
+    reg {
+        name = "This reg name has a single quote in it ' ";
+        enum my_enum {
+            ZERO = 1'b0 {
+                name = "This enum name has a single quote in it ' ";
+                desc = "This enum desc has a single quote in it ' ";
+            };
+            ONE = 1'b1 {
+                name = "This enum name has a double quote in it \" ";
+            };
+        };
+        field {
+            name = "This field name has a single quote in it ' ";
+            encode = my_enum;
+        } field_a;
+    } reg_a;
+};