eric: eric6/Debugger/DebugUI.py@91e843545d9a (annotated)

 # -*- coding: utf-8 -*-
 # Copyright (c) 2002 - 2021 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 """
 Module implementing the debugger UI.
 """
 import os
 from PyQt5.QtCore import pyqtSignal, pyqtSlot, QObject, Qt
 from PyQt5.QtGui import QKeySequence
 from PyQt5.QtWidgets import QMenu, QToolBar, QApplication, QDialog
 from UI.Info import Program
 from .DebugClientCapabilities import (
     HasDebugger, HasInterpreter, HasProfiler, HasCoverage
 )
 import Preferences
 import Utilities
 import UI.PixmapCache
 import UI.Config
 from E5Gui.E5Action import E5Action, createActionGroup
 from E5Gui import E5MessageBox
 from eric6config import getConfig
 class DebugUI(QObject):
     """
     Class implementing the debugger part of the UI.
     @signal clientStack(stack, debuggerId) emitted at breaking after a reported
         exception
     @signal compileForms() emitted if changed project forms should be compiled
     @signal compileResources() emitted if changed project resources should be
         compiled
     @signal executeMake() emitted if a project specific make run should be
         performed
     @signal debuggingStarted(filename) emitted when a debugging session was
         started
     @signal resetUI() emitted to reset the UI
     @signal exceptionInterrupt() emitted after the execution was interrupted
         by an exception and acknowledged by the user
     @signal appendStdout(msg) emitted when the client program has terminated
         and the display of the termination dialog is suppressed
     """
     clientStack = pyqtSignal(list, str)
     resetUI = pyqtSignal()
     exceptionInterrupt = pyqtSignal()
     compileForms = pyqtSignal()
     compileResources = pyqtSignal()
     executeMake = pyqtSignal()
     debuggingStarted = pyqtSignal(str)
     appendStdout = pyqtSignal(str)
     def __init__(self, ui, vm, debugServer, debugViewer, project):
         """
         Constructor
         @param ui reference to the main UI
         @param vm reference to the viewmanager
         @param debugServer reference to the debug server
         @param debugViewer reference to the debug viewer widget
         @param project reference to the project object
         """
         super(DebugUI, self).__init__(ui)
         self.ui = ui
         self.viewmanager = vm
         self.debugServer = debugServer
         self.debugViewer = debugViewer
         self.project = project
         # Clear some variables
         self.projectOpen = False
         self.editorOpen = False
         # read the saved debug info values
         self.lastUsedVenvName = Preferences.Prefs.settings.value(
             'DebugInfo/VirtualEnvironment', '')
         self.argvHistory = Preferences.toList(
             Preferences.Prefs.settings.value('DebugInfo/ArgumentsHistory'))
         self.wdHistory = Preferences.toList(
             Preferences.Prefs.settings.value(
                 'DebugInfo/WorkingDirectoryHistory'))
         self.envHistory = Preferences.toList(
             Preferences.Prefs.settings.value('DebugInfo/EnvironmentHistory'))
         self.excList = Preferences.toList(
             Preferences.Prefs.settings.value('DebugInfo/Exceptions'))
         self.excIgnoreList = Preferences.toList(
             Preferences.Prefs.settings.value('DebugInfo/IgnoredExceptions'))
         self.exceptions = Preferences.toBool(
             Preferences.Prefs.settings.value(
                 'DebugInfo/ReportExceptions', True))
         self.autoClearShell = Preferences.toBool(
             Preferences.Prefs.settings.value('DebugInfo/AutoClearShell', True))
         self.tracePython = Preferences.toBool(
             Preferences.Prefs.settings.value('DebugInfo/TracePython', False))
         self.autoContinue = Preferences.toBool(
             Preferences.Prefs.settings.value('DebugInfo/AutoContinue', True))
         self.enableMultiprocess = Preferences.toBool(
             Preferences.Prefs.settings.value(
                 'DebugInfo/EnableMultiprocess', False))
         self.multiprocessNoDebugHistory = Preferences.toList(
             Preferences.Prefs.settings.value(
                 'DebugInfo/MultiprocessNoDebugHistory'))
         self.lastDebuggedFile = None
         self.lastStartAction = 0    # 0=None, 1=Script, 2=Project
         self.clientType = ""
         self.lastAction = -1
         self.debugActions = [
             self.__continue, self.__step, self.__stepOver, self.__stepOut,
             self.__stepQuit, self.__runToCursor, self.__runUntil,
             self.__moveInstructionPointer
         ]
         self.__localsVarFilterList, self.__globalsVarFilterList = (
             Preferences.getVarFilters())
         self.debugViewer.setVariablesFilter(
             self.__globalsVarFilterList, self.__localsVarFilterList)
         # Connect the signals emitted by the debug-server
         debugServer.clientGone.connect(self.__clientGone)
         debugServer.clientLine.connect(self.__clientLine)
         debugServer.clientExit.connect(self.__clientExit)
         debugServer.lastClientExited.connect(self.__lastClientExited)
         debugServer.clientSyntaxError.connect(self.__clientSyntaxError)
         debugServer.clientException.connect(self.__clientException)
         debugServer.clientSignal.connect(self.__clientSignal)
         debugServer.clientVariables.connect(self.__clientVariables)
         debugServer.clientVariable.connect(self.__clientVariable)
         debugServer.clientBreakConditionError.connect(
             self.__clientBreakConditionError)
         debugServer.clientWatchConditionError.connect(
             self.__clientWatchConditionError)
         debugServer.passiveDebugStarted.connect(self.__passiveDebugStarted)
         debugServer.clientThreadSet.connect(self.__clientThreadSet)
         # Connect the signals emitted by the viewmanager
         vm.editorOpened.connect(self.__editorOpened)
         vm.lastEditorClosed.connect(self.__lastEditorClosed)
         vm.checkActions.connect(self.__checkActions)
         vm.cursorChanged.connect(self.__cursorChanged)
         vm.breakpointToggled.connect(self.__cursorChanged)
         # Connect the signals emitted by the project
         project.projectOpened.connect(self.__projectOpened)
         project.newProject.connect(self.__projectOpened)
         project.projectClosed.connect(self.__projectClosed)
         # Set a flag for the passive debug mode
         self.passive = Preferences.getDebugger("PassiveDbgEnabled")
     def showNotification(self, notification):
         """
         Public method to show some notification message.
         @param notification meessage to be shown
         @type str
         """
         if self.ui.notificationsEnabled():
             self.ui.showNotification(
                 UI.PixmapCache.getPixmap("debug48"),
                 self.tr("Notification"), notification)
         else:
             self.appendStdout.emit(notification)
     def variablesFilter(self, scope):
         """
         Public method to get the variables filter for a scope.
         @param scope flag indicating global (True) or local (False) scope
         @return filters list
         @rtype list of str
         """
         if scope:
             return self.__globalsVarFilterList[:]
         else:
             return self.__localsVarFilterList[:]
     def initActions(self):
         """
         Public method defining the user interface actions.
         """
         self.actions = []
         self.runAct = E5Action(
             self.tr('Run Script'),
             UI.PixmapCache.getIcon("runScript"),
             self.tr('&Run Script...'),
             Qt.Key_F2, 0, self, 'dbg_run_script')
         self.runAct.setStatusTip(self.tr('Run the current Script'))
         self.runAct.setWhatsThis(self.tr(
             """<b>Run Script</b>"""
             """<p>Set the command line arguments and run the script outside"""
             """ the debugger. If the file has unsaved changes it may be"""
             """ saved first.</p>"""
         ))
         self.runAct.triggered.connect(self.__runScript)
         self.actions.append(self.runAct)
         self.runProjectAct = E5Action(
             self.tr('Run Project'),
             UI.PixmapCache.getIcon("runProject"),
             self.tr('Run &Project...'), Qt.SHIFT + Qt.Key_F2, 0, self,
             'dbg_run_project')
         self.runProjectAct.setStatusTip(self.tr('Run the current Project'))
         self.runProjectAct.setWhatsThis(self.tr(
             """<b>Run Project</b>"""
             """<p>Set the command line arguments and run the current project"""
             """ outside the debugger."""
             """ If files of the current project have unsaved changes they"""
             """ may be saved first.</p>"""
         ))
         self.runProjectAct.triggered.connect(self.__runProject)
         self.actions.append(self.runProjectAct)
         self.coverageAct = E5Action(
             self.tr('Coverage run of Script'),
             UI.PixmapCache.getIcon("coverageScript"),
             self.tr('Coverage run of Script...'), 0, 0, self,
             'dbg_coverage_script')
         self.coverageAct.setStatusTip(
             self.tr('Perform a coverage run of the current Script'))
         self.coverageAct.setWhatsThis(self.tr(
             """<b>Coverage run of Script</b>"""
             """<p>Set the command line arguments and run the script under"""
             """ the control of a coverage analysis tool. If the file has"""
             """ unsaved changes it may be saved first.</p>"""
         ))
         self.coverageAct.triggered.connect(self.__coverageScript)
         self.actions.append(self.coverageAct)
         self.coverageProjectAct = E5Action(
             self.tr('Coverage run of Project'),
             UI.PixmapCache.getIcon("coverageProject"),
             self.tr('Coverage run of Project...'), 0, 0, self,
             'dbg_coverage_project')
         self.coverageProjectAct.setStatusTip(
             self.tr('Perform a coverage run of the current Project'))
         self.coverageProjectAct.setWhatsThis(self.tr(
             """<b>Coverage run of Project</b>"""
             """<p>Set the command line arguments and run the current project"""
             """ under the control of a coverage analysis tool."""
             """ If files of the current project have unsaved changes"""
             """ they may be saved first.</p>"""
         ))
         self.coverageProjectAct.triggered.connect(self.__coverageProject)
         self.actions.append(self.coverageProjectAct)
         self.profileAct = E5Action(
             self.tr('Profile Script'),
             UI.PixmapCache.getIcon("profileScript"),
             self.tr('Profile Script...'), 0, 0, self, 'dbg_profile_script')
         self.profileAct.setStatusTip(self.tr('Profile the current Script'))
         self.profileAct.setWhatsThis(self.tr(
             """<b>Profile Script</b>"""
             """<p>Set the command line arguments and profile the script."""
             """ If the file has unsaved changes it may be saved first.</p>"""
         ))
         self.profileAct.triggered.connect(self.__profileScript)
         self.actions.append(self.profileAct)
         self.profileProjectAct = E5Action(
             self.tr('Profile Project'),
             UI.PixmapCache.getIcon("profileProject"),
             self.tr('Profile Project...'), 0, 0, self,
             'dbg_profile_project')
         self.profileProjectAct.setStatusTip(
             self.tr('Profile the current Project'))
         self.profileProjectAct.setWhatsThis(self.tr(
             """<b>Profile Project</b>"""
             """<p>Set the command line arguments and profile the current"""
             """ project. If files of the current project have unsaved"""
             """ changes they may be saved first.</p>"""
         ))
         self.profileProjectAct.triggered.connect(self.__profileProject)
         self.actions.append(self.profileProjectAct)
         self.debugAct = E5Action(
             self.tr('Debug Script'),
             UI.PixmapCache.getIcon("debugScript"),
             self.tr('&Debug Script...'), Qt.Key_F5, 0, self,
             'dbg_debug_script')
         self.debugAct.setStatusTip(self.tr('Debug the current Script'))
         self.debugAct.setWhatsThis(self.tr(
             """<b>Debug Script</b>"""
             """<p>Set the command line arguments and set the current line"""
             """ to be the first executable Python statement of the current"""
             """ editor window. If the file has unsaved changes it may be"""
             """ saved first.</p>"""
         ))
         self.debugAct.triggered.connect(self.__debugScript)
         self.actions.append(self.debugAct)
         self.debugProjectAct = E5Action(
             self.tr('Debug Project'),
             UI.PixmapCache.getIcon("debugProject"),
             self.tr('Debug &Project...'), Qt.SHIFT + Qt.Key_F5, 0, self,
             'dbg_debug_project')
         self.debugProjectAct.setStatusTip(self.tr(
             'Debug the current Project'))
         self.debugProjectAct.setWhatsThis(self.tr(
             """<b>Debug Project</b>"""
             """<p>Set the command line arguments and set the current line"""
             """ to be the first executable Python statement of the main"""
             """ script of the current project. If files of the current"""
             """ project have unsaved changes they may be saved first.</p>"""
         ))
         self.debugProjectAct.triggered.connect(self.__debugProject)
         self.actions.append(self.debugProjectAct)
         self.restartAct = E5Action(
             self.tr('Restart'),
             UI.PixmapCache.getIcon("debugRestart"),
             self.tr('Restart'), Qt.Key_F4, 0, self, 'dbg_restart_script')
         self.restartAct.setStatusTip(self.tr(
             'Restart the last debugged script'))
         self.restartAct.setWhatsThis(self.tr(
             """<b>Restart</b>"""
             """<p>Set the command line arguments and set the current line"""
             """ to be the first executable Python statement of the script"""
             """ that was debugged last. If there are unsaved changes, they"""
             """ may be saved first.</p>"""
         ))
         self.restartAct.triggered.connect(self.__doRestart)
         self.actions.append(self.restartAct)
         self.stopAct = E5Action(
             self.tr('Stop'),
             UI.PixmapCache.getIcon("stopScript"),
             self.tr('Stop'), Qt.SHIFT + Qt.Key_F10, 0,
             self, 'dbg_stop_script')
         self.stopAct.setStatusTip(self.tr("""Stop the running script."""))
         self.stopAct.setWhatsThis(self.tr(
             """<b>Stop</b>"""
             """<p>This stops the script running in the debugger backend.</p>"""
         ))
         self.stopAct.triggered.connect(self.__stopScript)
         self.actions.append(self.stopAct)
         self.debugActGrp = createActionGroup(self)
         act = E5Action(
             self.tr('Continue'),
             UI.PixmapCache.getIcon("continue"),
             self.tr('&Continue'), Qt.Key_F6, 0,
             self.debugActGrp, 'dbg_continue')
         act.setStatusTip(
             self.tr('Continue running the program from the current line'))
         act.setWhatsThis(self.tr(
             """<b>Continue</b>"""
             """<p>Continue running the program from the current line. The"""
             """ program will stop when it terminates or when a breakpoint"""
             """ is reached.</p>"""
         ))
         act.triggered.connect(self.__continue)
         self.actions.append(act)
         act = E5Action(
             self.tr('Continue to Cursor'),
             UI.PixmapCache.getIcon("continueToCursor"),
             self.tr('Continue &To Cursor'), Qt.SHIFT + Qt.Key_F6, 0,
             self.debugActGrp, 'dbg_continue_to_cursor')
         act.setStatusTip(self.tr(
             """Continue running the program from the"""
             """ current line to the current cursor position"""))
         act.setWhatsThis(self.tr(
             """<b>Continue To Cursor</b>"""
             """<p>Continue running the program from the current line to the"""
             """ current cursor position.</p>"""
         ))
         act.triggered.connect(self.__runToCursor)
         self.actions.append(act)
         act = E5Action(
             self.tr('Continue Until'),
             UI.PixmapCache.getIcon("continueUntil"),
             self.tr('Continue &Until'), Qt.CTRL + Qt.Key_F6, 0,
             self.debugActGrp, 'dbg_continue_until')
         act.setStatusTip(self.tr(
             """Continue running the program from the current line to the"""
             """ current cursor position or until leaving the current frame"""))
         act.setWhatsThis(self.tr(
             """<b>Continue Until</b>"""
             """<p>Continue running the program from the current line to the"""
             """ cursor position greater than the current line or until"""
             """ leaving the current frame.</p>"""
         ))
         act.triggered.connect(self.__runUntil)
         self.actions.append(act)
         act = E5Action(
             self.tr('Move Instruction Pointer to Cursor'),
             UI.PixmapCache.getIcon("moveInstructionPointer"),
             self.tr('&Jump To Cursor'), Qt.Key_F12, 0,
             self.debugActGrp, 'dbg_jump_to_cursor')
         act.setStatusTip(self.tr(
             """Skip the code from the"""
             """ current line to the current cursor position"""))
         act.setWhatsThis(self.tr(
             """<b>Move Instruction Pointer to Cursor</b>"""
             """<p>Move the Python internal instruction pointer to the"""
             """ current cursor position without executing the code in"""
             """ between.</p>"""
             """<p>It's not possible to jump out of a function or jump"""
             """ in a code block, e.g. a loop. In these cases, a error"""
             """ message is printed to the log window.</p>"""
         ))
         act.triggered.connect(self.__moveInstructionPointer)
         self.actions.append(act)
         act = E5Action(
             self.tr('Single Step'),
             UI.PixmapCache.getIcon("step"),
             self.tr('Sin&gle Step'), Qt.Key_F7, 0,
             self.debugActGrp, 'dbg_single_step')
         act.setStatusTip(self.tr('Execute a single Python statement'))
         act.setWhatsThis(self.tr(
             """<b>Single Step</b>"""
             """<p>Execute a single Python statement. If the statement"""
             """ is an <tt>import</tt> statement, a class constructor, or a"""
             """ method or function call then control is returned to the"""
             """ debugger at the next statement.</p>"""
         ))
         act.triggered.connect(self.__step)
         self.actions.append(act)
         act = E5Action(
             self.tr('Step Over'),
             UI.PixmapCache.getIcon("stepOver"),
             self.tr('Step &Over'), Qt.Key_F8, 0,
             self.debugActGrp, 'dbg_step_over')
         act.setStatusTip(self.tr(
             """Execute a single Python statement staying"""
             """ in the current frame"""))
         act.setWhatsThis(self.tr(
             """<b>Step Over</b>"""
             """<p>Execute a single Python statement staying in the same"""
             """ frame. If the statement is an <tt>import</tt> statement,"""
             """ a class constructor, or a method or function call then"""
             """ control is returned to the debugger after the statement"""
             """ has completed.</p>"""
         ))
         act.triggered.connect(self.__stepOver)
         self.actions.append(act)
         act = E5Action(
             self.tr('Step Out'),
             UI.PixmapCache.getIcon("stepOut"),
             self.tr('Step Ou&t'), Qt.Key_F9, 0,
             self.debugActGrp, 'dbg_step_out')
         act.setStatusTip(self.tr(
             """Execute Python statements until leaving"""
             """ the current frame"""))
         act.setWhatsThis(self.tr(
             """<b>Step Out</b>"""
             """<p>Execute Python statements until leaving the current"""
             """ frame. If the statements are inside an <tt>import</tt>"""
             """ statement, a class constructor, or a method or function"""
             """ call then control is returned to the debugger after the"""
             """ current frame has been left.</p>"""
         ))
         act.triggered.connect(self.__stepOut)
         self.actions.append(act)
         act = E5Action(
             self.tr('Stop'),
             UI.PixmapCache.getIcon("stepQuit"),
             self.tr('&Stop'), Qt.Key_F10, 0,
             self.debugActGrp, 'dbg_stop')
         act.setStatusTip(self.tr('Stop debugging'))
         act.setWhatsThis(self.tr(
             """<b>Stop</b>"""
             """<p>Stop the running debugging session.</p>"""
         ))
         act.triggered.connect(self.__stepQuit)
         self.actions.append(act)
         self.dbgFilterAct = E5Action(
             self.tr('Variables Type Filter'),
             self.tr('Varia&bles Type Filter...'), 0, 0, self,
             'dbg_variables_filter')
         self.dbgFilterAct.setStatusTip(self.tr(
             'Configure variables type filter'))
         self.dbgFilterAct.setWhatsThis(self.tr(
             """<b>Variables Type Filter</b>"""
             """<p>Configure the variables type filter. Only variable types"""
             """ that are not selected are displayed in the global or local"""
             """ variables window during a debugging session.</p>"""
         ))
         self.dbgFilterAct.triggered.connect(
             self.__configureVariablesFilters)
         self.actions.append(self.dbgFilterAct)
         self.excFilterAct = E5Action(
             self.tr('Exceptions Filter'),
             self.tr('&Exceptions Filter...'), 0, 0, self,
             'dbg_exceptions_filter')
         self.excFilterAct.setStatusTip(self.tr(
             'Configure exceptions filter'))
         self.excFilterAct.setWhatsThis(self.tr(
             """<b>Exceptions Filter</b>"""
             """<p>Configure the exceptions filter. Only exception types"""
             """ that are listed are highlighted during a debugging"""
             """ session.</p><p>Please note, that all unhandled exceptions"""
             """ are highlighted indepent from the filter list.</p>"""
         ))
         self.excFilterAct.triggered.connect(
             self.__configureExceptionsFilter)
         self.actions.append(self.excFilterAct)
         self.excIgnoreFilterAct = E5Action(
             self.tr('Ignored Exceptions'),
             self.tr('&Ignored Exceptions...'), 0, 0,
             self, 'dbg_ignored_exceptions')
         self.excIgnoreFilterAct.setStatusTip(self.tr(
             'Configure ignored exceptions'))
         self.excIgnoreFilterAct.setWhatsThis(self.tr(
             """<b>Ignored Exceptions</b>"""
             """<p>Configure the ignored exceptions. Only exception types"""
             """ that are not listed are highlighted during a debugging"""
             """ session.</p><p>Please note, that unhandled exceptions"""
             """ cannot be ignored.</p>"""
         ))
         self.excIgnoreFilterAct.triggered.connect(
             self.__configureIgnoredExceptions)
         self.actions.append(self.excIgnoreFilterAct)
         self.dbgSetBpActGrp = createActionGroup(self)
         self.dbgToggleBpAct = E5Action(
             self.tr('Toggle Breakpoint'),
             UI.PixmapCache.getIcon("breakpointToggle"),
             self.tr('Toggle Breakpoint'),
             QKeySequence(self.tr("Shift+F11", "Debug|Toggle Breakpoint")),
 , self.dbgSetBpActGrp, 'dbg_toggle_breakpoint')
         self.dbgToggleBpAct.setStatusTip(self.tr('Toggle Breakpoint'))
         self.dbgToggleBpAct.setWhatsThis(self.tr(
             """<b>Toggle Breakpoint</b>"""
             """<p>Toggles a breakpoint at the current line of the"""
             """ current editor.</p>"""
         ))
         self.dbgToggleBpAct.triggered.connect(self.__toggleBreakpoint)
         self.actions.append(self.dbgToggleBpAct)
         self.dbgEditBpAct = E5Action(
             self.tr('Edit Breakpoint'),
             UI.PixmapCache.getIcon("cBreakpointToggle"),
             self.tr('Edit Breakpoint...'),
             QKeySequence(self.tr("Shift+F12", "Debug|Edit Breakpoint")), 0,
             self.dbgSetBpActGrp, 'dbg_edit_breakpoint')
         self.dbgEditBpAct.setStatusTip(self.tr('Edit Breakpoint'))
         self.dbgEditBpAct.setWhatsThis(self.tr(
             """<b>Edit Breakpoint</b>"""
             """<p>Opens a dialog to edit the breakpoints properties."""
             """ It works at the current line of the current editor.</p>"""
         ))
         self.dbgEditBpAct.triggered.connect(self.__editBreakpoint)
         self.actions.append(self.dbgEditBpAct)
         self.dbgNextBpAct = E5Action(
             self.tr('Next Breakpoint'),
             UI.PixmapCache.getIcon("breakpointNext"),
             self.tr('Next Breakpoint'),
             QKeySequence(
                 self.tr("Ctrl+Shift+PgDown", "Debug|Next Breakpoint")), 0,
             self.dbgSetBpActGrp, 'dbg_next_breakpoint')
         self.dbgNextBpAct.setStatusTip(self.tr('Next Breakpoint'))
         self.dbgNextBpAct.setWhatsThis(self.tr(
             """<b>Next Breakpoint</b>"""
             """<p>Go to next breakpoint of the current editor.</p>"""
         ))
         self.dbgNextBpAct.triggered.connect(self.__nextBreakpoint)
         self.actions.append(self.dbgNextBpAct)
         self.dbgPrevBpAct = E5Action(
             self.tr('Previous Breakpoint'),
             UI.PixmapCache.getIcon("breakpointPrevious"),
             self.tr('Previous Breakpoint'),
             QKeySequence(
                 self.tr("Ctrl+Shift+PgUp", "Debug|Previous Breakpoint")),
 , self.dbgSetBpActGrp, 'dbg_previous_breakpoint')
         self.dbgPrevBpAct.setStatusTip(self.tr('Previous Breakpoint'))
         self.dbgPrevBpAct.setWhatsThis(self.tr(
             """<b>Previous Breakpoint</b>"""
             """<p>Go to previous breakpoint of the current editor.</p>"""
         ))
         self.dbgPrevBpAct.triggered.connect(self.__previousBreakpoint)
         self.actions.append(self.dbgPrevBpAct)
         act = E5Action(
             self.tr('Clear Breakpoints'),
             self.tr('Clear Breakpoints'),
 , 0,
             self.dbgSetBpActGrp, 'dbg_clear_breakpoint')
         act.setStatusTip(self.tr('Clear Breakpoints'))
         act.setWhatsThis(self.tr(
             """<b>Clear Breakpoints</b>"""
             """<p>Clear breakpoints of all editors.</p>"""
         ))
         act.triggered.connect(self.__clearBreakpoints)
         self.actions.append(act)
         self.debugActGrp.setEnabled(False)
         self.dbgSetBpActGrp.setEnabled(False)
         self.runAct.setEnabled(False)
         self.runProjectAct.setEnabled(False)
         self.profileAct.setEnabled(False)
         self.profileProjectAct.setEnabled(False)
         self.coverageAct.setEnabled(False)
         self.coverageProjectAct.setEnabled(False)
         self.debugAct.setEnabled(False)
         self.debugProjectAct.setEnabled(False)
         self.restartAct.setEnabled(False)
         self.stopAct.setEnabled(False)
     def initMenus(self):
         """
         Public slot to initialize the project menu.
         @return the generated menu
         """
         dmenu = QMenu(self.tr('&Debug'), self.parent())
         dmenu.setTearOffEnabled(True)
         smenu = QMenu(self.tr('Sta&rt'), self.parent())
         smenu.setTearOffEnabled(True)
         self.breakpointsMenu = QMenu(self.tr('&Breakpoints'), dmenu)
         smenu.addAction(self.restartAct)
         smenu.addAction(self.stopAct)
         smenu.addSeparator()
         smenu.addAction(self.runAct)
         smenu.addAction(self.runProjectAct)
         smenu.addSeparator()
         smenu.addAction(self.debugAct)
         smenu.addAction(self.debugProjectAct)
         smenu.addSeparator()
         smenu.addAction(self.profileAct)
         smenu.addAction(self.profileProjectAct)
         smenu.addSeparator()
         smenu.addAction(self.coverageAct)
         smenu.addAction(self.coverageProjectAct)
         dmenu.addActions(self.debugActGrp.actions())
         dmenu.addSeparator()
         dmenu.addActions(self.dbgSetBpActGrp.actions())
         self.menuBreakpointsAct = dmenu.addMenu(self.breakpointsMenu)
         dmenu.addSeparator()
         dmenu.addAction(self.dbgFilterAct)
         dmenu.addAction(self.excFilterAct)
         dmenu.addAction(self.excIgnoreFilterAct)
         self.breakpointsMenu.aboutToShow.connect(self.__showBreakpointsMenu)
         self.breakpointsMenu.triggered.connect(self.__breakpointSelected)
         dmenu.aboutToShow.connect(self.__showDebugMenu)
         return smenu, dmenu
     def initToolbars(self, toolbarManager):
         """
         Public slot to initialize the debug toolbars.
         @param toolbarManager reference to a toolbar manager object
             (E5ToolBarManager)
         @return the generated toolbars (list of QToolBar)
         """
         starttb = QToolBar(self.tr("Start"), self.ui)
         starttb.setIconSize(UI.Config.ToolBarIconSize)
         starttb.setObjectName("StartToolbar")
         starttb.setToolTip(self.tr('Start'))
         starttb.addAction(self.restartAct)
         starttb.addAction(self.stopAct)
         starttb.addSeparator()
         starttb.addAction(self.runAct)
         starttb.addAction(self.runProjectAct)
         starttb.addSeparator()
         starttb.addAction(self.debugAct)
         starttb.addAction(self.debugProjectAct)
         debugtb = QToolBar(self.tr("Debug"), self.ui)
         debugtb.setIconSize(UI.Config.ToolBarIconSize)
         debugtb.setObjectName("DebugToolbar")
         debugtb.setToolTip(self.tr('Debug'))
         debugtb.addActions(self.debugActGrp.actions())
         debugtb.addSeparator()
         debugtb.addAction(self.dbgToggleBpAct)
         debugtb.addAction(self.dbgEditBpAct)
         debugtb.addAction(self.dbgNextBpAct)
         debugtb.addAction(self.dbgPrevBpAct)
         toolbarManager.addToolBar(starttb, starttb.windowTitle())
         toolbarManager.addToolBar(debugtb, debugtb.windowTitle())
         toolbarManager.addAction(self.profileAct, starttb.windowTitle())
         toolbarManager.addAction(self.profileProjectAct, starttb.windowTitle())
         toolbarManager.addAction(self.coverageAct, starttb.windowTitle())
         toolbarManager.addAction(self.coverageProjectAct,
                                  starttb.windowTitle())
         return [starttb, debugtb]
     def setArgvHistory(self, argsStr, clearHistories=False, history=None):
         """
         Public slot to initialize the argv history.
         @param argsStr the commandline arguments (string)
         @param clearHistories flag indicating, that the list should
             be cleared (boolean)
         @param history list of history entries to be set (list of strings)
         """
         if clearHistories:
             del self.argvHistory[1:]
         elif history is not None:
             self.argvHistory = history[:]
         else:
             if argsStr in self.argvHistory:
                 self.argvHistory.remove(argsStr)
             self.argvHistory.insert(0, argsStr)
     def setWdHistory(self, wdStr, clearHistories=False, history=None):
         """
         Public slot to initialize the wd history.
         @param wdStr the working directory (string)
         @param clearHistories flag indicating, that the list should
             be cleared (boolean)
         @param history list of history entries to be set (list of strings)
         """
         if clearHistories:
             del self.wdHistory[1:]
         elif history is not None:
             self.wdHistory = history[:]
         else:
             if wdStr in self.wdHistory:
                 self.wdHistory.remove(wdStr)
             self.wdHistory.insert(0, wdStr)
     def setEnvHistory(self, envStr, clearHistories=False, history=None):
         """
         Public slot to initialize the env history.
         @param envStr the environment settings (string)
         @param clearHistories flag indicating, that the list should
             be cleared (boolean)
         @param history list of history entries to be set (list of strings)
         """
         if clearHistories:
             del self.envHistory[1:]
         elif history is not None:
             self.envHistory = history[:]
         else:
             if envStr in self.envHistory:
                 self.envHistory.remove(envStr)
             self.envHistory.insert(0, envStr)
     def setExceptionReporting(self, exceptions):
         """
         Public slot to initialize the exception reporting flag.
         @param exceptions flag indicating exception reporting status (boolean)
         """
         self.exceptions = exceptions
     def setExcList(self, excList):
         """
         Public slot to initialize the exceptions type list.
         @param excList list of exception types (list of strings)
         """
         self.excList = excList[:]   # keep a copy
     def setExcIgnoreList(self, excIgnoreList):
         """
         Public slot to initialize the ignored exceptions type list.
         @param excIgnoreList list of ignored exception types (list of strings)
         """
         self.excIgnoreList = excIgnoreList[:]   # keep a copy
     def setAutoClearShell(self, autoClearShell):
         """
         Public slot to initialize the autoClearShell flag.
         @param autoClearShell flag indicating, that the interpreter window
             should be cleared (boolean)
         """
         self.autoClearShell = autoClearShell
     def setTracePython(self, tracePython):
         """
         Public slot to initialize the trace Python flag.
         @param tracePython flag indicating if the Python library should be
             traced as well (boolean)
         """
         self.tracePython = tracePython
     def setAutoContinue(self, autoContinue):
         """
         Public slot to initialize the autoContinue flag.
         @param autoContinue flag indicating, that the debugger should not
             stop at the first executable line (boolean)
         """
         self.autoContinue = autoContinue
     def __editorOpened(self, fn):
         """
         Private slot to handle the editorOpened signal.
         @param fn filename of the opened editor
         """
         self.editorOpen = True
         if fn:
             editor = self.viewmanager.getOpenEditor(fn)
         else:
             editor = None
         self.__checkActions(editor)
     def __lastEditorClosed(self):
         """
         Private slot to handle the closeProgram signal.
         """
         self.editorOpen = False
         self.debugAct.setEnabled(False)
         self.runAct.setEnabled(False)
         self.profileAct.setEnabled(False)
         self.coverageAct.setEnabled(False)
         self.debugActGrp.setEnabled(False)
         self.dbgSetBpActGrp.setEnabled(False)
         self.lastAction = -1
         if not self.projectOpen:
             self.restartAct.setEnabled(False)
             self.lastDebuggedFile = None
             self.lastStartAction = 0
             self.clientType = ""
     def __checkActions(self, editor):
         """
         Private slot to check some actions for their enable/disable status.
         @param editor editor window
         """
         if editor:
             fn = editor.getFileName()
         else:
             fn = None
         cap = 0
         if fn:
             for language in self.debugServer.getSupportedLanguages():
                 exts = self.debugServer.getExtensions(language)
                 if fn.endswith(exts):
                     cap = self.debugServer.getClientCapabilities(language)
                     break
             else:
                 if editor.isPy3File():
                     cap = self.debugServer.getClientCapabilities('Python3')
                 elif editor.isRubyFile():
                     cap = self.debugServer.getClientCapabilities('Ruby')
             if not self.passive:
                 self.runAct.setEnabled(cap & HasInterpreter)
                 self.coverageAct.setEnabled(cap & HasCoverage)
                 self.profileAct.setEnabled(cap & HasProfiler)
                 self.debugAct.setEnabled(cap & HasDebugger)
             self.dbgSetBpActGrp.setEnabled(cap & HasDebugger)
             if editor.curLineHasBreakpoint():
                 self.dbgEditBpAct.setEnabled(True)
             else:
                 self.dbgEditBpAct.setEnabled(False)
             if editor.hasBreakpoints():
                 self.dbgNextBpAct.setEnabled(True)
                 self.dbgPrevBpAct.setEnabled(True)
             else:
                 self.dbgNextBpAct.setEnabled(False)
                 self.dbgPrevBpAct.setEnabled(False)
         else:
             self.runAct.setEnabled(False)
             self.coverageAct.setEnabled(False)
             self.profileAct.setEnabled(False)
             self.debugAct.setEnabled(False)
             self.dbgSetBpActGrp.setEnabled(False)
     def __cursorChanged(self, editor):
         """
         Private slot handling the cursorChanged signal of the viewmanager.
         @param editor editor window
         """
         if editor is None:
             return
         if editor.isPyFile() or editor.isRubyFile():
             if editor.curLineHasBreakpoint():
                 self.dbgEditBpAct.setEnabled(True)
             else:
                 self.dbgEditBpAct.setEnabled(False)
             if editor.hasBreakpoints():
                 self.dbgNextBpAct.setEnabled(True)
                 self.dbgPrevBpAct.setEnabled(True)
             else:
                 self.dbgNextBpAct.setEnabled(False)
                 self.dbgPrevBpAct.setEnabled(False)
     def __projectOpened(self):
         """
         Private slot to handle the projectOpened signal.
         """
         self.projectOpen = True
         cap = self.debugServer.getClientCapabilities(
             self.project.getProjectLanguage())
         if not self.passive:
             self.debugProjectAct.setEnabled(cap & HasDebugger)
             self.runProjectAct.setEnabled(cap & HasInterpreter)
             self.profileProjectAct.setEnabled(cap & HasProfiler)
             self.coverageProjectAct.setEnabled(cap & HasCoverage)
     def __projectClosed(self):
         """
         Private slot to handle the projectClosed signal.
         """
         self.projectOpen = False
         self.runProjectAct.setEnabled(False)
         self.profileProjectAct.setEnabled(False)
         self.coverageProjectAct.setEnabled(False)
         self.debugProjectAct.setEnabled(False)
         if not self.editorOpen:
             self.restartAct.setEnabled(False)
             self.lastDebuggedFile = None
             self.lastStartAction = 0
             self.clientType = ""
     def clearHistories(self):
         """
         Public method to clear the various debug histories.
         """
         self.argvHistory = []
         self.wdHistory = []
         self.envHistory = []
         self.multiprocessNoDebugHistory = []
         Preferences.Prefs.settings.setValue(
             'DebugInfo/ArgumentsHistory', self.argvHistory)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/WorkingDirectoryHistory', self.wdHistory)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/EnvironmentHistory', self.envHistory)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/MultiprocessNoDebugHistory',
             self.multiprocessNoDebugHistory)
     def shutdown(self):
         """
         Public method to perform shutdown actions.
         """
         # Just save the 10 most recent entries
         del self.argvHistory[10:]
         del self.wdHistory[10:]
         del self.envHistory[10:]
         Preferences.Prefs.settings.setValue(
             'DebugInfo/VirtualEnvironment', self.lastUsedVenvName)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/ArgumentsHistory', self.argvHistory)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/WorkingDirectoryHistory', self.wdHistory)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/EnvironmentHistory', self.envHistory)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/Exceptions', self.excList)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/IgnoredExceptions', self.excIgnoreList)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/ReportExceptions', self.exceptions)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/AutoClearShell', self.autoClearShell)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/TracePython', self.tracePython)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/AutoContinue', self.autoContinue)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/EnableMultiprocess', self.enableMultiprocess)
         Preferences.Prefs.settings.setValue(
             'DebugInfo/MultiprocessNoDebugHistory',
             self.multiprocessNoDebugHistory)
     def shutdownServer(self):
         """
         Public method to shut down the debug server.
         This is needed to cleanly close the sockets on Win OS.
         @return always true
         """
         self.debugServer.shutdownServer()
         return True
     def __resetUI(self):
         """
         Private slot to reset the user interface.
         """
         self.lastAction = -1
         self.debugActGrp.setEnabled(False)
         if not self.passive:
             if self.editorOpen:
                 editor = self.viewmanager.activeWindow()
             else:
                 editor = None
             self.__checkActions(editor)
             self.debugProjectAct.setEnabled(self.projectOpen)
             self.runProjectAct.setEnabled(self.projectOpen)
             self.profileProjectAct.setEnabled(self.projectOpen)
             self.coverageProjectAct.setEnabled(self.projectOpen)
             if (
                 self.lastDebuggedFile is not None and
                 (self.editorOpen or self.projectOpen)
             ):
                 self.restartAct.setEnabled(True)
             else:
                 self.restartAct.setEnabled(False)
             self.stopAct.setEnabled(False)
         self.resetUI.emit()
     def __clientLine(self, fn, line, debuggerId, forStack):
         """
         Private method to handle a change to the current line.
         @param fn filename
         @type str
         @param line linenumber
         @type int
         @param debuggerId ID of the debugger backend
         @type str
         @param forStack flag indicating this is for a stack dump
         @type bool
         """
         self.ui.raise_()
         self.ui.activateWindow()
         if self.ui.getViewProfile() != "debug":
             self.ui.setDebugProfile()
         self.viewmanager.setFileLine(fn, line)
         if not forStack:
             self.__getThreadList(debuggerId)
             self.__getClientVariables(debuggerId)
         self.debugActGrp.setEnabled(True)
     @pyqtSlot(str, int, str, bool)
     def __clientExit(self, program, status, message, quiet):
         """
         Private method to handle the debugged program terminating.
         @param program name of the exited program
         @type str
         @param status exit code of the debugged program
         @type int
         @param message exit message of the debugged program
         @type str
         @param quiet flag indicating to suppress exit info display
         @type bool
         """
         if not quiet:
             if not program:
                 program = self.ui.currentProg
             if (
                 not Preferences.getDebugger("SuppressClientExit") or
                 status != 0
             ):
                 if message:
                     info = self.tr("<p>Message: {0}</p>").format(
                         Utilities.html_uencode(message))
                 else:
                     info = ""
                 if program is None:
                     E5MessageBox.information(
                         self.ui, Program,
                         self.tr('<p>The program has terminated with an exit'
                                 ' status of {0}.</p>{1}').format(status, info)
                     )
                 else:
                     E5MessageBox.information(
 f35037a08d4
Unit Test: added capability to run test with debugger support and to stop the test on the first error or failure.

Detlev Offenbach <detlev@die-offe

Mercurial Repositories > eric / annotate

eric6/Debugger/DebugUI.py@91e843545d9a (annotated)

eric6/Debugger/DebugUI.py