Improve SCode modifiers in getModelInstance (#9187)

- Use `$value` for binding expressions in SCode modifiers to allow
  mixing it with submodifiers, and change the structure to be more
  compact.

Author: perost

OMCompiler/Compiler/Script/NFApi.mo

@@ -937,7 +937,7 @@ algorithm
 
   json := JSON.addPair("restriction",
     JSON.makeString(Restriction.toString(InstNode.restriction(node))), json);
-  json := dumpJSONMod(SCodeUtil.elementMod(def), json);
+  json := dumpJSONSCodeMod(SCodeUtil.elementMod(def), json);
 
   if not listEmpty(exts) then
     json := JSON.addPair("extends", dumpJSONExtends(exts), json);
@@ -986,7 +986,7 @@ algorithm
     ext_def := InstNode.extendsDefinition(node);
 
     ext_json := JSON.emptyObject();
-    ext_json := dumpJSONMod(SCodeUtil.elementMod(ext_def), ext_json);
+    ext_json := dumpJSONSCodeMod(SCodeUtil.elementMod(ext_def), ext_json);
     ext_json := dumpJSONCommentOpt(SCodeUtil.getElementComment(ext_def), node, ext_json);
     ext_json := JSON.addPair("baseClass", dumpJSONInstanceTree(ext, root = false), ext_json);
 
@@ -1042,10 +1042,7 @@ algorithm
             dumpJSONDims(elem.attributes.arrayDims, Type.arrayDims(comp.ty)), json);
         end if;
 
-        j := dumpJSONMod(elem.modifications, JSON.makeNull());
-        if not JSON.isNull(j) then
-          json := JSON.addPair("modifiers", j, json);
-        end if;
+        json := dumpJSONSCodeMod(elem.modifications, json);
 
         //if not Type.isComplex(comp.ty) then
         //  json := dumpJSONBuiltinClassComponents(comp.classInst, elem.modifications, json);
@@ -1461,35 +1458,47 @@ algorithm
   end for;
 end dumpJSONReplaceableElements;
 
-function dumpJSONMod
+function dumpJSONSCodeMod
   input SCode.Mod mod;
   input output JSON json;
 protected
   JSON j;
+algorithm
+  j := dumpJSONSCodeMod_impl(mod);
+
+  if not JSON.isNull(j) then
+    json := JSON.addPair("modifiers", j, json);
+  end if;
+end dumpJSONSCodeMod;
+
+function dumpJSONSCodeMod_impl
+  input SCode.Mod mod;
+  output JSON json = JSON.makeNull();
+protected
+  JSON binding_json;
 algorithm
   () := match mod
     case SCode.Mod.MOD()
       algorithm
-        if isSome(mod.binding) then
-          json := JSON.addPair("value",
-            JSON.makeString(Dump.printExpStr(Util.getOption(mod.binding))), json);
-        end if;
-
-        if not listEmpty(mod.subModLst) then
-          j := JSON.emptyObject();
+        for m in mod.subModLst loop
+          json := JSON.addPair(m.ident, dumpJSONSCodeMod_impl(m.mod), json);
+        end for;
 
-          for sm in mod.subModLst loop
-            j := JSON.addPair(sm.ident, dumpJSONMod(sm.mod, JSON.makeNull()), j);
-          end for;
+        if isSome(mod.binding) then
+          binding_json := JSON.makeString(Dump.printExpStr(Util.getOption(mod.binding)));
 
-          json := JSON.addPair("modifiers", j, json);
+          if JSON.isNull(json) then
+            json := binding_json;
+          else
+            json := JSON.addPair("$value", binding_json, json);
+          end if;
         end if;
       then
         ();
 
     else ();
   end match;
-end dumpJSONMod;
+end dumpJSONSCodeMod_impl;
 
   annotation(__OpenModelica_Interface="backend");
 end NFApi;

doc/instanceAPI/getModelInstance.schema.json

@@ -12,9 +12,9 @@
       "description": "The kind of class",
       "type": "string"
     },
