]> git.siccegge.de Git - frida/frida.git/blobdiff - src/gui/widgets/BasicBlockWidget.cxx
Comments in BasicBlockWidget for the magic
[frida/frida.git] / src / gui / widgets / BasicBlockWidget.cxx
index 37814014596b29e860a53778b9b09cfbc551ff33..ee3b7afc0048ead4a014630349187602ea61b2a4 100644 (file)
@@ -3,28 +3,44 @@
 #include "gui/dialogs/SimpleStringDialog.hxx"
 #include "core/BasicBlock.hxx"
 #include "core/Function.hxx"
+#include "core/Comment.hxx"
+#include "disassembler/Instruction.hxx"
 #include "core/InformationManager.hxx"
 #include "core/events/RenameFunctionEvent.hxx"
-#include <iostream>
+#include "core/events/ChangeCommentEvent.hxx"
+#include <algorithm>
 
 class CustomQGraphicsTextItem : public QObject, public QGraphicsTextItem {
 public:
        CustomQGraphicsTextItem(const QString& text, BasicBlockWidget* parent)
                : QGraphicsTextItem(text, parent), parent(parent) {}
        void contextMenuEvent(QGraphicsSceneContextMenuEvent*);
+
+       void adjustSize();
 private:
-       void addComment(QTextTableCell cell, const QString& title);
+       void addComment(int row, bool global);
 
        BasicBlockWidget* parent;
 };
 
-void CustomQGraphicsTextItem::addComment(QTextTableCell cell, const QString& title) {
-       SimpleStringDialog dialog(title);
+void CustomQGraphicsTextItem::addComment(int row, bool global) {
+       SimpleStringDialog dialog(global ? "Global comment" : "Local comment");
        int result = dialog.exec();
+       uint64_t address = parent->instructions[row].getAddress();
        if (QDialog::Accepted == result) {
-               LOG4CXX_DEBUG(parent->logger, "adding comment " << dialog.result().toStdString()
-                             << " at row " << cell.row());
-               cell.firstCursorPosition().insertHtml(QString(";; ") + dialog.result());
+               Comment* comment;
+               if (global) {
+                       comment = parent->block->getManager()->newGlobalComment(address);
+               } else {
+                       /* TODO: 0x23 as we currently don't have the function here
+                        * and setting it to null will make the comment appear
+                        * global. Also means local comments are largely still
+                        * broken.
+                        */
+                       comment = parent->block->getManager()->newLocalComment(address, (Function*)0x23);
+               }
+               comment->setText(dialog.result().toStdString());
+               parent->block->getManager()->finishComment(comment);
        } else {
                LOG4CXX_DEBUG(parent->logger, "addComment aborted");
        }
@@ -47,22 +63,46 @@ void CustomQGraphicsTextItem::contextMenuEvent(QGraphicsSceneContextMenuEvent* e
        QTextTable* table = c.currentTable();
        if (NULL != table) {
                int row = table->cellAt(c).row();
-               QTextTableCell cell = table->cellAt(row, 2);
                QAction* globalComment = menu.addAction("Add global Comment");
                QAction* localComment = menu.addAction("Add local Comment");
 
                QObject::connect(globalComment, &QAction::triggered,
-                                [=]() { addComment(cell, "Global comment"); });
+                                [=]() { addComment(row, true); });
                QObject::connect(localComment, &QAction::triggered,
-                                [=]() { addComment(cell, "Local comment"); });
+                                [=]() { addComment(row, false); });
        }
 
        menu.exec(event->screenPos());
 }
 
+/* QGraphicsTextItem has an adjustSize() function that is supposed to
+ * resize the widget to it's "ideal" size. However it totally ignores
+ * all directives to not wrap lines and "ideal" is actually just a
+ * bunch of heuristics.
+ *
+ * We are starting with a hopefully absurdly large startingwidth and
+ * reduce it untill a line is broken (detected by a change in
+ * height). As long as the width (1000 here) is sufficiently large,
+ * this should give us a widget without any line-wrapping.
+ *
+ * One needs to call this on a Pointer of tye CustomQGraphicsTextItem
+ * as the adjustSize() function is not polymorphic (vurtual).
+ */
+void CustomQGraphicsTextItem::adjustSize() {
+       int width = 1000;
+       setTextWidth(width);
+       int height = boundingRect().height();
+       while (width > 250 && height == boundingRect().height()) {
+               setTextWidth(width -= 10);
+       }
+       width += 10;
+       if (width < 250) width = 250;
+       setTextWidth(width);
+}
+
 BasicBlockWidget::BasicBlockWidget(const QString& name, BasicBlock * block,
                                    Mainwindow * mainwindow)
-       : width(270), height(45), name(name)
+       : width(200), height(45), name(name)
        , _table(NULL)
        , block(block), mainwindow(mainwindow)
        , logger(log4cxx::Logger::getLogger("gui.BasicBlockWidget." + name.toStdString())) {
@@ -86,6 +126,7 @@ BasicBlockWidget::BasicBlockWidget(const QString& name, BasicBlock * block,
                         });
        instructions = block->getInstructions();
        populateWidget();
