# eric3.Debugger.DebugUI

Module implementing the debugger UI.

### Classes

DebugUI | Class implementing the debugger part of the UI.

### Functions

None

## DebugUI

Class implementing the debugger part of the UI.

#### Signals

clientStack(stack)
  emitted at breaking after a reported exception
compileForms()
  emitted if changed project forms should be compiled
debuggingStarted(filename)
  emitted when a debugging session was started
resetUI()
  emitted to reset the UI

### Derived from

QObject

### Methods

DebugUI | Constructor
checkActions | Private slot to check some actions for their enable/disable status.
compileChangedProjectForms | Private method to signal compilation of changed forms is wanted.
enterRemote | Private method to update the user interface.
getActions | Public method to get a list of all actions.
getAllBreakpoints | Public method to get all breakpoints
getClientVariables | Private method to request the global and local variables.
getFileBreakpoints | Public method to get all file breakpoints.
getProjectBreakpoints | Public method to get all breakpoints of the current project
handleBreakpointSelected | Private method to handle the breakpoint selected signal.
handleClearBreakpoints | Private slot to handle the 'Clear breakpoints' action.
handleClientBreakConditionError | Private method to handle a condition error of a breakpoint.
handleClientClearBreak | Private method to clear a temporary breakpoint.
handleClientGone | Private method to handle the disconnection of the debugger client.
handleClientVariable | Private method to write the contents of a clients classvariable to the user interface.
handleClientVariables | Private method to write the clients variables to the user interface.
handleConfigFilters | Private slot for displaying the variables filter configuration dialog.
handleContinue | Private method to handle the Continue action.
handleCoverage | Private method to handle the coverage actions.
handleCoverageProject | Private slot to handle the coverage of project action.
handleCoverageScript | Private slot to handle the coverage of script action.
handleCursorChanged | Private slot handling the cursorChanged signal of the viewmanager.
handleCyclops | Private method to handle the cyclops actions.
handleCyclopsError | Private slot to handle a cyclops error.
handleCyclopsProject | Private slot to handle the cyclops project action.
handleCyclopsScript | Private slot to handle the cyclops script action.
handleDebug | Private method to handle the debug actions.
handleDebugProject | Private slot to handle the debug project action.
handleDebugScript | Private slot to handle the debug script action.
handleEditBreakpoint | Private slot to handle the 'Edit breakpoint' action.
handleEditorOpened | Private slot to handle the editorOpened signal.
handleEval | Private method to handle the Eval action.
handleException | Private method to handle an exception of the debugged program.
handleExceptionsFilter | Private slot for displaying the exception filter dialog.
handleExec | Private method to handle the Exec action.
handleExit | Private method to handle the debugged program terminating.
handleGotoBreakpoint | Public method to show the source related to a breakpoint.
handleLastEditorClosed | Private slot to handle the closeProgram signal.
handleLineChange | Private method to handle a change to the current line.
handleNextBreakpoint | Private slot to handle the 'Next breakpoint' action.
handlePassiveDebugStarted | Private slot to handle a passive debug session start.
handlePreviousBreakpoint | Private slot to handle the 'Previous breakpoint' action.
handleProfile | Private method to handle the profile actions.
handleProfileProject | Private slot to handle the profile project action.
handleProfileScript | Private slot to handle the profile script action.
handleProjectClosed | Private slot to handle the projectClosed signal.
handleProjectOpened | Private slot to handle the projectOpened signal.
handleProjectSessionLoaded | Private slot to handle the projectSessionLoaded signal.
handleRestart | Private slot to handle the restart action to restart the last debugged file.
handleRun | Private method to handle the run actions.
handleRunProject | Private slot to handle the run project action.
handleRunScript | Private slot to handle the run script action.
handleRunToCursor | Private method to handle the Run to Cursor action.
handleShowBreakpointsMenu | Private method to handle the show breakpoints menu signal.
handleSpecialContinue | Private method to handle the Special Continue action.
handleStep | Private method to handle the Step action.
handleStepOut | Private method to handle the Step Out action.
handleStepOver | Private method to handle the Step Over action.
handleStepQuit | Private method to handle the Step Quit action.
handleSyntaxError | Private method to handle a syntax error in the debugged program.
handleToggleBreakpoint | Private slot to handle the 'Set/Reset breakpoint' action.
initActions | Method defining the user interface actions.
initMenu | Public slot to initialize the project menu.
initToolbar | Public slot to initialize the project toolbar.
newBreakpointWithProperties | Public method to set a new breakpoint and its properties.
resetUI | Private slot to reset the user interface.
setArgvHistory | Public slot to initialize the argv History used for debugging.
setBreakpointProperties | Public method to set a breakpoints properties.
setCovexcHistory | Public slot to initialize the coverage exclusion pattern History.
setEnvHistory | Public slot to initialize the env History used for debugging.
setExcList | Public slot to initialize the exceptions type list.
setExceptionReporting | Public slot to initialize the exception reporting flag.
setTracePython | Public slot to initialize the trace Python flag.
setWdHistory | Public slot to initialize the wd History used for debugging.
shutdownServer | Public method to shutdown the debug server.
toggleBreakpoint | Public method to toggle a breakpoint.

