--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric6.Debugger.DebugServer.html Sat Jul 05 12:29:15 2014 +0200 @@ -0,0 +1,1781 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Debugger.DebugServer</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric6.Debugger.DebugServer</h1> +<p> +Module implementing the debug server. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>DebuggerInterfaces</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#DebugServer">DebugServer</a></td> +<td>Class implementing the debug server embedded within the IDE.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="DebugServer" ID="DebugServer"></a> +<h2>DebugServer</h2> +<p> + Class implementing the debug server embedded within the IDE. +</p><h3>Signals</h3> +<dl> +<dt>appendStdout(msg)</dt> +<dd> +emitted when a passive debug connection is + established or lost +</dd><dt>callTraceInfo</dt> +<dd> +emitted after the client reported the call trace + data (isCall, fromFile, fromLine, fromFunction, toFile, toLine, + toFunction) +</dd><dt>clientBanner(banner)</dt> +<dd> +emitted after the client banner was received +</dd><dt>clientBreakConditionError(fn, lineno)</dt> +<dd> +emitted after the client has + signaled a syntax error in a breakpoint condition +</dd><dt>clientCapabilities(int capabilities, string cltype)</dt> +<dd> +emitted after + the clients capabilities were received +</dd><dt>clientClearBreak(filename, lineno)</dt> +<dd> +emitted after the debug client + has decided to clear a temporary breakpoint +</dd><dt>clientClearWatch(condition)</dt> +<dd> +emitted after the debug client + has decided to clear a temporary watch expression +</dd><dt>clientCompletionList(completionList, text)</dt> +<dd> +emitted after the client + the commandline completion list and the reworked searchstring was + received from the client +</dd><dt>clientException(exception)</dt> +<dd> +emitted after an exception occured on + the client side +</dd><dt>clientExit(int)</dt> +<dd> +emitted with the exit status after the client has + exited +</dd><dt>clientGone(bool)</dt> +<dd> +emitted if the client went away (planned or + unplanned) +</dd><dt>clientInterpreterChanged(str)</dt> +<dd> +emitted to signal a change of the + client interpreter +</dd><dt>clientLine(filename, lineno, forStack)</dt> +<dd> +emitted after the + debug client has executed a line of code +</dd><dt>clientOutput(str)</dt> +<dd> +emitted after the client has sent some output +</dd><dt>clientProcessStderr(str)</dt> +<dd> +emitted after the client has sent some + output via stderr +</dd><dt>clientProcessStdout(str)</dt> +<dd> +emitted after the client has sent some + output via stdout +</dd><dt>clientRawInput(prompt, echo)</dt> +<dd> +emitted after a raw input request was + received +</dd><dt>clientRawInputSent()</dt> +<dd> +emitted after the data was sent to the + debug client +</dd><dt>clientStack(stack)</dt> +<dd> +emitted after the debug client has executed a + line of code +</dd><dt>clientStatement(bool)</dt> +<dd> +emitted after an interactive command has + been executed. The parameter is 0 to indicate that the command is + complete and 1 if it needs more input. +</dd><dt>clientSyntaxError(exception)</dt> +<dd> +emitted after a syntax error has been + detected on the client side +</dd><dt>clientThreadList(currentId, threadList)</dt> +<dd> +emitted after a thread list + has been received +</dd><dt>clientThreadSet()</dt> +<dd> +emitted after the client has acknowledged the + change of the current thread +</dd><dt>clientVariable(scope, variables)</dt> +<dd> +emitted after a dump for one class + variable has been received +</dd><dt>clientVariables(scope, variables)</dt> +<dd> +emitted after a variables dump + has been received +</dd><dt>clientWatchConditionError(condition)</dt> +<dd> +emitted after the client has + signaled a syntax error in a watch expression +</dd><dt>passiveDebugStarted(str, bool)</dt> +<dd> +emitted after the debug client has + connected in passive debug mode +</dd><dt>utFinished()</dt> +<dd> +emitted after the client signalled the end of the + unittest +</dd><dt>utPrepared(nrTests, exc_type, exc_value)</dt> +<dd> +emitted after the client + has loaded a unittest suite +</dd><dt>utStartTest(testname, testdocu)</dt> +<dd> +emitted after the client has + started a test +</dd><dt>utStopTest()</dt> +<dd> +emitted after the client has finished a test +</dd><dt>utTestErrored(testname, exc_info, id)</dt> +<dd> +emitted after the client + reported an errored test +</dd><dt>utTestFailed(testname, exc_info, id)</dt> +<dd> +emitted after the client + reported a failed test +</dd><dt>utTestFailedExpected(testname, exc_info, id)</dt> +<dd> +emitted after the + client reported an expected test failure +</dd><dt>utTestSkipped(testname, reason, id)</dt> +<dd> +emitted after the client + reported a skipped test +</dd><dt>utTestSucceededUnexpected(testname, id)</dt> +<dd> +emitted after the client + reported an unexpected test success +</dd> +</dl> +<h3>Derived from</h3> +QTcpServer +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#DebugServer.__init__">DebugServer</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#DebugServer.__addBreakPoints">__addBreakPoints</a></td> +<td>Private slot to add breakpoints.</td> +</tr><tr> +<td><a href="#DebugServer.__addWatchPoints">__addWatchPoints</a></td> +<td>Private slot to set a watch expression.</td> +</tr><tr> +<td><a href="#DebugServer.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td> +<td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td> +</tr><tr> +<td><a href="#DebugServer.__changeBreakPoints">__changeBreakPoints</a></td> +<td>Private slot to set changed breakpoints.</td> +</tr><tr> +<td><a href="#DebugServer.__changeWatchPoints">__changeWatchPoints</a></td> +<td>Private slot to set changed watch expressions.</td> +</tr><tr> +<td><a href="#DebugServer.__clientClearBreakPoint">__clientClearBreakPoint</a></td> +<td>Private slot to handle the clientClearBreak signal.</td> +</tr><tr> +<td><a href="#DebugServer.__clientClearWatchPoint">__clientClearWatchPoint</a></td> +<td>Private slot to handle the clientClearWatch signal.</td> +</tr><tr> +<td><a href="#DebugServer.__clientProcessError">__clientProcessError</a></td> +<td>Private slot to process client output received via stderr.</td> +</tr><tr> +<td><a href="#DebugServer.__clientProcessOutput">__clientProcessOutput</a></td> +<td>Private slot to process client output received via stdout.</td> +</tr><tr> +<td><a href="#DebugServer.__createDebuggerInterface">__createDebuggerInterface</a></td> +<td>Private slot to create the debugger interface object.</td> +</tr><tr> +<td><a href="#DebugServer.__deleteBreakPoints">__deleteBreakPoints</a></td> +<td>Private slot to delete breakpoints.</td> +</tr><tr> +<td><a href="#DebugServer.__deleteWatchPoints">__deleteWatchPoints</a></td> +<td>Private slot to delete watch expressions.</td> +</tr><tr> +<td><a href="#DebugServer.__getNetworkInterfaceAndIndex">__getNetworkInterfaceAndIndex</a></td> +<td>Private method to determine the network interface and the interface index.</td> +</tr><tr> +<td><a href="#DebugServer.__makeWatchCondition">__makeWatchCondition</a></td> +<td>Private method to construct the condition string.</td> +</tr><tr> +<td><a href="#DebugServer.__newConnection">__newConnection</a></td> +<td>Private slot to handle a new connection.</td> +</tr><tr> +<td><a href="#DebugServer.__passiveShutDown">__passiveShutDown</a></td> +<td>Private method to shut down a passive debug connection.</td> +</tr><tr> +<td><a href="#DebugServer.__registerDebuggerInterfaces">__registerDebuggerInterfaces</a></td> +<td>Private method to register the available debugger interface modules.</td> +</tr><tr> +<td><a href="#DebugServer.__remoteBreakpointEnable">__remoteBreakpointEnable</a></td> +<td>Private method to enable or disable a breakpoint.</td> +</tr><tr> +<td><a href="#DebugServer.__remoteBreakpointIgnore">__remoteBreakpointIgnore</a></td> +<td>Private method to ignore a breakpoint the next couple of occurrences.</td> +</tr><tr> +<td><a href="#DebugServer.__remoteWatchpoint">__remoteWatchpoint</a></td> +<td>Private method to set or clear a watch expression.</td> +</tr><tr> +<td><a href="#DebugServer.__remoteWatchpointEnable">__remoteWatchpointEnable</a></td> +<td>Private method to enable or disable a watch expression.</td> +</tr><tr> +<td><a href="#DebugServer.__remoteWatchpointIgnore">__remoteWatchpointIgnore</a></td> +<td>Private method to ignore a watch expression the next couple of occurrences.</td> +</tr><tr> +<td><a href="#DebugServer.__restoreBreakpoints">__restoreBreakpoints</a></td> +<td>Private method to restore the breakpoints after a restart.</td> +</tr><tr> +<td><a href="#DebugServer.__restoreWatchpoints">__restoreWatchpoints</a></td> +<td>Private method to restore the watch expressions after a restart.</td> +</tr><tr> +<td><a href="#DebugServer.__setClientType">__setClientType</a></td> +<td>Private method to set the client type.</td> +</tr><tr> +<td><a href="#DebugServer.__splitWatchCondition">__splitWatchCondition</a></td> +<td>Private method to split a remote watch expression.</td> +</tr><tr> +<td><a href="#DebugServer.__watchPointDataAboutToBeChanged">__watchPointDataAboutToBeChanged</a></td> +<td>Private slot to handle the dataAboutToBeChanged signal of the watch expression model.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtFinished">clientUtFinished</a></td> +<td>Public method to process the client unit test finished info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtPrepared">clientUtPrepared</a></td> +<td>Public method to process the client unittest prepared info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtStartTest">clientUtStartTest</a></td> +<td>Public method to process the client start test info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtStopTest">clientUtStopTest</a></td> +<td>Public method to process the client stop test info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtTestErrored">clientUtTestErrored</a></td> +<td>Public method to process the client test errored info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtTestFailed">clientUtTestFailed</a></td> +<td>Public method to process the client test failed info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtTestFailedExpected">clientUtTestFailedExpected</a></td> +<td>Public method to process the client test failed expected info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtTestSkipped">clientUtTestSkipped</a></td> +<td>Public method to process the client test skipped info.</td> +</tr><tr> +<td><a href="#DebugServer.clientUtTestSucceededUnexpected">clientUtTestSucceededUnexpected</a></td> +<td>Public method to process the client test succeeded unexpected info.</td> +</tr><tr> +<td><a href="#DebugServer.getBreakPointModel">getBreakPointModel</a></td> +<td>Public slot to get a reference to the breakpoint model object.</td> +</tr><tr> +<td><a href="#DebugServer.getClientCapabilities">getClientCapabilities</a></td> +<td>Public method to retrieve the debug clients capabilities.</td> +</tr><tr> +<td><a href="#DebugServer.getClientInterpreter">getClientInterpreter</a></td> +<td>Public method to get the interpreter of the debug client.</td> +</tr><tr> +<td><a href="#DebugServer.getExtensions">getExtensions</a></td> +<td>Public slot to get the extensions associated with the given language.</td> +</tr><tr> +<td><a href="#DebugServer.getHostAddress">getHostAddress</a></td> +<td>Public method to get the IP address or hostname the debug server is listening.</td> +</tr><tr> +<td><a href="#DebugServer.getSupportedLanguages">getSupportedLanguages</a></td> +<td>Public slot to return the supported programming languages.</td> +</tr><tr> +<td><a href="#DebugServer.getWatchPointModel">getWatchPointModel</a></td> +<td>Public slot to get a reference to the watch expression model object.</td> +</tr><tr> +<td><a href="#DebugServer.isConnected">isConnected</a></td> +<td>Public method to test, if the debug server is connected to a backend.</td> +</tr><tr> +<td><a href="#DebugServer.passiveStartUp">passiveStartUp</a></td> +<td>Public method to handle a passive debug connection.</td> +</tr><tr> +<td><a href="#DebugServer.preferencesChanged">preferencesChanged</a></td> +<td>Public slot to handle the preferencesChanged signal.</td> +</tr><tr> +<td><a href="#DebugServer.remoteBanner">remoteBanner</a></td> +<td>Public slot to get the banner info of the remote client.</td> +</tr><tr> +<td><a href="#DebugServer.remoteBreakpoint">remoteBreakpoint</a></td> +<td>Public method to set or clear a breakpoint.</td> +</tr><tr> +<td><a href="#DebugServer.remoteCapabilities">remoteCapabilities</a></td> +<td>Public slot to get the debug clients capabilities.</td> +</tr><tr> +<td><a href="#DebugServer.remoteClientSetFilter">remoteClientSetFilter</a></td> +<td>Public method to set a variables filter list.</td> +</tr><tr> +<td><a href="#DebugServer.remoteClientVariable">remoteClientVariable</a></td> +<td>Public method to request the variables of the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteClientVariables">remoteClientVariables</a></td> +<td>Public method to request the variables of the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteCompletion">remoteCompletion</a></td> +<td>Public slot to get the a list of possible commandline completions from the remote client.</td> +</tr><tr> +<td><a href="#DebugServer.remoteContinue">remoteContinue</a></td> +<td>Public method to continue the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteCoverage">remoteCoverage</a></td> +<td>Public method to load a new program to collect coverage data.</td> +</tr><tr> +<td><a href="#DebugServer.remoteEnvironment">remoteEnvironment</a></td> +<td>Public method to set the environment for a program to debug, run, ...</td> +</tr><tr> +<td><a href="#DebugServer.remoteEval">remoteEval</a></td> +<td>Public method to evaluate arg in the current context of the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteExec">remoteExec</a></td> +<td>Public method to execute stmt in the current context of the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteLoad">remoteLoad</a></td> +<td>Public method to load a new program to debug.</td> +</tr><tr> +<td><a href="#DebugServer.remoteProfile">remoteProfile</a></td> +<td>Public method to load a new program to collect profiling data.</td> +</tr><tr> +<td><a href="#DebugServer.remoteRawInput">remoteRawInput</a></td> +<td>Public method to send the raw input to the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteRun">remoteRun</a></td> +<td>Public method to load a new program to run.</td> +</tr><tr> +<td><a href="#DebugServer.remoteSetThread">remoteSetThread</a></td> +<td>Public method to request to set the given thread as current thread.</td> +</tr><tr> +<td><a href="#DebugServer.remoteStatement">remoteStatement</a></td> +<td>Public method to execute a Python statement.</td> +</tr><tr> +<td><a href="#DebugServer.remoteStep">remoteStep</a></td> +<td>Public method to single step the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteStepOut">remoteStepOut</a></td> +<td>Public method to step out the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteStepOver">remoteStepOver</a></td> +<td>Public method to step over the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteStepQuit">remoteStepQuit</a></td> +<td>Public method to stop the debugged program.</td> +</tr><tr> +<td><a href="#DebugServer.remoteThreadList">remoteThreadList</a></td> +<td>Public method to request the list of threads from the client.</td> +</tr><tr> +<td><a href="#DebugServer.remoteUTPrepare">remoteUTPrepare</a></td> +<td>Public method to prepare a new unittest run.</td> +</tr><tr> +<td><a href="#DebugServer.remoteUTRun">remoteUTRun</a></td> +<td>Public method to start a unittest run.</td> +</tr><tr> +<td><a href="#DebugServer.remoteUTStop">remoteUTStop</a></td> +<td>public method to stop a unittest run.</td> +</tr><tr> +<td><a href="#DebugServer.setCallTraceEnabled">setCallTraceEnabled</a></td> +<td>Public method to set the call trace state.</td> +</tr><tr> +<td><a href="#DebugServer.shutdownServer">shutdownServer</a></td> +<td>Public method to cleanly shut down.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientBanner">signalClientBanner</a></td> +<td>Public method to process the client banner info.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientBreakConditionError">signalClientBreakConditionError</a></td> +<td>Public method to process the client breakpoint condition error info.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientCallTrace">signalClientCallTrace</a></td> +<td>Public method to process the client call trace data.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientCapabilities">signalClientCapabilities</a></td> +<td>Public method to process the client capabilities info.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientClearBreak">signalClientClearBreak</a></td> +<td>Public method to process the client clear breakpoint command.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientClearWatch">signalClientClearWatch</a></td> +<td>Public slot to handle the clientClearWatch signal.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientCompletionList">signalClientCompletionList</a></td> +<td>Public method to process the client auto completion info.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientException">signalClientException</a></td> +<td>Public method to process the exception info from the client.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientExit">signalClientExit</a></td> +<td>Public method to process the client exit status.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientLine">signalClientLine</a></td> +<td>Public method to process client position feedback.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientOutput">signalClientOutput</a></td> +<td>Public method to process a line of client output.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientRawInput">signalClientRawInput</a></td> +<td>Public method to process the client raw input command.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientStack">signalClientStack</a></td> +<td>Public method to process a client's stack information.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientStatement">signalClientStatement</a></td> +<td>Public method to process the input response from the client.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientSyntaxError">signalClientSyntaxError</a></td> +<td>Public method to process the syntax error info from the client.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientThreadList">signalClientThreadList</a></td> +<td>Public method to process the client thread list info.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientThreadSet">signalClientThreadSet</a></td> +<td>Public method to handle the change of the client thread.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientVariable">signalClientVariable</a></td> +<td>Public method to process the client variable info.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientVariables">signalClientVariables</a></td> +<td>Public method to process the client variables info.</td> +</tr><tr> +<td><a href="#DebugServer.signalClientWatchConditionError">signalClientWatchConditionError</a></td> +<td>Public method to process the client watch expression error info.</td> +</tr><tr> +<td><a href="#DebugServer.startClient">startClient</a></td> +<td>Public method to start a debug client.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="DebugServer.__init__" ID="DebugServer.__init__"></a> +<h4>DebugServer (Constructor)</h4> +<b>DebugServer</b>(<i></i>) +<p> + Constructor +</p><a NAME="DebugServer.__addBreakPoints" ID="DebugServer.__addBreakPoints"></a> +<h4>DebugServer.__addBreakPoints</h4> +<b>__addBreakPoints</b>(<i>parentIndex, start, end</i>) +<p> + Private slot to add breakpoints. +</p><dl> +<dt><i>parentIndex</i></dt> +<dd> +index of parent item (QModelIndex) +</dd><dt><i>start</i></dt> +<dd> +start row (integer) +</dd><dt><i>end</i></dt> +<dd> +end row (integer) +</dd> +</dl><a NAME="DebugServer.__addWatchPoints" ID="DebugServer.__addWatchPoints"></a> +<h4>DebugServer.__addWatchPoints</h4> +<b>__addWatchPoints</b>(<i>parentIndex, start, end</i>) +<p> + Private slot to set a watch expression. +</p><dl> +<dt><i>parentIndex</i></dt> +<dd> +index of parent item (QModelIndex) +</dd><dt><i>start</i></dt> +<dd> +start row (integer) +</dd><dt><i>end</i></dt> +<dd> +end row (integer) +</dd> +</dl><a NAME="DebugServer.__breakPointDataAboutToBeChanged" ID="DebugServer.__breakPointDataAboutToBeChanged"></a> +<h4>DebugServer.__breakPointDataAboutToBeChanged</h4> +<b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) +<p> + Private slot to handle the dataAboutToBeChanged signal of the + breakpoint model. +</p><dl> +<dt><i>startIndex</i></dt> +<dd> +start index of the rows to be changed (QModelIndex) +</dd><dt><i>endIndex</i></dt> +<dd> +end index of the rows to be changed (QModelIndex) +</dd> +</dl><a NAME="DebugServer.__changeBreakPoints" ID="DebugServer.__changeBreakPoints"></a> +<h4>DebugServer.__changeBreakPoints</h4> +<b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>) +<p> + Private slot to set changed breakpoints. +</p><dl> +<dt><i>startIndex</i></dt> +<dd> +starting index of the change breakpoins (QModelIndex) +</dd><dt><i>endIndex</i></dt> +<dd> +ending index of the change breakpoins (QModelIndex) +</dd> +</dl><a NAME="DebugServer.__changeWatchPoints" ID="DebugServer.__changeWatchPoints"></a> +<h4>DebugServer.__changeWatchPoints</h4> +<b>__changeWatchPoints</b>(<i>startIndex, endIndex</i>) +<p> + Private slot to set changed watch expressions. +</p><dl> +<dt><i>startIndex</i></dt> +<dd> +start index of the rows to be changed (QModelIndex) +</dd><dt><i>endIndex</i></dt> +<dd> +end index of the rows to be changed (QModelIndex) +</dd> +</dl><a NAME="DebugServer.__clientClearBreakPoint" ID="DebugServer.__clientClearBreakPoint"></a> +<h4>DebugServer.__clientClearBreakPoint</h4> +<b>__clientClearBreakPoint</b>(<i>fn, lineno</i>) +<p> + Private slot to handle the clientClearBreak signal. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename of breakpoint to clear (string) +</dd><dt><i>lineno</i></dt> +<dd> +line number of breakpoint to clear (integer) +</dd> +</dl><a NAME="DebugServer.__clientClearWatchPoint" ID="DebugServer.__clientClearWatchPoint"></a> +<h4>DebugServer.__clientClearWatchPoint</h4> +<b>__clientClearWatchPoint</b>(<i>condition</i>) +<p> + Private slot to handle the clientClearWatch signal. +</p><dl> +<dt><i>condition</i></dt> +<dd> +expression of watch expression to clear (string) +</dd> +</dl><a NAME="DebugServer.__clientProcessError" ID="DebugServer.__clientProcessError"></a> +<h4>DebugServer.__clientProcessError</h4> +<b>__clientProcessError</b>(<i></i>) +<p> + Private slot to process client output received via stderr. +</p><a NAME="DebugServer.__clientProcessOutput" ID="DebugServer.__clientProcessOutput"></a> +<h4>DebugServer.__clientProcessOutput</h4> +<b>__clientProcessOutput</b>(<i></i>) +<p> + Private slot to process client output received via stdout. +</p><a NAME="DebugServer.__createDebuggerInterface" ID="DebugServer.__createDebuggerInterface"></a> +<h4>DebugServer.__createDebuggerInterface</h4> +<b>__createDebuggerInterface</b>(<i>clientType=None</i>) +<p> + Private slot to create the debugger interface object. +</p><dl> +<dt><i>clientType</i></dt> +<dd> +type of the client interface to be created (string) +</dd> +</dl><a NAME="DebugServer.__deleteBreakPoints" ID="DebugServer.__deleteBreakPoints"></a> +<h4>DebugServer.__deleteBreakPoints</h4> +<b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>) +<p> + Private slot to delete breakpoints. +</p><dl> +<dt><i>parentIndex</i></dt> +<dd> +index of parent item (QModelIndex) +</dd><dt><i>start</i></dt> +<dd> +start row (integer) +</dd><dt><i>end</i></dt> +<dd> +end row (integer) +</dd> +</dl><a NAME="DebugServer.__deleteWatchPoints" ID="DebugServer.__deleteWatchPoints"></a> +<h4>DebugServer.__deleteWatchPoints</h4> +<b>__deleteWatchPoints</b>(<i>parentIndex, start, end</i>) +<p> + Private slot to delete watch expressions. +</p><dl> +<dt><i>parentIndex</i></dt> +<dd> +index of parent item (QModelIndex) +</dd><dt><i>start</i></dt> +<dd> +start row (integer) +</dd><dt><i>end</i></dt> +<dd> +end row (integer) +</dd> +</dl><a NAME="DebugServer.__getNetworkInterfaceAndIndex" ID="DebugServer.__getNetworkInterfaceAndIndex"></a> +<h4>DebugServer.__getNetworkInterfaceAndIndex</h4> +<b>__getNetworkInterfaceAndIndex</b>(<i>address</i>) +<p> + Private method to determine the network interface and the interface + index. +</p><dl> +<dt><i>address</i></dt> +<dd> +address to determine the info for (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple of network interface name (string) and index (integer) +</dd> +</dl><a NAME="DebugServer.__makeWatchCondition" ID="DebugServer.__makeWatchCondition"></a> +<h4>DebugServer.__makeWatchCondition</h4> +<b>__makeWatchCondition</b>(<i>cond, special</i>) +<p> + Private method to construct the condition string. +</p><dl> +<dt><i>cond</i></dt> +<dd> +condition (string) +</dd><dt><i>special</i></dt> +<dd> +special condition (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +condition string (string) +</dd> +</dl><a NAME="DebugServer.__newConnection" ID="DebugServer.__newConnection"></a> +<h4>DebugServer.__newConnection</h4> +<b>__newConnection</b>(<i></i>) +<p> + Private slot to handle a new connection. +</p><a NAME="DebugServer.__passiveShutDown" ID="DebugServer.__passiveShutDown"></a> +<h4>DebugServer.__passiveShutDown</h4> +<b>__passiveShutDown</b>(<i></i>) +<p> + Private method to shut down a passive debug connection. +</p><a NAME="DebugServer.__registerDebuggerInterfaces" ID="DebugServer.__registerDebuggerInterfaces"></a> +<h4>DebugServer.__registerDebuggerInterfaces</h4> +<b>__registerDebuggerInterfaces</b>(<i></i>) +<p> + Private method to register the available debugger interface modules. +</p><a NAME="DebugServer.__remoteBreakpointEnable" ID="DebugServer.__remoteBreakpointEnable"></a> +<h4>DebugServer.__remoteBreakpointEnable</h4> +<b>__remoteBreakpointEnable</b>(<i>fn, line, enable</i>) +<p> + Private method to enable or disable a breakpoint. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename the breakpoint belongs to (string) +</dd><dt><i>line</i></dt> +<dd> +linenumber of the breakpoint (int) +</dd><dt><i>enable</i></dt> +<dd> +flag indicating enabling or disabling a breakpoint + (boolean) +</dd> +</dl><a NAME="DebugServer.__remoteBreakpointIgnore" ID="DebugServer.__remoteBreakpointIgnore"></a> +<h4>DebugServer.__remoteBreakpointIgnore</h4> +<b>__remoteBreakpointIgnore</b>(<i>fn, line, count</i>) +<p> + Private method to ignore a breakpoint the next couple of occurrences. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename the breakpoint belongs to (string) +</dd><dt><i>line</i></dt> +<dd> +linenumber of the breakpoint (int) +</dd><dt><i>count</i></dt> +<dd> +number of occurrences to ignore (int) +</dd> +</dl><a NAME="DebugServer.__remoteWatchpoint" ID="DebugServer.__remoteWatchpoint"></a> +<h4>DebugServer.__remoteWatchpoint</h4> +<b>__remoteWatchpoint</b>(<i>cond, set, temp=False</i>) +<p> + Private method to set or clear a watch expression. +</p><dl> +<dt><i>cond</i></dt> +<dd> +expression of the watch expression (string) +</dd><dt><i>set</i></dt> +<dd> +flag indicating setting or resetting a watch expression + (boolean) +</dd><dt><i>temp</i></dt> +<dd> +flag indicating a temporary watch expression (boolean) +</dd> +</dl><a NAME="DebugServer.__remoteWatchpointEnable" ID="DebugServer.__remoteWatchpointEnable"></a> +<h4>DebugServer.__remoteWatchpointEnable</h4> +<b>__remoteWatchpointEnable</b>(<i>cond, enable</i>) +<p> + Private method to enable or disable a watch expression. +</p><dl> +<dt><i>cond</i></dt> +<dd> +expression of the watch expression (string) +</dd><dt><i>enable</i></dt> +<dd> +flag indicating enabling or disabling a watch expression + (boolean) +</dd> +</dl><a NAME="DebugServer.__remoteWatchpointIgnore" ID="DebugServer.__remoteWatchpointIgnore"></a> +<h4>DebugServer.__remoteWatchpointIgnore</h4> +<b>__remoteWatchpointIgnore</b>(<i>cond, count</i>) +<p> + Private method to ignore a watch expression the next couple of + occurrences. +</p><dl> +<dt><i>cond</i></dt> +<dd> +expression of the watch expression (string) +</dd><dt><i>count</i></dt> +<dd> +number of occurrences to ignore (int) +</dd> +</dl><a NAME="DebugServer.__restoreBreakpoints" ID="DebugServer.__restoreBreakpoints"></a> +<h4>DebugServer.__restoreBreakpoints</h4> +<b>__restoreBreakpoints</b>(<i></i>) +<p> + Private method to restore the breakpoints after a restart. +</p><a NAME="DebugServer.__restoreWatchpoints" ID="DebugServer.__restoreWatchpoints"></a> +<h4>DebugServer.__restoreWatchpoints</h4> +<b>__restoreWatchpoints</b>(<i></i>) +<p> + Private method to restore the watch expressions after a restart. +</p><a NAME="DebugServer.__setClientType" ID="DebugServer.__setClientType"></a> +<h4>DebugServer.__setClientType</h4> +<b>__setClientType</b>(<i>clType</i>) +<p> + Private method to set the client type. +</p><dl> +<dt><i>clType</i></dt> +<dd> +type of client to be started (string) +</dd> +</dl><a NAME="DebugServer.__splitWatchCondition" ID="DebugServer.__splitWatchCondition"></a> +<h4>DebugServer.__splitWatchCondition</h4> +<b>__splitWatchCondition</b>(<i>cond</i>) +<p> + Private method to split a remote watch expression. +</p><dl> +<dt><i>cond</i></dt> +<dd> +remote expression (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple of local expression (string) and special condition + (string) +</dd> +</dl><a NAME="DebugServer.__watchPointDataAboutToBeChanged" ID="DebugServer.__watchPointDataAboutToBeChanged"></a> +<h4>DebugServer.__watchPointDataAboutToBeChanged</h4> +<b>__watchPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) +<p> + Private slot to handle the dataAboutToBeChanged signal of the + watch expression model. +</p><dl> +<dt><i>startIndex</i></dt> +<dd> +start index of the rows to be changed (QModelIndex) +</dd><dt><i>endIndex</i></dt> +<dd> +end index of the rows to be changed (QModelIndex) +</dd> +</dl><a NAME="DebugServer.clientUtFinished" ID="DebugServer.clientUtFinished"></a> +<h4>DebugServer.clientUtFinished</h4> +<b>clientUtFinished</b>(<i></i>) +<p> + Public method to process the client unit test finished info. +</p><a NAME="DebugServer.clientUtPrepared" ID="DebugServer.clientUtPrepared"></a> +<h4>DebugServer.clientUtPrepared</h4> +<b>clientUtPrepared</b>(<i>result, exceptionType, exceptionValue</i>) +<p> + Public method to process the client unittest prepared info. +</p><dl> +<dt><i>result</i></dt> +<dd> +number of test cases (0 = error) (integer) +</dd><dt><i>exceptionType</i></dt> +<dd> +exception type (string) +</dd><dt><i>exceptionValue</i></dt> +<dd> +exception message (string) +</dd> +</dl><a NAME="DebugServer.clientUtStartTest" ID="DebugServer.clientUtStartTest"></a> +<h4>DebugServer.clientUtStartTest</h4> +<b>clientUtStartTest</b>(<i>testname, doc</i>) +<p> + Public method to process the client start test info. +</p><dl> +<dt><i>testname</i></dt> +<dd> +name of the test (string) +</dd><dt><i>doc</i></dt> +<dd> +short description of the test (string) +</dd> +</dl><a NAME="DebugServer.clientUtStopTest" ID="DebugServer.clientUtStopTest"></a> +<h4>DebugServer.clientUtStopTest</h4> +<b>clientUtStopTest</b>(<i></i>) +<p> + Public method to process the client stop test info. +</p><a NAME="DebugServer.clientUtTestErrored" ID="DebugServer.clientUtTestErrored"></a> +<h4>DebugServer.clientUtTestErrored</h4> +<b>clientUtTestErrored</b>(<i>testname, traceback, id</i>) +<p> + Public method to process the client test errored info. +</p><dl> +<dt><i>testname</i></dt> +<dd> +name of the test (string) +</dd><dt><i>traceback</i></dt> +<dd> +lines of traceback info (list of strings) +</dd><dt><i>id</i></dt> +<dd> +id of the test (string) +</dd> +</dl><a NAME="DebugServer.clientUtTestFailed" ID="DebugServer.clientUtTestFailed"></a> +<h4>DebugServer.clientUtTestFailed</h4> +<b>clientUtTestFailed</b>(<i>testname, traceback, id</i>) +<p> + Public method to process the client test failed info. +</p><dl> +<dt><i>testname</i></dt> +<dd> +name of the test (string) +</dd><dt><i>traceback</i></dt> +<dd> +lines of traceback info (list of strings) +</dd><dt><i>id</i></dt> +<dd> +id of the test (string) +</dd> +</dl><a NAME="DebugServer.clientUtTestFailedExpected" ID="DebugServer.clientUtTestFailedExpected"></a> +<h4>DebugServer.clientUtTestFailedExpected</h4> +<b>clientUtTestFailedExpected</b>(<i>testname, traceback, id</i>) +<p> + Public method to process the client test failed expected info. +</p><dl> +<dt><i>testname</i></dt> +<dd> +name of the test (string) +</dd><dt><i>traceback</i></dt> +<dd> +lines of traceback info (list of strings) +</dd><dt><i>id</i></dt> +<dd> +id of the test (string) +</dd> +</dl><a NAME="DebugServer.clientUtTestSkipped" ID="DebugServer.clientUtTestSkipped"></a> +<h4>DebugServer.clientUtTestSkipped</h4> +<b>clientUtTestSkipped</b>(<i>testname, reason, id</i>) +<p> + Public method to process the client test skipped info. +</p><dl> +<dt><i>testname</i></dt> +<dd> +name of the test (string) +</dd><dt><i>reason</i></dt> +<dd> +reason for skipping the test (string) +</dd><dt><i>id</i></dt> +<dd> +id of the test (string) +</dd> +</dl><a NAME="DebugServer.clientUtTestSucceededUnexpected" ID="DebugServer.clientUtTestSucceededUnexpected"></a> +<h4>DebugServer.clientUtTestSucceededUnexpected</h4> +<b>clientUtTestSucceededUnexpected</b>(<i>testname, id</i>) +<p> + Public method to process the client test succeeded unexpected info. +</p><dl> +<dt><i>testname</i></dt> +<dd> +name of the test (string) +</dd><dt><i>id</i></dt> +<dd> +id of the test (string) +</dd> +</dl><a NAME="DebugServer.getBreakPointModel" ID="DebugServer.getBreakPointModel"></a> +<h4>DebugServer.getBreakPointModel</h4> +<b>getBreakPointModel</b>(<i></i>) +<p> + Public slot to get a reference to the breakpoint model object. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the breakpoint model object (BreakPointModel) +</dd> +</dl><a NAME="DebugServer.getClientCapabilities" ID="DebugServer.getClientCapabilities"></a> +<h4>DebugServer.getClientCapabilities</h4> +<b>getClientCapabilities</b>(<i>type</i>) +<p> + Public method to retrieve the debug clients capabilities. +</p><dl> +<dt><i>type</i></dt> +<dd> +debug client type (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +debug client capabilities (integer) +</dd> +</dl><a NAME="DebugServer.getClientInterpreter" ID="DebugServer.getClientInterpreter"></a> +<h4>DebugServer.getClientInterpreter</h4> +<b>getClientInterpreter</b>(<i></i>) +<p> + Public method to get the interpreter of the debug client. +</p><dl> +<dt>Returns:</dt> +<dd> +interpreter of the debug client (string) +</dd> +</dl><a NAME="DebugServer.getExtensions" ID="DebugServer.getExtensions"></a> +<h4>DebugServer.getExtensions</h4> +<b>getExtensions</b>(<i>language</i>) +<p> + Public slot to get the extensions associated with the given language. +</p><dl> +<dt><i>language</i></dt> +<dd> +language to get extensions for (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple of extensions associated with the language + (tuple of strings) +</dd> +</dl><a NAME="DebugServer.getHostAddress" ID="DebugServer.getHostAddress"></a> +<h4>DebugServer.getHostAddress</h4> +<b>getHostAddress</b>(<i>localhost</i>) +<p> + Public method to get the IP address or hostname the debug server is + listening. +</p><dl> +<dt><i>localhost</i></dt> +<dd> +flag indicating to return the address for localhost + (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +IP address or hostname (string) +</dd> +</dl><a NAME="DebugServer.getSupportedLanguages" ID="DebugServer.getSupportedLanguages"></a> +<h4>DebugServer.getSupportedLanguages</h4> +<b>getSupportedLanguages</b>(<i>shellOnly=False</i>) +<p> + Public slot to return the supported programming languages. +</p><dl> +<dt><i>shellOnly</i></dt> +<dd> +flag indicating only languages supporting an + interactive shell should be returned +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of supported languages (list of strings) +</dd> +</dl><a NAME="DebugServer.getWatchPointModel" ID="DebugServer.getWatchPointModel"></a> +<h4>DebugServer.getWatchPointModel</h4> +<b>getWatchPointModel</b>(<i></i>) +<p> + Public slot to get a reference to the watch expression model object. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the watch expression model object + (WatchPointModel) +</dd> +</dl><a NAME="DebugServer.isConnected" ID="DebugServer.isConnected"></a> +<h4>DebugServer.isConnected</h4> +<b>isConnected</b>(<i></i>) +<p> + Public method to test, if the debug server is connected to a backend. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating a connection (boolean) +</dd> +</dl><a NAME="DebugServer.passiveStartUp" ID="DebugServer.passiveStartUp"></a> +<h4>DebugServer.passiveStartUp</h4> +<b>passiveStartUp</b>(<i>fn, exc</i>) +<p> + Public method to handle a passive debug connection. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename of the debugged script (string) +</dd><dt><i>exc</i></dt> +<dd> +flag to enable exception reporting of the IDE (boolean) +</dd> +</dl><a NAME="DebugServer.preferencesChanged" ID="DebugServer.preferencesChanged"></a> +<h4>DebugServer.preferencesChanged</h4> +<b>preferencesChanged</b>(<i></i>) +<p> + Public slot to handle the preferencesChanged signal. +</p><a NAME="DebugServer.remoteBanner" ID="DebugServer.remoteBanner"></a> +<h4>DebugServer.remoteBanner</h4> +<b>remoteBanner</b>(<i></i>) +<p> + Public slot to get the banner info of the remote client. +</p><a NAME="DebugServer.remoteBreakpoint" ID="DebugServer.remoteBreakpoint"></a> +<h4>DebugServer.remoteBreakpoint</h4> +<b>remoteBreakpoint</b>(<i>fn, line, set, cond=None, temp=False</i>) +<p> + Public method to set or clear a breakpoint. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename the breakpoint belongs to (string) +</dd><dt><i>line</i></dt> +<dd> +linenumber of the breakpoint (int) +</dd><dt><i>set</i></dt> +<dd> +flag indicating setting or resetting a breakpoint (boolean) +</dd><dt><i>cond</i></dt> +<dd> +condition of the breakpoint (string) +</dd><dt><i>temp</i></dt> +<dd> +flag indicating a temporary breakpoint (boolean) +</dd> +</dl><a NAME="DebugServer.remoteCapabilities" ID="DebugServer.remoteCapabilities"></a> +<h4>DebugServer.remoteCapabilities</h4> +<b>remoteCapabilities</b>(<i></i>) +<p> + Public slot to get the debug clients capabilities. +</p><a NAME="DebugServer.remoteClientSetFilter" ID="DebugServer.remoteClientSetFilter"></a> +<h4>DebugServer.remoteClientSetFilter</h4> +<b>remoteClientSetFilter</b>(<i>scope, filter</i>) +<p> + Public method to set a variables filter list. +</p><dl> +<dt><i>scope</i></dt> +<dd> +the scope of the variables (0 = local, 1 = global) +</dd><dt><i>filter</i></dt> +<dd> +regexp string for variable names to filter out (string) +</dd> +</dl><a NAME="DebugServer.remoteClientVariable" ID="DebugServer.remoteClientVariable"></a> +<h4>DebugServer.remoteClientVariable</h4> +<b>remoteClientVariable</b>(<i>scope, filter, var, framenr=0</i>) +<p> + Public method to request the variables of the debugged program. +</p><dl> +<dt><i>scope</i></dt> +<dd> +the scope of the variables (0 = local, 1 = global) +</dd><dt><i>filter</i></dt> +<dd> +list of variable types to filter out (list of int) +</dd><dt><i>var</i></dt> +<dd> +list encoded name of variable to retrieve (string) +</dd><dt><i>framenr</i></dt> +<dd> +framenumber of the variables to retrieve (int) +</dd> +</dl><a NAME="DebugServer.remoteClientVariables" ID="DebugServer.remoteClientVariables"></a> +<h4>DebugServer.remoteClientVariables</h4> +<b>remoteClientVariables</b>(<i>scope, filter, framenr=0</i>) +<p> + Public method to request the variables of the debugged program. +</p><dl> +<dt><i>scope</i></dt> +<dd> +the scope of the variables (0 = local, 1 = global) +</dd><dt><i>filter</i></dt> +<dd> +list of variable types to filter out (list of int) +</dd><dt><i>framenr</i></dt> +<dd> +framenumber of the variables to retrieve (int) +</dd> +</dl><a NAME="DebugServer.remoteCompletion" ID="DebugServer.remoteCompletion"></a> +<h4>DebugServer.remoteCompletion</h4> +<b>remoteCompletion</b>(<i>text</i>) +<p> + Public slot to get the a list of possible commandline completions + from the remote client. +</p><dl> +<dt><i>text</i></dt> +<dd> +the text to be completed (string) +</dd> +</dl><a NAME="DebugServer.remoteContinue" ID="DebugServer.remoteContinue"></a> +<h4>DebugServer.remoteContinue</h4> +<b>remoteContinue</b>(<i>special=False</i>) +<p> + Public method to continue the debugged program. +</p><dl> +<dt><i>special</i></dt> +<dd> +flag indicating a special continue operation +</dd> +</dl><a NAME="DebugServer.remoteCoverage" ID="DebugServer.remoteCoverage"></a> +<h4>DebugServer.remoteCoverage</h4> +<b>remoteCoverage</b>(<i>fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>) +<p> + Public method to load a new program to collect coverage data. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to run (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd><dt><i>env</i></dt> +<dd> +environment settings (string) +</dd><dt><i>autoClearShell=</i></dt> +<dd> +flag indicating, that the interpreter window + should be cleared (boolean) +</dd><dt><i>erase=</i></dt> +<dd> +flag indicating that coverage info should be + cleared first (boolean) +</dd><dt><i>forProject=</i></dt> +<dd> +flag indicating a project related action (boolean) +</dd><dt><i>runInConsole=</i></dt> +<dd> +flag indicating to start the debugger in a + console window (boolean) +</dd><dt><i>clientType=</i></dt> +<dd> +client type to be used (string) +</dd> +</dl><a NAME="DebugServer.remoteEnvironment" ID="DebugServer.remoteEnvironment"></a> +<h4>DebugServer.remoteEnvironment</h4> +<b>remoteEnvironment</b>(<i>env</i>) +<p> + Public method to set the environment for a program to debug, run, ... +</p><dl> +<dt><i>env</i></dt> +<dd> +environment settings (string) +</dd> +</dl><a NAME="DebugServer.remoteEval" ID="DebugServer.remoteEval"></a> +<h4>DebugServer.remoteEval</h4> +<b>remoteEval</b>(<i>arg</i>) +<p> + Public method to evaluate arg in the current context of the debugged + program. +</p><dl> +<dt><i>arg</i></dt> +<dd> +the arguments to evaluate (string) +</dd> +</dl><a NAME="DebugServer.remoteExec" ID="DebugServer.remoteExec"></a> +<h4>DebugServer.remoteExec</h4> +<b>remoteExec</b>(<i>stmt</i>) +<p> + Public method to execute stmt in the current context of the debugged + program. +</p><dl> +<dt><i>stmt</i></dt> +<dd> +statement to execute (string) +</dd> +</dl><a NAME="DebugServer.remoteLoad" ID="DebugServer.remoteLoad"></a> +<h4>DebugServer.remoteLoad</h4> +<b>remoteLoad</b>(<i>fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType="", enableCallTrace=False</i>) +<p> + Public method to load a new program to debug. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to debug (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd><dt><i>env</i></dt> +<dd> +environment settings (string) +</dd><dt><i>autoClearShell=</i></dt> +<dd> +flag indicating, that the interpreter window + should be cleared (boolean) +</dd><dt><i>tracePython=</i></dt> +<dd> +flag indicating if the Python library should be + traced as well (boolean) +</dd><dt><i>autoContinue=</i></dt> +<dd> +flag indicating, that the debugger should not + stop at the first executable line (boolean) +</dd><dt><i>forProject=</i></dt> +<dd> +flag indicating a project related action (boolean) +</dd><dt><i>runInConsole=</i></dt> +<dd> +flag indicating to start the debugger in a + console window (boolean) +</dd><dt><i>autoFork=</i></dt> +<dd> +flag indicating the automatic fork mode (boolean) +</dd><dt><i>forkChild=</i></dt> +<dd> +flag indicating to debug the child after forking + (boolean) +</dd><dt><i>clientType=</i></dt> +<dd> +client type to be used (string) +</dd><dt><i>enableCallTrace=</i></dt> +<dd> +flag indicating to enable the call trace + function (boolean) +</dd> +</dl><a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a> +<h4>DebugServer.remoteProfile</h4> +<b>remoteProfile</b>(<i>fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>) +<p> + Public method to load a new program to collect profiling data. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to run (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd><dt><i>env</i></dt> +<dd> +environment settings (string) +</dd><dt><i>autoClearShell=</i></dt> +<dd> +flag indicating, that the interpreter window + should be cleared (boolean) +</dd><dt><i>erase=</i></dt> +<dd> +flag indicating that timing info should be cleared + first (boolean) +</dd><dt><i>forProject=</i></dt> +<dd> +flag indicating a project related action (boolean) +</dd><dt><i>runInConsole=</i></dt> +<dd> +flag indicating to start the debugger in a + console window (boolean) +</dd><dt><i>clientType=</i></dt> +<dd> +client type to be used (string) +</dd> +</dl><a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a> +<h4>DebugServer.remoteRawInput</h4> +<b>remoteRawInput</b>(<i>s</i>) +<p> + Public method to send the raw input to the debugged program. +</p><dl> +<dt><i>s</i></dt> +<dd> +the raw input (string) +</dd> +</dl><a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a> +<h4>DebugServer.remoteRun</h4> +<b>remoteRun</b>(<i>fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType=""</i>) +<p> + Public method to load a new program to run. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to run (string) +</dd><dt><i>argv</i></dt> +<dd> +the commandline arguments to pass to the program (string) +</dd><dt><i>wd</i></dt> +<dd> +the working directory for the program (string) +</dd><dt><i>env</i></dt> +<dd> +environment settings (string) +</dd><dt><i>autoClearShell=</i></dt> +<dd> +flag indicating, that the interpreter window + should be cleared (boolean) +</dd><dt><i>forProject=</i></dt> +<dd> +flag indicating a project related action (boolean) +</dd><dt><i>runInConsole=</i></dt> +<dd> +flag indicating to start the debugger in a + console window (boolean) +</dd><dt><i>autoFork=</i></dt> +<dd> +flag indicating the automatic fork mode (boolean) +</dd><dt><i>forkChild=</i></dt> +<dd> +flag indicating to debug the child after forking + (boolean) +</dd><dt><i>clientType=</i></dt> +<dd> +client type to be used (string) +</dd> +</dl><a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a> +<h4>DebugServer.remoteSetThread</h4> +<b>remoteSetThread</b>(<i>tid</i>) +<p> + Public method to request to set the given thread as current thread. +</p><dl> +<dt><i>tid</i></dt> +<dd> +id of the thread (integer) +</dd> +</dl><a NAME="DebugServer.remoteStatement" ID="DebugServer.remoteStatement"></a> +<h4>DebugServer.remoteStatement</h4> +<b>remoteStatement</b>(<i>stmt</i>) +<p> + Public method to execute a Python statement. +</p><dl> +<dt><i>stmt</i></dt> +<dd> +the Python statement to execute (string). It + should not have a trailing newline. +</dd> +</dl><a NAME="DebugServer.remoteStep" ID="DebugServer.remoteStep"></a> +<h4>DebugServer.remoteStep</h4> +<b>remoteStep</b>(<i></i>) +<p> + Public method to single step the debugged program. +</p><a NAME="DebugServer.remoteStepOut" ID="DebugServer.remoteStepOut"></a> +<h4>DebugServer.remoteStepOut</h4> +<b>remoteStepOut</b>(<i></i>) +<p> + Public method to step out the debugged program. +</p><a NAME="DebugServer.remoteStepOver" ID="DebugServer.remoteStepOver"></a> +<h4>DebugServer.remoteStepOver</h4> +<b>remoteStepOver</b>(<i></i>) +<p> + Public method to step over the debugged program. +</p><a NAME="DebugServer.remoteStepQuit" ID="DebugServer.remoteStepQuit"></a> +<h4>DebugServer.remoteStepQuit</h4> +<b>remoteStepQuit</b>(<i></i>) +<p> + Public method to stop the debugged program. +</p><a NAME="DebugServer.remoteThreadList" ID="DebugServer.remoteThreadList"></a> +<h4>DebugServer.remoteThreadList</h4> +<b>remoteThreadList</b>(<i></i>) +<p> + Public method to request the list of threads from the client. +</p><a NAME="DebugServer.remoteUTPrepare" ID="DebugServer.remoteUTPrepare"></a> +<h4>DebugServer.remoteUTPrepare</h4> +<b>remoteUTPrepare</b>(<i>fn, tn, tfn, failed, cov, covname, coverase, clientType=""</i>) +<p> + Public method to prepare a new unittest run. +</p><dl> +<dt><i>fn</i></dt> +<dd> +the filename to load (string) +</dd><dt><i>tn</i></dt> +<dd> +the testname to load (string) +</dd><dt><i>tfn</i></dt> +<dd> +the test function name to load tests from (string) +</dd><dt><i>failed</i></dt> +<dd> +list of failed test, if only failed test should be run + (list of strings) +</dd><dt><i>cov</i></dt> +<dd> +flag indicating collection of coverage data is requested + (boolean) +</dd><dt><i>covname</i></dt> +<dd> +filename to be used to assemble the coverage caches + filename (string) +</dd><dt><i>coverase</i></dt> +<dd> +flag indicating erasure of coverage data is requested + (boolean) +</dd><dt><i>clientType=</i></dt> +<dd> +client type to be used (string) +</dd> +</dl><a NAME="DebugServer.remoteUTRun" ID="DebugServer.remoteUTRun"></a> +<h4>DebugServer.remoteUTRun</h4> +<b>remoteUTRun</b>(<i></i>) +<p> + Public method to start a unittest run. +</p><a NAME="DebugServer.remoteUTStop" ID="DebugServer.remoteUTStop"></a> +<h4>DebugServer.remoteUTStop</h4> +<b>remoteUTStop</b>(<i></i>) +<p> + public method to stop a unittest run. +</p><a NAME="DebugServer.setCallTraceEnabled" ID="DebugServer.setCallTraceEnabled"></a> +<h4>DebugServer.setCallTraceEnabled</h4> +<b>setCallTraceEnabled</b>(<i>on</i>) +<p> + Public method to set the call trace state. +</p><dl> +<dt><i>on</i></dt> +<dd> +flag indicating to enable the call trace function (boolean) +</dd> +</dl><a NAME="DebugServer.shutdownServer" ID="DebugServer.shutdownServer"></a> +<h4>DebugServer.shutdownServer</h4> +<b>shutdownServer</b>(<i></i>) +<p> + Public method to cleanly shut down. +</p><p> + It closes our socket and shuts down + the debug client. (Needed on Win OS) +</p><a NAME="DebugServer.signalClientBanner" ID="DebugServer.signalClientBanner"></a> +<h4>DebugServer.signalClientBanner</h4> +<b>signalClientBanner</b>(<i>version, platform, debugClient</i>) +<p> + Public method to process the client banner info. +</p><dl> +<dt><i>version</i></dt> +<dd> +interpreter version info (string) +</dd><dt><i>platform</i></dt> +<dd> +hostname of the client (string) +</dd><dt><i>debugClient</i></dt> +<dd> +additional debugger type info (string) +</dd> +</dl><a NAME="DebugServer.signalClientBreakConditionError" ID="DebugServer.signalClientBreakConditionError"></a> +<h4>DebugServer.signalClientBreakConditionError</h4> +<b>signalClientBreakConditionError</b>(<i>filename, lineno</i>) +<p> + Public method to process the client breakpoint condition error info. +</p><dl> +<dt><i>filename</i></dt> +<dd> +filename of the breakpoint (string) +</dd><dt><i>lineno</i></dt> +<dd> +line umber of the breakpoint (integer) +</dd> +</dl><a NAME="DebugServer.signalClientCallTrace" ID="DebugServer.signalClientCallTrace"></a> +<h4>DebugServer.signalClientCallTrace</h4> +<b>signalClientCallTrace</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>) +<p> + Public method to process the client call trace data. +</p><dl> +<dt><i>isCall</i></dt> +<dd> +flag indicating a 'call' (boolean) +</dd><dt><i>fromFile</i></dt> +<dd> +name of the originating file (string) +</dd><dt><i>fromLine</i></dt> +<dd> +line number in the originating file (string) +</dd><dt><i>fromFunction</i></dt> +<dd> +name of the originating function (string) +</dd><dt><i>toFile</i></dt> +<dd> +name of the target file (string) +</dd><dt><i>toLine</i></dt> +<dd> +line number in the target file (string) +</dd><dt><i>toFunction</i></dt> +<dd> +name of the target function (string) +</dd> +</dl><a NAME="DebugServer.signalClientCapabilities" ID="DebugServer.signalClientCapabilities"></a> +<h4>DebugServer.signalClientCapabilities</h4> +<b>signalClientCapabilities</b>(<i>capabilities, clientType</i>) +<p> + Public method to process the client capabilities info. +</p><dl> +<dt><i>capabilities</i></dt> +<dd> +bitmaks with the client capabilities (integer) +</dd><dt><i>clientType</i></dt> +<dd> +type of the debug client (string) +</dd> +</dl><a NAME="DebugServer.signalClientClearBreak" ID="DebugServer.signalClientClearBreak"></a> +<h4>DebugServer.signalClientClearBreak</h4> +<b>signalClientClearBreak</b>(<i>filename, lineno</i>) +<p> + Public method to process the client clear breakpoint command. +</p><dl> +<dt><i>filename</i></dt> +<dd> +filename of the breakpoint (string) +</dd><dt><i>lineno</i></dt> +<dd> +line umber of the breakpoint (integer) +</dd> +</dl><a NAME="DebugServer.signalClientClearWatch" ID="DebugServer.signalClientClearWatch"></a> +<h4>DebugServer.signalClientClearWatch</h4> +<b>signalClientClearWatch</b>(<i>condition</i>) +<p> + Public slot to handle the clientClearWatch signal. +</p><dl> +<dt><i>condition</i></dt> +<dd> +expression of watch expression to clear (string) +</dd> +</dl><a NAME="DebugServer.signalClientCompletionList" ID="DebugServer.signalClientCompletionList"></a> +<h4>DebugServer.signalClientCompletionList</h4> +<b>signalClientCompletionList</b>(<i>completionList, text</i>) +<p> + Public method to process the client auto completion info. +</p><dl> +<dt><i>completionList</i></dt> +<dd> +list of possible completions (list of strings) +</dd><dt><i>text</i></dt> +<dd> +the text to be completed (string) +</dd> +</dl><a NAME="DebugServer.signalClientException" ID="DebugServer.signalClientException"></a> +<h4>DebugServer.signalClientException</h4> +<b>signalClientException</b>(<i>exceptionType, exceptionMessage, stackTrace</i>) +<p> + Public method to process the exception info from the client. +</p><dl> +<dt><i>exceptionType</i></dt> +<dd> +type of exception raised (string) +</dd><dt><i>exceptionMessage</i></dt> +<dd> +message given by the exception (string) +</dd><dt><i>stackTrace</i></dt> +<dd> +list of stack entries with the exception position + first. Each stack entry is a list giving the filename and the + linenumber. +</dd> +</dl><a NAME="DebugServer.signalClientExit" ID="DebugServer.signalClientExit"></a> +<h4>DebugServer.signalClientExit</h4> +<b>signalClientExit</b>(<i>status</i>) +<p> + Public method to process the client exit status. +</p><dl> +<dt><i>status</i></dt> +<dd> +exit code as a string (string) +</dd> +</dl><a NAME="DebugServer.signalClientLine" ID="DebugServer.signalClientLine"></a> +<h4>DebugServer.signalClientLine</h4> +<b>signalClientLine</b>(<i>filename, lineno, forStack=False</i>) +<p> + Public method to process client position feedback. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the file currently being executed (string) +</dd><dt><i>lineno</i></dt> +<dd> +line of code currently being executed (integer) +</dd><dt><i>forStack</i></dt> +<dd> +flag indicating this is for a stack dump (boolean) +</dd> +</dl><a NAME="DebugServer.signalClientOutput" ID="DebugServer.signalClientOutput"></a> +<h4>DebugServer.signalClientOutput</h4> +<b>signalClientOutput</b>(<i>line</i>) +<p> + Public method to process a line of client output. +</p><dl> +<dt><i>line</i></dt> +<dd> +client output (string) +</dd> +</dl><a NAME="DebugServer.signalClientRawInput" ID="DebugServer.signalClientRawInput"></a> +<h4>DebugServer.signalClientRawInput</h4> +<b>signalClientRawInput</b>(<i>prompt, echo</i>) +<p> + Public method to process the client raw input command. +</p><dl> +<dt><i>prompt</i></dt> +<dd> +the input prompt (string) +</dd><dt><i>echo</i></dt> +<dd> +flag indicating an echoing of the input (boolean) +</dd> +</dl><a NAME="DebugServer.signalClientStack" ID="DebugServer.signalClientStack"></a> +<h4>DebugServer.signalClientStack</h4> +<b>signalClientStack</b>(<i>stack</i>) +<p> + Public method to process a client's stack information. +</p><dl> +<dt><i>stack</i></dt> +<dd> +list of stack entries. Each entry is a tuple of three + values giving the filename, linenumber and method + (list of lists of (string, integer, string)) +</dd> +</dl><a NAME="DebugServer.signalClientStatement" ID="DebugServer.signalClientStatement"></a> +<h4>DebugServer.signalClientStatement</h4> +<b>signalClientStatement</b>(<i>more</i>) +<p> + Public method to process the input response from the client. +</p><dl> +<dt><i>more</i></dt> +<dd> +flag indicating that more user input is required +</dd> +</dl><a NAME="DebugServer.signalClientSyntaxError" ID="DebugServer.signalClientSyntaxError"></a> +<h4>DebugServer.signalClientSyntaxError</h4> +<b>signalClientSyntaxError</b>(<i>message, filename, lineNo, characterNo</i>) +<p> + Public method to process the syntax error info from the client. +</p><dl> +<dt><i>message</i></dt> +<dd> +message of the syntax error (string) +</dd><dt><i>filename</i></dt> +<dd> +translated filename of the syntax error position + (string) +</dd><dt><i>lineNo</i></dt> +<dd> +line number of the syntax error position (integer) +</dd><dt><i>characterNo</i></dt> +<dd> +character number of the syntax error position + (integer) +</dd> +</dl><a NAME="DebugServer.signalClientThreadList" ID="DebugServer.signalClientThreadList"></a> +<h4>DebugServer.signalClientThreadList</h4> +<b>signalClientThreadList</b>(<i>currentId, threadList</i>) +<p> + Public method to process the client thread list info. +</p><dl> +<dt><i>currentId</i></dt> +<dd> +id of the current thread (integer) +</dd><dt><i>threadList</i></dt> +<dd> +list of dictionaries containing the thread data +</dd> +</dl><a NAME="DebugServer.signalClientThreadSet" ID="DebugServer.signalClientThreadSet"></a> +<h4>DebugServer.signalClientThreadSet</h4> +<b>signalClientThreadSet</b>(<i></i>) +<p> + Public method to handle the change of the client thread. +</p><a NAME="DebugServer.signalClientVariable" ID="DebugServer.signalClientVariable"></a> +<h4>DebugServer.signalClientVariable</h4> +<b>signalClientVariable</b>(<i>scope, variables</i>) +<p> + Public method to process the client variable info. +</p><dl> +<dt><i>scope</i></dt> +<dd> +scope of the variables (-1 = empty global, 1 = global, + 0 = local) +</dd><dt><i>variables</i></dt> +<dd> +the list of members of a classvariable from the client +</dd> +</dl><a NAME="DebugServer.signalClientVariables" ID="DebugServer.signalClientVariables"></a> +<h4>DebugServer.signalClientVariables</h4> +<b>signalClientVariables</b>(<i>scope, variables</i>) +<p> + Public method to process the client variables info. +</p><dl> +<dt><i>scope</i></dt> +<dd> +scope of the variables (-1 = empty global, 1 = global, + 0 = local) +</dd><dt><i>variables</i></dt> +<dd> +the list of variables from the client +</dd> +</dl><a NAME="DebugServer.signalClientWatchConditionError" ID="DebugServer.signalClientWatchConditionError"></a> +<h4>DebugServer.signalClientWatchConditionError</h4> +<b>signalClientWatchConditionError</b>(<i>condition</i>) +<p> + Public method to process the client watch expression error info. +</p><dl> +<dt><i>condition</i></dt> +<dd> +expression of watch expression to clear (string) +</dd> +</dl><a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a> +<h4>DebugServer.startClient</h4> +<b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False</i>) +<p> + Public method to start a debug client. +</p><dl> +<dt><i>unplanned=</i></dt> +<dd> +flag indicating that the client has died (boolean) +</dd><dt><i>clType=</i></dt> +<dd> +type of client to be started (string) +</dd><dt><i>forProject=</i></dt> +<dd> +flag indicating a project related action (boolean) +</dd><dt><i>runInConsole=</i></dt> +<dd> +flag indicating to start the debugger in a + console window (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file