Debugger: Rework editor tooltips handling

Fix expansion and updating.

Persistence and non-locals are still lacking.

Change-Id: I74e25199d50350516afc686a05836e239bfc8acb
Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
Reviewed-by: hjk <hjk121@nokiamail.com>

src/plugins/debugger/cdb/cdbengine.cpp

@@ -1968,8 +1968,10 @@ void CdbEngine::handleLocals(const CdbExtensionCommandPtr &reply)
             foreach (const WatchData &wd, watchData)
                 nsp << wd.toString() <<'\n';
         }
-        if (flags & LocalsUpdateForNewFrame)
+        if (flags & LocalsUpdateForNewFrame) {
             emit stackFrameCompleted();
+            DebuggerToolTipManager::updateEngine(this);
+        }
     } else {
         showMessage(QString::fromLatin1(reply->errorMessage), LogWarning);
     }

src/plugins/debugger/debuggercore.h

@@ -60,7 +60,6 @@ class BreakHandler;
 class SnapshotHandler;
 class Symbol;
 class Section;
-class DebuggerToolTipManager;
 class GlobalDebuggerOptions;
 
 enum TestCases
@@ -120,7 +119,6 @@ public:
     virtual QStringList stringListSetting(int code) const = 0;
     virtual void setThreads(const QStringList &list, int index) = 0;
 
-    virtual DebuggerToolTipManager *toolTipManager() const = 0;
     virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const = 0;
 
     static QTreeView *inspectorView();

src/plugins/debugger/debuggerengine.cpp

@@ -35,6 +35,7 @@
 #include "debuggerrunner.h"
 #include "debuggerstringutils.h"
 #include "debuggerstartparameters.h"
+#include "debuggertooltipmanager.h"
 
 #include "breakhandler.h"
 #include "disassembleragent.h"
@@ -1176,11 +1177,16 @@ void DebuggerEngine::setState(DebuggerState state, bool forced)
     if (!forced && !isAllowedTransition(oldState, state))
         qDebug() << "*** UNEXPECTED STATE TRANSITION: " << this << msg;
 
+    if (state == EngineRunRequested) {
+        DebuggerToolTipManager::registerEngine(this);
+    }
+
     if (state == DebuggerFinished) {
         // Give up ownership on claimed breakpoints.
         BreakHandler *handler = breakHandler();
         foreach (BreakpointModelId id, handler->engineBreakpointIds(this))
             handler->notifyBreakpointReleased(id);
+        DebuggerToolTipManager::deregisterEngine(this);
     }
 
     showMessage(msg, LogDebug);

src/plugins/debugger/debuggerplugin.cpp

@@ -1202,7 +1202,6 @@ public slots:
     bool parseArguments(const QStringList &args, QString *errorMessage);
     void parseCommandLineArguments();
 