### DebugUI (Constructor)

DebugUI(ui, vm, dbs, sbv, pro)

Constructor

ui
  reference to the main UI
vm
  reference to the viewmanager
dbs
  reference to the debug server
sbv
  reference to the shell/browser/variables/exception widget
pro
  reference to the project object

### DebugUI.checkActions

checkActions(editor)

Private slot to check some actions for their enable/disable status.

editor
  editor window

### DebugUI.compileChangedProjectForms

compileChangedProjectForms()

Private method to signal compilation of changed forms is wanted.

### DebugUI.enterRemote

enterRemote()

Private method to update the user interface.

This method is called just prior to executing some of the program being debugged.

### DebugUI.getActions

getActions()

Public method to get a list of all actions.

Returns:
  list of all actions (list of E3Action)

### DebugUI.getAllBreakpoints

getAllBreakpoints()

Public method to get all breakpoints

Returns:
  list of all breakpoints

### DebugUI.getClientVariables

getClientVariables()

Private method to request the global and local variables.

In the first step, the global variables are requested from the client. Once these have been received, the local variables are requested. This happens in the method 'handleClientVariables'.

### DebugUI.getFileBreakpoints

getFileBreakpoints(fn)

Public method to get all file breakpoints.

fn
  filename (string)

Returns:
  list of file breakpoints

### DebugUI.getProjectBreakpoints

getProjectBreakpoints()

Public method to get all breakpoints of the current project

Returns:
  list of breakpoints belonging to the current project

### DebugUI.handleBreakpointSelected

handleBreakpointSelected(id)

Private method to handle the breakpoint selected signal.

id
  index of the selected menu entry This acts as an index into the list of breakpoints that was created, when the breakpoints menu was built.

### DebugUI.handleClearBreakpoints

handleClearBreakpoints()

Private slot to handle the 'Clear breakpoints' action.

### DebugUI.handleClientBreakConditionError

handleClientBreakConditionError(filename, lineno)

Private method to handle a condition error of a breakpoint.

filename
  filename of the breakpoint
lineno
  linenumber of the breakpoint

### DebugUI.handleClientClearBreak

handleClientClearBreak(filename, lineno)

Private method to clear a temporary breakpoint.

filename
  filename of the breakpoint
lineno
  linenumber of the breakpoint

### DebugUI.handleClientGone

handleClientGone(unplanned)

Private method to handle the disconnection of the debugger client.

unplanned
  1 if the client died, 0 otherwise

### DebugUI.handleClientVariable

handleClientVariable(vars)

Private method to write the contents of a clients classvariable to the user interface.

vars
  the list of members of a classvariable from the client

### DebugUI.handleClientVariables

handleClientVariables(vars)

Private method to write the clients variables to the user interface.

vars
  the list of variables from the client

### DebugUI.handleConfigFilters

handleConfigFilters()

Private slot for displaying the variables filter configuration dialog.

