Improve constraining modifiers on classes (#8298)

- Change the merging of modifiers on classes so that the constraining
  class from the replaced class has lower priority than the constraining
  class on the replacing class.

Author: perost

OMCompiler/Compiler/NFFrontEnd/NFClass.mo

@@ -93,6 +93,7 @@ constant Prefixes DEFAULT_PREFIXES = Prefixes.PREFIXES(
   record PARTIAL_CLASS
     ClassTree elements;
     Modifier modifier;
+    Modifier ccMod;
     Prefixes prefixes;
   end PARTIAL_CLASS;
 
@@ -107,13 +108,15 @@ constant Prefixes DEFAULT_PREFIXES = Prefixes.PREFIXES(
   record EXPANDED_CLASS
     ClassTree elements;
     Modifier modifier;
+    Modifier ccMod;
     Prefixes prefixes;
     Restriction restriction;
   end EXPANDED_CLASS;
 
   record EXPANDED_DERIVED
     InstNode baseClass;
     Modifier modifier;
+    Modifier ccMod;
     array<Dimension> dims;
     Prefixes prefixes;
     Component.Attributes attributes;
@@ -154,7 +157,7 @@ constant Prefixes DEFAULT_PREFIXES = Prefixes.PREFIXES(
     ClassTree tree;
   algorithm
     tree := ClassTree.fromSCode(elements, isClassExtends, scope);
-    cls := PARTIAL_CLASS(tree, Modifier.NOMOD(), prefixes);
+    cls := PARTIAL_CLASS(tree, Modifier.NOMOD(), Modifier.NOMOD(), prefixes);
   end fromSCode;
 
   function fromEnumeration
@@ -187,7 +190,7 @@ constant Prefixes DEFAULT_PREFIXES = Prefixes.PREFIXES(
   algorithm
     cls := match cls
       case PARTIAL_CLASS()
-        then EXPANDED_CLASS(cls.elements, cls.modifier, cls.prefixes, Restriction.UNKNOWN());
+        then EXPANDED_CLASS(cls.elements, cls.modifier, cls.ccMod, cls.prefixes, Restriction.UNKNOWN());
     end match;
   end initExpandedClass;
 
@@ -331,6 +334,18 @@ constant Prefixes DEFAULT_PREFIXES = Prefixes.PREFIXES(
     end match;
   end getModifier;
 
+  function getCCModifier
+    input Class cls;
+    output Modifier modifier;
+  algorithm
+    modifier := match cls
+      case PARTIAL_CLASS() then cls.ccMod;
+      case EXPANDED_CLASS() then cls.ccMod;
+      case EXPANDED_DERIVED() then cls.ccMod;
+      else Modifier.NOMOD();
+    end match;
+  end getCCModifier;
+
   function setModifier
     input Modifier modifier;
     input output Class cls;

OMCompiler/Compiler/NFFrontEnd/NFInst.mo

@@ -334,7 +334,7 @@ algorithm
       then
         Class.fromEnumeration(cdef.enumLst, ty, prefs, scope);
 
-    else Class.PARTIAL_CLASS(NFClassTree.EMPTY, Modifier.NOMOD(), prefs);
+    else Class.PARTIAL_CLASS(NFClassTree.EMPTY, Modifier.NOMOD(), Modifier.NOMOD(), prefs);
   end match;
 end partialInstClass2;
 
@@ -418,7 +418,7 @@ function expandClassParts
 protected
   Class cls;
   ClassTree cls_tree;
-  Modifier mod;
+  Modifier mod, cc_mod;
   InstNode builtin_ext;
   Class.Prefixes prefs;
   Restriction res;
@@ -428,7 +428,7 @@ algorithm
   cls := Class.initExpandedClass(cls);
   node := InstNode.updateClass(cls, node);
 
-  Class.EXPANDED_CLASS(elements = cls_tree, modifier = mod, prefixes = prefs) := cls;
+  Class.EXPANDED_CLASS(elements = cls_tree, modifier = mod, ccMod = cc_mod, prefixes = prefs) := cls;
   builtin_ext := ClassTree.mapFoldExtends(cls_tree, expandExtends, InstNode.EMPTY_NODE());
 
   if InstNode.name(builtin_ext) == "ExternalObject" then
@@ -440,7 +440,7 @@ algorithm
 
     cls_tree := ClassTree.expand(cls_tree);
     res := Restriction.fromSCode(SCodeUtil.getClassRestriction(def));
-    cls := Class.EXPANDED_CLASS(cls_tree, mod, prefs, res);
+    cls := Class.EXPANDED_CLASS(cls_tree, mod, cc_mod, prefs, res);
     node := InstNode.updateClass(cls, node);
   end if;
 end expandClassParts;
@@ -683,7 +683,7 @@ protected
   SCode.Attributes sattrs;
   Component.Attributes attrs;
   list<Dimension> dims;
-  Modifier mod;
+  Modifier mod, cc_mod;
   Restriction res;
 algorithm
   SCode.DERIVED(typeSpec = ty, attributes = sattrs) := definition;
@@ -713,9 +713,10 @@ algorithm
   attrs := instDerivedAttributes(sattrs);
   dims := list(Dimension.RAW_DIM(d, InstNode.parent(node)) for d in AbsynUtil.typeSpecDimensions(ty));
   mod := Class.getModifier(cls);
+  cc_mod := Class.getCCModifier(cls);
 
   res := Restriction.fromSCode(SCodeUtil.getClassRestriction(element));
-  cls := Class.EXPANDED_DERIVED(ext_node, mod, listArray(dims), prefs, attrs, res);
+  cls := Class.EXPANDED_DERIVED(ext_node, mod, cc_mod, listArray(dims), prefs, attrs, res);
   node := InstNode.updateClass(cls, node);
 end expandClassDerived;
 
@@ -809,6 +810,7 @@ algorithm
         // Fetch modification on the class definition (for class extends).
         mod := instElementModifier(InstNode.definition(node), node, par);
         mod := Modifier.propagate(mod, node, par);
+        mod := Modifier.merge(mod, cls.ccMod);
         // Merge with any outer modifications.
         outer_mod := Modifier.propagate(cls.modifier, node, par);
         outer_mod := Modifier.merge(outerMod, outer_mod);
@@ -857,6 +859,7 @@ algorithm
         // Merge outer modifiers and attributes.
         mod := instElementModifier(InstNode.definition(node), node, InstNode.rootParent(node));
         mod := Modifier.propagate(mod, node, par);
+        mod := Modifier.merge(mod, cls.ccMod);
         outer_mod := Modifier.propagate(cls.modifier, node, par);
         outer_mod := Modifier.merge(outerMod, outer_mod);
         mod := Modifier.merge(outer_mod, mod);
@@ -1314,7 +1317,7 @@ algorithm
   rdcl_cls := InstNode.getClass(redeclareNode);
 
   mod := Class.getModifier(rdcl_cls);
-  mod := Modifier.merge(mod, constrainingMod);
+  //mod := Modifier.merge(mod, constrainingMod);
   mod := Modifier.merge(outerMod, mod);
 
   prefs := mergeRedeclaredClassPrefixes(Class.getPrefixes(orig_cls),
@@ -1346,6 +1349,7 @@ algorithm
           orig_node := InstNode.setNodeType(node_ty, orig_node);
           rdcl_cls.elements := ClassTree.setClassExtends(orig_node, rdcl_cls.elements);
           rdcl_cls.modifier := mod;
+          rdcl_cls.ccMod := constrainingMod;
           rdcl_cls.prefixes := prefs;
         then
           rdcl_cls;
@@ -1365,6 +1369,7 @@ algorithm
         algorithm
           rdcl_cls.prefixes := prefs;
           rdcl_cls.modifier := mod;
+          rdcl_cls.ccMod := constrainingMod;
         then
           rdcl_cls;
 

testsuite/flattening/modelica/scodeinst/ConstrainingClassFunc2.mo

@@ -0,0 +1,31 @@
+// name: ConstrainingClassFunc2
+// keywords:
+// status: correct
+// cflags: -d=newInst
+//
+
+function f
+  input Real x;
+  output Real y;
+end f;
+
+model A
+  replaceable function f2 = f(x = 0);
+
+  Real x = f2();
+end A;
+
+model ConstrainingClassFunc2
+  A a(redeclare function f2 = f(x = 1));
+end ConstrainingClassFunc2;
+
+// Result:
+// function ConstrainingClassFunc2.a.f2
+//   input Real x = 1.0;
+//   output Real y;
+// end ConstrainingClassFunc2.a.f2;
+//
+// class ConstrainingClassFunc2
+//   Real a.x = ConstrainingClassFunc2.a.f2(1.0);
+// end ConstrainingClassFunc2;
+// endResult

testsuite/flattening/modelica/scodeinst/Makefile

@@ -306,6 +306,7 @@ ConstrainingClass1.mo \
 ConstrainingClass2.mo \
 ConstrainingClass3.mo \
 ConstrainingClassFunc1.mo \
+ConstrainingClassFunc2.mo \
 DimCyclic1.mo \
 DimCyclic2.mo \
 DimCyclic3.mo \