Use the redeclare class instead of the component type (#10375)

adeas31 · web-flow · commit ac82ac2ddd32 · 2023-03-10T12:13:39.000+01:00
* Use the redeclare class instead of the component type

Move the functions related to parser to FlatModelica::Parser
Parse the element redeclaration to get the element type

* Read the redeclare class type from JSON

Use both JSON and the parser to get the element type
diff --git a/OMEdit/OMEditLIB/CMakeLists.txt b/OMEdit/OMEditLIB/CMakeLists.txt
@@ -127,6 +127,7 @@ set(OMEDITLIB_SOURCES Util/Helper.cpp
                       Util/NetworkAccessManager.cpp
                       FlatModelica/Expression.cpp
                       FlatModelica/ExpressionFuncs.cpp
+                      FlatModelica/Parser.cpp
                       Animation/OpenGLWidget.cpp
                       Animation/AbstractAnimationWindow.cpp
                       Animation/ViewerWidget.cpp
@@ -259,6 +260,7 @@ set(OMEDITLIB_HEADERS Util/Helper.h
                       Util/NetworkAccessManager.h
                       FlatModelica/Expression.h
                       FlatModelica/ExpressionFuncs.h
+                      FlatModelica/Parser.h
                       Animation/OpenGLWidget.h
                       Animation/AbstractAnimationWindow.h
                       Animation/ViewerWidget.h
diff --git a/OMEdit/OMEditLIB/Element/ElementProperties.cpp b/OMEdit/OMEditLIB/Element/ElementProperties.cpp
@@ -38,6 +38,7 @@
 #include "Modeling/Commands.h"
 #include "Options/OptionsDialog.h"
 #include "OMPlot.h"
+#include "FlatModelica/Parser.h"
 
 #include <QApplication>
 #include <QMenu>
@@ -200,11 +201,11 @@ Parameter::Parameter(ModelInstance::Component *pComponent, ElementParameters *pE
     // For now we only handle replaceable component. Enable the line below once we start handling the replaceable class.
     //mValueType = Parameter::ReplaceableClass;
     if (mpModelInstanceComponent->getModel()) {
-      mpModifyReplaceableButton = new QToolButton;
-      mpModifyReplaceableButton->setIcon( QIcon(":/Resources/icons/edit-icon.svg"));
-      mpModifyReplaceableButton->setToolTip(tr("Edit"));
-      mpModifyReplaceableButton->setAutoRaise(true);
-      connect(mpModifyReplaceableButton, SIGNAL(clicked()), SLOT(modifyReplaceableButtonClicked()));
+      mpEditRedeclareClassButton = new QToolButton;
+      mpEditRedeclareClassButton->setIcon( QIcon(":/Resources/icons/edit-icon.svg"));
+      mpEditRedeclareClassButton->setToolTip(tr("Edit"));
+      mpEditRedeclareClassButton->setAutoRaise(true);
+      connect(mpEditRedeclareClassButton, SIGNAL(clicked()), SLOT(editRedeclareClassButtonClicked()));
     }
   } else if (!mpModelInstanceComponent->getAnnotation()->getChoices().getChoices().isEmpty()) {
     mValueType = Parameter::Choices;
@@ -515,8 +516,8 @@ void Parameter::setEnabled(bool enable)
   if (enable) {
     enableDisableUnitComboBox(getValue());
   }
-  if (mpModifyReplaceableButton) {
-    mpModifyReplaceableButton->setEnabled(enable);
+  if (mpEditRedeclareClassButton) {
+    mpEditRedeclareClassButton->setEnabled(enable);
   }
 }
 
@@ -624,7 +625,7 @@ void Parameter::createValueWidget()
         if (MainWindow::instance()->isNewApi()) {
           comment = choice;
         } else {
-          comment = StringHandler::getModelicaComment(choice);
+          comment = StringHandler::removeFirstLastQuotes(FlatModelica::Parser::getModelicaComment(choice));
         }
         mpValueComboBox->addItem(comment, choice);
       }
@@ -717,22 +718,50 @@ void Parameter::updateValueBinding(const FlatModelica::Expression expression)
   }
 }
 
-void Parameter::modifyReplaceableButtonClicked()
+/*!
+ * \brief Parameter::editRedeclareClassButtonClicked
+ * Slot activate when mpEditRedeclareClassButton clicked signal is raised.
+ * Opens ElementParameters dialog for the redeclare class.
+ */
+void Parameter::editRedeclareClassButtonClicked()
 {
-//  QString className = mpModelInstanceComponent->getType();
-//  qDebug() << className;
-  MainWindow::instance()->getProgressBar()->setRange(0, 0);
-  MainWindow::instance()->showProgressBar();
-  ElementParameters *pElementParameters = new ElementParameters(mpModelInstanceComponent, mpElementParameters->getGraphicsView(),
-                                                                mpElementParameters->isInherited(), true, mpElementParameters);
-  MainWindow::instance()->hideProgressBar();
-  MainWindow::instance()->getStatusBar()->clearMessage();
-  if (pElementParameters->exec() == QDialog::Accepted) {
-    if (!pElementParameters->getModification().isEmpty()) {
-      setValueWidget(pElementParameters->getModification(), false, mUnit, true);
+  QString type;
+  if (mpValueComboBox->currentIndex() == 0) {
+    type = mpModelInstanceComponent->getType();
+  } else {
+    type = mpModelInstanceComponent->getAnnotation()->getChoices().getType(mpValueComboBox->currentIndex() - 1);
+  }
+
+  // if type is empty then try to parse the Modelica code of redeclare to get the type
+  if (type.isEmpty()) {
+    type = FlatModelica::Parser::getTypeFromElementRedeclaration(mpValueComboBox->lineEdit()->text());
+  }
+
+  if (type.isEmpty()) {
+    QMessageBox::critical(MainWindow::instance(), QString("%1 - %2").arg(Helper::applicationName, Helper::error),
+                          tr("Unable to find the redeclare class %1.").arg(type), Helper::ok);
+  } else {
+    MainWindow::instance()->getProgressBar()->setRange(0, 0);
+    MainWindow::instance()->showProgressBar();
+    ModelInstance::Model *pCurrentModel = mpModelInstanceComponent->getModel();
+    const QJsonObject newModelJSON = MainWindow::instance()->getOMCProxy()->getModelInstance(type);
+    if (!newModelJSON.isEmpty()) {
+      ModelInstance::Model *pNewModel = new ModelInstance::Model(newModelJSON);
+      mpModelInstanceComponent->setModel(pNewModel);
+      ElementParameters *pElementParameters = new ElementParameters(mpModelInstanceComponent, mpElementParameters->getGraphicsView(), mpElementParameters->isInherited(), true, mpElementParameters);
+      MainWindow::instance()->hideProgressBar();
+      MainWindow::instance()->getStatusBar()->clearMessage();
+      if (pElementParameters->exec() == QDialog::Accepted) {
+        if (!pElementParameters->getModification().isEmpty()) {
+          setValueWidget(pElementParameters->getModification(), false, mUnit, true);
+        }
+      }
+      pElementParameters->deleteLater();
+      // reset the actual model of the element
+      mpModelInstanceComponent->setModel(pCurrentModel);
+      delete pNewModel;
     }
   }
-  pElementParameters->deleteLater();
 }
 
 /*!
@@ -1201,8 +1230,8 @@ void ElementParameters::setUpDialog()
           }
           pGroupBoxGridLayout->addWidget(pParameter->getValueWidget(), layoutIndex, columnIndex++);
 
-          if (pParameter->getModifyReplaceableButton()) {
-            pGroupBoxGridLayout->addWidget(pParameter->getModifyReplaceableButton(), layoutIndex, columnIndex++);
+          if (pParameter->getEditRedeclareClassButton()) {
+            pGroupBoxGridLayout->addWidget(pParameter->getEditRedeclareClassButton(), layoutIndex, columnIndex++);
           } else {
             pGroupBoxGridLayout->addItem(new QSpacerItem(1, 1), layoutIndex, columnIndex++);
           }
@@ -1716,12 +1745,6 @@ void ElementParametersOld::setUpDialog()
           }
           pGroupBoxGridLayout->addWidget(pParameter->getValueWidget(), layoutIndex, columnIndex++);
 
-          if (pParameter->getModifyReplaceableButton()) {
-            pGroupBoxGridLayout->addWidget(pParameter->getModifyReplaceableButton(), layoutIndex, columnIndex++);
-          } else {
-            pGroupBoxGridLayout->addItem(new QSpacerItem(1, 1), layoutIndex, columnIndex++);
-          }
-
           if (pParameter->getLoadSelectorFilter().compare("-") != 0 || pParameter->getLoadSelectorCaption().compare("-") != 0 ||
               pParameter->getSaveSelectorFilter().compare("-") != 0 || pParameter->getSaveSelectorCaption().compare("-") != 0) {
             pGroupBoxGridLayout->addWidget(pParameter->getFileSelectorButton(), layoutIndex, columnIndex++);
diff --git a/OMEdit/OMEditLIB/Element/ElementProperties.h b/OMEdit/OMEditLIB/Element/ElementProperties.h
@@ -81,7 +81,7 @@ class Parameter : public QObject
   QWidget* getValueWidget();
   bool isValueModified();
   QString getValue();
-  QToolButton *getModifyReplaceableButton() const {return mpModifyReplaceableButton;}
+  QToolButton *getEditRedeclareClassButton() const {return mpEditRedeclareClassButton;}
   QToolButton* getFileSelectorButton() {return mpFileSelectorButton;}
   void setLoadSelectorFilter(QString loadSelectorFilter) {mLoadSelectorFilter = loadSelectorFilter;}
   QString getLoadSelectorFilter() {return mLoadSelectorFilter;}
@@ -127,7 +127,7 @@ class Parameter : public QObject
   QComboBox *mpValueComboBox;
   QLineEdit *mpValueTextBox;
   QCheckBox *mpValueCheckBox;
-  QToolButton *mpModifyReplaceableButton = 0;
+  QToolButton *mpEditRedeclareClassButton = 0;
   QToolButton *mpFileSelectorButton;
   QString mUnit;
   QString mDisplayUnit;
@@ -139,7 +139,7 @@ class Parameter : public QObject
   void enableDisableUnitComboBox(const QString &value);
   void updateValueBinding(const FlatModelica::Expression expression);
 public slots:
-  void modifyReplaceableButtonClicked();
+  void editRedeclareClassButtonClicked();
   void fileSelectorButtonClicked();
   void unitComboBoxChanged(int index);
   void valueComboBoxChanged(int index);
diff --git a/OMEdit/OMEditLIB/FlatModelica/Parser.cpp b/OMEdit/OMEditLIB/FlatModelica/Parser.cpp
@@ -0,0 +1,88 @@
+/*
+ * This file is part of OpenModelica.
+ *
+ * Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
+ * c/o Linköpings universitet, Department of Computer and Information Science,
+ * SE-58183 Linköping, Sweden.
+ *
+ * All rights reserved.
+ *
+ * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
+ * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
+ * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE
+ * OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
+ *
+ * The OpenModelica software and the Open Source Modelica
+ * Consortium (OSMC) Public License (OSMC-PL) are obtained
+ * from OSMC, either from the above address,
+ * from the URLs: http://www.ida.liu.se/projects/OpenModelica or
+ * http://www.openmodelica.org, and in the OpenModelica distribution.
+ * GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
+ *
+ * This program is distributed WITHOUT ANY WARRANTY; without
+ * even the implied warranty of  MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
+ * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
+ *
+ * See the full OSMC Public License conditions for more details.
+ *
+ */
+/*
+ * @author Adeel Asghar <adeel.asghar@liu.se>
+ */
+
+#define ANTLR4CPP_STATIC
+#include "antlr4-runtime.h"
+#include "modelicaLexer.h"
+#include "modelicaParser.h"
+#include "modelicaBaseListener.h"
+
+#include "Parser.h"
+
+static std::string cmt = "";
+
+class ModelicaCommentListener : public openmodelica::modelicaBaseListener {
+  void exitComment(openmodelica::modelicaParser::CommentContext *ctx) override {
+    cmt = ctx->getText();
+  }
+};
+
+/*!
+ * \brief FlatModelica::Parser::getModelicaComment
+ * \param element
+ * \return comment
+ */
+QString FlatModelica::Parser::getModelicaComment(QString element)
+{
+  cmt = "";
+  std::string s = element.toStdString();
+  antlr4::ANTLRInputStream input(s);
+  openmodelica::modelicaLexer lexer(&input);
+  antlr4::CommonTokenStream tokens(&lexer);
+  openmodelica::modelicaParser parser(&tokens);
+  antlr4::tree::ParseTree* tree = parser.argument();
+  ModelicaCommentListener listener;
+  antlr4::tree::ParseTreeWalker::DEFAULT.walk(&listener, tree);
+  if (cmt.size() > 1) {
+    return QString::fromStdString(cmt);
+  }
+  return element;
+}
+
+/*!
+ * \brief FlatModelica::Parser::getTypeFromElementRedeclaration
+ * \param elmentRedeclaration
+ * \return
+ */
+QString FlatModelica::Parser::getTypeFromElementRedeclaration(const QString &elmentRedeclaration)
+{
+  antlr4::ANTLRInputStream input(elmentRedeclaration.toStdString());
+  openmodelica::modelicaLexer lexer(&input);
+  antlr4::CommonTokenStream tokens(&lexer);
+  openmodelica::modelicaParser parser(&tokens);
+  openmodelica::modelicaParser::Element_redeclarationContext *pElement_redeclarationContext = parser.element_redeclaration();
+  if (pElement_redeclarationContext && pElement_redeclarationContext->component_clause1()) {
+    return QString::fromStdString(pElement_redeclarationContext->component_clause1()->type_specifier()->getText());
+  }
+  return "";
+}
diff --git a/OMEdit/OMEditLIB/FlatModelica/Parser.h b/OMEdit/OMEditLIB/FlatModelica/Parser.h
@@ -0,0 +1,46 @@
+/*
+ * This file is part of OpenModelica.
+ *
+ * Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
+ * c/o Linköpings universitet, Department of Computer and Information Science,
+ * SE-58183 Linköping, Sweden.
+ *
+ * All rights reserved.
+ *
+ * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
+ * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
+ * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE
+ * OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
+ *
+ * The OpenModelica software and the Open Source Modelica
+ * Consortium (OSMC) Public License (OSMC-PL) are obtained
+ * from OSMC, either from the above address,
+ * from the URLs: http://www.ida.liu.se/projects/OpenModelica or
+ * http://www.openmodelica.org, and in the OpenModelica distribution.
+ * GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
+ *
+ * This program is distributed WITHOUT ANY WARRANTY; without
+ * even the implied warranty of  MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
+ * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
+ *
+ * See the full OSMC Public License conditions for more details.
+ *
+ */
+/*
+ * @author Adeel Asghar <adeel.asghar@liu.se>
+ */
+#ifndef PARSER_H
+#define PARSER_H
+
+#include <QString>
+
+namespace FlatModelica
+{
+  namespace Parser {
+    QString getModelicaComment(QString element);
+    QString getTypeFromElementRedeclaration(const QString &elmentRedeclaration);
+  } // namespace Utilities
+} // namespace FlatModelica
+
+#endif // PARSER_H
diff --git a/OMEdit/OMEditLIB/Modeling/Model.cpp b/OMEdit/OMEditLIB/Modeling/Model.cpp
@@ -1336,6 +1336,7 @@ namespace ModelInstance
   {
     mCheckBox = false;
     mDymolaCheckBox = false;
+    mChoices.clear();
   }
 
   void Choices::deserialize(const QJsonObject &jsonObject)
@@ -1351,18 +1352,39 @@ namespace ModelInstance
     if (jsonObject.contains("choice")) {
       QJsonArray choices = jsonObject.value("choice").toArray();
       foreach (auto choice, choices) {
+        QString type = "";
         if (choice.isObject()) {
           QJsonObject choiceObject = choice.toObject();
+          if (choiceObject.contains("$type")) {
+            type = choiceObject.value("$type").toString();
+          }
           if (choiceObject.contains("$value")) {
-            mChoice.append(choiceObject.value("$value").toString());
+            mChoices.append(qMakePair(choiceObject.value("$value").toString(), type));
           }
         } else {
-          mChoice.append(choice.toString());
+          mChoices.append(qMakePair(choice.toString(), type));
         }
       }
     }
   }
 
+  QStringList Choices::getChoices() const
+  {
+    QStringList choices;
+    foreach (Choice choice, mChoices) {
+      choices.append(choice.first);
+    }
+    return choices;
+  }
+
+  QString Choices::getType(int index) const
+  {
+    if (0 <= index && index < mChoices.size()) {
+      return mChoices.at(index).second;
+    }
+    return "";
+  }
+
   Element::Element(Model *pParentModel)
   {
     mpParentModel = pParentModel;
diff --git a/OMEdit/OMEditLIB/Modeling/Model.h b/OMEdit/OMEditLIB/Modeling/Model.h
@@ -353,6 +353,7 @@ namespace ModelInstance
     BooleanAnnotation mConnectorSizing;
   };
 
+  typedef QPair<QString, QString> Choice;
   class Choices
   {
   public:
@@ -361,11 +362,12 @@ namespace ModelInstance
 
     bool isCheckBox() const {return mCheckBox;}
     bool isDymolaCheckBox() const {return mDymolaCheckBox;}
-    QStringList getChoices() const {return mChoice;}
+    QStringList getChoices() const;
+    QString getType(int index) const;
   private:
     BooleanAnnotation mCheckBox;
     BooleanAnnotation mDymolaCheckBox;
-    QStringList mChoice;
+    QVector<Choice> mChoices;
   };
 
   class IconDiagramMap
@@ -786,7 +788,8 @@ namespace ModelInstance
     std::unique_ptr<Connector> mpStartConnector;
     std::unique_ptr<Annotation> mpAnnotation;
   };
+} // namespace ModelInstance
 
-}
+Q_DECLARE_METATYPE(ModelInstance::Choice)
 
 #endif // MODEL_H
diff --git a/OMEdit/OMEditLIB/OMEditLIB.pro b/OMEdit/OMEditLIB/OMEditLIB.pro
diff --git a/OMEdit/OMEditLIB/Util/StringHandler.cpp b/OMEdit/OMEditLIB/Util/StringHandler.cpp
diff --git a/OMEdit/OMEditLIB/Util/StringHandler.h b/OMEdit/OMEditLIB/Util/StringHandler.h
