Merge pull request #63 from engineerjoe440/bugfix/array-initialization-with-zero

FIX: Address Issue with Array-Initialization and Other General Cleanup

Author: klauer

blark/iec.lark

@@ -334,9 +334,8 @@ _array_spec_type: STRING_TYPE
 
 object_initializer_array: function_block_type_name "[" structure_initialization ( "," structure_initialization )* "]"
 
-array_initialization: "[" array_initial_element ( "," array_initial_element )* "]"
-// Removed to allow correct parsing of FB attribute assignment - JS - 20230410
-//                    | array_initial_element ( "," array_initial_element )*
+array_initialization: "[" array_initial_element ( "," array_initial_element )* "]" -> bracketed_array_initialization
+                    | array_initial_element ( "," array_initial_element )*         -> bare_array_initialization
 
 array_initial_element: ( integer | enumerated_value ) "(" [ _array_initial_element ] ")" -> array_initial_element_count
                      | _array_initial_element
@@ -719,7 +718,6 @@ function_call: symbolic_variable "(" [ param_assignment ( "," param_assignment )
 statement_list: _statement+
 
 _statement: ";"
-          | method_statement
           | assignment_statement
           | no_op_statement
           | set_statement
@@ -748,9 +746,6 @@ reset_statement: _variable "R="i expression ";"+
 
 reference_assignment_statement: _variable "REF="i expression ";"+
 
-// method ::= expression [DEREFERENCED] '.' _identifier '(' ')';
-method_statement: symbolic_variable "(" ")" DEREFERENCED? ";"+
-
 // B.3.2.2
 return_statement.1: "RETURN"i ";"*
 // return_statement: priority > 0 so that it doesn't clash with no_op_statement

blark/tests/source/array_with_integer_initializer.st

@@ -0,0 +1,8 @@
+{attribute 'hide'}
+METHOD prv_Detection : BOOL
+VAR_IN_OUT
+        currentChannel : ARRAY[*] OF someStruct := 0;
+END_VAR
+
+// do some stuff
+END_METHOD

blark/tests/test_transformer.py

@@ -28,8 +28,16 @@ def roundtrip_rule(rule_name: str, value: str, expected: Optional[str] = None):
     print(transformed)
     if expected is None:
         expected = value
-    assert str(transformed) == expected, \
-        "Transformed object does not produce identical source code"
+    try:
+        assert str(transformed) == expected, \
+            "Transformed object does not produce identical source code"
+    except Exception:
+        tree = parse_source_code(value, parser=parser, transform=False)
+        print("\n\nTransformation failure. The original source code was:")
+        print(value)
+        print("\n\nThe parse tree is:")
+        print(tree.pretty())
+        raise
 
     conftest.check_serialization(
         transformed, deserialize=True, require_same_source=True
@@ -63,6 +71,9 @@ def test_check_unhandled_rules(grammar):
         # handled as aliases
         "case_list",
 
+        # handled as special cases
+        "array_initialization",
+
         # handled as tree
         "global_var_list",
         "var_body",
@@ -406,8 +417,6 @@ def test_input_roundtrip(rule_name, value):
             END_VAR
             """,
             ),
-            marks=pytest.mark.xfail(reason="TODO; this is valid grammar, I think"),
-            # Appears to collide with enum rule; need to fix
         ),
     ],
 )
@@ -447,15 +456,20 @@ def test_output_roundtrip(rule_name, value):
             END_VAR
             """
         )),
+        param("input_output_declarations", tf.multiline_code_block(
+            """
+            VAR_IN_OUT
+                fbProblematic1 : FB_Test(initializer := 5) := (A := 1, B := 2, C := 3);
+            END_VAR
+            """
+        )),
         param("input_output_declarations", tf.multiline_code_block(
             """
             VAR_IN_OUT
                 fbTest : FB_Test := (A := 1, B := 2, C := 3);
             END_VAR
             """,
             ),
-            marks=pytest.mark.xfail(reason="TODO; this is valid grammar, I think"),
-            # Appears to collide with enum rule; need to fix
         ),
     ],
 )

blark/transform.py

@@ -1226,19 +1226,32 @@ def from_lark(
 
 
 @dataclass
-@_rule_handler("array_initialization")
-class ArrayInitialization:
-    elements: List[ArrayInitialElement]
-    count: Optional[Union[EnumeratedValue, Integer]] = None
-    meta: Optional[Meta] = meta_field()
+@_rule_handler("bracketed_array_initialization")
+class _BracketedArrayInitialization:
+    @staticmethod
+    def from_lark(*elements: ArrayInitialElement) -> ArrayInitialization:
+        return ArrayInitialization(list(elements), brackets=True)
 
+
+@dataclass
+@_rule_handler("bare_array_initialization")
+class _BareArrayInitialization:
     @staticmethod
     def from_lark(*elements: ArrayInitialElement) -> ArrayInitialization:
-        return ArrayInitialization(list(elements))
+        return ArrayInitialization(list(elements), brackets=False)
+
+
+@dataclass
+class ArrayInitialization:
+    elements: List[ArrayInitialElement]
+    brackets: bool = False
+    meta: Optional[Meta] = meta_field()
 
     def __str__(self) -> str:
         elements = ", ".join(str(element) for element in self.elements)
-        return f"[{elements}]"
+        if self.brackets:
+            return f"[{elements}]"
+        return elements
 
 
 @dataclass
@@ -1619,25 +1632,19 @@ def value(self) -> str:
     @staticmethod
     def from_lark(
         name: SymbolicVariable,
-        first_parameter: Optional[ParameterAssignment] = None,
-        *remaining_parameters: ParameterAssignment,
+        *params: Union[ParameterAssignment, lark.Token, None],
     ) -> FunctionCall:
-        # Remove the Dereference Token if Present in the Remaining Parameters
-        dereferenced = False
-        if remaining_parameters:
-            if str(remaining_parameters[-1]) == "^":
-                dereferenced = True
-                remaining_parameters = remaining_parameters[:-1]
         # Condition parameters (which may be `None`) to represent empty tuple
-        if first_parameter is None:
-            parameters = []
-        else:
-            parameters = [first_parameter] + list(remaining_parameters)
+        if params and params[0] is None:
+            params = params[1:]
+        dereferenced = bool(params and params[-1] == "^")
+        if dereferenced:
+            params = params[:-1]
 
         return FunctionCall(
             name=name,
-            parameters=parameters,
-            dereferenced=dereferenced
+            parameters=typing.cast(List[ParameterAssignment], list(params)),
+            dereferenced=dereferenced,
         )
 
     def __str__(self) -> str:
@@ -2890,16 +2897,6 @@ def __str__(self):
         return f"{variables} := {self.expression};"
 
 
-@dataclass
-@_rule_handler("method_statement", comments=True)
-class MethodStatement(Statement):
-    method: SymbolicVariable
-    meta: Optional[Meta] = meta_field()
-
-    def __str__(self):
-        return f"{self.method}();"
-
-
 @dataclass
 @_rule_handler("while_statement", comments=True)
 class WhileStatement(Statement):