+       block->getManager()->registerChangeCommentEvent([=](ChangeCommentEvent* e) {changeCommentHandler(e);});
 }
 
 void BasicBlockWidget::updateFunctionName(RenameFunctionEvent *event) {
@@ -99,13 +140,24 @@ void BasicBlockWidget::updateFunctionName(RenameFunctionEvent *event) {
                        if (isLink)
                        {
                                if (search == format.anchorHref()) {
-                                       LOG4CXX_DEBUG(logger, i.fragment().text().toStdString() << " ---> " << format.anchorHref().toStdString());
+                                       LOG4CXX_DEBUG(logger, i.fragment().text().toStdString() << " ---> "
+                                                     << format.anchorHref().toStdString());
+
+                                       /* This should select the function name. It stars
+                                        * by selecting the whole link fragment from back
+                                        * to front and then moves one word to the back
+                                        * again deselecting whatever mnemonic is used for
+                                        * the call instruction.
+                                        */
                                        QTextCursor c(b);
                                        c.setPosition(i.fragment().position());
                                        c.movePosition(QTextCursor::Right, QTextCursor::MoveAnchor, i.fragment().length());
                                        c.movePosition(QTextCursor::Left,  QTextCursor::KeepAnchor, i.fragment().length());
                                        c.movePosition(QTextCursor::WordRight,  QTextCursor::KeepAnchor);
                                        c.insertText(event->new_name.c_str());
+
+                                       QGraphicsTextItem* item = _widget.get();
+                                       ((CustomQGraphicsTextItem*)item)->adjustSize();
                                }
                        }
                }
@@ -113,6 +165,31 @@ void BasicBlockWidget::updateFunctionName(RenameFunctionEvent *event) {
        }
 }
 
+void BasicBlockWidget::changeCommentHandler(ChangeCommentEvent* event) {
+       auto inst_it = std::find_if(instructions.begin(), instructions.end(),
+                                   [=](Instruction& inst) {
+                                           return inst.getAddress() == event->address;
+                                   });
+       if (inst_it != instructions.end()) {
+               if (std::find(inst_it->comments().begin(),
+                             inst_it->comments().begin(),
+                             event->comment) == inst_it->comments().end()) {
+                       LOG4CXX_DEBUG(logger, "Change Comment Event --  New Comment!");
+                       inst_it->comments().push_back(event->comment);
+               }
+               int row = inst_it - instructions.begin();
+               LOG4CXX_DEBUG(logger, "Inserting comment for instruction at row " << std::hex << row);
+               QTextCursor cursor = _table->cellAt(row, 2).lastCursorPosition();
+               while (cursor != _table->cellAt(row, 2).firstCursorPosition()) {
+                       cursor.movePosition(QTextCursor::Left, QTextCursor::KeepAnchor, 1);
+               }
+               cursor.removeSelectedText();
+               cursor.insertHtml(formatComments(&*inst_it));
+               QGraphicsTextItem* item = _widget.get();
+               ((CustomQGraphicsTextItem*)item)->adjustSize();
+       }
+}
+
 void BasicBlockWidget::populateWidget() {
        int row;
        QTextTableFormat format;
@@ -134,7 +211,7 @@ void BasicBlockWidget::populateWidget() {
                        bytestring += hexdigits[byte & 0xF];
                        bytestring += ' ';
                }
-               _table->cellAt(row, 0).firstCursorPosition().insertText(bytestring);
+               _table->cellAt(row, 0).firstCursorPosition().insertHtml("<nobr>" + bytestring + "</nobr>");
 
                QString line = inst.getText().c_str();
                line = line.replace('\t', ' ').toHtmlEscaped();
@@ -152,14 +229,24 @@ void BasicBlockWidget::populateWidget() {
                        }
                        line = "<a href=\"" + href + "\">" + line + "</a>";
                }
+               _table->cellAt(row, 1).firstCursorPosition().insertHtml("<nobr>" + line + "</nobr>");
+               _table->cellAt(row, 2).firstCursorPosition().insertHtml(formatComments(&inst));
+       }
+       QGraphicsTextItem* item = _widget.get();
+       ((CustomQGraphicsTextItem*)item)->adjustSize();
+}
 
-               _table->cellAt(row, 1).firstCursorPosition().insertHtml(line);
+QString BasicBlockWidget::formatComments(Instruction* inst) {
+       QString comments;
+       for (Comment* c: inst->comments()) {
+               comments += "<br />";
+               comments += QString(c->getText().c_str()).toHtmlEscaped();
        }
+       return (comments == "" ? "" : ";; ") + comments.trimmed();
 }
 
 void BasicBlockWidget::paint(QPainter *painter, const QStyleOptionGraphicsItem*,
                   QWidget*) {
-       _widget->adjustSize();
        width = 10 + _widget->boundingRect().width();
        height = 25 + _widget->boundingRect().height();
        if (width < 250) width = 250;