Add keyword filtering to add escapes to RDL keywords used in identifiers. #7

Author: amykyta3

src/peakrdl_systemrdl/identifier_filter.py

@@ -0,0 +1,23 @@
+# All SystemRDL 2.0 keywords
+RDL_KEYWORDS = {
+    "abstract", "accesstype", "addressingtype", "addrmap", "alias", "all",
+    "bit", "boolean", "bothedge", "compact", "component", "componentwidth",
+    "constraint", "default", "encode", "enum", "external", "false", "field",
+    "fullalign", "hw", "inside", "internal", "level", "longint", "mem", "na",
+    "negedge", "nonsticky", "number", "onreadtype", "onwritetype", "posedge",
+    "property", "r", "rclr", "ref", "reg", "regalign", "regfile", "rset",
+    "ruser", "rw", "rw1", "signal", "string", "struct", "sw", "this", "true",
+    "type", "unsigned", "w", "w1", "wclr", "woclr", "woset", "wot", "wr",
+    "wset", "wuser", "wzc", "wzs", "wzt",
+}
+
+def kw_filter(s: str) -> str:
+    """
+    Make all user identifiers 'safe' and ensure they do not collide with
+    SystemRDL keywords.
+
+    SystemRDL allows identifier escaping with a preceding backslash
+    """
+    if s in RDL_KEYWORDS:
+        s = "\\" + s
+    return s

src/peakrdl_systemrdl/rdl_generator.py

@@ -5,6 +5,7 @@
 
 from .definition_generator import DefinitionGenerator
 from .stringify import stringify_rdl_value
+from .identifier_filter import kw_filter as kwf
 
 if TYPE_CHECKING:
     from systemrdl.node import AddressableNode
@@ -14,9 +15,9 @@ class RDLGenerator(DefinitionGenerator, RDLListener):
     def get_content(self, node: 'Node') -> str:
 
         if node.type_name is not None:
-            type_name = node.type_name
+            type_name = kwf(node.type_name)
         else:
-            type_name = node.inst_name
+            type_name = kwf(node.inst_name)
 
         self.start("addrmap", type_name)
         self.assign_properties(node)
@@ -39,7 +40,7 @@ def assign_properties(self, node: 'Node') -> None:
             self.add_content(f"{prop_name} = {value_s};")
 
     def define_enum(self, enum: Type[rdltypes.UserEnum])-> None:
-        self.push(f"enum {enum.type_name}", "")
+        self.push(f"enum {kwf(enum.type_name)}", "")
         for identifier, member in enum.members.items():
             if member.rdl_name or member.rdl_desc:
                 self.add_content(f"{identifier} = {member.value} {{")
@@ -61,22 +62,22 @@ def get_addressable_assignment(self, node: 'AddressableNode') -> str:
 
     def enter_Addrmap(self, node: 'AddrmapNode') -> None:
         suffix = self.get_addressable_assignment(node)
-        self.push("addrmap", node.inst_name, node.array_dimensions, suffix)
+        self.push("addrmap", kwf(node.inst_name), node.array_dimensions, suffix)
         self.assign_properties(node)
 
     def enter_Regfile(self, node: 'RegfileNode') -> None:
         suffix = self.get_addressable_assignment(node)
-        self.push("regfile", node.inst_name, node.array_dimensions, suffix, node.external)
+        self.push("regfile", kwf(node.inst_name), node.array_dimensions, suffix, node.external)
         self.assign_properties(node)
 
     def enter_Mem(self, node: 'MemNode') -> None:
         suffix = self.get_addressable_assignment(node)
-        self.push("mem", node.inst_name, node.array_dimensions, suffix, True)
+        self.push("mem", kwf(node.inst_name), node.array_dimensions, suffix, True)
         self.assign_properties(node)
 
     def enter_Reg(self, node: 'RegNode') -> None:
         suffix = self.get_addressable_assignment(node)
-        self.push("reg", node.inst_name, node.array_dimensions, suffix, node.external)
+        self.push("reg", kwf(node.inst_name), node.array_dimensions, suffix, node.external)
         self.assign_properties(node)
 
     def enter_Field(self, node: 'FieldNode') -> None:
@@ -85,7 +86,7 @@ def enter_Field(self, node: 'FieldNode') -> None:
         if isinstance(reset, int):
             suffix += f" = 0x{reset:X}"
 
-        self.push("field", node.inst_name, suffix=suffix, is_external=node.external)
+        self.push("field", kwf(node.inst_name), suffix=suffix, is_external=node.external)
 
         encode = node.get_property('encode')
         if encode is not None:
@@ -94,7 +95,7 @@ def enter_Field(self, node: 'FieldNode') -> None:
         self.assign_properties(node)
 
     def enter_Signal(self, node: 'SignalNode') -> None:
-        self.push("signal", node.inst_name)
+        self.push("signal", kwf(node.inst_name))
         self.assign_properties(node)
 
     def exit_Component(self, node: 'Node') -> None:

src/peakrdl_systemrdl/stringify.py

@@ -2,6 +2,8 @@
 
 from systemrdl import rdltypes, node
 
+from .identifier_filter import kw_filter as kwf
+
 def stringify_rdl_value(value: Any) -> str:
     """
     Convert value into its RDL string.
@@ -57,13 +59,13 @@ def stringify_builtin_enum(value: rdltypes.BuiltinEnum) -> str:
 
 
 def stringify_user_enum_member(value: rdltypes.UserEnum) -> str:
-    return "%s::%s" % (type(value).type_name, value.name) # type: ignore
+    return "%s::%s" % (kwf(type(value).type_name), kwf(value.name)) # type: ignore
 
 
 def stringify_struct(value: rdltypes.UserStruct) -> str:
     elements = ["%s:%s" % (k, stringify_rdl_value(v)) for k,v in value._values.items()]
-    return "%s'{%s}" % (type(value).type_name, ", ".join(elements))
+    return "%s'{%s}" % (kwf(type(value).type_name), ", ".join(elements))
 
 
 def stringify_user_enum_type(value: rdltypes.UserEnum) -> str:
-    return value.type_name # type: ignore
+    return kwf(value.type_name) # type: ignore