-    "modifier": {
+    "modifiers": {
       "description": "Modifier from the SCode",
-      "type": "#/definitions/modifier"
+      "type": "#/definitions/scodeModifier"
     },
     "comment": {
       "$ref": "#/definitions/comment"
@@ -125,7 +125,7 @@
       "properties": {
         "modifiers": {
           "description": "SCode modifier on the extends clause",
-          "type": "#/definitions/modifier"
+          "type": "#/definitions/scodeModifier"
         },
         "annotation": {
           "description": "Annotation on the extends clause",
@@ -187,7 +187,7 @@
             },
             "modifiers": {
               "description": "Modifier from the SCode",
-              "type": "#/definitions/modifier"
+              "type": "#/definitions/scodeModifier"
             },
             "value": {
               "description": "The component's binding equation",
@@ -261,21 +261,29 @@
       },
       "required": ["binding"]
     },
-    "modifier": {
-      "description": "A modifier",
-      "type": "object",
-      "properties": {
-        "value": {
-          "type": "string"
+    "scodeModifier": {
+      "description": "An SCode modifier",
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "The string representation of the binding equation"
         },
-        "modifiers": {
-          "type": "array",
-          "items": {
-            "type": "#/definitions/modifier"
-          }
+        {
+          "type": "object",
+          "description": "A modifier with submodifiers",
+          "properties": {
+            "$value": {
+              "type": "string",
+              "description": "The string representation of the binding equation"
+            }
+          },
+          "additionalProperties": {
+            "$ref": "#/definitions/scodeModifier"
+          },
+          "required": [],
+          "minProperties": 1
         }
-      },
-      "required": []
+      ]
     }
   }
 }

testsuite/openmodelica/instance-API/GetModelInstanceAttributes1.mos

@@ -24,9 +24,7 @@ getModelInstance(M, prettyPrint = true);
 //     {
 //       \"name\": \"pi\",
 //       \"type\": \"Real\",
-//       \"modifiers\": {
-//         \"value\": \"3\"
-//       },
+//       \"modifiers\": \"3\",
 //       \"value\": {
 //         \"binding\": 3
 //       },
@@ -38,12 +36,8 @@ getModelInstance(M, prettyPrint = true);
 //       \"name\": \"deg\",
 //       \"type\": \"Real\",
 //       \"modifiers\": {
-//         \"value\": \"2\",
-//         \"modifiers\": {
-//           \"start\": {
-//             \"value\": \"pi\"
-//           }
-//         }
+//         \"start\": \"pi\",
+//         \"$value\": \"2\"
 //       },
 //       \"value\": {
 //         \"binding\": 2

testsuite/openmodelica/instance-API/GetModelInstanceExp1.mos

@@ -28,9 +28,7 @@ getModelInstance(M, prettyPrint = true);
 //     {
 //       \"name\": \"x\",
 //       \"type\": \"Real\",
-//       \"modifiers\": {
-//         \"value\": \"2.0\"
-//       },
+//       \"modifiers\": \"2.0\",
 //       \"value\": {
 //         \"binding\": 2
 //       },
@@ -55,9 +53,7 @@ getModelInstance(M, prettyPrint = true);
 //                 \"3\"
 //               ]
 //             },
-//             \"modifiers\": {
-//               \"value\": \"{1, 2, 3}\"
-//             },
+//             \"modifiers\": \"{1, 2, 3}\",
 //             \"value\": {
 //               \"binding\": [
 //                 1,
@@ -78,9 +74,7 @@ getModelInstance(M, prettyPrint = true);
 //     {
 //       \"name\": \"y\",
 //       \"type\": \"Real\",
-//       \"modifiers\": {
-//         \"value\": \"a.x[1]\"
-//       },
+//       \"modifiers\": \"a.x[1]\",
 //       \"value\": {
 //         \"binding\": {
 //           \"$kind\": \"cref\",

testsuite/openmodelica/instance-API/GetModelInstanceExtends1.mos

@@ -29,9 +29,7 @@ getModelInstance(M, prettyPrint=true);
 //   \"extends\": [
 //     {
 //       \"modifiers\": {
-//         \"x\": {
-//           \"value\": \"1\"
-//         }
+//         \"x\": \"1\"
 //       },
 //       \"annotation\": {
 //         \"IconMap\": {