more case insensitivity and no more : or ; in item names

Author: DenSinH

blark/plain.py

@@ -8,7 +8,7 @@
 from .input import (BlarkCompositeSourceItem, BlarkSourceItem,
                     register_input_handler)
 from .output import OutputBlock, register_output_handler
-from .util import AnyPath, SourceType, find_pou_type_and_identifier
+from .util import AnyPath, SourceType, find_pou_type_and_identifier_plain
 
 
 @dataclasses.dataclass
@@ -40,7 +40,7 @@ def load(
         with open(filename, "rt") as fp:
             contents = fp.read()
 
-        source_type, identifier = find_pou_type_and_identifier(contents)
+        source_type, identifier = find_pou_type_and_identifier_plain(contents)
         # if source_type is None:
         #     return []
         source_type = SourceType.general

blark/solution.py

@@ -351,9 +351,7 @@ def from_xml(
     ) -> Self:
         declaration = get_child_located_text(xml, "Declaration", filename=filename)
         if declaration is not None:
-            source_type, identifier = util.find_pou_type_and_identifier(
-                declaration.value
-            )
+            source_type, identifier = util.find_pou_type_and_identifier_xml(xml)
         else:
             source_type, identifier = None, None
 

blark/summary.py

@@ -370,7 +370,7 @@ class MethodSummary(Summary):
     declarations: Dict[str, DeclarationSummary] = field(default_factory=dict)
 
     def __getitem__(self, key: str) -> DeclarationSummary:
-        return self.declarations[key]
+        return get_case_insensitive(self.declarations, key)
 
     @property
     def declarations_by_block(self) -> Dict[str, Dict[str, DeclarationSummary]]:
@@ -415,7 +415,7 @@ class PropertyGetSetSummary(Summary):
     implementation_source: Optional[str] = None
 
     def __getitem__(self, key: str) -> DeclarationSummary:
-        return self.declarations[key]
+        return get_case_insensitive(self.declarations, key)
 
 
 @dataclass
@@ -486,7 +486,7 @@ class FunctionSummary(Summary):
     declarations: Dict[str, DeclarationSummary] = field(default_factory=dict)
 
     def __getitem__(self, key: str) -> DeclarationSummary:
-        return self.declarations[key]
+        return get_case_insensitive(self.declarations, key)
 
     @property
     def declarations_by_block(self) -> Dict[str, Dict[str, DeclarationSummary]]:
@@ -540,11 +540,11 @@ class FunctionBlockSummary(Summary):
     def __getitem__(
         self, key: str
     ) -> Union[DeclarationSummary, MethodSummary, PropertySummary, ActionSummary]:
-        key = key.strip(":;")
-        if key in self.declarations:
-            return self.declarations[key]
+        decl = get_case_insensitive(self.declarations, key)
+        if decl is not None:
+            return decl
         for item in self.actions + self.methods + self.properties:
-            if item.name == key:
+            if item.name.lower() == key.lower():
                 return item
         raise KeyError(key)
 
@@ -647,10 +647,11 @@ class InterfaceSummary(Summary):
     def __getitem__(
         self, key: str
     ) -> Union[DeclarationSummary, MethodSummary, PropertySummary]:
-        if key in self.declarations:
-            return self.declarations[key]
-        for item in self.methods + self.properties:
-            if item.name == key:
+        decl = get_case_insensitive(self.declarations, key)
+        if decl is not None:
+            return decl
+        for item in self.actions + self.methods + self.properties:
+            if item.name.lower() == key.lower():
                 return item
         raise KeyError(key)
 
@@ -744,7 +745,7 @@ class DataTypeSummary(Summary):
     declarations: Dict[str, DeclarationSummary] = field(default_factory=dict)
 
     def __getitem__(self, key: str) -> DeclarationSummary:
-        return self.declarations[key]
+        return get_case_insensitive(self.declarations, key)
 
     @property
     def declarations_by_block(self) -> Dict[str, Dict[str, DeclarationSummary]]:
@@ -853,7 +854,7 @@ class GlobalVariableSummary(Summary):
     declarations: Dict[str, DeclarationSummary] = field(default_factory=dict)
 
     def __getitem__(self, key: str) -> DeclarationSummary:
-        return self.declarations[key]
+        return get_case_insensitive(self.declarations, key)
 
     @property
     def declarations_by_block(self) -> Dict[str, Dict[str, DeclarationSummary]]:
@@ -908,10 +909,11 @@ class ProgramSummary(Summary):
     properties: List[PropertySummary] = field(default_factory=list)
 
     def __getitem__(self, key: str) -> DeclarationSummary:
-        if key in self.declarations:
-            return self.declarations[key]
+        decl = get_case_insensitive(self.declarations, key)
+        if decl is not None:
+            return decl
         for item in self.actions + self.methods + self.properties:
-            if item.name == key:
+            if item.name.lower() == key.lower():
                 return item
         raise KeyError(key)
 
@@ -1129,10 +1131,9 @@ def get_all_items_by_name(
             self.data_types,
         ):
             # Very inefficient, be warned
-            try:
-                yield dct[name]
-            except KeyError:
-                ...
+            decl = get_case_insensitive(dct, name)
+            if decl is not None:
+                yield decl
 
     def get_item_by_name(self, name: str) -> Optional[TopLevelCodeSummaryType]:
         """

blark/util.py

@@ -224,11 +224,12 @@ def python_debug_session(namespace: Dict[str, Any], message: str):
         embed()
 
 
-def find_pou_type_and_identifier(code: str) -> tuple[Optional[SourceType], Optional[str]]:
+def find_pou_type_and_identifier_plain(code: str) -> tuple[Optional[SourceType], Optional[str]]:
     types = {source.name for source in SourceType}
     clean_code = remove_all_comments(code)
     for line in clean_code.splitlines():
-        parts = line.lstrip().split()
+        # split line on non-word and non-dot characters
+        parts = re.split(r"[^\w.]+", line.lstrip())
         if parts and parts[0].lower() in types:
             source_type = SourceType[parts[0].lower()]
             identifier = None
@@ -247,6 +248,28 @@ def find_pou_type_and_identifier(code: str) -> tuple[Optional[SourceType], Optio
     return None, None
 
 
+def find_pou_type_and_identifier_xml(
+    xml: lxml.etree.Element
+) -> tuple[Optional[SourceType], Optional[str]]:
+    tag_source_type_map = {
+        "Get": SourceType.property_get,
+        "Set": SourceType.property_set,
+        "Itf": SourceType.interface,
+        "GVL": SourceType.var_global,
+    }
+
+    if xml.tag in tag_source_type_map:
+        source_type = tag_source_type_map[xml.tag]
+    elif xml.tag == "POU":
+        # POU may be function block or function (or maybe others)
+        # so we figure it out the 'old fashioned' way
+        source_type, _ = find_pou_type_and_identifier_plain(xml.xpath("Declaration")[0].text)
+    else:
+        source_type = SourceType[xml.tag.lower()]
+
+    return source_type, xml.attrib.get("Name")
+
+
 def remove_all_comments(text: str, *, replace_char: str = " ") -> str:
     """
     Remove all comments and replace them with the provided character.