Merge pull request #437 from QuangNguyenMinh123/feature/Go_to_definition_Ctrl_Click

Go to definition, but with Ctrl + Click

Author: epasveer

src/SeerEditorWidgetSource.h

@@ -20,7 +20,7 @@
 #include <QtCore/QMap>
 #include <QtCore/QFileSystemWatcher>
 #include <QtCore/QPoint>
-
+#include <QMouseEvent>
 
 class SeerEditorWidgetSourceLineNumberArea;
 class SeerEditorWidgetSourceBreakPointArea;
@@ -162,6 +162,8 @@ class SeerEditorWidgetSourceArea : public SeerPlainTextEdit {
         void                                        showExpressionTooltip               ();
         void                                        hideExpressionTooltip               ();
         void                                        mousePressEvent                     (QMouseEvent *event) override;
+        void                                        keyPressEvent                       (QKeyEvent* event) override;
+        void                                        keyReleaseEvent                     (QKeyEvent* event) override;
 
     private slots:
         void                                        refreshExtraSelections              ();
@@ -172,6 +174,9 @@ class SeerEditorWidgetSourceArea : public SeerPlainTextEdit {
 
     private:
         void                                        handleCursorPositionChanged         ();
+        void                                        updateCursor                        (const QPoint &pos);
+        bool                                        isOverWord                          (const QPoint &pos);
+        QString                                     wordUnderCursor                     (const QPoint &pos) const;
         bool                                        isValidIdentifier                   (const QString& text);
 
         QString                                     _fullname;
@@ -207,6 +212,11 @@ class SeerEditorWidgetSourceArea : public SeerPlainTextEdit {
         QString                                     _externalEditorCommand;
         bool                                        _autoSourceReload;
         int                                         _ignoreThumbMouseEvent = 0;
+
+        // Variables for Goto Definition (Ctrl + Click)
+        static QTimer*                              _ctrlHeldTimer;
+        static bool                                 _ctrlHeld;
+        QString                                     _wordUnderCursor;
 };
 
 class SeerEditorWidgetSourceLineNumberArea : public QWidget {

src/SeerEditorWidgetSourceAreas.cpp

@@ -34,6 +34,9 @@
 #include <QtCore/QCoreApplication>
 #include <QtCore/QProcess>
 
+bool SeerEditorWidgetSourceArea::_ctrlHeld = false;
+QTimer* SeerEditorWidgetSourceArea::_ctrlHeldTimer = new QTimer();
+
 SeerEditorWidgetSourceArea::SeerEditorWidgetSourceArea(QWidget* parent) : SeerPlainTextEdit(parent) {
 
     _fileWatcher                = 0;
@@ -64,6 +67,11 @@ SeerEditorWidgetSourceArea::SeerEditorWidgetSourceArea(QWidget* parent) : SeerPl
     enableLineNumberArea(true);
     enableBreakPointArea(true);
 
+    _ctrlHeldTimer->setInterval(40);  // 40 ms interval = 25Hz update rate
+    QObject::connect(_ctrlHeldTimer, &QTimer::timeout, this, [this]() {
+        updateCursor(QCursor::pos());
+    });
+
     QObject::connect(this, &SeerEditorWidgetSourceArea::blockCountChanged,                  this, &SeerEditorWidgetSourceArea::updateMarginAreasWidth);
     QObject::connect(this, &SeerEditorWidgetSourceArea::updateRequest,                      this, &SeerEditorWidgetSourceArea::updateLineNumberArea);
     QObject::connect(this, &SeerEditorWidgetSourceArea::updateRequest,                      this, &SeerEditorWidgetSourceArea::updateBreakPointArea);
@@ -83,6 +91,8 @@ SeerEditorWidgetSourceArea::SeerEditorWidgetSourceArea(QWidget* parent) : SeerPl
     _lineNumberArea->installEventFilter(lineNumberAreaWheelForwarder);
     _breakPointArea->installEventFilter(breakPointAreaWheelForwarder);
 
+    _ctrlHeldTimer->start();
+
     // Calling close() will clear the text document.
     close();
 }
@@ -2066,6 +2076,16 @@ void SeerEditorWidgetSourceArea::mousePressEvent(QMouseEvent *event)
             }
         } );
     }
