Show disassembly var tooltips (#3206)

.gitignore

@@ -94,3 +94,7 @@ docs/source/_build
 # Local gdb files
 .gdb_history
 .gdbinit
+
+# Kdevelop
+.kdev/
+*.kdev4

src/common/Configuration.cpp

@@ -783,6 +783,16 @@ bool Configuration::getPreviewValue() const
     return s.value("asm.preview").toBool();
 }
 
+void Configuration::setShowVarTooltips(bool enabled)
+{
+    s.setValue("showVarTooltips", enabled);
+}
+
+bool Configuration::getShowVarTooltips() const
+{
+    return s.value("showVarTooltips").toBool();
+}
+
 bool Configuration::getGraphBlockEntryOffset()
 {
     return s.value("graphBlockEntryOffset", true).value<bool>();

src/common/Configuration.h

@@ -215,6 +215,12 @@ class CUTTER_EXPORT Configuration : public QObject
     void setPreviewValue(bool checked);
     bool getPreviewValue() const;
 
+    /**
+     * @brief Show tooltips for known values of registers, variables, and memory when debugging
+     */
+    void setShowVarTooltips(bool enabled);
+    bool getShowVarTooltips() const;
+
     /**
      * @brief Recently opened binaries, as shown in NewFileDialog.
      */

src/common/DisassemblyPreview.cpp

@@ -82,3 +82,75 @@ RVA DisassemblyPreview::readDisassemblyOffset(QTextCursor tc)
 
     return userData->line.offset;
 }
+
+typedef struct mmio_lookup_context
+{
+    QString selected;
+    RVA mmio_address;
+} mmio_lookup_context_t;
+
+static bool lookup_mmio_addr_cb(void *user, const ut64 key, const void *value)
+{
+    mmio_lookup_context_t *ctx = (mmio_lookup_context_t *)user;
+    if (ctx->selected == (const char *)value) {
+        ctx->mmio_address = key;
+        return false;
+    }
+    return true;
+}
+
+bool DisassemblyPreview::showDebugValueTooltip(QWidget *parent, const QPoint &pointOfEvent,
+                                               const QString &selectedText, const RVA offset)
+{
+    if (selectedText.isEmpty())
+        return false;
+
+    if (selectedText.at(0).isLetter()) {
+        {
+            const auto registerRefs = Core()->getRegisterRefValues();
+            for (auto &reg : registerRefs) {
+                if (reg.name == selectedText) {
+                    auto msg = QString("reg %1 = %2").arg(reg.name, reg.value);
+                    QToolTip::showText(pointOfEvent, msg, parent);
+                    return true;
+                }
+            }
+        }
+
+        if (offset != RVA_INVALID) {
+            auto vars = Core()->getVariables(offset);
+            for (auto &var : vars) {
+                if (var.name == selectedText) {
+                    auto msg = QString("var %1 = %2").arg(var.name, var.value);
+                    QToolTip::showText(pointOfEvent, msg, parent);
+                    return true;
+                }
+            }
+        }
+
+        {
+            // Lookup MMIO address
+            mmio_lookup_context_t ctx;
+            ctx.selected = selectedText;
+            ctx.mmio_address = RVA_INVALID;
+            auto core = Core()->core();
+            RzPlatformTarget *arch_target = core->analysis->arch_target;
+            if (arch_target && arch_target->profile) {
+                ht_up_foreach(arch_target->profile->registers_mmio, lookup_mmio_addr_cb, &ctx);
+            }
+            if (ctx.mmio_address != RVA_INVALID) {
+                int len = 8; // TODO: Determine proper len of mmio address for the cpu
+                if (char *r = rz_core_print_hexdump_or_hexdiff_str(core, RZ_OUTPUT_MODE_STANDARD,
+                                                                   ctx.mmio_address, len, false)) {
+                    auto val = QString::fromUtf8(r).trimmed().split("\n").last();
+                    auto msg = QString("mmio %1 %2").arg(selectedText, val);
+                    free(r);
+                    QToolTip::showText(pointOfEvent, msg, parent);
+                    return true;
+                }
+            }
+        }
+    }
+    // Else show preview for value?
+    return false;
+}

src/common/DisassemblyPreview.h

@@ -41,5 +41,13 @@ bool showDisasPreview(QWidget *parent, const QPoint &pointOfEvent, const RVA off
  * @return The disassembly offset of the hovered asm text
  */
 RVA readDisassemblyOffset(QTextCursor tc);
+
+/**
+ * @brief Show a QToolTip that shows the value of the highlighted register, variable, or memory
+ * @return True if the tooltip is shown
+ */
+bool showDebugValueTooltip(QWidget *parent, const QPoint &pointOfEvent, const QString &selectedText,
+                           const RVA offset);
+
 }
 #endif

src/core/Cutter.cpp

@@ -1804,6 +1804,12 @@ QList<VariableDescription> CutterCore::getVariables(RVA at)
         }
         desc.type = QString::fromUtf8(tn);
         rz_mem_free(tn);
+
+        if (char *v = rz_core_analysis_var_display(core, var, false)) {
+            desc.value = QString::fromUtf8(v).trimmed();
+            rz_mem_free(v);
+        }
+
         ret.push_back(desc);
     }
     return ret;

src/core/CutterDescriptions.h

@@ -357,6 +357,7 @@ struct VariableDescription
     RzAnalysisVarStorageType storageType;
     QString name;
     QString type;
+    QString value;
 };
 
 struct RegisterRefValueDescription

src/dialogs/preferences/AsmOptionsWidget.cpp

@@ -65,6 +65,12 @@ AsmOptionsWidget::AsmOptionsWidget(PreferencesDialog *dialog)
             &AsmOptionsWidget::relOffCheckBoxToggled);
     connect(Core(), &CutterCore::asmOptionsChanged, this,
             &AsmOptionsWidget::updateAsmOptionsFromVars);
+
+    connect(ui->varTooltipsCheckBox, &QCheckBox::toggled, [this](bool checked) {
+        Config()->setShowVarTooltips(checked);
+        triggerAsmOptionsChanged();
+    });
+
     updateAsmOptionsFromVars();
 }
 
@@ -138,6 +144,8 @@ void AsmOptionsWidget::updateAsmOptionsFromVars()
     ui->previewCheckBox->setChecked(Config()->getPreviewValue());
     ui->previewCheckBox->blockSignals(false);
 
+    qhelpers::setCheckedWithoutSignals(ui->varTooltipsCheckBox, Config()->getShowVarTooltips());
+
     QList<ConfigCheckbox>::iterator confCheckbox;
 
     // Set the value for each checkbox in "checkboxes" as it exists in the configuration