Fix handling of quoted string literals for autocompletion (OpenModelica#14059)

Fixes OpenModelica#11112 and OpenModelica#6317
Added tests for autocompletion

Author: adeas31

OMEdit/OMEditLIB/Editors/BaseEditor.cpp

@@ -2135,6 +2135,21 @@ bool BaseEditor::isModelicaModelInPackageOneFile()
           mpModelWidget->getLibraryTreeItem()->isModelica());
 }
 
+/*!
+ * \brief BaseEditor::completerItemsToStringList
+ * Converts the CompleterItem list to QStringList using the CompleterItem::mValue.
+ * \param items
+ * \return
+ */
+QStringList BaseEditor::completerItemsToStringList(const QList<CompleterItem> &items)
+{
+  QStringList list;
+  for (const CompleterItem &item : items) {
+    list.append(item.mValue);
+  }
+  return list;
+}
+
 /*!
  * \brief BaseEditor::initialize
  * Initializes the editor with default values.

OMEdit/OMEditLIB/Editors/BaseEditor.h

@@ -336,6 +336,7 @@ class BaseEditor : public QWidget
   virtual QString wordUnderCursor();
   virtual void symbolAtPosition(const QPoint &pos);
   bool isModelicaModelInPackageOneFile();
+  static QStringList completerItemsToStringList(const QList<CompleterItem> &items);
 private:
   void initialize();
   void createActions();

OMEdit/OMEditLIB/Editors/ModelicaEditor.cpp

@@ -78,7 +78,7 @@ void ModelicaEditor::popUpCompleter()
   mpPlainTextEdit->clearCompleter();
 
   QList<CompleterItem> annotations;
-  bool inAnnotation = getCompletionAnnotations(stringAfterWord("annotation"), annotations);
+  bool inAnnotation = ModelicaEditor::getCompletionAnnotations(stringAfterWord("annotation"), annotations);
   mpPlainTextEdit->insertCompleterSymbols(annotations, ":/Resources/icons/completerAnnotation.svg");
 
   bool startsWithUpperCase = !word.isEmpty() && word[0].isUpper();
@@ -97,13 +97,7 @@ void ModelicaEditor::popUpCompleter()
   }
   if (!inAnnotation) {
     QList<CompleterItem> classes, components;
-    getCompletionSymbols(word, classes, components);
-
-    std::sort(classes.begin(), classes.end());
-    classes.erase(std::unique(classes.begin(), classes.end()), classes.end());
-
-    std::sort(components.begin(), components.end());
-    components.erase(std::unique(components.begin(), components.end()), components.end());
+    ModelicaEditor::getCompletionSymbols(getModelWidget()->getLibraryTreeItem(), word, classes, components);
 
     mpPlainTextEdit->insertCompleterSymbols(classes, ":/Resources/icons/completerClass.svg");
     mpPlainTextEdit->insertCompleterSymbols(components, ":/Resources/icons/completerComponent.svg");
@@ -149,14 +143,20 @@ LibraryTreeItem *ModelicaEditor::deepResolve(LibraryTreeItem *pItem, QStringList
   return pCurrentItem;
 }
 
-QList<LibraryTreeItem*> ModelicaEditor::getCandidateContexts(QStringList nameComponents)
+/*!
+ * \brief ModelicaEditor::getCandidateContexts
+ * \param pLibraryTreeItem
+ * \param nameComponents
+ * \return
+ */
+QList<LibraryTreeItem*> ModelicaEditor::getCandidateContexts(LibraryTreeItem *pLibraryTreeItem, QStringList nameComponents)
 {
   QList<LibraryTreeItem*> result;
   QList<LibraryTreeItem*> roots;
-  LibraryTreeItem *pItem = getModelWidget()->getLibraryTreeItem();
-  while (pItem) {
-    roots.append(pItem->getInheritedClassesDeepList());
-    pItem = pItem->parent();
+
+  while (pLibraryTreeItem) {
+    roots.append(pLibraryTreeItem->getInheritedClassesDeepList());
+    pLibraryTreeItem = pLibraryTreeItem->parent();
   }
 
   for (int i = 0; i < roots.size(); ++i) {
@@ -235,7 +235,14 @@ QString ModelicaEditor::stringAfterWord(const QString &word)
     return plainText.mid(index, pos - index);
 }
 
-void ModelicaEditor::getCompletionSymbols(QString word, QList<CompleterItem> &classes, QList<CompleterItem> &components)
+/*!
+ * \brief ModelicaEditor::getCompletionSymbols
+ * \param pLibraryTreeItem
+ * \param word
+ * \param classes
+ * \param components
+ */
+void ModelicaEditor::getCompletionSymbols(LibraryTreeItem *pLibraryTreeItem, QString word, QList<CompleterItem> &classes, QList<CompleterItem> &components)
 {
   QStringList nameComponents = word.split('.');
   QString lastPart;
@@ -246,11 +253,17 @@ void ModelicaEditor::getCompletionSymbols(QString word, QList<CompleterItem> &cl
     lastPart = "";
   }
 
-  QList<LibraryTreeItem*> contexts = getCandidateContexts(nameComponents);
+  QList<LibraryTreeItem*> contexts = ModelicaEditor::getCandidateContexts(pLibraryTreeItem, nameComponents);
 
   for (int i = 0; i < contexts.size(); ++i) {
     contexts[i]->tryToComplete(classes, components, lastPart);
   }
+
+  std::sort(classes.begin(), classes.end());
+  classes.erase(std::unique(classes.begin(), classes.end()), classes.end());
+
+  std::sort(components.begin(), components.end());
+  components.erase(std::unique(components.begin(), components.end()), components.end());
 }
 
 /*!
@@ -264,6 +277,7 @@ LibraryTreeItem *ModelicaEditor::getAnnotationCompletionRoot()
   for (int i = 0; i < pLibraryRoot->childrenSize(); ++i) {
     if (pLibraryRoot->childAt(i)->getName() == "OpenModelica") {
       pModelicaReference = pLibraryRoot->childAt(i);
+      break;
     }
   }
 
@@ -281,7 +295,7 @@ LibraryTreeItem *ModelicaEditor::getAnnotationCompletionRoot()
  */
 void ModelicaEditor::getCompletionAnnotations(const QStringList &stack, QList<CompleterItem> &annotations)
 {
-  LibraryTreeItem *pReference = getAnnotationCompletionRoot();
+  LibraryTreeItem *pReference = ModelicaEditor::getAnnotationCompletionRoot();
   if (pReference) {
     LibraryTreeItem *pAnnotation = deepResolve(pReference, stack);
     if (pAnnotation) {
@@ -323,13 +337,16 @@ bool ModelicaEditor::getCompletionAnnotations(const QString &str, QList<Complete
 
     // First, handle string literals
     if (ch == '"') {
-      for (++i; i < str.size() && str[i] != '"'; ++i) {
-        if (str[i] == '\\')
-          ++i;
+      ++i;
+      while (i < str.size()) {
+        if (str[i] == '\\') {
+          ++i; // skip escaped character
+        } else if (str[i] == '"') {
+          break; // end of quoted string
+        }
+        ++i;
       }
-      // skipped, restarting as usual
-      --i;
-      continue;
+      continue; // don't treat quoted string contents as syntax
     }
 
     // Now, handle the stack of annotations
@@ -355,7 +372,7 @@ bool ModelicaEditor::getCompletionAnnotations(const QString &str, QList<Complete
     return false;
   }
   stack.pop_front(); // pop 'annotation'
-  getCompletionAnnotations(stack, annotations);
+  ModelicaEditor::getCompletionAnnotations(stack, annotations);
   return true;
 }
 

OMEdit/OMEditLIB/Editors/ModelicaEditor.h

@@ -62,12 +62,12 @@ class ModelicaEditor : public BaseEditor
   virtual void symbolAtPosition(const QPoint &pos) override;
   QString stringAfterWord(const QString &word);
   static LibraryTreeItem *deepResolve(LibraryTreeItem *pItem, QStringList nameComponents);
-  QList<LibraryTreeItem *> getCandidateContexts(QStringList nameComponents);
+  static QList<LibraryTreeItem *> getCandidateContexts(LibraryTreeItem *pLibraryTreeItem, QStringList nameComponents);
   static void tryToCompleteInSingleContext(QStringList &result, LibraryTreeItem *pItem, QString lastPart);
-  void getCompletionSymbols(QString word, QList<CompleterItem> &classes, QList<CompleterItem> &components);
-  LibraryTreeItem *getAnnotationCompletionRoot();
-  void getCompletionAnnotations(const QStringList &stack, QList<CompleterItem> &annotations);
-  bool getCompletionAnnotations(const QString &str, QList<CompleterItem> &annotations);
+  static void getCompletionSymbols(LibraryTreeItem *pLibraryTreeItem, QString word, QList<CompleterItem> &classes, QList<CompleterItem> &components);
+  static LibraryTreeItem *getAnnotationCompletionRoot();
+  static void getCompletionAnnotations(const QStringList &stack, QList<CompleterItem> &annotations);
+  static bool getCompletionAnnotations(const QString &str, QList<CompleterItem> &annotations);
   static QList<CompleterItem> getCodeSnippets();
 private:
   QString mLastValidText;

OMEdit/Testsuite/AutoCompletion/AutoCompletion.pro

@@ -0,0 +1,38 @@
+#
+ # 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.
+ #
+ #/
+
+include(../Common/Testsuite.pri)
+include(../Common/Util.pri)
+
+TARGET = AutoCompletion
+
+SOURCES += AutoCompletionTest.cpp
+
+HEADERS += AutoCompletionTest.h

OMEdit/Testsuite/AutoCompletion/AutoCompletionTest.cpp

@@ -0,0 +1,157 @@
+/*
+ * 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>
+ */
+
+#include "AutoCompletionTest.h"
+#include "Util.h"
+#include "OMEditApplication.h"
+#include "MainWindow.h"
+#include "Editors/ModelicaEditor.h"
+#include "Modeling/LibraryTreeWidget.h"
+
+#define GC_THREADS
+extern "C" {
+#include "meta/meta_modelica.h"
+}
+
+OMEDITTEST_MAIN(AutoCompletionTest)
+
+void AutoCompletionTest::initTestCase()
+{
+  // Load OpenModelica for auto completion
+  MainWindow::instance()->getLibraryWidget()->getLibraryTreeModel()->addModelicaLibraries();
+
+  MainWindow::instance()->getLibraryWidget()->openFile(QFINDTESTDATA(mFileName));
+  if (!MainWindow::instance()->getOMCProxy()->existClass(mModelName)) {
+    QFAIL(QString("Failed to load file %1").arg(mFileName).toStdString().c_str());
+  }
+}
+
+void AutoCompletionTest::inOutAnnotationTest()
+{
+  QFETCH(QString, word);
+  QFETCH(bool, result);
+
+  QList<CompleterItem> annotations;
+  QCOMPARE(ModelicaEditor::getCompletionAnnotations(word, annotations), result);
+}
+
+void AutoCompletionTest::inOutAnnotationTest_data()
+{
+  QTest::addColumn<QString>("word");
+  QTest::addColumn<bool>("result");
+
+  QTest::newRow("InAnnotation")
+      << "annotation(Dialog(tab = \"General\")"
+      << true;
+
+  QTest::newRow("InDialogAnnotation")
+      << "annotation(Dialog(tab = \"General\""
+      << true;
+
+  QTest::newRow("OutDialogAnnotationButInAnnotation")
+      << "annotation(Dialog(tab = \"General\")"
+      << true;
+
+  QTest::newRow("OutAnnotation1")
+      << "annotation(Dialog(tab = \"General\"))"
+      << false;
+
+  QTest::newRow("OutAnnotation2")
+      << "annotation(Dialog(tab = \"General\"));"
+      << false;
+}
+
+void AutoCompletionTest::getCompletionAnnotationsTest()
+{
+  QFETCH(QString, word);
+  QFETCH(QStringList, result);
+
+  QList<CompleterItem> annotations;
+  ModelicaEditor::getCompletionAnnotations(word, annotations);
+  QCOMPARE(BaseEditor::completerItemsToStringList(annotations), result);
+}
+
+void AutoCompletionTest::getCompletionAnnotationsTest_data()
+{
+  QTest::addColumn<QString>("word");
+  QTest::addColumn<QStringList>("result");
+
+  QTest::newRow("DocumentationAnnotation")
+      << "annotation(Documentation("
+      << QStringList({"info = ", "revisions = "});
+
+  QTest::newRow("ExperimentAnnotation")
+      << "annotation(experiment("
+      << QStringList({"StartTime = 0", "StopTime = 1", "Interval = 0.002", "Tolerance = 1e-6"});
+}
+
+void AutoCompletionTest::getCompletionSymbolsTest()
+{
+  LibraryTreeItem *pLibraryTreeItem = MainWindow::instance()->getLibraryWidget()->getLibraryTreeModel()->findLibraryTreeItem(mModelName);
+  if (!pLibraryTreeItem) {
+    QFAIL(QString("Failed to find library tree item for %1").arg(mModelName).toStdString().c_str());
+  }
+
+  QFETCH(QString, word);
+  QFETCH(QStringList, expectedClasses);
+  QFETCH(QStringList, expectedComponents);
+
+  QList<CompleterItem> classes, components;
+  ModelicaEditor::getCompletionSymbols(pLibraryTreeItem, word, classes, components);
+  QCOMPARE(BaseEditor::completerItemsToStringList(classes), expectedClasses);
+  QCOMPARE(BaseEditor::completerItemsToStringList(components), expectedComponents);
+}
+
+void AutoCompletionTest::getCompletionSymbolsTest_data()
+{
+  QTest::addColumn<QString>("word");
+  QTest::addColumn<QStringList>("expectedClasses");
+  QTest::addColumn<QStringList>("expectedComponents");
+
+  // Test the auto completion for classes and components in the model
+  QTest::newRow("EmptyWord")
+      << ""
+      << QStringList({"KindOfController", "test_annotation"})
+      << QStringList({"Bonjour", "Hej", "Hello", "Hola", "isActive"});
+
+  QTest::newRow("ClassName")
+      << "test_annotation."
+      << QStringList({"KindOfController"})
+      << QStringList({"Bonjour", "Hej", "Hello", "Hola", "isActive"});
+}
+
+void AutoCompletionTest::cleanupTestCase()
+{
+  MainWindow::instance()->close();
+}