+    // This part is for Go to definition (Ctrl + Click) feature
+    if (event->button() == Qt::LeftButton && _ctrlHeld) {
+        if (_wordUnderCursor != "")
+        {
+            QApplication::restoreOverrideCursor();
+            signalGotoDefinition(_wordUnderCursor);
+            event->ignore();        // If we don't ignore the event, the cursor will move to that position, which is not desired
+            return;
+        }
+    }
     QPlainTextEdit::mousePressEvent(event);
 }
 
@@ -2089,8 +2109,72 @@ void SeerEditorWidgetSourceArea::handleCursorPositionChanged()
 }
 
 /***********************************************************************************************************************
- * Go to definition (F12) feature                                                                                            *
+ * Go to definition (F12) feature                                                                                      *
  **********************************************************************************************************************/
+void SeerEditorWidgetSourceArea::keyPressEvent(QKeyEvent *event)
+{
+    if (event->key() == Qt::Key_Control)
+    {
+        _ctrlHeld = true;
+    }
+    QPlainTextEdit::keyPressEvent(event);
+}
+
+void SeerEditorWidgetSourceArea::keyReleaseEvent(QKeyEvent *event)
+{
+    if (event->key() == Qt::Key_Control)
+    {
+        _ctrlHeld = false;
+    }
+    QPlainTextEdit::keyReleaseEvent(event);
+}
+
+bool SeerEditorWidgetSourceArea::isOverWord(const QPoint &pos)
+{
+    QTextCursor cursor = cursorForPosition(pos);
+    cursor.select(QTextCursor::WordUnderCursor);
+    return !cursor.selectedText().isEmpty();
+}
+
+QString SeerEditorWidgetSourceArea::wordUnderCursor(const QPoint &pos) const
+{
+    int leftMarginOffset = 0;
+    QMargins margins = viewportMargins();
+    QPoint adjustedPos = pos;
+
+    // The correct position to get the word under cursor should subtract the left margin 
+    // offset (breakpoint area and line number area)
+    leftMarginOffset = margins.left();
+    adjustedPos.setX(pos.x() - leftMarginOffset);
+    QTextCursor cursor = cursorForPosition(adjustedPos);
+    cursor.select(QTextCursor::WordUnderCursor);
+    return cursor.selectedText();
+}
+
+void SeerEditorWidgetSourceArea::updateCursor(const QPoint &pos)
+{
+    // Why not QApplication::setOverrideCursor()? Because QApplication::setOverrideCursor uses internal stack
+    // It causes delay and sometimes the cursor won't change back to normal when we want it to. 
+    // In short, QApplication::setOverrideCursor is global and not real time
+    // In contrary, viewport()->setCursor() is local and real time, apply only for that widget, in this case, the text area 
+    QPoint localPos = mapFromGlobal(pos);
+    if (!_ctrlHeld) {
+        viewport()->setCursor(Qt::IBeamCursor);
+        _wordUnderCursor = "";
+        return;
+    }
+    if (!hasFocus())
+        return;
+    _wordUnderCursor = wordUnderCursor(localPos);
+    if (isValidIdentifier(_wordUnderCursor))
+    {
+        viewport()->setCursor(Qt::PointingHandCursor);
+    } else {
+        viewport()->setCursor(Qt::IBeamCursor);
+        _wordUnderCursor = "";
+    }
+}
+
 // Check text and decide if that text is valid identifier (function, variable, type name)
 bool SeerEditorWidgetSourceArea::isValidIdentifier(const QString& text) 
 {

src/resources/help/CodeManager.md

@@ -44,9 +44,20 @@ The easiest method for logging a variable to the Variable Logger is to double-cl
       Ctrl+Shift    Prepend '*&' to variable              '*&argc'
 ```
 
-Using ^F will bring up a search bar in the source window.
-
-Using ^O will bring up a file bar to help locate the file for the source (in case it isn't in the directory that GDB thinks it is).
+Other key sequences.
+```
+      Keys          Description
+      ------------  ------------------------------------
+      Ctrl+LMB      Goto function defintion identified by
+                    text under cursor.
+      ^F            Bring up a text search bar in the
+                    source window.
+      ^L            Bring up a line number search bar in
+                    the source window.
+      ^O            Bring up a file bar to help locate the file
+                    for the source (in case it isn't in the
+                    directory that GDB thinks it is).
+```
 
 ### Buttons