feat: graph debugging dialog for unit-testing, code cleanup

Author: Dax89

CMakeLists.txt

@@ -38,6 +38,7 @@ target_sources(${PROJECT_NAME}
         src/dialogs/analyzer.cpp
         src/dialogs/decoder.cpp
         src/dialogs/detail.cpp
+        src/dialogs/devgraphs.cpp
         src/dialogs/flc.cpp
         src/dialogs/goto.cpp
         src/dialogs/loader.cpp
@@ -80,6 +81,8 @@ target_sources(${PROJECT_NAME}
         src/views/dashboard.cpp
         src/views/log.cpp
         src/views/welcome.cpp
+        src/widgets/feedbackpushbutton.cpp
+        src/widgets/feedbacktoolbutton.cpp
         src/main.cpp
         src/mainwindow.cpp
         src/statusbar.cpp

src/dialogs/devgraphs.cpp

@@ -0,0 +1,85 @@
+#include "devgraphs.h"
+#include "support/surfacerenderer.h"
+#include "support/utils.h"
+#include <QApplication>
+#include <QClipboard>
+#include <QHeaderView>
+
+DevGraphsDialog::DevGraphsDialog(RDContext* ctx, QWidget* parent)
+    : QDialog{parent}, m_ui{this}, m_context{ctx} {
+
+    m_ui.ftbcopyhash->setEnabled(false);
+    m_ui.ftbcopygraph->setEnabled(false);
+
+    m_functionsmodel = new FunctionsModel(ctx, m_ui.tvfunctions);
+    m_ui.tvfunctions->setModel(m_functionsmodel);
+
+    m_ui.ptedot->setFont(surface_renderer::get_font());
+    m_ui.ptedot->setTabStopDistance(4 * surface_renderer::cell_width());
+
+    QHeaderView* hdrview = m_ui.tvfunctions->header();
+    hdrview->setSectionResizeMode(0, QHeaderView::ResizeToContents);
+    hdrview->setSectionResizeMode(1, QHeaderView::Stretch);
+
+    this->setFocus(); // don't focus function list
+
+    connect(m_ui.tvfunctions, &QTreeView::clicked, this,
+            &DevGraphsDialog::show_dot);
+
+    connect(m_ui.ftbcopytests, &FeedbackPushButton::feedback, this,
+            &DevGraphsDialog::copy_tests);
+
+    connect(m_ui.ftbcopygraph, &FeedbackPushButton::feedback, this,
+            [&]() { qApp->clipboard()->setText(m_currentgraph); });
+
+    connect(m_ui.ftbcopyhash, &FeedbackPushButton::feedback, this, [&]() {
+        qApp->clipboard()->setText(
+            QString{"0x%1"}.arg(utils::to_hex(m_currenthash)));
+    });
+}
+
+void DevGraphsDialog::copy_tests() {
+    QString s = "{\n";
+
+    for(int i = 0; i < m_functionsmodel->rowCount({}); i++) {
+        QModelIndex index = m_functionsmodel->index(i);
+        RDAddress address = m_functionsmodel->address(index);
+        const RDFunction* f = rd_find_function(m_context, address);
+        Q_ASSERT(f);
+        u32 hash = rd_function_get_hash(f);
+
+        s.append(QString{"  {0x%1, 0x%2},\n"}
+                     .arg(utils::to_hex(address))
+                     .arg(utils::to_hex(hash)));
+    }
+
+    s.append("};");
+    qApp->clipboard()->setText(s);
+}
+
+void DevGraphsDialog::show_dot(const QModelIndex& index) {
+    m_currentgraph = {};
+    m_currenthash = {};
+    m_ui.ptedot->clear();
+
+    RDAddress address = m_functionsmodel->address(index);
+    const char* dot = nullptr;
+
+    const RDFunction* f = rd_find_function(m_context, address);
+    if(!f) goto fail;
+
+    dot = rd_function_generate_dot(f);
+    if(!dot) goto fail;
+
+    m_currenthash = rd_function_get_hash(f);
+    m_currentgraph = QString::fromUtf8(dot);
+
+    m_ui.ptedot->setPlainText(m_currentgraph);
+    m_ui.ftbcopyhash->setEnabled(true);
+    m_ui.ftbcopygraph->setEnabled(true);
+    return;
+
+fail:
+    m_ui.ftbcopyhash->setEnabled(false);
+    m_ui.ftbcopygraph->setEnabled(false);
+}

src/dialogs/devgraphs.h

@@ -0,0 +1,23 @@
+#pragma once
+
+#include "models/functions.h"
+#include "ui/devgraphsdialog.h"
+#include <redasm/redasm.h>
+
+class DevGraphsDialog: public QDialog {
+    Q_OBJECT
+
+public:
+    explicit DevGraphsDialog(RDContext* ctx, QWidget* parent = nullptr);
+
+private Q_SLOTS:
+    void show_dot(const QModelIndex& index);
+    void copy_tests();
+
+private:
+    ui::DevGraphsDialog m_ui;
+    RDContext* m_context;
+    FunctionsModel* m_functionsmodel;
+    QString m_currentgraph{};
+    u32 m_currenthash{};
+};

src/dialogs/memorymap.cpp

@@ -15,8 +15,8 @@ MemoryMapDialog::MemoryMapDialog(const RDContext* ctx, QWidget* parent)
 
     for(usize i = 0; i < rd_slice_length(segments); i++) {
         const RDSegment* s = rd_slice_at(segments, i);
-        QString startaddr = utils::to_hex_addr(s->start_address, s);
-        QString endaddr = utils::to_hex_addr(s->end_address, s);
+        QString startaddr = utils::to_hex(s->start_address, s);
+        QString endaddr = utils::to_hex(s->end_address, s);
 
         m_ui.cbsegments->addItem(
             QString{"%1 (%2 - %3)"}.arg(s->name).arg(startaddr).arg(endaddr));

src/mainwindow.cpp

@@ -1,6 +1,7 @@
 #include "mainwindow.h"
 #include "dialogs/analyzer.h"
 #include "dialogs/decoder.h"
+#include "dialogs/devgraphs.h"
 #include "dialogs/flc.h"
 #include "dialogs/loader.h"
 #include "dialogs/memorymap.h"
@@ -75,11 +76,18 @@ MainWindow::MainWindow(QWidget* parent): QMainWindow{parent}, m_ui{this} {
         dlgflc->show();
     });
 
-    connect(m_ui.acttoolsdecoder, &QAction::triggered, this, [&]() {
+    connect(m_ui.actdevdecoder, &QAction::triggered, this, [&]() {
         auto* dlgdecoder = new DecoderDialog(this);
         dlgdecoder->show();
     });
 
+    connect(m_ui.actdevgraphs, &QAction::triggered, this, [&]() {
+        ContextView* ctxview = this->context_view();
+        if(!ctxview) return;
+        auto* dlggraphdots = new DevGraphsDialog(ctxview->context(), this);
+        dlggraphdots->show();
+    });
+
     connect(m_ui.acttoolsproblems, &QAction::triggered, this,
             &MainWindow::show_problems);
 
@@ -261,9 +269,11 @@ void MainWindow::enable_context_actions(bool e) { // NOLINT
 
     m_ui.acttbseparator1->setVisible(e);
     m_ui.acttbseparator2->setVisible(e);
+    m_ui.acttbseparator3->setVisible(e);
 
     m_ui.acttoolsflc->setVisible(e);
     m_ui.acttoolsproblems->setVisible(e);
+    m_ui.actdevgraphs->setVisible(e);
     m_ui.actviewexported->setVisible(e);
     m_ui.actviewsegmentregs->setVisible(e);
     m_ui.actviewsegments->setVisible(e);

src/models/exported.cpp

@@ -16,7 +16,7 @@ QVariant ExportedModel::data(const QModelIndex& index, int role) const {
         const RDSegment* seg = rd_find_segment(m_context, addr);
 
         switch(index.column()) {
-            case 0: return utils::to_hex_addr(addr, seg);
+            case 0: return utils::to_hex(addr, seg);
             case 1: return rd_get_name(m_context, addr);
 
             case 2: {

src/models/functions.cpp

@@ -22,7 +22,8 @@ QVariant FunctionsModel::data(const QModelIndex& index, int role) const {
         RDAddress addr = rd_function_get_address(f);
 
         switch(index.column()) {
-            case 0: return rd_get_name(m_context, addr);
+            case 0: return QString::fromUtf8(rd_to_hexaddr(m_context, addr));
+            case 1: return QString::fromUtf8(rd_get_name(m_context, addr));
             default: break;
         }
     }
@@ -37,14 +38,15 @@ QVariant FunctionsModel::headerData(int section, Qt::Orientation orientation,
     if(orientation == Qt::Vertical || role != Qt::DisplayRole) return {};
 
     switch(section) {
-        case 0: return "Functions";
+        case 0: return "Address";
+        case 1: return "Functions";
         default: break;
     }
 
     return {};
 }
 
-int FunctionsModel::columnCount(const QModelIndex&) const { return 1; }
+int FunctionsModel::columnCount(const QModelIndex&) const { return 2; }
 
 int FunctionsModel::rowCount(const QModelIndex&) const {
     return static_cast<int>(rd_slice_length(m_functions));

src/models/imported.cpp

@@ -19,7 +19,7 @@ QVariant ImportedModel::data(const QModelIndex& index, int role) const {
         bool ok = rd_get_imported(m_context, addr, &imp);
 
         switch(index.column()) {
-            case 0: return utils::to_hex_addr(addr, seg);
+            case 0: return utils::to_hex(addr, seg);
 
             case 1:
                 return ok && imp.ordinal.has_value

src/models/mappings.cpp

@@ -15,9 +15,9 @@ QVariant MappingsModel::data(const QModelIndex& index, int role) const {
         RDInputMapping m = rd_slice_at(m_mappings, index.row());
 
         switch(index.column()) {
-            case 0: return utils::to_hex_addr(m.offset);
-            case 1: return utils::to_hex_addr(m.start_address);
-            case 2: return utils::to_hex_addr(m.end_address);
+            case 0: return utils::to_hex(m.offset);
+            case 1: return utils::to_hex(m.start_address);
+            case 2: return utils::to_hex(m.end_address);
             default: break;
         }
     }

src/models/problems.cpp

@@ -21,8 +21,8 @@ QVariant ProblemsModel::data(const QModelIndex& index, int role) const {
         const RDSegment* toseg = rd_find_segment(m_context, p->address);
 
         switch(index.column()) {
-            case 0: return utils::to_hex_addr(p->from_address, fromseg);
-            case 1: return utils::to_hex_addr(p->address, toseg);
+            case 0: return utils::to_hex(p->from_address, fromseg);
+            case 1: return utils::to_hex(p->address, toseg);
             case 2: return QString::fromUtf8(p->message);
             default: break;
         }