Show meaningful descriptions for autocompleted classes and components

OMEdit/OMEditGUI/Component/Component.cpp

@@ -393,6 +393,12 @@ bool ComponentInfo::operator!=(const ComponentInfo &componentInfo) const
   return !operator==(componentInfo);
 }
 
+QString ComponentInfo::getHTMLDescription() const
+{
+  return QString("<b>%1</b><br/>&nbsp;&nbsp;&nbsp;&nbsp;%2 <i>\"%3\"<i>")
+      .arg(mClassName, mName, Utilities::escapeForHtmlNonSecure(mComment));
+}
+
 /*!
  * \brief ComponentInfo::isModiferClassRecord
  * Returns true if a modifier class is a record.

OMEdit/OMEditGUI/Component/Component.h

@@ -127,6 +127,7 @@ class ComponentInfo : public QObject
   // operator overloading
   bool operator==(const ComponentInfo &componentInfo) const;
   bool operator!=(const ComponentInfo &componentInfo) const;
+  QString getHTMLDescription() const;
 private:
   QString mClassName;
   QString mName;

OMEdit/OMEditGUI/Editors/BaseEditor.cpp

@@ -754,24 +754,37 @@ bool PlainTextEdit::eventFilter(QObject *pObject, QEvent *pEvent)
  * The constructor is set from outside depending on which editor is used (eg.) MetaModelicaEditor,
  * ModelicaEditor,CEditor etc..
  */
-CompleterItem::CompleterItem(QString key, QString value, QString select)
+CompleterItem::CompleterItem(const QString &key, const QString &value, const QString &select)
+  : mKey(key), mValue(value), mSelect(select)
+{
+  int ind = value.indexOf(select, 0);
+  if (ind < 0) {
+    mDescription = value;
+  } else {
+    mDescription = QString("<b>%1</b><i>%2</i>%3").arg(
+          QStringRef(&value).left(ind).toString(),
+          select,
+          QStringRef(&value).right(value.size() - select.size() - ind).toString()
+        ).replace("\n", "<br/>");
+  }
+}
+
+CompleterItem::CompleterItem(const QString &value, const QString &description)
+  : mKey(value), mValue(value), mSelect(value), mDescription(description)
 {
-  mKey=key;
-  mValue=value;
-  mSelect=select;
 }
 
 void PlainTextEdit::clearCompleter()
 {
   mpStandardItemModel->clear();
 }
 
-void PlainTextEdit::insertCompleterSymbols(QStringList symbols)
+void PlainTextEdit::insertCompleterSymbols(QList<CompleterItem> symbols)
 {
   for (int i = 0; i < symbols.size(); ++i) {
-    QStandardItem *pStandardItem = new QStandardItem(symbols[i]);
+    QStandardItem *pStandardItem = new QStandardItem(symbols[i].mKey);
     pStandardItem->setIcon(QIcon(":/Resources/icons/completerSymbol.svg"));
-    pStandardItem->setData(QVariant::fromValue(CompleterItem(symbols[i], symbols[i], "")), Qt::UserRole);
+    pStandardItem->setData(QVariant::fromValue(symbols[i]), Qt::UserRole);
     mpStandardItemModel->appendRow(pStandardItem);
   }
 }
