Highlight breakpoints in the code browser

Author: tetsuo-cpp

BreakpointModel.cpp

@@ -31,9 +31,9 @@ QVariant BreakpointModel::data(const QModelIndex &index, int role) const {
   return QVariant();
 }
 
-void BreakpointModel::setBreakpoints(std::vector<Breakpoint> &&newBps) {
+void BreakpointModel::setBreakpoints(const std::vector<Breakpoint> &newBps) {
   const size_t prevSize = bps.size();
-  bps = std::move(newBps);
+  bps = newBps;
   int diff = bps.size() - prevSize;
   if (diff > 0)
     insertRows(prevSize, diff);

BreakpointModel.h

@@ -19,7 +19,7 @@ class BreakpointModel : public QAbstractTableModel {
   QVariant data(const QModelIndex &index,
                 int role = Qt::DisplayRole) const override;
 
-  void setBreakpoints(std::vector<Breakpoint> &&newBps);
+  void setBreakpoints(const std::vector<Breakpoint> &newBps);
 
 private:
   std::vector<Breakpoint> bps;

CodeBrowser.cpp

@@ -1,5 +1,6 @@
 #include "CodeBrowser.h"
 
+#include <QMenu>
 #include <QPainter>
 #include <QTextBlock>
 
@@ -12,11 +13,8 @@ CodeBrowser::CodeBrowser(QWidget *parent) : QPlainTextEdit(parent) {
           &CodeBrowser::updateLineNumberAreaWidth);
   connect(this, &CodeBrowser::updateRequest, this,
           &CodeBrowser::updateLineNumberArea);
-  connect(this, &CodeBrowser::cursorPositionChanged, this,
-          &CodeBrowser::highlightCurrentLine);
 
   updateLineNumberAreaWidth(0);
-  highlightCurrentLine();
 }
 
 int CodeBrowser::lineNumberAreaWidth() {
@@ -32,6 +30,13 @@ int CodeBrowser::lineNumberAreaWidth() {
   return space;
 }
 
+void CodeBrowser::contextMenuEvent(QContextMenuEvent *event) {
+  QMenu *menu = createStandardContextMenu();
+  menu->addAction(tr("Toggle Breakpoint"));
+  menu->exec(event->globalPos());
+  delete menu;
+}
+
 void CodeBrowser::updateLineNumberAreaWidth(int /* newBlockCount */) {
   setViewportMargins(lineNumberAreaWidth(), 0, 0, 0);
 }
@@ -54,17 +59,28 @@ void CodeBrowser::resizeEvent(QResizeEvent *e) {
       QRect(cr.left(), cr.top(), lineNumberAreaWidth(), cr.height()));
 }
 
-void CodeBrowser::highlightCurrentLine() {
+void CodeBrowser::updateHighlightedLines(const std::vector<Breakpoint> &bps,
+                                         size_t currentLine) {
   QList<QTextEdit::ExtraSelection> extraSelections;
-
-  if (!isReadOnly()) {
+  // Mark each breakpoint as red.
+  for (const auto &bp : bps) {
     QTextEdit::ExtraSelection selection;
-
+    QTextCursor cursor(document()->findBlockByLineNumber(bp.lineNumber - 1));
+    QColor lineColor = QColor(Qt::red).lighter(160);
+    selection.format.setBackground(lineColor);
+    selection.format.setProperty(QTextFormat::FullWidthSelection, true);
+    selection.cursor = cursor;
+    selection.cursor.clearSelection();
+    extraSelections.append(selection);
+  }
+  // Mark current position as yellow.
+  if (currentLine > 0) {
+    QTextEdit::ExtraSelection selection;
+    QTextCursor cursor(document()->findBlockByLineNumber(currentLine));
     QColor lineColor = QColor(Qt::yellow).lighter(160);
-
     selection.format.setBackground(lineColor);
     selection.format.setProperty(QTextFormat::FullWidthSelection, true);
-    selection.cursor = textCursor();
+    selection.cursor = cursor;
     selection.cursor.clearSelection();
     extraSelections.append(selection);
   }

CodeBrowser.h

@@ -1,5 +1,7 @@
 #pragma once
 
+#include "BreakpointModel.h"
+
 #include <QPlainTextEdit>
 
 QT_BEGIN_NAMESPACE
@@ -21,13 +23,15 @@ class CodeBrowser : public QPlainTextEdit {
 
   void lineNumberAreaPaintEvent(QPaintEvent *event);
   int lineNumberAreaWidth();
+  void contextMenuEvent(QContextMenuEvent *event) override;
+  void updateHighlightedLines(const std::vector<Breakpoint> &bps,
+                              size_t currentLine);
 
 protected:
   void resizeEvent(QResizeEvent *event) override;
 
 private slots:
   void updateLineNumberAreaWidth(int newBlockCount);
-  void highlightCurrentLine();
   void updateLineNumberArea(const QRect &rect, int dy);
 
 private:

MainWindow.cpp

@@ -54,24 +54,31 @@ void MainWindow::onOpenFile() {
   const QString openFile = QFileDialog::getOpenFileName();
   if (openFile.isEmpty())
     return;
-  populateCodeBrowser(openFile.toStdString());
+  // FIXME: Breakpoints markings will disappear if you open a file manually.
+  populateCodeBrowser(openFile.toStdString(), 0, {});
 }
 
 void MainWindow::updateView() {
-  updateCodeBrowser();
-  updateBreakpointModel();
+  // Not sure what this could should look but this ain't it.
+  //
+  // Since multiple components care about breakpoints, maybe we should be using
+  // that signal/slot mechanism?
+  const auto bps = updateBreakpointModel();
+  updateCodeBrowser(bps);
   updateFrameModel();
 }
 
-void MainWindow::updateCodeBrowser() {
+void MainWindow::updateCodeBrowser(const std::vector<Breakpoint> &bps) {
   const auto codeLoc = debugger.getLocation();
   // Do something smarter than this.
   const std::string filePath =
       codeLoc.getDirectory() + '/' + codeLoc.getFileName();
-  populateCodeBrowser(filePath);
+  populateCodeBrowser(filePath, codeLoc.getLine(), bps);
 }
 
-void MainWindow::populateCodeBrowser(const std::string &filePath) {
+void MainWindow::populateCodeBrowser(const std::string &filePath,
+                                     size_t lineNumber,
+                                     const std::vector<Breakpoint> &bps) {
   if (currentFile != filePath) {
     // Read the contents off the disk and populate the code view.
     std::ifstream file(filePath);
@@ -84,6 +91,7 @@ void MainWindow::populateCodeBrowser(const std::string &filePath) {
     currentFile = filePath;
   }
   // Mark the breakpoints visually as well as the current position.
+  ui->codeBrowser->updateHighlightedLines(bps, lineNumber);
 }
 
 void MainWindow::updateFrameModel() {
@@ -101,7 +109,7 @@ void MainWindow::updateFrameModel() {
   frameModel.setFrameVariables(std::move(modelFrame));
 }
 
-void MainWindow::updateBreakpointModel() {
+std::vector<Breakpoint> MainWindow::updateBreakpointModel() {
   // Debugger should just return this instead of doing transformation here.
   auto &debuggerBps = debugger.getBreakpoints();
   std::vector<Breakpoint> modelBps;
@@ -117,7 +125,8 @@ void MainWindow::updateBreakpointModel() {
                    return modelBp;
                  });
   logMsg("Added " + std::to_string(modelBps.size()) + " breakpoints");
-  bpModel.setBreakpoints(std::move(modelBps));
+  bpModel.setBreakpoints(modelBps);
+  return modelBps;
 }
 
 void MainWindow::logMsg(const std::string &msg) {

MainWindow.h

@@ -28,10 +28,11 @@ public slots:
 
 private:
   void updateView();
-  void updateCodeBrowser();
+  void updateCodeBrowser(const std::vector<Breakpoint> &bps);
   void updateFrameModel();
-  void updateBreakpointModel();
-  void populateCodeBrowser(const std::string &fileName);
+  std::vector<Breakpoint> updateBreakpointModel();
+  void populateCodeBrowser(const std::string &fileName, size_t lineNumber,
+                           const std::vector<Breakpoint> &bps);
   void logMsg(const std::string &msg);
 
   Ui::MainWindow *ui;