Refactor: use marks API (#3510)

* Remove: unecessary changes
* Add: `rz_mark` in `BundledRizin.cmake`
* Fix: clang format
* Remove: `::fromString()`
* Fix: mark handling
* Refactor: use tooltip instead of label
* Minimize tooltip flicker with similar dummy text

Author: PremadeS

cmake/BundledRizin.cmake

@@ -55,7 +55,7 @@ endif()
 # instead of being hardcoded.
 set (Rizin_VERSION 0.9)
 
-set (RZ_LIBS rz_core rz_config rz_cons rz_io rz_util rz_flag rz_arch rz_debug
+set (RZ_LIBS rz_core rz_config rz_cons rz_io rz_util rz_flag rz_mark rz_arch rz_debug
         rz_hash rz_bin rz_lang rz_il rz_egg rz_reg rz_search rz_syscall
         rz_socket rz_magic rz_crypto rz_type rz_diff rz_sign rz_demangler)
 set (RZ_EXTRA_LIBS rz_main)

src/CMakeLists.txt

@@ -158,6 +158,7 @@ set(SOURCES
     dialogs/preferences/ShortcutOptionsWidget.cpp
     shortcuts/ShortcutManager.cpp
     shortcuts/DefaultShortcuts.cpp
+    dialogs/MarkDialog.cpp
 )
 set(HEADER_FILES
     core/Cutter.h
@@ -325,6 +326,7 @@ set(HEADER_FILES
     dialogs/preferences/ShortcutOptionsWidget.h
     shortcuts/ShortcutManager.h
     shortcuts/DefaultShortcuts.h
+    dialogs/MarkDialog.h
 )
 set(UI_FILES
     dialogs/AboutDialog.ui
@@ -400,6 +402,7 @@ set(UI_FILES
     tools/basefind/BaseFindSearchDialog.ui
     tools/basefind/BaseFindResultsDialog.ui
     dialogs/preferences/ShortcutOptionsWidget.ui
+    dialogs/MarkDialog.ui
 )
 set(QRC_FILES
     resources.qrc

src/core/Cutter.cpp

@@ -16,6 +16,7 @@
 #include "common/Configuration.h"
 #include "common/AsyncTask.h"
 #include "common/RizinTask.h"
+#include "dialogs/MarkDialog.h"
 #include "dialogs/RizinTaskDialog.h"
 #include "common/Json.h"
 #include "core/Cutter.h"
@@ -4457,6 +4458,88 @@ QString CutterCore::nearestFlag(RVA offset, RVA *flagOffsetOut)
     return r->name;
 }
 
+void CutterCore::addMark(RVA from, RVA to, QString name, QString comment, QColor color)
+{
+    CORE_LOCK();
+    auto m = rz_mark_set(core->marks, name.toStdString().c_str(), from, to);
+    if (m) {
+        rz_mark_item_set_comment(m, comment.toStdString().c_str());
+        rz_mark_item_set_color(m, color.name().toStdString().c_str());
+    }
+    emit marksChanged();
+}
+
+void CutterCore::delMark(const QString &name)
+{
+    CORE_LOCK();
+    auto m = rz_mark_get(core->marks, name.toStdString().c_str());
+    if (m) {
+        rz_mark_unset(core->marks, m);
+    }
+    emit marksChanged();
+}
+
+QList<MarkDescription> CutterCore::convertMarks(RzList *marks)
+{
+    QList<MarkDescription> markList;
+
+    RzListIter *it;
+    RzMarkItem *mark;
+    CutterRzListForeach (marks, it, RzMarkItem, mark) {
+        MarkDescription desc;
+        desc.from = mark->from;
+        desc.to = mark->to;
+        desc.name = mark->name;
+        desc.realname = mark->realname;
+        desc.comment = mark->comment;
+        desc.color = mark->color ? QColor(mark->color) : QColor(Qt::black);
+
+        markList.append(desc);
+    }
+    rz_list_free(marks);
+    return markList;
+}
+
+QList<MarkDescription> CutterCore::getMarks()
+{
+    CORE_LOCK();
+    return convertMarks(rz_mark_all_list(core->marks));
+}
+
+QList<MarkDescription> CutterCore::getMarksAt(RVA addr)
+{
+    CORE_LOCK();
+    return convertMarks(rz_mark_get_all_off(core->marks, addr));
+}
+
+QColor CutterCore::getBlendedMarksColorAt(RVA addr)
+{
+    const auto &marks = getMarksAt(addr);
+    double r = 0, g = 0, b = 0, a = 0;
+    bool first = true;
+
+    // Iterate in reverse because the oldest/first mark is at the end
+    for (auto it = marks.crbegin(); it != marks.crend(); ++it) {
+        QColor c = it->color;
+        if (!c.isValid()) {
+            continue;
+        }
+
+        double cr = c.redF(), cg = c.greenF(), cb = c.blueF();
+        if (first) {
+            r = cr, g = cg, b = cb, a = MARK_ALPHA_F;
+            first = false;
+        } else {
+            double a_out = MARK_ALPHA_F + a * (1.0 - MARK_ALPHA_F);
+            r = (cr * MARK_ALPHA_F + r * a * (1.0 - MARK_ALPHA_F)) / a_out;
+            g = (cg * MARK_ALPHA_F + g * a * (1.0 - MARK_ALPHA_F)) / a_out;
+            b = (cb * MARK_ALPHA_F + b * a * (1.0 - MARK_ALPHA_F)) / a_out;
+            a = a_out;
+        }
+    }
+    return first ? QColor() : QColor::fromRgbF(r, g, b, a);
+}
+
 void CutterCore::handleREvent(int type, void *data)
 {
     switch (type) {

src/core/Cutter.h

@@ -253,6 +253,19 @@ class CUTTER_EXPORT CutterCore : public QObject
     QString nearestFlag(RVA offset, RVA *flagOffsetOut);
     void triggerFlagsChanged();
 
+    /* Marks */
+    void addMark(RVA from, RVA to, QString name, QString comment = {}, QColor color = {});
+    void delMark(const QString &name);
+    QList<MarkDescription> getMarks();
+    QList<MarkDescription> getMarksAt(RVA addr);
+    /**
+     * @brief Compute the blended color of all marks containing a specific address.
+     * @param addr address to query
+     * @return resulting blended color, or invalid QColor if no marks are present at
+     * the specified address
+     */
+    QColor getBlendedMarksColorAt(RVA addr);
+
     /* Global Variables */
     void addGlobalVariable(RVA offset, QString name, QString typ);
     void delGlobalVariable(QString name);
@@ -788,6 +801,7 @@ class CUTTER_EXPORT CutterCore : public QObject
     void breakpointsChanged(RVA offset);
     void refreshCodeViews();
     void stackChanged();
+    void marksChanged();
     /**
      * @brief update all the widgets that are affected by rebasing in debug mode
      */
@@ -872,6 +886,7 @@ class CUTTER_EXPORT CutterCore : public QObject
     QVector<QString> getCutterRCFilePaths() const;
     QList<TypeDescription> getBaseType(RzBaseTypeKind kind, const char *category);
     QList<SearchDescription> getAllSearchCommand(QString searchFor, SearchKind kind, QString in);
+    QList<MarkDescription> convertMarks(RzList *marks);
 };
 
 class CUTTER_EXPORT RzCoreLocked

src/core/CutterDescriptions.h

@@ -418,6 +418,16 @@ struct BasefindResultDescription
     ut32 score;
 };
 
+struct MarkDescription
+{
+    RVA from;
+    RVA to;
+    QString name;
+    QString realname;
+    QString comment;
+    QColor color;
+};
+
 Q_DECLARE_METATYPE(FunctionDescription)
 Q_DECLARE_METATYPE(ImportDescription)
 Q_DECLARE_METATYPE(ExportDescription)
@@ -459,5 +469,6 @@ Q_DECLARE_METATYPE(RefDescription)
 Q_DECLARE_METATYPE(VariableDescription)
 Q_DECLARE_METATYPE(BasefindCoreStatusDescription)
 Q_DECLARE_METATYPE(BasefindResultDescription)
+Q_DECLARE_METATYPE(MarkDescription)
 
 #endif // DESCRIPTIONS_H

src/dialogs/MarkDialog.cpp

@@ -0,0 +1,108 @@
+#include "MarkDialog.h"
+#include "Cutter.h"
+#include "CutterCommon.h"
+#include "ui_MarkDialog.h"
+#include <QColorDialog>
+#include <QRegularExpressionValidator>
+
+MarkDialog::MarkDialog(RVA start, RVA end, QWidget *parent, QString name)
+    : QDialog(parent),
+      ui(new Ui::MarkDialog),
+      markName(name),
+      markFrom(start),
+      markTo(end),
+      markColor(Qt::black),
+      markComment(""),
+      edit(false)
+{
+    ui->setupUi(this);
+
+    if (!markName.isEmpty()) {
+        // Editing existing Mark
+        setWindowTitle("Edit Mark");
+        RzCoreLocked core(Core());
+        RzMarkItem *mark = rz_mark_get(core->marks, markName.toStdString().c_str());
+        if (mark) {
+            markFrom = mark->from;
+            markTo = mark->to;
+            markColor = QColor(mark->color);
+            markComment = mark->comment;
+        }
+        edit = true;
+    } else {
+        // Creating new Mark
+        setWindowTitle("Add Mark");
+        markName = QString("%1_%2").arg(RzAddressString(markFrom), RzAddressString(markTo));
+    }
+
+    ui->startAddressEdit->setText(RzAddressString(markFrom));
+    ui->endAddressEdit->setText(RzAddressString(markTo));
+    ui->nameEdit->setText(markName);
+    ui->commentEdit->setText(markComment);
+    ui->colorDisplay->setStyleSheet(colorToStyle(markColor));
+
+    auto hexValidator =
+            new QRegularExpressionValidator(QRegularExpression("(?:0[xX])?[0-9a-fA-F]+"), this);
+    ui->startAddressEdit->setValidator(hexValidator);
+    ui->endAddressEdit->setValidator(hexValidator);
+
+    connect(ui->colorButton, &QPushButton::clicked, this, &MarkDialog::onPickColor);
+    connect(ui->buttonBox, &QDialogButtonBox::accepted, this, &MarkDialog::accept);
+    connect(ui->buttonBox, &QDialogButtonBox::rejected, this, &MarkDialog::reject);
+}
+
+void MarkDialog::accept()
+{
+    bool ok = false;
+    markFrom = ui->startAddressEdit->text().toULongLong(&ok, 16);
+    if (!ok) {
+        QMessageBox::warning(this, tr("Invalid Input"),
+                             tr("Starting address is not a valid hexadecimal number"));
+        return;
+    }
+    markTo = ui->endAddressEdit->text().toULongLong(&ok, 16);
+    if (!ok) {
+        QMessageBox::warning(this, tr("Invalid Input"),
+                             tr("Ending address is not a valid hexadecimal number"));
+        return;
+    }
+    if (markFrom > markTo) {
+        QMessageBox::warning(this, tr("Invalid Input"),
+                             tr("Starting address cannot be greater than ending address"));
+        return;
+    }
+
+    QString name = ui->nameEdit->text();
+    if (edit && !name.isEmpty() && name != markName) {
+        Core()->delMark(markName); // Delete the old mark
+    } else if (name.isEmpty()) {
+        QMessageBox::warning(this, tr("Invalid Input"), tr("Name cannot be empty"));
+        return;
+    }
+
+    markName = name;
+    markComment = ui->commentEdit->toPlainText();
+    Core()->addMark(markFrom, markTo, markName, markComment, markColor);
+
+    QDialog::accept();
+}
+
+MarkDialog::~MarkDialog() {}
+
+void MarkDialog::onPickColor()
+{
+    QColor c = QColorDialog::getColor(markColor, this, tr("Pick Background Color"));
+    if (c.isValid()) {
+        markColor = c;
+        ui->colorDisplay->setStyleSheet(colorToStyle(markColor));
+    }
+}
+
+QString MarkDialog::colorToStyle(const QColor &color)
+{
+    return QString("background-color: rgba(%1, %2, %3, %4);")
+            .arg(color.red())
+            .arg(color.green())
+            .arg(color.blue())
+            .arg(MARK_ALPHA_F);
+}

src/dialogs/MarkDialog.h

@@ -0,0 +1,39 @@
+#ifndef MARKDIALOG_H
+#define MARKDIALOG_H
+
+#include "CutterCommon.h"
+#include <QDialog>
+#include <QColor>
+
+constexpr qreal MARK_ALPHA_F = 0.5; // 50% alpha to show blending of multiple overalapping marks
+
+namespace Ui {
+class MarkDialog;
+}
+
+class MarkDialog : public QDialog
+{
+    Q_OBJECT
+
+public:
+    explicit MarkDialog(RVA from, RVA to, QWidget *parent = nullptr, QString name = {});
+    ~MarkDialog();
+
+    void accept() override;
+
+private slots:
+    void onPickColor();
+
+private:
+    std::unique_ptr<Ui::MarkDialog> ui;
+    QString markName;
+    RVA markFrom;
+    RVA markTo;
+    QColor markColor;
+    QString markComment;
+    bool edit;
+
+    static QString colorToStyle(const QColor &color);
+};
+
+#endif // MARKDIALOG_H