Add choices comments to the instance API (#12786)

Author: perost

OMCompiler/Compiler/Script/NFApi.mo

@@ -2158,6 +2158,10 @@ algorithm
           json := JSON.addPair("each", JSON.makeBoolean(true), json);
         end if;
 
+        if isChoices and isSome(mod.comment) then
+          json := JSON.addPair("comment", JSON.makeString(Util.getOption(mod.comment)), json);
+        end if;
+
         if isSome(mod.binding) then
           binding_json := JSON.makeString(Dump.printExpStr(Util.getOption(mod.binding)));
 

OMEdit/OMEditLIB/Modeling/Model.cpp

@@ -733,6 +733,8 @@ namespace ModelInstance
           mFinal = true;
         } else if (modifierKey.compare(QStringLiteral("each")) == 0) {
           mEach = true;
+        } else if (modifierKey.compare(QStringLiteral("comment")) == 0) {
+          mComment = modifierValue.toString();
         } else if (modifierKey.compare(QStringLiteral("$value")) == 0) {
           if (modifierValue.isObject()) {
             QJsonObject valueObject = modifierValue.toObject();
@@ -777,15 +779,14 @@ namespace ModelInstance
       if (!subModifiers.isEmpty()) {
         value.append("(" % subModifiers.join(", ") % ")");
       }
-      if (mValue.isEmpty()) {
-        if (value.compare(mName) != 0) {
-          return value;
-        } else {
-          return "";
-        }
-      } else {
-        return value.append(mName.isEmpty() ? mValue : " = " % mValue);
+      if (!mValue.isEmpty()) {
+        value.append(mName.isEmpty() ? mValue : " = " % mValue);
       }
+      if (!mComment.isEmpty()) {
+        value.append(" \"" % mComment % "\"");
+      }
+
+      return value.compare(mName) == 0 ? "" : value;
     }
   }
 

OMEdit/OMEditLIB/Modeling/Model.h

@@ -487,6 +487,7 @@ namespace ModelInstance
     bool mEach = false;
     QString mValue;
     bool mValueDefined = false;
+    QString mComment;
     Element *mpElement = 0;
     QList<Modifier*> mModifiers;
 

testsuite/openmodelica/instance-API/GetModelInstanceChoices1.mos

@@ -40,9 +40,18 @@ getErrorString();
 //       \"annotation\": {
 //         \"choices\": {
 //           \"choice\": [
-//             \"1.0\",
-//             \"2.0\",
-//             \"3.0\"
+//             {
+//               \"comment\": \"A\",
+//               \"$value\": \"1.0\"
+//             },
+//             {
+//               \"comment\": \"B\",
+//               \"$value\": \"2.0\"
+//             },
+//             {
+//               \"comment\": \"C\",
+//               \"$value\": \"3.0\"
+//             }
 //           ],
 //           \"checkBox\": true
 //         }