Merge pull request #94 from robertbasic/feature/break-at-first-line

Feature/break at first line. Resolves #39

Author: robertbasic

pugdebug/debugger.py

@@ -33,6 +33,7 @@ class PugdebugDebugger(QObject):
     step_command_signal = pyqtSignal()
     got_all_variables_signal = pyqtSignal(object)
     got_stacktraces_signal = pyqtSignal(object)
+    init_breakpoints_set = pyqtSignal()
     breakpoint_removed_signal = pyqtSignal(int)
     breakpoints_listed_signal = pyqtSignal(list)
     expression_evaluated_signal = pyqtSignal(int, dict)
@@ -98,7 +99,7 @@ def connect_connection_signals(self, connection):
 
         # Breakpoints signals
         connection.set_init_breakpoints_signal.connect(
-            self.handle_set_breakpoint
+            self.handle_set_init_breakpoint
         )
         connection.set_breakpoint_signal.connect(
             self.handle_set_breakpoint
@@ -269,6 +270,11 @@ def handle_set_breakpoint(self, successful):
         if successful:
             self.list_breakpoints()
 
+    def handle_set_init_breakpoint(self, successful):
+        if successful:
+            self.list_breakpoints()
+            self.init_breakpoints_set.emit()
+
     def remove_breakpoint(self, breakpoint_id):
         self.current_connection.remove_breakpoint(breakpoint_id)
 

pugdebug/gui/settings.py

@@ -9,7 +9,8 @@
 
 __author__ = "robertbasic"
 
-from PyQt5.QtWidgets import QWidget, QLineEdit, QFormLayout, QSpinBox
+from PyQt5.QtWidgets import (QWidget, QLineEdit, QFormLayout,
+                             QSpinBox, QCheckBox)
 
 from pugdebug.models.settings import get_setting, set_setting
 
@@ -60,6 +61,15 @@ def __init__(self, parent):
         idekey = get_setting('debugger/idekey')
         self.idekey.setText(idekey)
 
+        self.break_at_first_line = QCheckBox("Break at first line")
+
+        self.break_at_first_line.stateChanged.connect(
+            self.handle_break_at_first_line_changed
+        )
+
+        break_at_first_line = int(get_setting('debugger/break_at_first_line'))
+        self.break_at_first_line.setCheckState(break_at_first_line)
+
         layout = QFormLayout()
         self.setLayout(layout)
 
@@ -68,6 +78,7 @@ def __init__(self, parent):
         layout.addRow("Host", self.host)
         layout.addRow("Port", self.port_number)
         layout.addRow("IDE Key", self.idekey)
+        layout.addRow("", self.break_at_first_line)
 
     def get_project_root(self):
         return self.project_root.text()
@@ -102,3 +113,6 @@ def handle_port_number_changed(self, value):
     def handle_idekey_changed(self):
         value = self.idekey.text()
         set_setting('debugger/idekey', value)
+
+    def handle_break_at_first_line_changed(self, value):
+        set_setting('debugger/break_at_first_line', value)

pugdebug/models/settings.py

@@ -51,6 +51,11 @@ def setup_debugger_settings(self):
         if not self.application_settings.contains('idekey'):
             self.application_settings.setValue('idekey', 'pugdebug')
 
+        if not self.application_settings.contains('break_at_first_line'):
+            # 2 is the init value because 1 is some weird
+            # between checked and unchecked state
+            self.application_settings.setValue('break_at_first_line', 2)
+
         self.application_settings.endGroup()
 
     def setup_path_settings(self):

pugdebug/pugdebug.py

@@ -12,7 +12,7 @@
 import os
 
 from PyQt5.QtCore import QObject
-from PyQt5.QtWidgets import QErrorMessage
+from PyQt5.QtWidgets import QErrorMessage, QMessageBox
 
 from pugdebug.debugger import PugdebugDebugger
 from pugdebug.syntaxer import PugdebugFormatter
@@ -168,6 +168,9 @@ def connect_debugger_signals(self):
         )
 
         # Breakpoints signals
+        self.debugger.init_breakpoints_set.connect(
+            self.handle_init_breakpoints_set
+        )
         self.debugger.breakpoint_removed_signal.connect(
             self.handle_breakpoint_removed
         )
@@ -354,13 +357,30 @@ def start_debug(self):
 
         Start a debugging session.
         """
-        self.variable_viewer.clear()
-        self.stacktrace_viewer.clear()
+        break_at_first_line = int(get_setting('debugger/break_at_first_line'))
+
+        start_debugging = True
+
+        if break_at_first_line == 0 and len(self.init_breakpoints) == 0:
+            messageBox = QMessageBox()
+            messageBox.setText("There are no breakpoints set and the break at"
+                               " first line setting is turned off.")
+            messageBox.setInformativeText("Are you sure you want to start"
+                                          " debugging?")
+            messageBox.setStandardButtons(QMessageBox.Yes | QMessageBox.No)
+            answer = messageBox.exec_()
+
+            if answer == QMessageBox.No:
+                start_debugging = False
+
+        if start_debugging:
+            self.variable_viewer.clear()
+            self.stacktrace_viewer.clear()
 
-        self.document_viewer.remove_line_highlights()
+            self.document_viewer.remove_line_highlights()
 
-        self.debugger.start_debug()
-        self.main_window.set_statusbar_text("Waiting for connection...")
+            self.debugger.start_debug()
+            self.main_window.set_statusbar_text("Waiting for connection...")
 
     def handle_debugging_started(self):
         """Handle when debugging starts
@@ -385,6 +405,10 @@ def handle_debugging_started(self):
 
         self.open_document(self.debugger.get_index_file())
 
+        break_at_first_line = int(get_setting('debugger/break_at_first_line'))
+        if break_at_first_line > 0:
+            self.step_into()
+
     def stop_debug(self):
         """Stop a debugging session
 
@@ -583,6 +607,15 @@ def remove_stale_breakpoints(self, path):
 
         self.breakpoint_viewer.set_breakpoints(breakpoints)
 
+    def handle_init_breakpoints_set(self):
+        """Handle when init breakpoints get set
+
+        If the code should not break at first line, run the debugger.
+        """
+        break_at_first_line = int(get_setting('debugger/break_at_first_line'))
+        if break_at_first_line == 0:
+            self.run_debug()
+
     def handle_breakpoint_removed(self, breakpoint_id):
         """Handle when a breakpoint gets removed