@@ -1545,7 +1558,7 @@ void PlainTextEdit::showCompletionItemToolTip(const QModelIndex &index)
   if (pTextEditorPage->getAutoCompleteCheckBox()->isChecked()) {
     QVariant value = index.data(Qt::UserRole);
     CompleterItem completerItem = qvariant_cast<CompleterItem>(value);
-    mpCompleterToolTipLabel->setText(completerItem.mValue);
+    mpCompleterToolTipLabel->setText(completerItem.mDescription);
     mpCompleterToolTipWidget->adjustSize();
     QRect rect = mpCompleter->popup()->visualRect(index);
     mpCompleterToolTipWidget->move(mpCompleter->popup()->mapToGlobal(QPoint(rect.x() + mpCompleter->popup()->width() + 2, rect.y() + 2)));

OMEdit/OMEditGUI/Editors/BaseEditor.h

@@ -214,10 +214,24 @@ class CompleterItem
 {
 public:
   CompleterItem() {}
-  CompleterItem(QString key , QString value , QString select);
+  CompleterItem(const QString &key, const QString &value, const QString &select);
+  CompleterItem(const QString &value, const QString &description);
   QString mKey;
   QString mValue;
   QString mSelect;
+  QString mDescription;
+
+  // Supposing two items with equal keys and different descriptions are
+  // different enough to show both and hoping that if the above two fields
+  // are identical, then other fields would be identical as well...
+  bool operator<(const CompleterItem &other) const
+  {
+    return (mKey < other.mKey) || ((mKey == other.mKey) && (mDescription == other.mDescription));
+  }
+  bool operator==(const CompleterItem &other) const
+  {
+    return mKey == other.mKey && mDescription == other.mDescription;
+  }
 };
 
 Q_DECLARE_METATYPE(CompleterItem)
@@ -232,7 +246,7 @@ class PlainTextEdit : public QPlainTextEdit
   bool eventFilter(QObject *pObject, QEvent *pEvent);
   LineNumberArea* getLineNumberArea() {return mpLineNumberArea;}
   void clearCompleter();
-  void insertCompleterSymbols(QStringList symbols);
+  void insertCompleterSymbols(QList<CompleterItem> symbols);
   void insertCompleterKeywords(QStringList keywords);
   void insertCompleterTypes(QStringList types);
   void insertCompleterCodeSnippets(QList<CompleterItem> items);

OMEdit/OMEditGUI/Editors/ModelicaEditor.cpp

@@ -81,8 +81,17 @@ void ModelicaEditor::popUpCompleter()
     QList<CompleterItem> codesnippets = getCodeSnippets();
     mpPlainTextEdit->insertCompleterCodeSnippets(codesnippets);
   }
-  QStringList symbols = getCodeSymbols(word);
-  mpPlainTextEdit->insertCompleterSymbols(symbols);
+  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());
+
+  mpPlainTextEdit->insertCompleterSymbols(classes);
+  mpPlainTextEdit->insertCompleterSymbols(components);
 
   QCompleter *completer = mpPlainTextEdit->completer();
   QRect cr = mpPlainTextEdit->cursorRect();
@@ -156,7 +165,7 @@ QString ModelicaEditor::wordUnderCursor()
   return mpPlainTextEdit->document()->toPlainText().mid(begin, end - begin);
 }
 