### DebugUI.handleContinue

handleContinue()

Private method to handle the Continue action.

### DebugUI.handleCoverage

handleCoverage(runProject)

Private method to handle the coverage actions.

runProject
  flag indicating coverage of the current project (1) or script (0)

### DebugUI.handleCoverageProject

handleCoverageProject()

Private slot to handle the coverage of project action.

### DebugUI.handleCoverageScript

handleCoverageScript()

Private slot to handle the coverage of script action.

### DebugUI.handleCursorChanged

handleCursorChanged(editor)

Private slot handling the cursorChanged signal of the viewmanager.

editor
  editor window

### DebugUI.handleCyclops

handleCyclops(runProject)

Private method to handle the cyclops actions.

runProject
  flag indicating cyclops of the current project (1) or script (0)

### DebugUI.handleCyclopsError

handleCyclopsError(fn, modfunc)

Private slot to handle a cyclops error.

fn
  filename of the file to be run through Cyclops (string)
modfunc
  function name of the entry point (string)

### DebugUI.handleCyclopsProject

handleCyclopsProject()

Private slot to handle the cyclops project action.

### DebugUI.handleCyclopsScript

handleCyclopsScript()

Private slot to handle the cyclops script action.

### DebugUI.handleDebug

handleDebug(debugProject)

Private method to handle the debug actions.

debugProject
  flag indicating debugging the current project (1) or script (0)

### DebugUI.handleDebugProject

handleDebugProject()

Private slot to handle the debug project action.

### DebugUI.handleDebugScript

handleDebugScript()

Private slot to handle the debug script action.

### DebugUI.handleEditBreakpoint

handleEditBreakpoint()

Private slot to handle the 'Edit breakpoint' action.

### DebugUI.handleEditorOpened

handleEditorOpened(fn)

Private slot to handle the editorOpened signal.

fn
  filename of the opened editor

### DebugUI.handleEval

handleEval()

Private method to handle the Eval action.

### DebugUI.handleException

handleException(status)

Private method to handle an exception of the debugged program.

status
  exception information

### DebugUI.handleExceptionsFilter

handleExceptionsFilter()

Private slot for displaying the exception filter dialog.

### DebugUI.handleExec

handleExec()

Private method to handle the Exec action.

### DebugUI.handleExit

handleExit(status)

Private method to handle the debugged program terminating.

tatus
  exit code of the debugged program (int)

### DebugUI.handleGotoBreakpoint

handleGotoBreakpoint(filename, lineno)

Public method to show the source related to a breakpoint.

filename
  name of the related file (string or QString)
line
  number of the breakpoint (integer)

### DebugUI.handleLastEditorClosed

handleLastEditorClosed()

Private slot to handle the closeProgram signal.

### DebugUI.handleLineChange

handleLineChange(fn, line)

Private method to handle a change to the current line.

fn
  filename (string)
line
  linenumber (int)

### DebugUI.handleNextBreakpoint

handleNextBreakpoint()

Private slot to handle the 'Next breakpoint' action.

### DebugUI.handlePassiveDebugStarted

handlePassiveDebugStarted(fn, exc)

Private slot to handle a passive debug session start.

fn
  filename of the debugged script
exc
  flag to enable exception reporting of the IDE (boolean)

### DebugUI.handlePreviousBreakpoint

handlePreviousBreakpoint()

Private slot to handle the 'Previous breakpoint' action.

### DebugUI.handleProfile

handleProfile(runProject)

Private method to handle the profile actions.

runProject
  flag indicating profiling of the current project (1) or script (0)

### DebugUI.handleProfileProject

handleProfileProject()

Private slot to handle the profile project action.

### DebugUI.handleProfileScript

handleProfileScript()

Private slot to handle the profile script action.

### DebugUI.handleProjectClosed

handleProjectClosed()

Private slot to handle the projectClosed signal.

### DebugUI.handleProjectOpened

handleProjectOpened()

Private slot to handle the projectOpened signal.

### DebugUI.handleProjectSessionLoaded

handleProjectSessionLoaded()

