Open the class under the cursor (#13432)

#8854

Added a context menu item Open Class.
Ctrl+click to open the class

Author: adeas31

OMEdit/OMEditLIB/Editors/BaseEditor.cpp

@@ -664,6 +664,7 @@ PlainTextEdit::PlainTextEdit(BaseEditor *pBaseEditor)
   : QPlainTextEdit(pBaseEditor), mpBaseEditor(pBaseEditor)
 {
   setObjectName("BaseEditor");
+  setMouseTracking(true);
   QTextDocument *pTextDocument = document();
   pTextDocument->setDocumentMargin(2);
   BaseEditorDocumentLayout *pModelicaTextDocumentLayout = new BaseEditorDocumentLayout(pTextDocument);
@@ -1375,7 +1376,6 @@ void PlainTextEdit::toggleBlockVisible(const QTextBlock &block)
   pBaseEditorDocumentLayout->emitDocumentSizeChanged();
 }
 
-
 /*!
  * \brief BaseEditor::updateLineNumberAreaWidth
  * Updates the width of LineNumberArea.
@@ -2053,6 +2053,38 @@ void PlainTextEdit::wheelEvent(QWheelEvent *event)
   QPlainTextEdit::wheelEvent(event);
 }
 
+/*!
+ * \brief PlainTextEdit::mousePressEvent
+ * Reimplementation of QPlainTextEdit::mousePressEvent
+ * \param event
+ */
+void PlainTextEdit::mousePressEvent(QMouseEvent *event)
+{
+  bool controlModifier = event->modifiers().testFlag(Qt::ControlModifier);
+  if (controlModifier) {
+    mpBaseEditor->symbolAtPosition(event->pos());
+    viewport()->unsetCursor();
+  }
+  QPlainTextEdit::mousePressEvent(event);
+}
+
+/*!
+ * \brief PlainTextEdit::mouseMoveEvent
+ * Reimplementation of QPlainTextEdit::mouseMoveEvent
+ * \param event
+ */
+void PlainTextEdit::mouseMoveEvent(QMouseEvent *event)
+{
+  bool controlModifier = event->modifiers().testFlag(Qt::ControlModifier);
+  if (controlModifier) {
+    viewport()->setCursor(Qt::PointingHandCursor);
+  } else {
+    viewport()->unsetCursor();
+  }
+
+  QPlainTextEdit::mouseMoveEvent(event);
+}
+
 /*!
  * \class BaseEditor
  * Base class for all editors.
@@ -2074,6 +2106,7 @@ BaseEditor::BaseEditor(QWidget *pParent)
 
 /*!
  * \brief BaseEditor::wordUnderCursor
+ * Returns the word under cursor.
  */
 QString BaseEditor::wordUnderCursor()
 {
@@ -2082,6 +2115,19 @@ QString BaseEditor::wordUnderCursor()
   return cursor.selectedText();
 }
 
+/*!
+ * \brief BaseEditor::symbolAtPosition
+ * Navigates to the symbol at position.\n
+ * The default implementation does nothing.\n
+ * Reimplement in the child class to navigate to the correct symbol based on the language.
+ * \param pos
+ */
+void BaseEditor::symbolAtPosition(const QPoint &pos)
+{
+  Q_UNUSED(pos);
+  // Do nothing. Reimplement in the child class.
+}
+
 bool BaseEditor::isModelicaModelInPackageOneFile()
 {
   return (mpModelWidget && mpModelWidget->getLibraryTreeItem() &&
@@ -2161,6 +2207,10 @@ void BaseEditor::createActions()
     connect(mpZoomOutAction, SIGNAL(triggered()), mpPlainTextEdit, SLOT(zoomOut()));
     mpPlainTextEdit->addAction(mpZoomOutAction);
   }
+  // open class action
+  mpOpenClassAction = new QAction(Helper::openClass, this);
+  mpOpenClassAction->setStatusTip(Helper::openClassTip);
+  connect(mpOpenClassAction, SIGNAL(triggered()), SLOT(openClass()));
   // toggle comment action
   mpToggleCommentSelectionAction = new QAction(tr("Toggle Comment Selection"), this);
   mpToggleCommentSelectionAction->setShortcut(QKeySequence("Ctrl+k"));
@@ -2325,6 +2375,17 @@ void BaseEditor::showGotoLineNumberDialog()
   pGotoLineWidget->exec();
 }
 
+/*!
+ * \brief BaseEditor::openClass
+ * Slot activated when open class is seleteted from context menu.
+ */
+void BaseEditor::openClass()
+{
+  if (mContextMenuStartPositionValid) {
+    symbolAtPosition(mContextMenuStartPosition);
+  }
+}
+
 /*!
  * \brief BaseEditor::toggleCommentSelection
  * Slot activated when toggle comment selection is seleteted from context menu or ctrl+k is pressed.

OMEdit/OMEditLIB/Editors/BaseEditor.h

@@ -314,6 +314,8 @@ public slots:
   virtual void focusOutEvent(QFocusEvent *event) override;
   void paintEvent(QPaintEvent *e) override;
   void wheelEvent(QWheelEvent *event) override;
+  virtual void mousePressEvent(QMouseEvent *event) override;
+  virtual void mouseMoveEvent(QMouseEvent *event) override;
 };
 
 class BaseEditor : public QWidget
@@ -332,6 +334,7 @@ class BaseEditor : public QWidget
   void setForceSetPlainText(bool forceSetPlainText) {mForceSetPlainText = forceSetPlainText;}
   virtual void popUpCompleter () = 0;
   virtual QString wordUnderCursor();
+  virtual void symbolAtPosition(const QPoint &pos);
   bool isModelicaModelInPackageOneFile();
 private:
   void initialize();
@@ -349,11 +352,14 @@ class BaseEditor : public QWidget
   QAction *mpResetZoomAction;
   QAction *mpZoomInAction;
   QAction *mpZoomOutAction;
+  QAction *mpOpenClassAction;
   QAction *mpToggleCommentSelectionAction;
   QAction *mpFoldAllAction;
   QAction *mpUnFoldAllAction;
   DocumentMarker *mpDocumentMarker = nullptr;
   bool mForceSetPlainText;
+  QPoint mContextMenuStartPosition;
+  bool mContextMenuStartPositionValid = false;
 
   QMenu* createStandardContextMenu();
   void contentsChanged();
@@ -364,6 +370,7 @@ public slots:
   void showFindReplaceWidget();
   void clearFindReplaceTexts();
   void showGotoLineNumberDialog();
+  void openClass();
   virtual void toggleCommentSelection();
 };
 

OMEdit/OMEditLIB/Editors/ModelicaEditor.cpp

@@ -185,6 +185,40 @@ QString ModelicaEditor::wordUnderCursor()
   return mpPlainTextEdit->document()->toPlainText().mid(begin, end - begin);
 }
 
+/*!
+ * \brief ModelicaEditor::symbolAtPosition
+ * Navigate to the Modelica class at position.
+ * \param pos
+ */
+void ModelicaEditor::symbolAtPosition(const QPoint &pos)
+{
+  if (mpModelWidget) {
+    QTextCursor cursor = mpPlainTextEdit->cursorForPosition(pos);
+    cursor.select(QTextCursor::WordUnderCursor);
+
+    int mid = cursor.position();
+    int end = mid;
+
+    while (end < cursor.block().length()) {
+      QChar ch = mpPlainTextEdit->document()->characterAt(end);
+      if (!(ch.isLetterOrNumber() || ch == '.' || ch == '_'))
+        break;
+      end++;
+    }
+
+    int begin = mid - 1;
+    while (begin >= 0) {
+      QChar ch = mpPlainTextEdit->document()->characterAt(begin);
+      if (!(ch.isLetterOrNumber() || ch == '.' || ch == '_'))
+        break;
+      begin--;
+    }
+    begin++;
+
+    mpModelWidget->navigateToClass(mpPlainTextEdit->document()->toPlainText().mid(begin, end - begin));
+  }
+}
+
 /*!
  * \brief Returns the substring from the last occurrence of `word` to the cursor position
  * \param word Starting word of the substring
@@ -510,11 +544,16 @@ void ModelicaEditor::showContextMenu(QPoint point)
 {
   QMenu *pMenu = BaseEditor::createStandardContextMenu();
   pMenu->addSeparator();
+  pMenu->addAction(mpOpenClassAction);
+  pMenu->addSeparator();
   pMenu->addAction(mpToggleCommentSelectionAction);
   pMenu->addSeparator();
   pMenu->addAction(mpFoldAllAction);
   pMenu->addAction(mpUnFoldAllAction);
+  mContextMenuStartPosition = point;
+  mContextMenuStartPositionValid = true;
   pMenu->exec(mapToGlobal(point));
+  mContextMenuStartPositionValid = false;
   delete pMenu;
 }
 

OMEdit/OMEditLIB/Editors/ModelicaEditor.h

@@ -59,6 +59,7 @@ class ModelicaEditor : public BaseEditor
   bool isTextChanged() {return mTextChanged;}
   virtual void popUpCompleter() override;
   virtual QString wordUnderCursor() override;
+  virtual void symbolAtPosition(const QPoint &pos) override;
   QString stringAfterWord(const QString &word);
   static LibraryTreeItem *deepResolve(LibraryTreeItem *pItem, QStringList nameComponents);
   QList<LibraryTreeItem *> getCandidateContexts(QStringList nameComponents);

OMEdit/OMEditLIB/Modeling/ModelWidgetContainer.cpp

@@ -6809,6 +6809,29 @@ void ModelWidget::selectDeselectElement(const QString &name, bool selected)
   }
 }
 
+/*!
+ * \brief ModelWidget::navigateToClass
+ * Lookup the class and open it.
+ * \param className
+ */
+void ModelWidget::navigateToClass(const QString &className)
+{
+  LibraryWidget *pLibraryWidget = MainWindow::instance()->getLibraryWidget();
+  LibraryTreeItem *pLibraryTreeItem = nullptr;
+  // first see if we find any relative class
+  const QString parentClassName = StringHandler::removeLastWordAfterDot(mpLibraryTreeItem->getNameStructure());
+  pLibraryTreeItem = pLibraryWidget->getLibraryTreeModel()->findLibraryTreeItem(parentClassName % "." % className);
+  if (pLibraryTreeItem) {
+    pLibraryWidget->getLibraryTreeModel()->showModelWidget(pLibraryTreeItem);
+  } else {
+    // relative class not found.
+    pLibraryTreeItem = pLibraryWidget->getLibraryTreeModel()->findLibraryTreeItem(className);
+    if (pLibraryTreeItem) {
+      pLibraryWidget->getLibraryTreeModel()->showModelWidget(pLibraryTreeItem);
+    }
+  }
+}
+
 /*!
  * \brief ModelWidget::createUndoStack
  * Creates the undo stack.

OMEdit/OMEditLIB/Modeling/ModelWidgetContainer.h

@@ -602,6 +602,7 @@ class ModelWidget : public QWidget
   ModelInfo createModelInfo() const;
   void showElement(ModelInstance::Model *pModelInstance, bool addToList);
   void selectDeselectElement(const QString &name, bool selected);
+  void navigateToClass(const QString &className);
 private:
   ModelWidgetContainer *mpModelWidgetContainer;
   ModelInstance::Model *mpModelInstance;