-QStringList ModelicaEditor::getCodeSymbols(QString word)
+void ModelicaEditor::getCompletionSymbols(QString word, QList<CompleterItem> &classes, QList<CompleterItem> &components)
 {
   QStringList nameComponents = word.split('.');
   QString lastPart;
@@ -169,12 +178,9 @@ QStringList ModelicaEditor::getCodeSymbols(QString word)
 
   QList<LibraryTreeItem*> contexts = getCandidateContexts(nameComponents);
 
-  QSet<QString> symbols;
   for (int i = 0; i < contexts.size(); ++i) {
-    contexts[i]->tryToComplete(symbols, lastPart);
+    contexts[i]->tryToComplete(classes, components, lastPart);
   }
-
-  return QStringList::fromSet(symbols);
 }
 
 /*!

OMEdit/OMEditGUI/Editors/ModelicaEditor.h

@@ -62,7 +62,7 @@ class ModelicaEditor : public BaseEditor
   static LibraryTreeItem *deepResolve(LibraryTreeItem *pItem, QStringList nameComponents);
   QList<LibraryTreeItem *> getCandidateContexts(QStringList nameComponents);
   static void tryToCompleteInSingleContext(QStringList &result, LibraryTreeItem *pItem, QString lastPart);
-  QStringList getCodeSymbols(QString word);
+  void getCompletionSymbols(QString word, QList<CompleterItem> &classes, QList<CompleterItem> &components);
   static QList<CompleterItem> getCodeSnippets();
 private:
   QString mLastValidText;

OMEdit/OMEditGUI/Modeling/LibraryTreeWidget.cpp

@@ -676,7 +676,7 @@ LibraryTreeItem *LibraryTreeItem::getComponentsClass(const QString &name)
   return 0;
 }
 
-void LibraryTreeItem::tryToComplete(QSet<QString> &result, const QString &lastPart)
+void LibraryTreeItem::tryToComplete(QList<CompleterItem> &completionClasses, QList<CompleterItem> &completionComponents, const QString &lastPart)
 {
   QList<LibraryTreeItem*> baseClasses = getInheritedClassesDeepList();
 
@@ -685,14 +685,14 @@ void LibraryTreeItem::tryToComplete(QSet<QString> &result, const QString &lastPa
     for (int i = 0; i < classes.size(); ++i) {
       if (classes[i]->getName().startsWith(lastPart) &&
               classes[i]->getNameStructure().compare("OMEdit.Search.Feature") != 0)
-        result.insert(classes[i]->getName());
+        completionClasses << (CompleterItem(classes[i]->getName(), classes[i]->getHTMLDescription()));
     }
 
     const QList<ComponentInfo*> &components = baseClasses[bc]->getComponentsList();
     if (!baseClasses[bc]->isRootItem() && baseClasses[bc]->getLibraryType() == LibraryTreeItem::Modelica) {
       for (int i = 0; i < components.size(); ++i) {
         if (components[i]->getName().startsWith(lastPart))
-          result.insert(components[i]->getName());
+          completionComponents << CompleterItem(components[i]->getName(), components[i]->getHTMLDescription() + QString("<br/>// Inside %1").arg(baseClasses[bc]->mNameStructure));
       }
     }
   }
@@ -859,6 +859,12 @@ bool LibraryTreeItem::isInstantiated()
   return mModelState == oms_modelState_instantiated;
 }
 
+QString LibraryTreeItem::getHTMLDescription() const
+{
+  return QString("<b>%1</b> %2<br/>&nbsp;&nbsp;&nbsp;&nbsp;<i>\"%3\"</i><br/>...")
+      .arg(mClassInformation.restriction, mName, Utilities::escapeForHtmlNonSecure(mClassInformation.comment));
+}
+
 /*!
  * \brief LibraryTreeItem::handleLoaded
  * Handles the case when an undefined inherited class is loaded.

OMEdit/OMEditGUI/Modeling/LibraryTreeWidget.h

@@ -44,6 +44,7 @@
 #include <QTreeView>
 #include <QSortFilterProxyModel>
 
+class CompleterItem;
 class GraphicsView;
 class ModelWidget;
 class ShapeAnnotation;
@@ -165,7 +166,7 @@ class LibraryTreeItem : public QObject
   QList<LibraryTreeItem*> getInheritedClassesDeepList();
   LibraryTreeItem *getDirectComponentsClass(const QString &name);
   LibraryTreeItem *getComponentsClass(const QString &name);
-  void tryToComplete(QSet<QString> &result, const QString &lastPart);
+  void tryToComplete(QList<CompleterItem> &completionClasses, QList<CompleterItem> &completionComponents, const QString &lastPart);
   void removeChild(LibraryTreeItem *pLibraryTreeItem);
   QVariant data(int column, int role = Qt::DisplayRole) const;
   int row() const;
@@ -183,6 +184,7 @@ class LibraryTreeItem : public QObject
   void emitConnectionAdded(LineAnnotation *pConnectionLineAnnotation) {emit connectionAdded(pConnectionLineAnnotation);}
   void emitCoOrdinateSystemUpdated(GraphicsView *pGraphicsView) {emit coOrdinateSystemUpdated(pGraphicsView);}
   bool isInstantiated();
+  QString getHTMLDescription() const;
 
   OMCInterface::getClassInformation_res mClassInformation;
   SimulationOptions mSimulationOptions;

OMEdit/OMEditGUI/Util/Utilities.cpp

@@ -421,6 +421,13 @@ void CodeColorsWidget::pickColor()
   emit colorUpdated();
 }
 
+QString Utilities::escapeForHtmlNonSecure(const QString &str)
+{
+  return QString(str)
+     .replace("& ", "&") // should be the first replacement
+     .replace("< ", "&lt;");
+}
+
 /*!
  * \brief Utilities::tempDirectory
  * Returns the application temporary directory.

OMEdit/OMEditGUI/Util/Utilities.h

@@ -434,6 +434,7 @@ namespace Utilities {
     AlwaysDeleteBom = 2
   };
 
+  QString escapeForHtmlNonSecure(const QString &str);
   QString& tempDirectory();
   QSettings* getApplicationSettings();
   void parseCompositeModelText(MessageHandler *pMessageHandler, QString contents);