Merge pull request #366 from ecmwf-ifs/naml-substitute-expr-string

String-based expression substitution and moar expression tests!

loki/expression/expr_visitors.py

@@ -24,8 +24,9 @@
 )
 
 __all__ = [
-    'FindExpressions', 'FindVariables', 'FindTypedSymbols', 'FindInlineCalls',
-    'FindLiterals', 'SubstituteExpressions', 'ExpressionFinder', 'AttachScopes'
+    'FindExpressions', 'FindVariables', 'FindTypedSymbols',
+    'FindInlineCalls', 'FindLiterals', 'SubstituteExpressions',
+    'SubstituteStringExpressions', 'ExpressionFinder', 'AttachScopes'
 ]
 
 
@@ -259,6 +260,34 @@ def visit_Import(self, o, **kwargs):
     visit_ProcedureDeclaration = visit_Import
 
 
+class SubstituteStringExpressions(SubstituteExpressions):
+    """
+    Extension to :any:`SubstituteExpressions` that allows symbol
+    substitution of pure string mappings via :any:`parse_expr`.
+
+    In addition to the input string mapping this requires a :any:`Scope`
+    (eg. :any:`Subroutine` or :any:`Module`) to parse the respective strings.
+
+    Parameters
+    ----------
+    expr_map : dict
+        String-to-string mapping of expressions to apply to the expression tree.
+    scope : :any:`Scope`
+        The scope to which symbol names inside the expression belong
+    invalidate_source : bool, optional
+        By default the :attr:`source` property of nodes is discarded
+        when rebuilding the node, setting this to `False` allows to
+        retain that information
+    """
+    def __init__(self, str_map, scope, invalidate_source=True):
+        from loki.expression.parser import parse_expr  # pylint: disable=import-outside-toplevel,cyclic-import
+        expr_map = {
+            parse_expr(k, scope=scope): parse_expr(v, scope=scope)
+            for k, v in str_map.items()
+        }
+        super().__init__(expr_map=expr_map, invalidate_source=invalidate_source)
+
+
 class AttachScopes(Visitor):
     """
     Scoping visitor that traverses the control flow tree and uses

loki/expression/tests/test_expr_visitors.py

@@ -0,0 +1,225 @@
+# (C) Copyright 2018- ECMWF.
+# This software is licensed under the terms of the Apache Licence Version 2.0
+# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+# In applying this licence, ECMWF does not waive the privileges and immunities
+# granted to it by virtue of its status as an intergovernmental organisation
+# nor does it submit to any jurisdiction.
+
+import pytest
+
+from loki import Sourcefile, Subroutine
+from loki.expression import (
+    symbols as sym, parse_expr, FindVariables, FindTypedSymbols,
+    SubstituteExpressions, SubstituteStringExpressions
+)
+from loki.frontend import available_frontends
+from loki.ir import nodes as ir, FindNodes
+
+
+@pytest.mark.parametrize('frontend', available_frontends())
+def test_expression_finder_retrieval_function(frontend, tmp_path):
+    """
+    Verify that expression finder visitors work as intended and remain
+    functional if re-used
+    """
+    fcode = """
+module some_mod
+    implicit none
+contains
+    function some_func() result(ret)
+        integer :: ret
+        ret = 1
+    end function some_func
+
+    subroutine other_routine
+        integer :: var, tmp
+        var = 5 + some_func()
+    end subroutine other_routine
+end module some_mod
+    """.strip()
+
+    source = Sourcefile.from_source(fcode, frontend=frontend, xmods=[tmp_path])
+
+    expected_ts = {'var', 'some_func'}
+    expected_vars = ('var',)
+
+    # Instantiate the first expression finder and make sure it works as expected
+    find_ts = FindTypedSymbols()
+    assert find_ts.visit(source['other_routine'].body) == expected_ts
+
+    # Verify that it works also on a repeated invocation
+    assert find_ts.visit(source['other_routine'].body) == expected_ts
+
+    # Instantiate the second expression finder and make sure it works as expected
+    find_vars = FindVariables(unique=False)
+    assert find_vars.visit(source['other_routine'].body) == expected_vars
+
+    # Make sure the first expression finder still works
+    assert find_ts.visit(source['other_routine'].body) == expected_ts
+
+
+@pytest.mark.parametrize('frontend', available_frontends())
+def test_find_variables(frontend, tmp_path):
+    """ Test that :any:`FindVariables` finds all symbol uses. """
+
+    fcode_external = """
+module external_mod
+implicit none
+contains
+subroutine rick(dave, never)
+  real(kind=8), intent(inout) :: dave, never
+end subroutine rick
+end module external_mod
+    """
+    fcode = """
+module test_mod
+  use external_mod, only: rick
+  implicit none
+
+  type my_type
+    real(kind=8) :: never
+    real(kind=8), pointer :: give_you(:)
+  end type my_type
+
+contains
+
+  subroutine test_routine(n, a, b, gonna)
+    integer, intent(in) :: n
+    real(kind=8), intent(inout) :: a, b(n)
+    type(my_type), intent(inout) :: gonna
+    integer :: i
+
+    associate(will=>gonna%never, up=>n)
+    do i=1, n
+      b(i) = b(i) + a
+    end do
+
+    call rick(will, never=gonna%give_you(up))
+    end associate
+  end subroutine test_routine
+end module test_mod
+    """
+    _ = Sourcefile.from_source(fcode_external, frontend=frontend, xmods=[tmp_path])
+    source = Sourcefile.from_source(fcode, frontend=frontend, xmods=[tmp_path])
+    routine = source['test_routine']
+
+    # Test unique=True|False using the spec
+    expected = ['n', 'a', 'gonna', 'i', 'b(n)']
+    spec_vars = FindVariables(unique=True).visit(routine.spec)
+    assert len(spec_vars) == 5
+    assert all(v in spec_vars for v in expected)
+
+    spec_vars = FindVariables(unique=False).visit(routine.spec)
+    assert len(spec_vars) == 6
+    assert all(v in spec_vars for v in expected)
+    assert len([v for v in spec_vars if v == 'n']) == 2  # two occurences of 'n'
+
+    # Test retrieval with associates and keyword arg calls
+    expected = [
+        'will', 'gonna', 'gonna%never', 'up', 'n', 'i', 'b(i)', 'a',
+        'rick', 'gonna%give_you(up)'
+    ]
+    body_vars = FindVariables(unique=True).visit(routine.body)
+    assert len(body_vars) == 10
+    assert all(v in body_vars for v in expected)
+
+
+@pytest.mark.parametrize('frontend', available_frontends())
+def test_substitute_expressions(frontend):
+    """ Test symbol replacement with :any:`Expression` symbols. """
+
+    fcode = """
+subroutine test_routine(n, a, b)
+  implicit none
+  integer, intent(in) :: n
+  real(kind=8), intent(inout) :: a, b(n)
+  real(kind=8) :: c(n)
+  integer :: i
+
+  associate(d => a)
+  do i=1, n
+    c(i) = b(i) + a
+  end do
+
+  call another_routine(n, a, c(:), a2=d)
+
+  end associate
+end subroutine test_routine
+"""
+    routine = Subroutine.from_source(fcode, frontend=frontend)
+
+    calls = FindNodes(ir.CallStatement).visit(routine.body)
+    assoc = FindNodes(ir.Associate).visit(routine.body)[0]
+    assert calls[0].arguments == ('n', 'a', 'c(:)')
+    assert calls[0].kwarguments == (('a2', 'd'),)
+
+    n = routine.variable_map['n']
+    i = routine.variable_map['i']
+    a = routine.variable_map['a']
+    b_i = parse_expr('b(i)', scope=routine)
+    c_r = parse_expr('c(:)', scope=routine)
+    d = parse_expr('d', scope=assoc)
+    expr_map = {
+        n: sym.Sum((n, sym.Product((-1, sym.Literal(1))))),
+        b_i: b_i.clone(dimensions=sym.Sum((i, sym.Literal(1)))),
+        c_r: c_r.clone(dimensions=sym.Range((sym.Literal(1), sym.Literal(2)))),
+        a: d,
+        d: a,
+    }
+    routine.body = SubstituteExpressions(expr_map).visit(routine.body)
+
+    loops = FindNodes(ir.Loop).visit(routine.body)
+    assert loops[0].bounds == '1:n-1'
+    assigns = FindNodes(ir.Assignment).visit(routine.body)
+    assert assigns[0].lhs == 'c(i)' and assigns[0].rhs == 'b(i+1) + d'
+    calls = FindNodes(ir.CallStatement).visit(routine.body)
+    assert calls[0].arguments == ('n - 1', 'd', 'c(1:2)')
+    assert calls[0].kwarguments == (('a2', 'a'),)
+
+
+@pytest.mark.parametrize('frontend', available_frontends())
+def test_substitute_string_expressions(frontend):
+    """ Test symbol replacement with symbol string mappping. """
+
+    fcode = """
+subroutine test_routine(n, a, b)
+  implicit none
+  integer, intent(in) :: n
+  real(kind=8), intent(inout) :: a, b(n)
+  real(kind=8) :: c(n)
+  integer :: i
+
+  associate(d => a)
+  do i=1, n
+    c(i) = b(i) + a
+  end do
+
+  call another_routine(n, a, c(:), a2=d)
+
+  end associate
+end subroutine test_routine
+"""
+    routine = Subroutine.from_source(fcode, frontend=frontend)
+
+    calls = FindNodes(ir.CallStatement).visit(routine.body)
+    assoc = FindNodes(ir.Associate).visit(routine.body)[0]
+    assert calls[0].arguments == ('n', 'a', 'c(:)')
+    assert calls[0].kwarguments == (('a2', 'd'),)
+
+    expr_map = {
+        'n': 'n - 1',
+        'b(i)': 'b(i+1)',
+        'c(:)': 'c(1:2)',
+        'a': 'd',
+        'd': 'a',
+    }
+    # Note that we need to use the associate block here, as it defines 'd'
+    routine.body = SubstituteStringExpressions(expr_map, scope=assoc).visit(routine.body)
+
+    loops = FindNodes(ir.Loop).visit(routine.body)
+    assert loops[0].bounds == '1:n-1'
+    assigns = FindNodes(ir.Assignment).visit(routine.body)
+    assert assigns[0].lhs == 'c(i)' and assigns[0].rhs == 'b(i+1) + d'
+    calls = FindNodes(ir.CallStatement).visit(routine.body)
+    assert calls[0].arguments == ('n - 1', 'd', 'c(1:2)')
+    assert calls[0].kwarguments == (('a2', 'a'),)