Merge pull request #112 from robertbasic/feature/breakpoint-jump-to-source

Feature/breakpoint jump to source. Resolves #111

Author: robertbasic

pugdebug/gui/breakpoints.py

@@ -9,11 +9,14 @@
 
 __author__ = "robertbasic"
 
+from PyQt5.QtCore import pyqtSignal
 from PyQt5.QtWidgets import QTreeWidget, QTreeWidgetItem
 
 
 class PugdebugBreakpointViewer(QTreeWidget):
 
+    item_double_clicked_signal = pyqtSignal(str, int)
+
     def __init__(self):
         super(PugdebugBreakpointViewer, self).__init__()
 
@@ -22,6 +25,8 @@ def __init__(self):
 
         self.setColumnWidth(0, 350)
 
+        self.itemDoubleClicked.connect(self.handle_item_double_clicked)
+
     def set_breakpoints(self, breakpoints):
         self.clear()
 
@@ -31,3 +36,9 @@ def set_breakpoints(self, breakpoints):
             item = QTreeWidgetItem(args)
 
             self.addTopLevelItem(item)
+
+    def handle_item_double_clicked(self, item, column):
+        file = item.text(0)
+        line = int(item.text(1))
+
+        self.item_double_clicked_signal.emit(file, line)

pugdebug/gui/document.py

@@ -91,9 +91,6 @@ def paint_line_numbers(self, line_numbers, event):
         height = font_metrics.height()
         width = line_numbers.width()
 
-        cursor = self.document_contents.textCursor()
-        current_line_number = cursor.blockNumber() + 1
-
         while block.isValid():
             # blocks are numbered from zero
             line_number += 1
@@ -116,7 +113,7 @@ def paint_line_numbers(self, line_numbers, event):
             if self.document_contents.block_has_breakpoint(block):
                 brush = painter.brush()
                 brush.setStyle(Qt.SolidPattern)
-                if line_number == current_line_number:
+                if self.document_contents.block_is_current(block):
                     brush.setColor(Qt.red)
                 else:
                     brush.setColor(Qt.darkGreen)
@@ -136,8 +133,8 @@ def paint_line_numbers(self, line_numbers, event):
     def get_path(self):
         return self.document_contents.document_model.path
 
-    def move_to_line(self, line):
-        self.document_contents.move_to_line(line)
+    def move_to_line(self, line, is_current=True):
+        self.document_contents.move_to_line(line, is_current)
         self.rehighlight_breakpoint_lines()
 
     def remove_line_highlights(self):
@@ -219,7 +216,7 @@ def mouseDoubleClickEvent(self, event):
     def contextMenuEvent(self, event):
         pass
 
-    def move_to_line(self, line):
+    def move_to_line(self, line, is_current=True):
         """Move cursor to line
 
         Move the cursor of the QPlainTextEdit that holds the document
@@ -244,11 +241,19 @@ def move_to_line(self, line):
                 1
             )
 
+            # Unmark block as current
+            block = cursor.block()
+            self.block_set_is_current(block, False)
+
             if cursor_moved is False:
                 break
 
             block_number = cursor.blockNumber()
 
+        # Mark block on which the cursor is as the current one
+        block = cursor.block()
+        self.block_set_is_current(block, is_current)
+
         self.setTextCursor(cursor)
 
     def highlight(self):
@@ -288,6 +293,15 @@ def block_remove_breakpoint(self, block):
         user_data.breakpoint = False
         block.setUserData(user_data)
 
+    def block_is_current(self, block):
+        user_data = self.__get_block_user_data(block)
+        return user_data.is_current
+
+    def block_set_is_current(self, block, is_current):
+        user_data = self.__get_block_user_data(block)
+        user_data.is_current = is_current
+        block.setUserData(user_data)
+
     def __get_block_user_data(self, block):
         user_data = block.userData()
         if user_data is None:
@@ -317,6 +331,7 @@ def paintEvent(self, event):
 class PugdebugBlockData(QTextBlockUserData):
 
     breakpoint = False
+    is_current = False
 
     def __init__(self):
         super(PugdebugBlockData, self).__init__()

pugdebug/pugdebug.py

@@ -87,6 +87,7 @@ def connect_signals(self):
         self.connect_debugger_signals()
         self.connect_expression_viewer_signals()
         self.connect_stacktrace_viewer_signals()
+        self.connect_breakpoint_viewer_signals()
 
     def connect_file_browser_signals(self):
         """Connect file browser signals
@@ -201,7 +202,12 @@ def connect_expression_viewer_signals(self):
 
     def connect_stacktrace_viewer_signals(self):
         self.stacktrace_viewer.item_double_clicked_signal.connect(
-            self.handle_stacktrace_double_clicked
+            self.jump_to_line_in_file
+        )
+
+    def connect_breakpoint_viewer_signals(self):
+        self.breakpoint_viewer.item_double_clicked_signal.connect(
+            self.jump_to_line_in_file
         )
 
     def file_browser_item_activated(self, index):
@@ -213,7 +219,7 @@ def file_browser_item_activated(self, index):
         if path is not None:
             self.open_document(path, False)
 
-    def open_document(self, path, map_paths=True, line=None):
+    def open_document(self, path, map_paths=True):
         """Open a document
 
         If a document is not already open, open it and add it as a new
@@ -260,19 +266,11 @@ def open_document(self, path, map_paths=True, line=None):
                 document_model.filename,
                 path
             )
-
-            # If a line is given, move to that line
-            if line:
-                document_widget.move_to_line(line)
         else:
             # Just focus the tab that has the opened document
             index = self.document_viewer.find_tab_index_by_path(path)
             self.document_viewer.setCurrentIndex(index)
 
-            # If a line is given, move to that line
-            if line:
-                self.document_viewer.get_document(index).move_to_line(line)
-
     def handle_document_double_click(self, path, line_number):
         """Handle when a document gets double clicked
 
@@ -334,6 +332,16 @@ def focus_current_line(self):
         document_widget = self.document_viewer.get_current_document()
         document_widget.move_to_line(current_line)
 
+    def jump_to_line_in_file(self, file, line):
+        """Jump to a line in a file.
+
+        Show the document, and scroll to the given line.
+        """
+        self.open_document(file)
+
+        document_widget = self.document_viewer.get_current_document()
+        document_widget.move_to_line(line, False)
+
     def handle_settings_changed(self, changed_settings):
         """Handle when settings have changed.
 
@@ -709,13 +717,6 @@ def handle_expression_added_or_changed(self, index, expression):
         if self.debugger.is_connected():
             self.debugger.evaluate_expression(index, expression)
 
-    def handle_stacktrace_double_clicked(self, file, line):
-        """Handle when an item in the stack trace viewer is double clicked.
-
-        Show the document, and scroll to the given line.
-        """
-        self.open_document(file, True, line)
-
     def handle_error(self, error):
         em = QErrorMessage(self.main_window)
         em.showMessage(error)