Private slot to handle the projectSessionLoaded signal.

### DebugUI.handleRestart

handleRestart()

Private slot to handle the restart action to restart the last debugged file.

### DebugUI.handleRun

handleRun(runProject)

Private method to handle the run actions.

unProject
  flag indicating running the current project (1) or script (0)

### DebugUI.handleRunProject

handleRunProject()

Private slot to handle the run project action.

### DebugUI.handleRunScript

handleRunScript()

Private slot to handle the run script action.

### DebugUI.handleRunToCursor

handleRunToCursor()

Private method to handle the Run to Cursor action.

### DebugUI.handleShowBreakpointsMenu

handleShowBreakpointsMenu()

Private method to handle the show breakpoints menu signal.

### DebugUI.handleSpecialContinue

handleSpecialContinue()

Private method to handle the Special Continue action.

### DebugUI.handleStep

handleStep()

Private method to handle the Step action.

### DebugUI.handleStepOut

handleStepOut()

Private method to handle the Step Out action.

### DebugUI.handleStepOver

handleStepOver()

Private method to handle the Step Over action.

### DebugUI.handleStepQuit

handleStepQuit()

Private method to handle the Step Quit action.

### DebugUI.handleSyntaxError

handleSyntaxError(status)

Private method to handle a syntax error in the debugged program.

status
  information about the syntax error

### DebugUI.handleToggleBreakpoint

handleToggleBreakpoint()

Private slot to handle the 'Set/Reset breakpoint' action.

### DebugUI.initActions

initActions()

Method defining the user interface actions.

### DebugUI.initMenu

initMenu()

Public slot to initialize the project menu.

Returns:
  the generated menu

### DebugUI.initToolbar

initToolbar()

Public slot to initialize the project toolbar.

Returns:
  the generated toolbar

### DebugUI.newBreakpointWithProperties

newBreakpointWithProperties(fn, line, properties)

Public method to set a new breakpoint and its properties.

fn
  filename of the breakpoint operation (string)
line
  line number of the breakpoint
properties
  properties for the breakpoint (tuple) (condition, temporary flag, enabled flag, ignore count)

### DebugUI.resetUI

resetUI()

Private slot to reset the user interface.

### DebugUI.setArgvHistory

setArgvHistory(argsStr)

Public slot to initialize the argv History used for debugging.

argsStr
  the commandline argumnets (string or QString)

### DebugUI.setBreakpointProperties

setBreakpointProperties(fn, line, properties)

Public method to set a breakpoints properties.

fn
  filename of the breakpoint operation (string)
line
  line number of the breakpoint
properties
  properties for the breakpoint (tuple) (condition, temporary flag, enabled flag, ignore count)

### DebugUI.setCovexcHistory

setCovexcHistory(covexcStr)

Public slot to initialize the coverage exclusion pattern History.

covexcStr
  the environment settings (string or QString)

### DebugUI.setEnvHistory

setEnvHistory(envStr)

Public slot to initialize the env History used for debugging.

envStr
  the environment settings (string or QString)

### DebugUI.setExcList

setExcList(excList)

Public slot to initialize the exceptions type list.

excList
  list of exception types (list of strings)

### DebugUI.setExceptionReporting

setExceptionReporting(exceptions)

Public slot to initialize the exception reporting flag.

exceptions
  flag indicating exception reporting status (boolean)

### DebugUI.setTracePython

setTracePython(tracePython)

Public slot to initialize the trace Python flag.

tracePython
  flag indicating if the Python library should be traced as well (boolean)

### DebugUI.setWdHistory

setWdHistory(wdStr)

Public slot to initialize the wd History used for debugging.

wdStr
  the working directory (string or QString)

### DebugUI.shutdownServer

shutdownServer()

Public method to shutdown the debug server.

This is needed to cleanly close the sockets on Win OS.

Returns:
  always true

### DebugUI.toggleBreakpoint

toggleBreakpoint(fn, line)

Public method to toggle a breakpoint.

fn
  filename of the breakpoint operation (string)
line
  line number of the breakpoint

Up