-    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
     QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
 
     void updateQmlActions() {
@@ -2526,7 +2525,7 @@ void DebuggerPluginPrivate::sessionLoaded()
 {
     m_breakHandler->loadSessionData();
     dummyEngine()->watchHandler()->loadSessionData();
-    m_toolTipManager->loadSessionData();
+    DebuggerToolTipManager::loadSessionData();
 }
 
 void DebuggerPluginPrivate::aboutToUnloadSession()
@@ -2537,8 +2536,8 @@ void DebuggerPluginPrivate::aboutToUnloadSession()
 void DebuggerPluginPrivate::aboutToSaveSession()
 {
     dummyEngine()->watchHandler()->saveSessionData();
-    m_toolTipManager->saveSessionData();
     m_breakHandler->saveSessionData();
+    DebuggerToolTipManager::saveSessionData();
 }
 
 void DebuggerPluginPrivate::showStatusMessage(const QString &msg0, int timeout)

src/plugins/debugger/debuggerrunner.cpp

@@ -38,7 +38,6 @@
 #include "debuggerrunconfigurationaspect.h"
 #include "debuggerstartparameters.h"
 #include "debuggerstringutils.h"
-#include "debuggertooltipmanager.h"
 #include "breakhandler.h"
 #include "shared/peutils.h"
 
@@ -136,9 +135,7 @@ DebuggerRunControl::DebuggerRunControl(RunConfiguration *runConfiguration,
     QString errorMessage;
     d->m_engine = DebuggerRunControlFactory::createEngine(sp.masterEngineType, sp, &errorMessage);
 
-    if (d->m_engine) {
-        DebuggerToolTipManager::registerEngine(d->m_engine);
-    } else {
+    if (!d->m_engine) {
         debuggingFinished();
         Core::ICore::showWarningWithOptions(DebuggerRunControl::tr("Debugger"), errorMessage);
     }

src/plugins/debugger/debuggertooltipmanager.h

@@ -52,14 +52,17 @@ class DebuggerToolTipContext
 {
 public:
     DebuggerToolTipContext();
-    static DebuggerToolTipContext fromEditor(Core::IEditor *ed, int pos);
-    bool isValid() const { return !fileName.isEmpty(); }
+    bool isValid() const { return !expression.isEmpty(); }
+    bool matchesFrame(const QString &frameFile, const QString &frameFunction) const;
+    bool isSame(const DebuggerToolTipContext &other) const;
 
     QString fileName;
     int position;
     int line;
     int column;
     QString function; //!< Optional function. This must be set by the engine as it is language-specific.
+    QString engineType;
+    QDate creationDate;
 
     QPoint mousePosition;
     QString expression;
@@ -85,7 +88,6 @@ private slots:
     void computeSize();
     void expandNode(const QModelIndex &idx);
     void collapseNode(const QModelIndex &idx);
-    void handleItemIsExpanded(const QModelIndex &sourceIdx);
 
 private:
     int computeHeight(const QModelIndex &index) const;
@@ -102,37 +104,40 @@ public:
     ~DebuggerToolTipManager();
 
     static void registerEngine(DebuggerEngine *engine);
+    static void deregisterEngine(DebuggerEngine *engine);
+    static void updateEngine(DebuggerEngine *engine);
     static bool hasToolTips();
 
     // Collect all expressions of DebuggerTreeViewToolTipWidget
-    static DebuggerToolTipContexts treeWidgetExpressions(const QString &fileName,
-                                               const QString &engineType = QString(),
-                                               const QString &function= QString());
+    static DebuggerToolTipContexts treeWidgetExpressions(DebuggerEngine *engine,
+        const QString &fileName, const QString &function = QString());
 
     static void showToolTip(const DebuggerToolTipContext &context,
                             DebuggerEngine *engine);
 
     virtual bool eventFilter(QObject *, QEvent *);
 
-    static bool debug();
-    static QString treeModelClipboardContents(const QAbstractItemModel *m);
+    static QString treeModelClipboardContents(const QAbstractItemModel *model);
 
 public slots:
     void debugModeEntered();
     void leavingDebugMode();
     void sessionAboutToChange();
-    void loadSessionData();
-    void saveSessionData();
+    static void loadSessionData();
+    static void saveSessionData();
     static void closeAllToolTips();
-    void hide();
+    static void hide();
 
 private slots:
-    void slotUpdateVisibleToolTips();
+    static void slotUpdateVisibleToolTips();
     void slotDebuggerStateChanged(Debugger::DebuggerState);
-    void slotStackFrameCompleted();
     void slotEditorOpened(Core::IEditor *);
     void slotTooltipOverrideRequested(TextEditor::ITextEditor *editor,
             const QPoint &point, int pos, bool *handled);
+
+private:
+    bool tryHandleToolTipOverride(TextEditor::ITextEditor *editor,
+            const QPoint &point, int pos);
 };
 
 } // namespace Internal

src/plugins/debugger/gdb/gdbengine.cpp

@@ -3629,39 +3629,30 @@ void GdbEngine::handleRegisterListValues(const GdbResponse &response)
 //
 //////////////////////////////////////////////////////////////////////
 
-void GdbEngine::showToolTip()
-{
-    if (m_toolTipContext.isNull())
-        return;
-    const QString expression = m_toolTipContext->expression;
-    if (DebuggerToolTipManager::debug())
-        qDebug() << "GdbEngine::showToolTip " << expression << m_toolTipContext->iname << (*m_toolTipContext);
-
-    if (m_toolTipContext->iname.startsWith("tooltip")
-        && (!debuggerCore()->boolSetting(UseToolTipsInMainEditor)
-            || !watchHandler()->isValidToolTip(m_toolTipContext->iname))) {
-        watchHandler()->removeData(m_toolTipContext->iname);
-        return;
-    }
-
-    DebuggerToolTipManager::showToolTip(*m_toolTipContext, this);
-    // Prevent tooltip from re-occurring (classic GDB, QTCREATORBUG-4711).
-    m_toolTipContext.reset();
-}
-
-QString GdbEngine::tooltipExpression() const
-{
-    return m_toolTipContext.isNull() ? QString() : m_toolTipContext->expression;
-}
+//void GdbEngine::showToolTip()
+//{
+//    const QString expression = m_toolTipContext.expression;
+//    if (DebuggerToolTipManager::debug())
+//        qDebug() << "GdbEngine::showToolTip " << expression << m_toolTipContext.iname << m_toolTipContext;
+
+//    if (m_toolTipContext.iname.startsWith("tooltip")
+//        && (!debuggerCore()->boolSetting(UseToolTipsInMainEditor)
+//            || !watchHandler()->isValidToolTip(m_toolTipContext.iname))) {
+//        watchHandler()->removeData(m_toolTipContext.iname);
+//        return;
+//    }
+
+//    DebuggerToolTipManager::showToolTip(m_toolTipContext, this);
+//}
 
 void GdbEngine::resetLocation()
 {
-    m_toolTipContext.reset();
+    m_toolTipContext.expression.clear();
     DebuggerEngine::resetLocation();
 }
 
 bool GdbEngine::setToolTipExpression(TextEditor::ITextEditor *editor,
-    const DebuggerToolTipContext &contextIn)
+    const DebuggerToolTipContext &context)
 {
     if (state() != InferiorStopOk || !isCppEditor(editor)) {
         //qDebug() << "SUPPRESSING DEBUGGER TOOLTIP, INFERIOR NOT STOPPED "
@@ -3669,45 +3660,13 @@ bool GdbEngine::setToolTipExpression(TextEditor::ITextEditor *editor,
         return false;
     }
 
-    DebuggerToolTipContext context = contextIn;
-    int line, column;
-    QString exp = fixCppExpression(cppExpressionAt(editor, context.position, &line, &column, &context.function));
-    if (exp.isEmpty())
-        return false;
-    // Prefer a filter on an existing local variable if it can be found.
-    QByteArray iname;
-    if (const WatchData *localVariable = watchHandler()->findCppLocalVariable(exp)) {
-        exp = QLatin1String(localVariable->exp);
-        iname = localVariable->iname;
-    } else {
-        iname = tooltipIName(exp);
-    }
-
-    if (DebuggerToolTipManager::debug())
-        qDebug() << "GdbEngine::setToolTipExpression1 " << exp << iname << context;
-
-    // Same expression: Display synchronously.
-    if (!m_toolTipContext.isNull() && m_toolTipContext->expression == exp) {
-        showToolTip();
-        return true;
-    }
-
-    m_toolTipContext.reset(new DebuggerToolTipContext(context));
-    m_toolTipContext->expression = exp;
-    m_toolTipContext->iname = iname;
-    // Local variable: Display synchronously.
-    if (iname.startsWith("local")) {
-        showToolTip();
-        return true;
-    }
-
-    if (DebuggerToolTipManager::debug())
-        qDebug() << "GdbEngine::setToolTipExpression2 " << exp << (*m_toolTipContext);
+    m_toolTipContext = context;
+    //  qDebug() << "GdbEngine::setToolTipExpression2 " << exp << m_toolTipContext;
 
     UpdateParameters params;
     params.tryPartial = true;
     params.tooltipOnly = true;
-    params.varList = iname;
+    params.varList = context.iname;
     updateLocalsPython(params);
     return true;
 }
@@ -3773,7 +3732,12 @@ void GdbEngine::rebuildWatchModel()
         showMessage(LogWindow::logTimeStamp(), LogMiscInput);
     showMessage(_("<Rebuild Watchmodel %1>").arg(count), LogMiscInput);
     showStatusMessage(tr("Finished retrieving data"), 400);
-    showToolTip();
+
+    if (m_toolTipContext.isValid()) {
+        DebuggerToolTipManager::showToolTip(m_toolTipContext, this);
+        m_toolTipContext = DebuggerToolTipContext();
+    }
+    DebuggerToolTipManager::updateEngine(this);
 }
 
 void GdbEngine::handleVarAssign(const GdbResponse &)
@@ -4875,9 +4839,9 @@ void GdbEngine::updateLocalsPython(const UpdateParameters &params)
         // Re-create tooltip items that are not filters on existing local variables in
         // the tooltip model.
         DebuggerToolTipContexts toolTips =
-            DebuggerToolTipManager::treeWidgetExpressions(fileName, objectName(), function);
+            DebuggerToolTipManager::treeWidgetExpressions(this, fileName, function);
 
-        const QString currentExpression = tooltipExpression();
+        const QString currentExpression = m_toolTipContext.expression;
         if (!currentExpression.isEmpty()) {
             int currentIndex = -1;
             for (int i = 0; i < toolTips.size(); ++i) {
@@ -5015,8 +4979,10 @@ void GdbEngine::handleStackFramePython(const GdbResponse &response)
             //PENDING_DEBUG("\n\n ....  AND TRIGGERS MODEL UPDATE\n");
             rebuildWatchModel();
         //}
-        if (!partial)
+        if (!partial) {
             emit stackFrameCompleted();
+            DebuggerToolTipManager::updateEngine(this);
+        }
     } else {
         showMessage(_("DUMPER FAILED: " + response.toString()));
     }

src/plugins/debugger/gdb/gdbengine.h

@@ -34,6 +34,7 @@
 
 #include <debugger/watchhandler.h>
 #include <debugger/watchutils.h>
+#include <debugger/debuggertooltipmanager.h>
 
 #include <coreplugin/id.h>
 
@@ -467,8 +468,7 @@ protected:
     void showExecutionError(const QString &message);
 
     static QByteArray tooltipIName(const QString &exp);
-    QString tooltipExpression() const;
-    QScopedPointer<DebuggerToolTipContext> m_toolTipContext;
+    DebuggerToolTipContext m_toolTipContext;
 
     // For short-circuiting stack and thread list evaluation.
     bool m_stackNeeded;

src/plugins/debugger/lldb/lldbengine.cpp

@@ -821,31 +821,23 @@ static QHash<QString, WatchData> m_toolTipCache;
 
 void LldbEngine::showToolTip()
 {
-    if (m_toolTipContext.isNull())
+    if (m_toolTipContext.expression.isEmpty())
         return;
-    const QString expression = m_toolTipContext->expression;
-    if (DebuggerToolTipManager::debug())
-        qDebug() << "LldbEngine::showToolTip " << expression << m_toolTipContext->iname << (*m_toolTipContext);
-
-    if (m_toolTipContext->iname.startsWith("tooltip")
-        && (!debuggerCore()->boolSetting(UseToolTipsInMainEditor)
-            || !watchHandler()->isValidToolTip(m_toolTipContext->iname))) {
-        watchHandler()->removeData(m_toolTipContext->iname);
-        return;
-    }
+    //const QString expression = m_toolTipContext->expression;
+    // qDebug() << "LldbEngine::showToolTip " << expression << m_toolTipContext->iname << (*m_toolTipContext);
 
-    DebuggerToolTipManager::showToolTip(*m_toolTipContext, this);
+    DebuggerToolTipManager::showToolTip(m_toolTipContext, this);
     // Prevent tooltip from re-occurring (classic GDB, QTCREATORBUG-4711).
-    m_toolTipContext.reset();
+    m_toolTipContext.expression.clear();
 }
 
 void LldbEngine::resetLocation()
 {
-    m_toolTipContext.reset();
+    m_toolTipContext.expression.clear();
     DebuggerEngine::resetLocation();
 }
 
-bool LldbEngine::setToolTipExpression(TextEditor::ITextEditor *editor, const DebuggerToolTipContext &contextIn)
+bool LldbEngine::setToolTipExpression(TextEditor::ITextEditor *editor, const DebuggerToolTipContext &context)
 {
     if (state() != InferiorStopOk || !isCppEditor(editor)) {
         //qDebug() << "SUPPRESSING DEBUGGER TOOLTIP, INFERIOR NOT STOPPED "
@@ -853,45 +845,12 @@ bool LldbEngine::setToolTipExpression(TextEditor::ITextEditor *editor, const Deb
         return false;
     }
 
-    DebuggerToolTipContext context = contextIn;
-    int line, column;
-    QString exp = fixCppExpression(cppExpressionAt(editor, context.position, &line, &column, &context.function));
-    if (exp.isEmpty())
-        return false;
-    // Prefer a filter on an existing local variable if it can be found.
-    QByteArray iname;
-    if (const WatchData *localVariable = watchHandler()->findCppLocalVariable(exp)) {
-        exp = QLatin1String(localVariable->exp);
-        iname = localVariable->iname;
-    } else {
-        iname = tooltipIName(exp);
-    }
-
-    if (DebuggerToolTipManager::debug())
-        qDebug() << "GdbEngine::setToolTipExpression1 " << exp << iname << context;
-
-    // Same expression: Display synchronously.
-    if (!m_toolTipContext.isNull() && m_toolTipContext->expression == exp) {
-        showToolTip();
-        return true;
-    }
-
-    m_toolTipContext.reset(new DebuggerToolTipContext(context));
-    m_toolTipContext->expression = exp;
-    m_toolTipContext->iname = iname;
-    // Local variable: Display synchronously.
-    if (iname.startsWith("local")) {
-        showToolTip();
-        return true;
-    }
-
-    if (DebuggerToolTipManager::debug())
-        qDebug() << "GdbEngine::setToolTipExpression2 " << exp << (*m_toolTipContext);
+    m_toolTipContext = context;
 
     UpdateParameters params;
     params.tryPartial = true;
     params.tooltipOnly = true;
-    params.varList = iname;
+    params.varList = context.iname;
     doUpdateLocals(params);
 
     return true;
@@ -980,10 +939,9 @@ void LldbEngine::doUpdateLocals(UpdateParameters params)
         // Re-create tooltip items that are not filters on existing local variables in
         // the tooltip model.
         DebuggerToolTipContexts toolTips =
-            DebuggerToolTipManager::treeWidgetExpressions(frame.file, objectName(), frame.function);
+            DebuggerToolTipManager::treeWidgetExpressions(this, frame.file, frame.function);
 
-        const QString currentExpression =
-             m_toolTipContext.isNull() ? QString() : m_toolTipContext->expression;
+        const QString currentExpression = m_toolTipContext.expression;
         if (!currentExpression.isEmpty()) {
             int currentIndex = -1;
             for (int i = 0; i < toolTips.size(); ++i) {

src/plugins/debugger/lldb/lldbengine.h

@@ -34,6 +34,7 @@
 #include <debugger/disassembleragent.h>
 #include <debugger/memoryagent.h>
 #include <debugger/watchhandler.h>
+#include <debugger/debuggertooltipmanager.h>
 
 #include <utils/consoleprocess.h>
 
@@ -217,7 +218,7 @@ private:
     QMap<QPointer<DisassemblerAgent>, int> m_disassemblerAgents;
     QMap<QPointer<MemoryAgent>, int> m_memoryAgents;
     QHash<int, QPointer<QObject> > m_memoryAgentTokens;
-    QScopedPointer<DebuggerToolTipContext> m_toolTipContext;
+    DebuggerToolTipContext m_toolTipContext;
 
     void showToolTip();
 

src/plugins/debugger/watchhandler.cpp

@@ -500,7 +500,11 @@ WatchItem *WatchModel::findItem(const QByteArray &iname) const
 
 void WatchModel::checkIndex(const QModelIndex &index) const
 {
-    QTC_CHECK(index.isValid() ? index.model() == this : index.model() == 0);
+    if (index.isValid()) {
+        QTC_CHECK(index.model() == this);
+    } else {
+        QTC_CHECK(index.model() == 0);
+    }
 }
 
 WatchItem *WatchModel::createItem(const WatchData &data)

src/plugins/debugger/watchwindow.cpp

@@ -1025,31 +1025,31 @@ void WatchTreeView::handleItemIsExpanded(const QModelIndex &idx)
         expand(idx);
 }
 
-void WatchTreeView::resetHelper()
-{
-    QModelIndex idx = model()->index(m_type, 0);
-    resetHelper(idx);
-    expand(idx);
-}
-
-void WatchTreeView::resetHelper(const QModelIndex &idx)
+void WatchTreeView::reexpand(QTreeView *view, const QModelIndex &idx)
 {
     if (idx.data(LocalsExpandedRole).toBool()) {
-        //qDebug() << "EXPANDING " << model()->data(idx, LocalsINameRole);
-        if (!isExpanded(idx)) {
-            expand(idx);
-            for (int i = 0, n = model()->rowCount(idx); i != n; ++i) {
-                QModelIndex idx1 = model()->index(i, 0, idx);
-                resetHelper(idx1);
+        //qDebug() << "EXPANDING " << view->model()->data(idx, LocalsINameRole);
+        if (!view->isExpanded(idx)) {
+            view->expand(idx);
+            for (int i = 0, n = view->model()->rowCount(idx); i != n; ++i) {
+                QModelIndex idx1 = view->model()->index(i, 0, idx);
+                reexpand(view, idx1);
             }
         }
     } else {
-        //qDebug() << "COLLAPSING " << model()->data(idx, LocalsINameRole);
-        if (isExpanded(idx))
-            collapse(idx);
+        //qDebug() << "COLLAPSING " << view->model()->data(idx, LocalsINameRole);
+        if (view->isExpanded(idx))
+            view->collapse(idx);
     }
 }
 
+void WatchTreeView::resetHelper()
+{
+    QModelIndex idx = model()->index(m_type, 0);
+    reexpand(this, idx);
+    expand(idx);
+}
+
 void WatchTreeView::reset()
 {
     BaseTreeView::reset();

src/plugins/debugger/watchwindow.h

@@ -56,6 +56,7 @@ public:
     void reset();
 
     void fillFormatMenu(QMenu *, const QModelIndex &mi);
+    static void reexpand(QTreeView *view, const QModelIndex &idx);
 
 public slots:
     void watchExpression(const QString &exp);
@@ -91,7 +92,6 @@ private:
 
     void inputNewExpression();
     void editItem(const QModelIndex &idx);
-    void resetHelper(const QModelIndex &idx);
 
     void setModelData(int role, const QVariant &value = QVariant(),
         const QModelIndex &index = QModelIndex());