Use the choice comment only for display (#12789)

#12756

Do not add the comment in the modification in the source code.

Author: adeas31

OMEdit/OMEditLIB/Element/ElementProperties.cpp

@@ -684,7 +684,7 @@ void Parameter::createValueWidget()
   }
   QString constrainedByClassName = QStringLiteral("$Any");
   QString replaceable = "", replaceableText = "", replaceableChoice = "", parentClassName = "", restriction = "", elementName = "";
-  QStringList enumerationLiterals, enumerationLiteralsDisplay, replaceableChoices, choices;
+  QStringList enumerationLiterals, enumerationLiteralsDisplay, replaceableChoices, choices, choicesComment;
 
   switch (mValueType) {
     case Parameter::Boolean:
@@ -740,7 +740,8 @@ void Parameter::createValueWidget()
           }
         }
         if (mpModelInstanceElement->getAnnotation()->getChoices()) {
-          choices = mpModelInstanceElement->getAnnotation()->getChoices()->getChoicesStringList();
+          choices = mpModelInstanceElement->getAnnotation()->getChoices()->getChoicesValueStringList();
+          choicesComment = mpModelInstanceElement->getAnnotation()->getChoices()->getChoicesCommentStringList();
         }
         parentClassName = mpElementParameters->getElementParentClassName();
         if (mpModelInstanceElement->getModel()) {
@@ -772,7 +773,7 @@ void Parameter::createValueWidget()
         QString choice = choices[i];
         QString comment;
         if (MainWindow::instance()->isNewApi()) {
-          comment = choice;
+          comment = i < choicesComment.size() ? choicesComment[i] : choice;
         } else {
           comment = StringHandler::removeFirstLastQuotes(FlatModelica::Parser::getModelicaComment(choice));
         }

OMEdit/OMEditLIB/Modeling/Model.cpp

@@ -761,7 +761,7 @@ namespace ModelInstance
     }
   }
 
-  QString Modifier::toString(bool skipTopLevel) const
+  QString Modifier::toString(bool skipTopLevel, bool includeComment) const
   {
     if (mpElement) {
       return mpElement->toString(skipTopLevel);
@@ -782,7 +782,7 @@ namespace ModelInstance
       if (!mValue.isEmpty()) {
         value.append(mName.isEmpty() ? mValue : " = " % mValue);
       }
-      if (!mComment.isEmpty()) {
+      if (includeComment && !mComment.isEmpty()) {
         value.append(" \"" % mComment % "\"");
       }
 
@@ -1763,7 +1763,7 @@ namespace ModelInstance
     }
   }
 
-  QStringList Choices::getChoicesStringList() const
+  QStringList Choices::getChoicesValueStringList() const
   {
     QStringList choices;
     foreach (auto *pChoice, mChoices) {
@@ -1772,6 +1772,15 @@ namespace ModelInstance
     return choices;
   }
 
+  QStringList Choices::getChoicesCommentStringList() const
+  {
+    QStringList choices;
+    foreach (auto *pChoice, mChoices) {
+      choices.append(pChoice->toString(false, true));
+    }
+    return choices;
+  }
+
   Element::Element(Model *pParentModel)
   {
     mpParentModel = pParentModel;

OMEdit/OMEditLIB/Modeling/Model.h

@@ -365,7 +365,8 @@ namespace ModelInstance
     bool isCheckBox() const {return mCheckBox;}
     bool isDymolaCheckBox() const {return mDymolaCheckBox;}
     const QList<Modifier*> &getChoices() const {return mChoices;}
-    QStringList getChoicesStringList() const;
+    QStringList getChoicesValueStringList() const;
+    QStringList getChoicesCommentStringList() const;
   private:
     Model *mpParentModel;
     BooleanAnnotation mCheckBox;
@@ -468,7 +469,7 @@ namespace ModelInstance
     const QString &getType() const {return mType;}
     QString getValueWithoutQuotes() const {return StringHandler::removeFirstLastQuotes(getValue());}
     bool isValueDefined() const {return mValueDefined;}
-    QString toString(bool skipTopLevel = false) const;
+    QString toString(bool skipTopLevel = false, bool includeComment = false) const;
     Modifier *getModifier(const QString &modifier) const;
     QPair<QString, bool> getModifierValue(const QString &modifier) const;
     bool hasModifier(const QString &modifier) const;