Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Debugger.DebugServer.html
eric6/Documentation/Source/eric6.Debugger.DebugServer.html
- changeset 6942
- 2602857055c5
- parent 6904
- 3f35037a08d4
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Debugger.DebugServer</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Debugger.DebugServer</h1> | |
| 23 <p> | |
| 24 Module implementing the debug server. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>DebuggerInterfaces</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#DebugServer">DebugServer</a></td> | |
| 34 <td>Class implementing the debug server embedded within the IDE.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="DebugServer" ID="DebugServer"></a> | |
| 43 <h2>DebugServer</h2> | |
| 44 <p> | |
| 45 Class implementing the debug server embedded within the IDE. | |
| 46 </p><h3>Signals</h3> | |
| 47 <dl> | |
| 48 <dt>appendStdout(msg)</dt> | |
| 49 <dd> | |
| 50 emitted when a passive debug connection is | |
| 51 established or lost | |
| 52 </dd><dt>callTraceInfo</dt> | |
| 53 <dd> | |
| 54 emitted after the client reported the call trace | |
| 55 data (isCall, fromFile, fromLine, fromFunction, toFile, toLine, | |
| 56 toFunction) | |
| 57 </dd><dt>clientBanner(version, platform, dbgclient, venvname)</dt> | |
| 58 <dd> | |
| 59 emitted after | |
| 60 the client banner data was received | |
| 61 </dd><dt>clientBreakConditionError(fn, lineno)</dt> | |
| 62 <dd> | |
| 63 emitted after the client has | |
| 64 signaled a syntax error in a breakpoint condition | |
| 65 </dd><dt>clientCapabilities(capabilities, cltype, venvname)</dt> | |
| 66 <dd> | |
| 67 emitted after | |
| 68 the clients capabilities were received | |
| 69 </dd><dt>clientClearBreak(filename, lineno)</dt> | |
| 70 <dd> | |
| 71 emitted after the debug client | |
| 72 has decided to clear a temporary breakpoint | |
| 73 </dd><dt>clientClearWatch(condition)</dt> | |
| 74 <dd> | |
| 75 emitted after the debug client | |
| 76 has decided to clear a temporary watch expression | |
| 77 </dd><dt>clientCompletionList(completionList, text)</dt> | |
| 78 <dd> | |
| 79 emitted after the client | |
| 80 the commandline completion list and the reworked searchstring was | |
| 81 received from the client | |
| 82 </dd><dt>clientException(exception)</dt> | |
| 83 <dd> | |
| 84 emitted after an exception occured on | |
| 85 the client side | |
| 86 </dd><dt>clientExit(int, str, bool)</dt> | |
| 87 <dd> | |
| 88 emitted after the client has exited | |
| 89 giving the exit status, an exit message and an indication to be quiet | |
| 90 </dd><dt>clientGone(bool)</dt> | |
| 91 <dd> | |
| 92 emitted if the client went away (planned or | |
| 93 unplanned) | |
| 94 </dd><dt>clientInterpreterChanged(str)</dt> | |
| 95 <dd> | |
| 96 emitted to signal a change of the | |
| 97 client interpreter | |
| 98 </dd><dt>clientLine(filename, lineno, forStack)</dt> | |
| 99 <dd> | |
| 100 emitted after the | |
| 101 debug client has executed a line of code | |
| 102 </dd><dt>clientOutput(str)</dt> | |
| 103 <dd> | |
| 104 emitted after the client has sent some output | |
| 105 </dd><dt>clientProcessStderr(str)</dt> | |
| 106 <dd> | |
| 107 emitted after the client has sent some | |
| 108 output via stderr | |
| 109 </dd><dt>clientProcessStdout(str)</dt> | |
| 110 <dd> | |
| 111 emitted after the client has sent some | |
| 112 output via stdout | |
| 113 </dd><dt>clientRawInput(prompt, echo)</dt> | |
| 114 <dd> | |
| 115 emitted after a raw input request was | |
| 116 received | |
| 117 </dd><dt>clientRawInputSent()</dt> | |
| 118 <dd> | |
| 119 emitted after the data was sent to the | |
| 120 debug client | |
| 121 </dd><dt>clientSignal(signal)</dt> | |
| 122 <dd> | |
| 123 emitted after a signal has been generated on | |
| 124 the client side | |
| 125 </dd><dt>clientStack(stack)</dt> | |
| 126 <dd> | |
| 127 emitted after the debug client has executed a | |
| 128 line of code | |
| 129 </dd><dt>clientStatement(bool)</dt> | |
| 130 <dd> | |
| 131 emitted after an interactive command has | |
| 132 been executed. The parameter is 0 to indicate that the command is | |
| 133 complete and 1 if it needs more input. | |
| 134 </dd><dt>clientSyntaxError(exception)</dt> | |
| 135 <dd> | |
| 136 emitted after a syntax error has been | |
| 137 detected on the client side | |
| 138 </dd><dt>clientThreadList(currentId, threadList)</dt> | |
| 139 <dd> | |
| 140 emitted after a thread list | |
| 141 has been received | |
| 142 </dd><dt>clientThreadSet()</dt> | |
| 143 <dd> | |
| 144 emitted after the client has acknowledged the | |
| 145 change of the current thread | |
| 146 </dd><dt>clientVariable(scope, variables)</dt> | |
| 147 <dd> | |
| 148 emitted after a dump for one class | |
| 149 variable has been received | |
| 150 </dd><dt>clientVariables(scope, variables)</dt> | |
| 151 <dd> | |
| 152 emitted after a variables dump | |
| 153 has been received | |
| 154 </dd><dt>clientWatchConditionError(condition)</dt> | |
| 155 <dd> | |
| 156 emitted after the client has | |
| 157 signaled a syntax error in a watch expression | |
| 158 </dd><dt>passiveDebugStarted(str, bool)</dt> | |
| 159 <dd> | |
| 160 emitted after the debug client has | |
| 161 connected in passive debug mode | |
| 162 </dd><dt>utDiscovered(testCases, exc_type, exc_value)</dt> | |
| 163 <dd> | |
| 164 emitted after the | |
| 165 client has performed a test case discovery action | |
| 166 </dd><dt>utFinished()</dt> | |
| 167 <dd> | |
| 168 emitted after the client signalled the end of the | |
| 169 unittest | |
| 170 </dd><dt>utPrepared(nrTests, exc_type, exc_value)</dt> | |
| 171 <dd> | |
| 172 emitted after the client | |
| 173 has loaded a unittest suite | |
| 174 </dd><dt>utStartTest(testname, testdocu)</dt> | |
| 175 <dd> | |
| 176 emitted after the client has | |
| 177 started a test | |
| 178 </dd><dt>utStopTest()</dt> | |
| 179 <dd> | |
| 180 emitted after the client has finished a test | |
| 181 </dd><dt>utTestErrored(testname, exc_info, id)</dt> | |
| 182 <dd> | |
| 183 emitted after the client | |
| 184 reported an errored test | |
| 185 </dd><dt>utTestFailed(testname, exc_info, id)</dt> | |
| 186 <dd> | |
| 187 emitted after the client | |
| 188 reported a failed test | |
| 189 </dd><dt>utTestFailedExpected(testname, exc_info, id)</dt> | |
| 190 <dd> | |
| 191 emitted after the | |
| 192 client reported an expected test failure | |
| 193 </dd><dt>utTestSkipped(testname, reason, id)</dt> | |
| 194 <dd> | |
| 195 emitted after the client | |
| 196 reported a skipped test | |
| 197 </dd><dt>utTestSucceededUnexpected(testname, id)</dt> | |
| 198 <dd> | |
| 199 emitted after the client | |
| 200 reported an unexpected test success | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <h3>Derived from</h3> | |
| 204 QTcpServer | |
| 205 <h3>Class Attributes</h3> | |
| 206 <table> | |
| 207 <tr><td>None</td></tr> | |
| 208 </table> | |
| 209 <h3>Class Methods</h3> | |
| 210 <table> | |
| 211 <tr><td>None</td></tr> | |
| 212 </table> | |
| 213 <h3>Methods</h3> | |
| 214 <table> | |
| 215 <tr> | |
| 216 <td><a href="#DebugServer.__init__">DebugServer</a></td> | |
| 217 <td>Constructor</td> | |
| 218 </tr><tr> | |
| 219 <td><a href="#DebugServer.__addBreakPoints">__addBreakPoints</a></td> | |
| 220 <td>Private slot to add breakpoints.</td> | |
| 221 </tr><tr> | |
| 222 <td><a href="#DebugServer.__addWatchPoints">__addWatchPoints</a></td> | |
| 223 <td>Private slot to set a watch expression.</td> | |
| 224 </tr><tr> | |
| 225 <td><a href="#DebugServer.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td> | |
| 226 <td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td> | |
| 227 </tr><tr> | |
| 228 <td><a href="#DebugServer.__changeBreakPoints">__changeBreakPoints</a></td> | |
| 229 <td>Private slot to set changed breakpoints.</td> | |
| 230 </tr><tr> | |
| 231 <td><a href="#DebugServer.__changeWatchPoints">__changeWatchPoints</a></td> | |
| 232 <td>Private slot to set changed watch expressions.</td> | |
| 233 </tr><tr> | |
| 234 <td><a href="#DebugServer.__clientClearBreakPoint">__clientClearBreakPoint</a></td> | |
| 235 <td>Private slot to handle the clientClearBreak signal.</td> | |
| 236 </tr><tr> | |
| 237 <td><a href="#DebugServer.__clientClearWatchPoint">__clientClearWatchPoint</a></td> | |
| 238 <td>Private slot to handle the clientClearWatch signal.</td> | |
| 239 </tr><tr> | |
| 240 <td><a href="#DebugServer.__clientProcessError">__clientProcessError</a></td> | |
| 241 <td>Private slot to process client output received via stderr.</td> | |
| 242 </tr><tr> | |
| 243 <td><a href="#DebugServer.__clientProcessOutput">__clientProcessOutput</a></td> | |
| 244 <td>Private slot to process client output received via stdout.</td> | |
| 245 </tr><tr> | |
| 246 <td><a href="#DebugServer.__createDebuggerInterface">__createDebuggerInterface</a></td> | |
| 247 <td>Private slot to create the debugger interface object.</td> | |
| 248 </tr><tr> | |
| 249 <td><a href="#DebugServer.__deleteBreakPoints">__deleteBreakPoints</a></td> | |
| 250 <td>Private slot to delete breakpoints.</td> | |
| 251 </tr><tr> | |
| 252 <td><a href="#DebugServer.__deleteWatchPoints">__deleteWatchPoints</a></td> | |
| 253 <td>Private slot to delete watch expressions.</td> | |
| 254 </tr><tr> | |
| 255 <td><a href="#DebugServer.__findLanguageForExtension">__findLanguageForExtension</a></td> | |
| 256 <td>Private method to get the language associated with a file extension.</td> | |
| 257 </tr><tr> | |
| 258 <td><a href="#DebugServer.__getNetworkInterfaceAndIndex">__getNetworkInterfaceAndIndex</a></td> | |
| 259 <td>Private method to determine the network interface and the interface index.</td> | |
| 260 </tr><tr> | |
| 261 <td><a href="#DebugServer.__makeWatchCondition">__makeWatchCondition</a></td> | |
| 262 <td>Private method to construct the condition string.</td> | |
| 263 </tr><tr> | |
| 264 <td><a href="#DebugServer.__newConnection">__newConnection</a></td> | |
| 265 <td>Private slot to handle a new connection.</td> | |
| 266 </tr><tr> | |
| 267 <td><a href="#DebugServer.__passiveShutDown">__passiveShutDown</a></td> | |
| 268 <td>Private method to shut down a passive debug connection.</td> | |
| 269 </tr><tr> | |
| 270 <td><a href="#DebugServer.__registerDebuggerInterfaces">__registerDebuggerInterfaces</a></td> | |
| 271 <td>Private method to register the available internal debugger interfaces.</td> | |
| 272 </tr><tr> | |
| 273 <td><a href="#DebugServer.__remoteBreakpointEnable">__remoteBreakpointEnable</a></td> | |
| 274 <td>Private method to enable or disable a breakpoint.</td> | |
| 275 </tr><tr> | |
| 276 <td><a href="#DebugServer.__remoteBreakpointIgnore">__remoteBreakpointIgnore</a></td> | |
| 277 <td>Private method to ignore a breakpoint the next couple of occurrences.</td> | |
| 278 </tr><tr> | |
| 279 <td><a href="#DebugServer.__remoteWatchpoint">__remoteWatchpoint</a></td> | |
| 280 <td>Private method to set or clear a watch expression.</td> | |
| 281 </tr><tr> | |
| 282 <td><a href="#DebugServer.__remoteWatchpointEnable">__remoteWatchpointEnable</a></td> | |
| 283 <td>Private method to enable or disable a watch expression.</td> | |
| 284 </tr><tr> | |
| 285 <td><a href="#DebugServer.__remoteWatchpointIgnore">__remoteWatchpointIgnore</a></td> | |
| 286 <td>Private method to ignore a watch expression the next couple of occurrences.</td> | |
| 287 </tr><tr> | |
| 288 <td><a href="#DebugServer.__restoreBreakpoints">__restoreBreakpoints</a></td> | |
| 289 <td>Private method to restore the breakpoints after a restart.</td> | |
| 290 </tr><tr> | |
| 291 <td><a href="#DebugServer.__restoreWatchpoints">__restoreWatchpoints</a></td> | |
| 292 <td>Private method to restore the watch expressions after a restart.</td> | |
| 293 </tr><tr> | |
| 294 <td><a href="#DebugServer.__setClientType">__setClientType</a></td> | |
| 295 <td>Private method to set the client type.</td> | |
| 296 </tr><tr> | |
| 297 <td><a href="#DebugServer.__splitWatchCondition">__splitWatchCondition</a></td> | |
| 298 <td>Private method to split a remote watch expression.</td> | |
| 299 </tr><tr> | |
| 300 <td><a href="#DebugServer.__watchPointDataAboutToBeChanged">__watchPointDataAboutToBeChanged</a></td> | |
| 301 <td>Private slot to handle the dataAboutToBeChanged signal of the watch expression model.</td> | |
| 302 </tr><tr> | |
| 303 <td><a href="#DebugServer.clientUtDiscovered">clientUtDiscovered</a></td> | |
| 304 <td>Public method to process the client unittest discover info.</td> | |
| 305 </tr><tr> | |
| 306 <td><a href="#DebugServer.clientUtFinished">clientUtFinished</a></td> | |
| 307 <td>Public method to process the client unit test finished info.</td> | |
| 308 </tr><tr> | |
| 309 <td><a href="#DebugServer.clientUtPrepared">clientUtPrepared</a></td> | |
| 310 <td>Public method to process the client unittest prepared info.</td> | |
| 311 </tr><tr> | |
| 312 <td><a href="#DebugServer.clientUtStartTest">clientUtStartTest</a></td> | |
| 313 <td>Public method to process the client start test info.</td> | |
| 314 </tr><tr> | |
| 315 <td><a href="#DebugServer.clientUtStopTest">clientUtStopTest</a></td> | |
| 316 <td>Public method to process the client stop test info.</td> | |
| 317 </tr><tr> | |
| 318 <td><a href="#DebugServer.clientUtTestErrored">clientUtTestErrored</a></td> | |
| 319 <td>Public method to process the client test errored info.</td> | |
| 320 </tr><tr> | |
| 321 <td><a href="#DebugServer.clientUtTestFailed">clientUtTestFailed</a></td> | |
| 322 <td>Public method to process the client test failed info.</td> | |
| 323 </tr><tr> | |
| 324 <td><a href="#DebugServer.clientUtTestFailedExpected">clientUtTestFailedExpected</a></td> | |
| 325 <td>Public method to process the client test failed expected info.</td> | |
| 326 </tr><tr> | |
| 327 <td><a href="#DebugServer.clientUtTestSkipped">clientUtTestSkipped</a></td> | |
| 328 <td>Public method to process the client test skipped info.</td> | |
| 329 </tr><tr> | |
| 330 <td><a href="#DebugServer.clientUtTestSucceededUnexpected">clientUtTestSucceededUnexpected</a></td> | |
| 331 <td>Public method to process the client test succeeded unexpected info.</td> | |
| 332 </tr><tr> | |
| 333 <td><a href="#DebugServer.getBreakPointModel">getBreakPointModel</a></td> | |
| 334 <td>Public slot to get a reference to the breakpoint model object.</td> | |
| 335 </tr><tr> | |
| 336 <td><a href="#DebugServer.getClientCapabilities">getClientCapabilities</a></td> | |
| 337 <td>Public method to retrieve the debug clients capabilities.</td> | |
| 338 </tr><tr> | |
| 339 <td><a href="#DebugServer.getClientInterpreter">getClientInterpreter</a></td> | |
| 340 <td>Public method to get the interpreter of the debug client.</td> | |
| 341 </tr><tr> | |
| 342 <td><a href="#DebugServer.getClientType">getClientType</a></td> | |
| 343 <td>Public method to get the currently running debug client type.</td> | |
| 344 </tr><tr> | |
| 345 <td><a href="#DebugServer.getExtensions">getExtensions</a></td> | |
| 346 <td>Public slot to get the extensions associated with the given language.</td> | |
| 347 </tr><tr> | |
| 348 <td><a href="#DebugServer.getHostAddress">getHostAddress</a></td> | |
| 349 <td>Public method to get the IP address or hostname the debug server is listening.</td> | |
| 350 </tr><tr> | |
| 351 <td><a href="#DebugServer.getSupportedLanguages">getSupportedLanguages</a></td> | |
| 352 <td>Public slot to return the supported programming languages.</td> | |
| 353 </tr><tr> | |
| 354 <td><a href="#DebugServer.getWatchPointModel">getWatchPointModel</a></td> | |
| 355 <td>Public slot to get a reference to the watch expression model object.</td> | |
| 356 </tr><tr> | |
| 357 <td><a href="#DebugServer.isClientProcessUp">isClientProcessUp</a></td> | |
| 358 <td>Public method to check, if the debug client process is up.</td> | |
| 359 </tr><tr> | |
| 360 <td><a href="#DebugServer.isConnected">isConnected</a></td> | |
| 361 <td>Public method to test, if the debug server is connected to a backend.</td> | |
| 362 </tr><tr> | |
| 363 <td><a href="#DebugServer.isDebugging">isDebugging</a></td> | |
| 364 <td>Public method to test, if the debug server is debugging.</td> | |
| 365 </tr><tr> | |
| 366 <td><a href="#DebugServer.passiveStartUp">passiveStartUp</a></td> | |
| 367 <td>Public method to handle a passive debug connection.</td> | |
| 368 </tr><tr> | |
| 369 <td><a href="#DebugServer.preferencesChanged">preferencesChanged</a></td> | |
| 370 <td>Public slot to handle the preferencesChanged signal.</td> | |
| 371 </tr><tr> | |
| 372 <td><a href="#DebugServer.registerDebuggerInterface">registerDebuggerInterface</a></td> | |
| 373 <td>Public method to register a debugger interface.</td> | |
| 374 </tr><tr> | |
| 375 <td><a href="#DebugServer.remoteBanner">remoteBanner</a></td> | |
| 376 <td>Public slot to get the banner info of the remote client.</td> | |
| 377 </tr><tr> | |
| 378 <td><a href="#DebugServer.remoteBreakpoint">remoteBreakpoint</a></td> | |
| 379 <td>Public method to set or clear a breakpoint.</td> | |
| 380 </tr><tr> | |
| 381 <td><a href="#DebugServer.remoteCapabilities">remoteCapabilities</a></td> | |
| 382 <td>Public slot to get the debug clients capabilities.</td> | |
| 383 </tr><tr> | |
| 384 <td><a href="#DebugServer.remoteClientSetFilter">remoteClientSetFilter</a></td> | |
| 385 <td>Public method to set a variables filter list.</td> | |
| 386 </tr><tr> | |
| 387 <td><a href="#DebugServer.remoteClientVariable">remoteClientVariable</a></td> | |
| 388 <td>Public method to request the variables of the debugged program.</td> | |
| 389 </tr><tr> | |
| 390 <td><a href="#DebugServer.remoteClientVariables">remoteClientVariables</a></td> | |
| 391 <td>Public method to request the variables of the debugged program.</td> | |
| 392 </tr><tr> | |
| 393 <td><a href="#DebugServer.remoteCompletion">remoteCompletion</a></td> | |
| 394 <td>Public slot to get the a list of possible commandline completions from the remote client.</td> | |
| 395 </tr><tr> | |
| 396 <td><a href="#DebugServer.remoteContinue">remoteContinue</a></td> | |
| 397 <td>Public method to continue the debugged program.</td> | |
| 398 </tr><tr> | |
| 399 <td><a href="#DebugServer.remoteCoverage">remoteCoverage</a></td> | |
| 400 <td>Public method to load a new program to collect coverage data.</td> | |
| 401 </tr><tr> | |
| 402 <td><a href="#DebugServer.remoteEnvironment">remoteEnvironment</a></td> | |
| 403 <td>Public method to set the environment for a program to debug, run, ...</td> | |
| 404 </tr><tr> | |
| 405 <td><a href="#DebugServer.remoteLoad">remoteLoad</a></td> | |
| 406 <td>Public method to load a new program to debug.</td> | |
| 407 </tr><tr> | |
| 408 <td><a href="#DebugServer.remoteMoveIP">remoteMoveIP</a></td> | |
| 409 <td>Public method to move the instruction pointer to a different line.</td> | |
| 410 </tr><tr> | |
| 411 <td><a href="#DebugServer.remoteProfile">remoteProfile</a></td> | |
| 412 <td>Public method to load a new program to collect profiling data.</td> | |
| 413 </tr><tr> | |
| 414 <td><a href="#DebugServer.remoteRawInput">remoteRawInput</a></td> | |
| 415 <td>Public method to send the raw input to the debugged program.</td> | |
| 416 </tr><tr> | |
| 417 <td><a href="#DebugServer.remoteRun">remoteRun</a></td> | |
| 418 <td>Public method to load a new program to run.</td> | |
| 419 </tr><tr> | |
| 420 <td><a href="#DebugServer.remoteSetThread">remoteSetThread</a></td> | |
| 421 <td>Public method to request to set the given thread as current thread.</td> | |
| 422 </tr><tr> | |
| 423 <td><a href="#DebugServer.remoteStatement">remoteStatement</a></td> | |
| 424 <td>Public method to execute a Python statement.</td> | |
| 425 </tr><tr> | |
| 426 <td><a href="#DebugServer.remoteStep">remoteStep</a></td> | |
| 427 <td>Public method to single step the debugged program.</td> | |
| 428 </tr><tr> | |
| 429 <td><a href="#DebugServer.remoteStepOut">remoteStepOut</a></td> | |
| 430 <td>Public method to step out the debugged program.</td> | |
| 431 </tr><tr> | |
| 432 <td><a href="#DebugServer.remoteStepOver">remoteStepOver</a></td> | |
| 433 <td>Public method to step over the debugged program.</td> | |
| 434 </tr><tr> | |
| 435 <td><a href="#DebugServer.remoteStepQuit">remoteStepQuit</a></td> | |
| 436 <td>Public method to stop the debugged program.</td> | |
| 437 </tr><tr> | |
| 438 <td><a href="#DebugServer.remoteThreadList">remoteThreadList</a></td> | |
| 439 <td>Public method to request the list of threads from the client.</td> | |
| 440 </tr><tr> | |
| 441 <td><a href="#DebugServer.remoteUTDiscover">remoteUTDiscover</a></td> | |
| 442 <td>Public method to perform a test case discovery.</td> | |
| 443 </tr><tr> | |
| 444 <td><a href="#DebugServer.remoteUTPrepare">remoteUTPrepare</a></td> | |
| 445 <td>Public method to prepare a new unittest run.</td> | |
| 446 </tr><tr> | |
| 447 <td><a href="#DebugServer.remoteUTRun">remoteUTRun</a></td> | |
| 448 <td>Public method to start a unittest run.</td> | |
| 449 </tr><tr> | |
| 450 <td><a href="#DebugServer.remoteUTStop">remoteUTStop</a></td> | |
| 451 <td>public method to stop a unittest run.</td> | |
| 452 </tr><tr> | |
| 453 <td><a href="#DebugServer.setCallTraceEnabled">setCallTraceEnabled</a></td> | |
| 454 <td>Public method to set the call trace state.</td> | |
| 455 </tr><tr> | |
| 456 <td><a href="#DebugServer.setDebugging">setDebugging</a></td> | |
| 457 <td>Public method to set the debugging state.</td> | |
| 458 </tr><tr> | |
| 459 <td><a href="#DebugServer.shutdownServer">shutdownServer</a></td> | |
| 460 <td>Public method to cleanly shut down.</td> | |
| 461 </tr><tr> | |
| 462 <td><a href="#DebugServer.signalClientBanner">signalClientBanner</a></td> | |
| 463 <td>Public method to process the client banner info.</td> | |
| 464 </tr><tr> | |
| 465 <td><a href="#DebugServer.signalClientBreakConditionError">signalClientBreakConditionError</a></td> | |
| 466 <td>Public method to process the client breakpoint condition error info.</td> | |
| 467 </tr><tr> | |
| 468 <td><a href="#DebugServer.signalClientCallTrace">signalClientCallTrace</a></td> | |
| 469 <td>Public method to process the client call trace data.</td> | |
| 470 </tr><tr> | |
| 471 <td><a href="#DebugServer.signalClientCapabilities">signalClientCapabilities</a></td> | |
| 472 <td>Public method to process the client capabilities info.</td> | |
| 473 </tr><tr> | |
| 474 <td><a href="#DebugServer.signalClientClearBreak">signalClientClearBreak</a></td> | |
| 475 <td>Public method to process the client clear breakpoint command.</td> | |
| 476 </tr><tr> | |
| 477 <td><a href="#DebugServer.signalClientClearWatch">signalClientClearWatch</a></td> | |
| 478 <td>Public slot to handle the clientClearWatch signal.</td> | |
| 479 </tr><tr> | |
| 480 <td><a href="#DebugServer.signalClientCompletionList">signalClientCompletionList</a></td> | |
| 481 <td>Public method to process the client auto completion info.</td> | |
| 482 </tr><tr> | |
| 483 <td><a href="#DebugServer.signalClientException">signalClientException</a></td> | |
| 484 <td>Public method to process the exception info from the client.</td> | |
| 485 </tr><tr> | |
| 486 <td><a href="#DebugServer.signalClientExit">signalClientExit</a></td> | |
| 487 <td>Public method to process the client exit status.</td> | |
| 488 </tr><tr> | |
| 489 <td><a href="#DebugServer.signalClientLine">signalClientLine</a></td> | |
| 490 <td>Public method to process client position feedback.</td> | |
| 491 </tr><tr> | |
| 492 <td><a href="#DebugServer.signalClientOutput">signalClientOutput</a></td> | |
| 493 <td>Public method to process a line of client output.</td> | |
| 494 </tr><tr> | |
| 495 <td><a href="#DebugServer.signalClientRawInput">signalClientRawInput</a></td> | |
| 496 <td>Public method to process the client raw input command.</td> | |
| 497 </tr><tr> | |
| 498 <td><a href="#DebugServer.signalClientSignal">signalClientSignal</a></td> | |
| 499 <td>Public method to process a signal generated on the client side.</td> | |
| 500 </tr><tr> | |
| 501 <td><a href="#DebugServer.signalClientStack">signalClientStack</a></td> | |
| 502 <td>Public method to process a client's stack information.</td> | |
| 503 </tr><tr> | |
| 504 <td><a href="#DebugServer.signalClientStatement">signalClientStatement</a></td> | |
| 505 <td>Public method to process the input response from the client.</td> | |
| 506 </tr><tr> | |
| 507 <td><a href="#DebugServer.signalClientSyntaxError">signalClientSyntaxError</a></td> | |
| 508 <td>Public method to process the syntax error info from the client.</td> | |
| 509 </tr><tr> | |
| 510 <td><a href="#DebugServer.signalClientThreadList">signalClientThreadList</a></td> | |
| 511 <td>Public method to process the client thread list info.</td> | |
| 512 </tr><tr> | |
| 513 <td><a href="#DebugServer.signalClientThreadSet">signalClientThreadSet</a></td> | |
| 514 <td>Public method to handle the change of the client thread.</td> | |
| 515 </tr><tr> | |
| 516 <td><a href="#DebugServer.signalClientVariable">signalClientVariable</a></td> | |
| 517 <td>Public method to process the client variable info.</td> | |
| 518 </tr><tr> | |
| 519 <td><a href="#DebugServer.signalClientVariables">signalClientVariables</a></td> | |
| 520 <td>Public method to process the client variables info.</td> | |
| 521 </tr><tr> | |
| 522 <td><a href="#DebugServer.signalClientWatchConditionError">signalClientWatchConditionError</a></td> | |
| 523 <td>Public method to process the client watch expression error info.</td> | |
| 524 </tr><tr> | |
| 525 <td><a href="#DebugServer.startClient">startClient</a></td> | |
| 526 <td>Public method to start a debug client.</td> | |
| 527 </tr><tr> | |
| 528 <td><a href="#DebugServer.unregisterDebuggerInterface">unregisterDebuggerInterface</a></td> | |
| 529 <td>Public method to unregister a debugger interface.</td> | |
| 530 </tr> | |
| 531 </table> | |
| 532 <h3>Static Methods</h3> | |
| 533 <table> | |
| 534 <tr><td>None</td></tr> | |
| 535 </table> | |
| 536 <a NAME="DebugServer.__init__" ID="DebugServer.__init__"></a> | |
| 537 <h4>DebugServer (Constructor)</h4> | |
| 538 <b>DebugServer</b>(<i>originalPathString, preventPassiveDebugging=False</i>) | |
| 539 <p> | |
| 540 Constructor | |
| 541 </p><dl> | |
| 542 <dt><i>originalPathString</i> (str)</dt> | |
| 543 <dd> | |
| 544 original PATH environment variable | |
| 545 </dd><dt><i>preventPassiveDebugging</i> (bool)</dt> | |
| 546 <dd> | |
| 547 flag overriding the PassiveDbgEnabled | |
| 548 setting | |
| 549 </dd> | |
| 550 </dl><a NAME="DebugServer.__addBreakPoints" ID="DebugServer.__addBreakPoints"></a> | |
| 551 <h4>DebugServer.__addBreakPoints</h4> | |
| 552 <b>__addBreakPoints</b>(<i>parentIndex, start, end</i>) | |
| 553 <p> | |
| 554 Private slot to add breakpoints. | |
| 555 </p><dl> | |
| 556 <dt><i>parentIndex</i></dt> | |
| 557 <dd> | |
| 558 index of parent item (QModelIndex) | |
| 559 </dd><dt><i>start</i></dt> | |
| 560 <dd> | |
| 561 start row (integer) | |
| 562 </dd><dt><i>end</i></dt> | |
| 563 <dd> | |
| 564 end row (integer) | |
| 565 </dd> | |
| 566 </dl><a NAME="DebugServer.__addWatchPoints" ID="DebugServer.__addWatchPoints"></a> | |
| 567 <h4>DebugServer.__addWatchPoints</h4> | |
| 568 <b>__addWatchPoints</b>(<i>parentIndex, start, end</i>) | |
| 569 <p> | |
| 570 Private slot to set a watch expression. | |
| 571 </p><dl> | |
| 572 <dt><i>parentIndex</i></dt> | |
| 573 <dd> | |
| 574 index of parent item (QModelIndex) | |
| 575 </dd><dt><i>start</i></dt> | |
| 576 <dd> | |
| 577 start row (integer) | |
| 578 </dd><dt><i>end</i></dt> | |
| 579 <dd> | |
| 580 end row (integer) | |
| 581 </dd> | |
| 582 </dl><a NAME="DebugServer.__breakPointDataAboutToBeChanged" ID="DebugServer.__breakPointDataAboutToBeChanged"></a> | |
| 583 <h4>DebugServer.__breakPointDataAboutToBeChanged</h4> | |
| 584 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) | |
| 585 <p> | |
| 586 Private slot to handle the dataAboutToBeChanged signal of the | |
| 587 breakpoint model. | |
| 588 </p><dl> | |
| 589 <dt><i>startIndex</i></dt> | |
| 590 <dd> | |
| 591 start index of the rows to be changed (QModelIndex) | |
| 592 </dd><dt><i>endIndex</i></dt> | |
| 593 <dd> | |
| 594 end index of the rows to be changed (QModelIndex) | |
| 595 </dd> | |
| 596 </dl><a NAME="DebugServer.__changeBreakPoints" ID="DebugServer.__changeBreakPoints"></a> | |
| 597 <h4>DebugServer.__changeBreakPoints</h4> | |
| 598 <b>__changeBreakPoints</b>(<i>startIndex, endIndex</i>) | |
| 599 <p> | |
| 600 Private slot to set changed breakpoints. | |
| 601 </p><dl> | |
| 602 <dt><i>startIndex</i></dt> | |
| 603 <dd> | |
| 604 starting index of the change breakpoins (QModelIndex) | |
| 605 </dd><dt><i>endIndex</i></dt> | |
| 606 <dd> | |
| 607 ending index of the change breakpoins (QModelIndex) | |
| 608 </dd> | |
| 609 </dl><a NAME="DebugServer.__changeWatchPoints" ID="DebugServer.__changeWatchPoints"></a> | |
| 610 <h4>DebugServer.__changeWatchPoints</h4> | |
| 611 <b>__changeWatchPoints</b>(<i>startIndex, endIndex</i>) | |
| 612 <p> | |
| 613 Private slot to set changed watch expressions. | |
| 614 </p><dl> | |
| 615 <dt><i>startIndex</i></dt> | |
| 616 <dd> | |
| 617 start index of the rows to be changed (QModelIndex) | |
| 618 </dd><dt><i>endIndex</i></dt> | |
| 619 <dd> | |
| 620 end index of the rows to be changed (QModelIndex) | |
| 621 </dd> | |
| 622 </dl><a NAME="DebugServer.__clientClearBreakPoint" ID="DebugServer.__clientClearBreakPoint"></a> | |
| 623 <h4>DebugServer.__clientClearBreakPoint</h4> | |
| 624 <b>__clientClearBreakPoint</b>(<i>fn, lineno</i>) | |
| 625 <p> | |
| 626 Private slot to handle the clientClearBreak signal. | |
| 627 </p><dl> | |
| 628 <dt><i>fn</i></dt> | |
| 629 <dd> | |
| 630 filename of breakpoint to clear (string) | |
| 631 </dd><dt><i>lineno</i></dt> | |
| 632 <dd> | |
| 633 line number of breakpoint to clear (integer) | |
| 634 </dd> | |
| 635 </dl><a NAME="DebugServer.__clientClearWatchPoint" ID="DebugServer.__clientClearWatchPoint"></a> | |
| 636 <h4>DebugServer.__clientClearWatchPoint</h4> | |
| 637 <b>__clientClearWatchPoint</b>(<i>condition</i>) | |
| 638 <p> | |
| 639 Private slot to handle the clientClearWatch signal. | |
| 640 </p><dl> | |
| 641 <dt><i>condition</i></dt> | |
| 642 <dd> | |
| 643 expression of watch expression to clear (string) | |
| 644 </dd> | |
| 645 </dl><a NAME="DebugServer.__clientProcessError" ID="DebugServer.__clientProcessError"></a> | |
| 646 <h4>DebugServer.__clientProcessError</h4> | |
| 647 <b>__clientProcessError</b>(<i></i>) | |
| 648 <p> | |
| 649 Private slot to process client output received via stderr. | |
| 650 </p><a NAME="DebugServer.__clientProcessOutput" ID="DebugServer.__clientProcessOutput"></a> | |
| 651 <h4>DebugServer.__clientProcessOutput</h4> | |
| 652 <b>__clientProcessOutput</b>(<i></i>) | |
| 653 <p> | |
| 654 Private slot to process client output received via stdout. | |
| 655 </p><a NAME="DebugServer.__createDebuggerInterface" ID="DebugServer.__createDebuggerInterface"></a> | |
| 656 <h4>DebugServer.__createDebuggerInterface</h4> | |
| 657 <b>__createDebuggerInterface</b>(<i>clientType=None</i>) | |
| 658 <p> | |
| 659 Private slot to create the debugger interface object. | |
| 660 </p><dl> | |
| 661 <dt><i>clientType</i></dt> | |
| 662 <dd> | |
| 663 type of the client interface to be created (string) | |
| 664 </dd> | |
| 665 </dl><a NAME="DebugServer.__deleteBreakPoints" ID="DebugServer.__deleteBreakPoints"></a> | |
| 666 <h4>DebugServer.__deleteBreakPoints</h4> | |
| 667 <b>__deleteBreakPoints</b>(<i>parentIndex, start, end</i>) | |
| 668 <p> | |
| 669 Private slot to delete breakpoints. | |
| 670 </p><dl> | |
| 671 <dt><i>parentIndex</i></dt> | |
| 672 <dd> | |
| 673 index of parent item (QModelIndex) | |
| 674 </dd><dt><i>start</i></dt> | |
| 675 <dd> | |
| 676 start row (integer) | |
| 677 </dd><dt><i>end</i></dt> | |
| 678 <dd> | |
| 679 end row (integer) | |
| 680 </dd> | |
| 681 </dl><a NAME="DebugServer.__deleteWatchPoints" ID="DebugServer.__deleteWatchPoints"></a> | |
| 682 <h4>DebugServer.__deleteWatchPoints</h4> | |
| 683 <b>__deleteWatchPoints</b>(<i>parentIndex, start, end</i>) | |
| 684 <p> | |
| 685 Private slot to delete watch expressions. | |
| 686 </p><dl> | |
| 687 <dt><i>parentIndex</i></dt> | |
| 688 <dd> | |
| 689 index of parent item (QModelIndex) | |
| 690 </dd><dt><i>start</i></dt> | |
| 691 <dd> | |
| 692 start row (integer) | |
| 693 </dd><dt><i>end</i></dt> | |
| 694 <dd> | |
| 695 end row (integer) | |
| 696 </dd> | |
| 697 </dl><a NAME="DebugServer.__findLanguageForExtension" ID="DebugServer.__findLanguageForExtension"></a> | |
| 698 <h4>DebugServer.__findLanguageForExtension</h4> | |
| 699 <b>__findLanguageForExtension</b>(<i>ext</i>) | |
| 700 <p> | |
| 701 Private method to get the language associated with a file extension. | |
| 702 </p><dl> | |
| 703 <dt><i>ext</i> (str)</dt> | |
| 704 <dd> | |
| 705 file extension | |
| 706 </dd> | |
| 707 </dl><dl> | |
| 708 <dt>Returns:</dt> | |
| 709 <dd> | |
| 710 associated language | |
| 711 </dd> | |
| 712 </dl><dl> | |
| 713 <dt>Return Type:</dt> | |
| 714 <dd> | |
| 715 str | |
| 716 </dd> | |
| 717 </dl><a NAME="DebugServer.__getNetworkInterfaceAndIndex" ID="DebugServer.__getNetworkInterfaceAndIndex"></a> | |
| 718 <h4>DebugServer.__getNetworkInterfaceAndIndex</h4> | |
| 719 <b>__getNetworkInterfaceAndIndex</b>(<i>address</i>) | |
| 720 <p> | |
| 721 Private method to determine the network interface and the interface | |
| 722 index. | |
| 723 </p><dl> | |
| 724 <dt><i>address</i></dt> | |
| 725 <dd> | |
| 726 address to determine the info for (string) | |
| 727 </dd> | |
| 728 </dl><dl> | |
| 729 <dt>Returns:</dt> | |
| 730 <dd> | |
| 731 tuple of network interface name (string) and index (integer) | |
| 732 </dd> | |
| 733 </dl><a NAME="DebugServer.__makeWatchCondition" ID="DebugServer.__makeWatchCondition"></a> | |
| 734 <h4>DebugServer.__makeWatchCondition</h4> | |
| 735 <b>__makeWatchCondition</b>(<i>cond, special</i>) | |
| 736 <p> | |
| 737 Private method to construct the condition string. | |
| 738 </p><dl> | |
| 739 <dt><i>cond</i></dt> | |
| 740 <dd> | |
| 741 condition (string) | |
| 742 </dd><dt><i>special</i></dt> | |
| 743 <dd> | |
| 744 special condition (string) | |
| 745 </dd> | |
| 746 </dl><dl> | |
| 747 <dt>Returns:</dt> | |
| 748 <dd> | |
| 749 condition string (string) | |
| 750 </dd> | |
| 751 </dl><a NAME="DebugServer.__newConnection" ID="DebugServer.__newConnection"></a> | |
| 752 <h4>DebugServer.__newConnection</h4> | |
| 753 <b>__newConnection</b>(<i></i>) | |
| 754 <p> | |
| 755 Private slot to handle a new connection. | |
| 756 </p><a NAME="DebugServer.__passiveShutDown" ID="DebugServer.__passiveShutDown"></a> | |
| 757 <h4>DebugServer.__passiveShutDown</h4> | |
| 758 <b>__passiveShutDown</b>(<i></i>) | |
| 759 <p> | |
| 760 Private method to shut down a passive debug connection. | |
| 761 </p><a NAME="DebugServer.__registerDebuggerInterfaces" ID="DebugServer.__registerDebuggerInterfaces"></a> | |
| 762 <h4>DebugServer.__registerDebuggerInterfaces</h4> | |
| 763 <b>__registerDebuggerInterfaces</b>(<i></i>) | |
| 764 <p> | |
| 765 Private method to register the available internal debugger interfaces. | |
| 766 </p><a NAME="DebugServer.__remoteBreakpointEnable" ID="DebugServer.__remoteBreakpointEnable"></a> | |
| 767 <h4>DebugServer.__remoteBreakpointEnable</h4> | |
| 768 <b>__remoteBreakpointEnable</b>(<i>fn, line, enable</i>) | |
| 769 <p> | |
| 770 Private method to enable or disable a breakpoint. | |
| 771 </p><dl> | |
| 772 <dt><i>fn</i></dt> | |
| 773 <dd> | |
| 774 filename the breakpoint belongs to (string) | |
| 775 </dd><dt><i>line</i></dt> | |
| 776 <dd> | |
| 777 linenumber of the breakpoint (int) | |
| 778 </dd><dt><i>enable</i></dt> | |
| 779 <dd> | |
| 780 flag indicating enabling or disabling a breakpoint | |
| 781 (boolean) | |
| 782 </dd> | |
| 783 </dl><a NAME="DebugServer.__remoteBreakpointIgnore" ID="DebugServer.__remoteBreakpointIgnore"></a> | |
| 784 <h4>DebugServer.__remoteBreakpointIgnore</h4> | |
| 785 <b>__remoteBreakpointIgnore</b>(<i>fn, line, count</i>) | |
| 786 <p> | |
| 787 Private method to ignore a breakpoint the next couple of occurrences. | |
| 788 </p><dl> | |
| 789 <dt><i>fn</i></dt> | |
| 790 <dd> | |
| 791 filename the breakpoint belongs to (string) | |
| 792 </dd><dt><i>line</i></dt> | |
| 793 <dd> | |
| 794 linenumber of the breakpoint (int) | |
| 795 </dd><dt><i>count</i></dt> | |
| 796 <dd> | |
| 797 number of occurrences to ignore (int) | |
| 798 </dd> | |
| 799 </dl><a NAME="DebugServer.__remoteWatchpoint" ID="DebugServer.__remoteWatchpoint"></a> | |
| 800 <h4>DebugServer.__remoteWatchpoint</h4> | |
| 801 <b>__remoteWatchpoint</b>(<i>cond, setWatch, temp=False</i>) | |
| 802 <p> | |
| 803 Private method to set or clear a watch expression. | |
| 804 </p><dl> | |
| 805 <dt><i>cond</i></dt> | |
| 806 <dd> | |
| 807 expression of the watch expression (string) | |
| 808 </dd><dt><i>setWatch</i></dt> | |
| 809 <dd> | |
| 810 flag indicating setting or resetting a watch expression | |
| 811 (boolean) | |
| 812 </dd><dt><i>temp</i></dt> | |
| 813 <dd> | |
| 814 flag indicating a temporary watch expression (boolean) | |
| 815 </dd> | |
| 816 </dl><a NAME="DebugServer.__remoteWatchpointEnable" ID="DebugServer.__remoteWatchpointEnable"></a> | |
| 817 <h4>DebugServer.__remoteWatchpointEnable</h4> | |
| 818 <b>__remoteWatchpointEnable</b>(<i>cond, enable</i>) | |
| 819 <p> | |
| 820 Private method to enable or disable a watch expression. | |
| 821 </p><dl> | |
| 822 <dt><i>cond</i></dt> | |
| 823 <dd> | |
| 824 expression of the watch expression (string) | |
| 825 </dd><dt><i>enable</i></dt> | |
| 826 <dd> | |
| 827 flag indicating enabling or disabling a watch expression | |
| 828 (boolean) | |
| 829 </dd> | |
| 830 </dl><a NAME="DebugServer.__remoteWatchpointIgnore" ID="DebugServer.__remoteWatchpointIgnore"></a> | |
| 831 <h4>DebugServer.__remoteWatchpointIgnore</h4> | |
| 832 <b>__remoteWatchpointIgnore</b>(<i>cond, count</i>) | |
| 833 <p> | |
| 834 Private method to ignore a watch expression the next couple of | |
| 835 occurrences. | |
| 836 </p><dl> | |
| 837 <dt><i>cond</i></dt> | |
| 838 <dd> | |
| 839 expression of the watch expression (string) | |
| 840 </dd><dt><i>count</i></dt> | |
| 841 <dd> | |
| 842 number of occurrences to ignore (int) | |
| 843 </dd> | |
| 844 </dl><a NAME="DebugServer.__restoreBreakpoints" ID="DebugServer.__restoreBreakpoints"></a> | |
| 845 <h4>DebugServer.__restoreBreakpoints</h4> | |
| 846 <b>__restoreBreakpoints</b>(<i></i>) | |
| 847 <p> | |
| 848 Private method to restore the breakpoints after a restart. | |
| 849 </p><a NAME="DebugServer.__restoreWatchpoints" ID="DebugServer.__restoreWatchpoints"></a> | |
| 850 <h4>DebugServer.__restoreWatchpoints</h4> | |
| 851 <b>__restoreWatchpoints</b>(<i></i>) | |
| 852 <p> | |
| 853 Private method to restore the watch expressions after a restart. | |
| 854 </p><a NAME="DebugServer.__setClientType" ID="DebugServer.__setClientType"></a> | |
| 855 <h4>DebugServer.__setClientType</h4> | |
| 856 <b>__setClientType</b>(<i>clType</i>) | |
| 857 <p> | |
| 858 Private method to set the client type. | |
| 859 </p><dl> | |
| 860 <dt><i>clType</i></dt> | |
| 861 <dd> | |
| 862 type of client to be started (string) | |
| 863 </dd> | |
| 864 </dl><a NAME="DebugServer.__splitWatchCondition" ID="DebugServer.__splitWatchCondition"></a> | |
| 865 <h4>DebugServer.__splitWatchCondition</h4> | |
| 866 <b>__splitWatchCondition</b>(<i>cond</i>) | |
| 867 <p> | |
| 868 Private method to split a remote watch expression. | |
| 869 </p><dl> | |
| 870 <dt><i>cond</i></dt> | |
| 871 <dd> | |
| 872 remote expression (string) | |
| 873 </dd> | |
| 874 </dl><dl> | |
| 875 <dt>Returns:</dt> | |
| 876 <dd> | |
| 877 tuple of local expression (string) and special condition | |
| 878 (string) | |
| 879 </dd> | |
| 880 </dl><a NAME="DebugServer.__watchPointDataAboutToBeChanged" ID="DebugServer.__watchPointDataAboutToBeChanged"></a> | |
| 881 <h4>DebugServer.__watchPointDataAboutToBeChanged</h4> | |
| 882 <b>__watchPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>) | |
| 883 <p> | |
| 884 Private slot to handle the dataAboutToBeChanged signal of the | |
| 885 watch expression model. | |
| 886 </p><dl> | |
| 887 <dt><i>startIndex</i></dt> | |
| 888 <dd> | |
| 889 start index of the rows to be changed (QModelIndex) | |
| 890 </dd><dt><i>endIndex</i></dt> | |
| 891 <dd> | |
| 892 end index of the rows to be changed (QModelIndex) | |
| 893 </dd> | |
| 894 </dl><a NAME="DebugServer.clientUtDiscovered" ID="DebugServer.clientUtDiscovered"></a> | |
| 895 <h4>DebugServer.clientUtDiscovered</h4> | |
| 896 <b>clientUtDiscovered</b>(<i>testCases, exceptionType, exceptionValue</i>) | |
| 897 <p> | |
| 898 Public method to process the client unittest discover info. | |
| 899 </p><dl> | |
| 900 <dt><i>testCases</i> (str)</dt> | |
| 901 <dd> | |
| 902 list of detected test cases | |
| 903 </dd><dt><i>exceptionType</i> (str)</dt> | |
| 904 <dd> | |
| 905 exception type | |
| 906 </dd><dt><i>exceptionValue</i> (str)</dt> | |
| 907 <dd> | |
| 908 exception message | |
| 909 </dd> | |
| 910 </dl><a NAME="DebugServer.clientUtFinished" ID="DebugServer.clientUtFinished"></a> | |
| 911 <h4>DebugServer.clientUtFinished</h4> | |
| 912 <b>clientUtFinished</b>(<i>status</i>) | |
| 913 <p> | |
| 914 Public method to process the client unit test finished info. | |
| 915 </p><dl> | |
| 916 <dt><i>status</i> (int)</dt> | |
| 917 <dd> | |
| 918 exit status of the unit test | |
| 919 </dd> | |
| 920 </dl><a NAME="DebugServer.clientUtPrepared" ID="DebugServer.clientUtPrepared"></a> | |
| 921 <h4>DebugServer.clientUtPrepared</h4> | |
| 922 <b>clientUtPrepared</b>(<i>result, exceptionType, exceptionValue</i>) | |
| 923 <p> | |
| 924 Public method to process the client unittest prepared info. | |
| 925 </p><dl> | |
| 926 <dt><i>result</i></dt> | |
| 927 <dd> | |
| 928 number of test cases (0 = error) (integer) | |
| 929 </dd><dt><i>exceptionType</i></dt> | |
| 930 <dd> | |
| 931 exception type (string) | |
| 932 </dd><dt><i>exceptionValue</i></dt> | |
| 933 <dd> | |
| 934 exception message (string) | |
| 935 </dd> | |
| 936 </dl><a NAME="DebugServer.clientUtStartTest" ID="DebugServer.clientUtStartTest"></a> | |
| 937 <h4>DebugServer.clientUtStartTest</h4> | |
| 938 <b>clientUtStartTest</b>(<i>testname, doc</i>) | |
| 939 <p> | |
| 940 Public method to process the client start test info. | |
| 941 </p><dl> | |
| 942 <dt><i>testname</i></dt> | |
| 943 <dd> | |
| 944 name of the test (string) | |
| 945 </dd><dt><i>doc</i></dt> | |
| 946 <dd> | |
| 947 short description of the test (string) | |
| 948 </dd> | |
| 949 </dl><a NAME="DebugServer.clientUtStopTest" ID="DebugServer.clientUtStopTest"></a> | |
| 950 <h4>DebugServer.clientUtStopTest</h4> | |
| 951 <b>clientUtStopTest</b>(<i></i>) | |
| 952 <p> | |
| 953 Public method to process the client stop test info. | |
| 954 </p><a NAME="DebugServer.clientUtTestErrored" ID="DebugServer.clientUtTestErrored"></a> | |
| 955 <h4>DebugServer.clientUtTestErrored</h4> | |
| 956 <b>clientUtTestErrored</b>(<i>testname, traceback, testId</i>) | |
| 957 <p> | |
| 958 Public method to process the client test errored info. | |
| 959 </p><dl> | |
| 960 <dt><i>testname</i></dt> | |
| 961 <dd> | |
| 962 name of the test (string) | |
| 963 </dd><dt><i>traceback</i></dt> | |
| 964 <dd> | |
| 965 lines of traceback info (list of strings) | |
| 966 </dd><dt><i>testId</i></dt> | |
| 967 <dd> | |
| 968 id of the test (string) | |
| 969 </dd> | |
| 970 </dl><a NAME="DebugServer.clientUtTestFailed" ID="DebugServer.clientUtTestFailed"></a> | |
| 971 <h4>DebugServer.clientUtTestFailed</h4> | |
| 972 <b>clientUtTestFailed</b>(<i>testname, traceback, testId</i>) | |
| 973 <p> | |
| 974 Public method to process the client test failed info. | |
| 975 </p><dl> | |
| 976 <dt><i>testname</i></dt> | |
| 977 <dd> | |
| 978 name of the test (string) | |
| 979 </dd><dt><i>traceback</i></dt> | |
| 980 <dd> | |
| 981 lines of traceback info (list of strings) | |
| 982 </dd><dt><i>testId</i></dt> | |
| 983 <dd> | |
| 984 id of the test (string) | |
| 985 </dd> | |
| 986 </dl><a NAME="DebugServer.clientUtTestFailedExpected" ID="DebugServer.clientUtTestFailedExpected"></a> | |
| 987 <h4>DebugServer.clientUtTestFailedExpected</h4> | |
| 988 <b>clientUtTestFailedExpected</b>(<i>testname, traceback, testId</i>) | |
| 989 <p> | |
| 990 Public method to process the client test failed expected info. | |
| 991 </p><dl> | |
| 992 <dt><i>testname</i></dt> | |
| 993 <dd> | |
| 994 name of the test (string) | |
| 995 </dd><dt><i>traceback</i></dt> | |
| 996 <dd> | |
| 997 lines of traceback info (list of strings) | |
| 998 </dd><dt><i>testId</i></dt> | |
| 999 <dd> | |
| 1000 id of the test (string) | |
| 1001 </dd> | |
| 1002 </dl><a NAME="DebugServer.clientUtTestSkipped" ID="DebugServer.clientUtTestSkipped"></a> | |
| 1003 <h4>DebugServer.clientUtTestSkipped</h4> | |
| 1004 <b>clientUtTestSkipped</b>(<i>testname, reason, testId</i>) | |
| 1005 <p> | |
| 1006 Public method to process the client test skipped info. | |
| 1007 </p><dl> | |
| 1008 <dt><i>testname</i></dt> | |
| 1009 <dd> | |
| 1010 name of the test (string) | |
| 1011 </dd><dt><i>reason</i></dt> | |
| 1012 <dd> | |
| 1013 reason for skipping the test (string) | |
| 1014 </dd><dt><i>testId</i></dt> | |
| 1015 <dd> | |
| 1016 id of the test (string) | |
| 1017 </dd> | |
| 1018 </dl><a NAME="DebugServer.clientUtTestSucceededUnexpected" ID="DebugServer.clientUtTestSucceededUnexpected"></a> | |
| 1019 <h4>DebugServer.clientUtTestSucceededUnexpected</h4> | |
| 1020 <b>clientUtTestSucceededUnexpected</b>(<i>testname, testId</i>) | |
| 1021 <p> | |
| 1022 Public method to process the client test succeeded unexpected info. | |
| 1023 </p><dl> | |
| 1024 <dt><i>testname</i></dt> | |
| 1025 <dd> | |
| 1026 name of the test (string) | |
| 1027 </dd><dt><i>testId</i></dt> | |
| 1028 <dd> | |
| 1029 id of the test (string) | |
| 1030 </dd> | |
| 1031 </dl><a NAME="DebugServer.getBreakPointModel" ID="DebugServer.getBreakPointModel"></a> | |
| 1032 <h4>DebugServer.getBreakPointModel</h4> | |
| 1033 <b>getBreakPointModel</b>(<i></i>) | |
| 1034 <p> | |
| 1035 Public slot to get a reference to the breakpoint model object. | |
| 1036 </p><dl> | |
| 1037 <dt>Returns:</dt> | |
| 1038 <dd> | |
| 1039 reference to the breakpoint model object (BreakPointModel) | |
| 1040 </dd> | |
| 1041 </dl><a NAME="DebugServer.getClientCapabilities" ID="DebugServer.getClientCapabilities"></a> | |
| 1042 <h4>DebugServer.getClientCapabilities</h4> | |
| 1043 <b>getClientCapabilities</b>(<i>clientType</i>) | |
| 1044 <p> | |
| 1045 Public method to retrieve the debug clients capabilities. | |
| 1046 </p><dl> | |
| 1047 <dt><i>clientType</i></dt> | |
| 1048 <dd> | |
| 1049 debug client type (string) | |
| 1050 </dd> | |
| 1051 </dl><dl> | |
| 1052 <dt>Returns:</dt> | |
| 1053 <dd> | |
| 1054 debug client capabilities (integer) | |
| 1055 </dd> | |
| 1056 </dl><a NAME="DebugServer.getClientInterpreter" ID="DebugServer.getClientInterpreter"></a> | |
| 1057 <h4>DebugServer.getClientInterpreter</h4> | |
| 1058 <b>getClientInterpreter</b>(<i></i>) | |
| 1059 <p> | |
| 1060 Public method to get the interpreter of the debug client. | |
| 1061 </p><dl> | |
| 1062 <dt>Returns:</dt> | |
| 1063 <dd> | |
| 1064 interpreter of the debug client (string) | |
| 1065 </dd> | |
| 1066 </dl><a NAME="DebugServer.getClientType" ID="DebugServer.getClientType"></a> | |
| 1067 <h4>DebugServer.getClientType</h4> | |
| 1068 <b>getClientType</b>(<i></i>) | |
| 1069 <p> | |
| 1070 Public method to get the currently running debug client type. | |
| 1071 </p><dl> | |
| 1072 <dt>Returns:</dt> | |
| 1073 <dd> | |
| 1074 debug client type | |
| 1075 </dd> | |
| 1076 </dl><dl> | |
| 1077 <dt>Return Type:</dt> | |
| 1078 <dd> | |
| 1079 str | |
| 1080 </dd> | |
| 1081 </dl><a NAME="DebugServer.getExtensions" ID="DebugServer.getExtensions"></a> | |
| 1082 <h4>DebugServer.getExtensions</h4> | |
| 1083 <b>getExtensions</b>(<i>language</i>) | |
| 1084 <p> | |
| 1085 Public slot to get the extensions associated with the given language. | |
| 1086 </p><dl> | |
| 1087 <dt><i>language</i></dt> | |
| 1088 <dd> | |
| 1089 language to get extensions for (string) | |
| 1090 </dd> | |
| 1091 </dl><dl> | |
| 1092 <dt>Returns:</dt> | |
| 1093 <dd> | |
| 1094 tuple of extensions associated with the language | |
| 1095 (tuple of strings) | |
| 1096 </dd> | |
| 1097 </dl><a NAME="DebugServer.getHostAddress" ID="DebugServer.getHostAddress"></a> | |
| 1098 <h4>DebugServer.getHostAddress</h4> | |
| 1099 <b>getHostAddress</b>(<i>localhost</i>) | |
| 1100 <p> | |
| 1101 Public method to get the IP address or hostname the debug server is | |
| 1102 listening. | |
| 1103 </p><dl> | |
| 1104 <dt><i>localhost</i></dt> | |
| 1105 <dd> | |
| 1106 flag indicating to return the address for localhost | |
| 1107 (boolean) | |
| 1108 </dd> | |
| 1109 </dl><dl> | |
| 1110 <dt>Returns:</dt> | |
| 1111 <dd> | |
| 1112 IP address or hostname (string) | |
| 1113 </dd> | |
| 1114 </dl><a NAME="DebugServer.getSupportedLanguages" ID="DebugServer.getSupportedLanguages"></a> | |
| 1115 <h4>DebugServer.getSupportedLanguages</h4> | |
| 1116 <b>getSupportedLanguages</b>(<i>shellOnly=False</i>) | |
| 1117 <p> | |
| 1118 Public slot to return the supported programming languages. | |
| 1119 </p><dl> | |
| 1120 <dt><i>shellOnly</i></dt> | |
| 1121 <dd> | |
| 1122 flag indicating only languages supporting an | |
| 1123 interactive shell should be returned | |
| 1124 </dd> | |
| 1125 </dl><dl> | |
| 1126 <dt>Returns:</dt> | |
| 1127 <dd> | |
| 1128 list of supported languages (list of strings) | |
| 1129 </dd> | |
| 1130 </dl><a NAME="DebugServer.getWatchPointModel" ID="DebugServer.getWatchPointModel"></a> | |
| 1131 <h4>DebugServer.getWatchPointModel</h4> | |
| 1132 <b>getWatchPointModel</b>(<i></i>) | |
| 1133 <p> | |
| 1134 Public slot to get a reference to the watch expression model object. | |
| 1135 </p><dl> | |
| 1136 <dt>Returns:</dt> | |
| 1137 <dd> | |
| 1138 reference to the watch expression model object | |
| 1139 (WatchPointModel) | |
| 1140 </dd> | |
| 1141 </dl><a NAME="DebugServer.isClientProcessUp" ID="DebugServer.isClientProcessUp"></a> | |
| 1142 <h4>DebugServer.isClientProcessUp</h4> | |
| 1143 <b>isClientProcessUp</b>(<i></i>) | |
| 1144 <p> | |
| 1145 Public method to check, if the debug client process is up. | |
| 1146 </p><dl> | |
| 1147 <dt>Returns:</dt> | |
| 1148 <dd> | |
| 1149 flag indicating a running debug client process | |
| 1150 </dd> | |
| 1151 </dl><dl> | |
| 1152 <dt>Return Type:</dt> | |
| 1153 <dd> | |
| 1154 bool | |
| 1155 </dd> | |
| 1156 </dl><a NAME="DebugServer.isConnected" ID="DebugServer.isConnected"></a> | |
| 1157 <h4>DebugServer.isConnected</h4> | |
| 1158 <b>isConnected</b>(<i></i>) | |
| 1159 <p> | |
| 1160 Public method to test, if the debug server is connected to a backend. | |
| 1161 </p><dl> | |
| 1162 <dt>Returns:</dt> | |
| 1163 <dd> | |
| 1164 flag indicating a connection (boolean) | |
| 1165 </dd> | |
| 1166 </dl><a NAME="DebugServer.isDebugging" ID="DebugServer.isDebugging"></a> | |
| 1167 <h4>DebugServer.isDebugging</h4> | |
| 1168 <b>isDebugging</b>(<i></i>) | |
| 1169 <p> | |
| 1170 Public method to test, if the debug server is debugging. | |
| 1171 </p><dl> | |
| 1172 <dt>Returns:</dt> | |
| 1173 <dd> | |
| 1174 flag indicating the debugging state | |
| 1175 </dd> | |
| 1176 </dl><dl> | |
| 1177 <dt>Return Type:</dt> | |
| 1178 <dd> | |
| 1179 bool | |
| 1180 </dd> | |
| 1181 </dl><a NAME="DebugServer.passiveStartUp" ID="DebugServer.passiveStartUp"></a> | |
| 1182 <h4>DebugServer.passiveStartUp</h4> | |
| 1183 <b>passiveStartUp</b>(<i>fn, exc</i>) | |
| 1184 <p> | |
| 1185 Public method to handle a passive debug connection. | |
| 1186 </p><dl> | |
| 1187 <dt><i>fn</i></dt> | |
| 1188 <dd> | |
| 1189 filename of the debugged script (string) | |
| 1190 </dd><dt><i>exc</i></dt> | |
| 1191 <dd> | |
| 1192 flag to enable exception reporting of the IDE (boolean) | |
| 1193 </dd> | |
| 1194 </dl><a NAME="DebugServer.preferencesChanged" ID="DebugServer.preferencesChanged"></a> | |
| 1195 <h4>DebugServer.preferencesChanged</h4> | |
| 1196 <b>preferencesChanged</b>(<i></i>) | |
| 1197 <p> | |
| 1198 Public slot to handle the preferencesChanged signal. | |
| 1199 </p><a NAME="DebugServer.registerDebuggerInterface" ID="DebugServer.registerDebuggerInterface"></a> | |
| 1200 <h4>DebugServer.registerDebuggerInterface</h4> | |
| 1201 <b>registerDebuggerInterface</b>(<i>interfaceName, getRegistryData, reregister=False</i>) | |
| 1202 <p> | |
| 1203 Public method to register a debugger interface. | |
| 1204 </p><dl> | |
| 1205 <dt><i>interfaceName</i> (str)</dt> | |
| 1206 <dd> | |
| 1207 name of the debugger interface | |
| 1208 </dd><dt><i>getRegistryData</i> (function)</dt> | |
| 1209 <dd> | |
| 1210 reference to a function to be called | |
| 1211 to get the debugger interface details. This method shall | |
| 1212 return the client language, the client capabilities, the | |
| 1213 list of associated file extensions and a function reference | |
| 1214 to create the debugger interface (see __createDebuggerInterface()) | |
| 1215 </dd><dt><i>reregister</i> (bool)</dt> | |
| 1216 <dd> | |
| 1217 flag indicating to re-register the interface | |
| 1218 </dd> | |
| 1219 </dl><a NAME="DebugServer.remoteBanner" ID="DebugServer.remoteBanner"></a> | |
| 1220 <h4>DebugServer.remoteBanner</h4> | |
| 1221 <b>remoteBanner</b>(<i></i>) | |
| 1222 <p> | |
| 1223 Public slot to get the banner info of the remote client. | |
| 1224 </p><a NAME="DebugServer.remoteBreakpoint" ID="DebugServer.remoteBreakpoint"></a> | |
| 1225 <h4>DebugServer.remoteBreakpoint</h4> | |
| 1226 <b>remoteBreakpoint</b>(<i>fn, line, setBreakpoint, cond=None, temp=False</i>) | |
| 1227 <p> | |
| 1228 Public method to set or clear a breakpoint. | |
| 1229 </p><dl> | |
| 1230 <dt><i>fn</i></dt> | |
| 1231 <dd> | |
| 1232 filename the breakpoint belongs to (string) | |
| 1233 </dd><dt><i>line</i></dt> | |
| 1234 <dd> | |
| 1235 linenumber of the breakpoint (int) | |
| 1236 </dd><dt><i>setBreakpoint</i></dt> | |
| 1237 <dd> | |
| 1238 flag indicating setting or resetting a breakpoint | |
| 1239 (boolean) | |
| 1240 </dd><dt><i>cond</i></dt> | |
| 1241 <dd> | |
| 1242 condition of the breakpoint (string) | |
| 1243 </dd><dt><i>temp</i></dt> | |
| 1244 <dd> | |
| 1245 flag indicating a temporary breakpoint (boolean) | |
| 1246 </dd> | |
| 1247 </dl><a NAME="DebugServer.remoteCapabilities" ID="DebugServer.remoteCapabilities"></a> | |
| 1248 <h4>DebugServer.remoteCapabilities</h4> | |
| 1249 <b>remoteCapabilities</b>(<i></i>) | |
| 1250 <p> | |
| 1251 Public slot to get the debug clients capabilities. | |
| 1252 </p><a NAME="DebugServer.remoteClientSetFilter" ID="DebugServer.remoteClientSetFilter"></a> | |
| 1253 <h4>DebugServer.remoteClientSetFilter</h4> | |
| 1254 <b>remoteClientSetFilter</b>(<i>scope, filterStr</i>) | |
| 1255 <p> | |
| 1256 Public method to set a variables filter list. | |
| 1257 </p><dl> | |
| 1258 <dt><i>scope</i></dt> | |
| 1259 <dd> | |
| 1260 the scope of the variables (0 = local, 1 = global) | |
| 1261 </dd><dt><i>filterStr</i></dt> | |
| 1262 <dd> | |
| 1263 regexp string for variable names to filter out | |
| 1264 (string) | |
| 1265 </dd> | |
| 1266 </dl><a NAME="DebugServer.remoteClientVariable" ID="DebugServer.remoteClientVariable"></a> | |
| 1267 <h4>DebugServer.remoteClientVariable</h4> | |
| 1268 <b>remoteClientVariable</b>(<i>scope, filterList, var, framenr=0</i>) | |
| 1269 <p> | |
| 1270 Public method to request the variables of the debugged program. | |
| 1271 </p><dl> | |
| 1272 <dt><i>scope</i></dt> | |
| 1273 <dd> | |
| 1274 the scope of the variables (0 = local, 1 = global) | |
| 1275 </dd><dt><i>filterList</i></dt> | |
| 1276 <dd> | |
| 1277 list of variable types to filter out (list of int) | |
| 1278 </dd><dt><i>var</i></dt> | |
| 1279 <dd> | |
| 1280 list encoded name of variable to retrieve (string) | |
| 1281 </dd><dt><i>framenr</i></dt> | |
| 1282 <dd> | |
| 1283 framenumber of the variables to retrieve (int) | |
| 1284 </dd> | |
| 1285 </dl><a NAME="DebugServer.remoteClientVariables" ID="DebugServer.remoteClientVariables"></a> | |
| 1286 <h4>DebugServer.remoteClientVariables</h4> | |
| 1287 <b>remoteClientVariables</b>(<i>scope, filterList, framenr=0</i>) | |
| 1288 <p> | |
| 1289 Public method to request the variables of the debugged program. | |
| 1290 </p><dl> | |
| 1291 <dt><i>scope</i></dt> | |
| 1292 <dd> | |
| 1293 the scope of the variables (0 = local, 1 = global) | |
| 1294 </dd><dt><i>filterList</i></dt> | |
| 1295 <dd> | |
| 1296 list of variable types to filter out (list of int) | |
| 1297 </dd><dt><i>framenr</i></dt> | |
| 1298 <dd> | |
| 1299 framenumber of the variables to retrieve (int) | |
| 1300 </dd> | |
| 1301 </dl><a NAME="DebugServer.remoteCompletion" ID="DebugServer.remoteCompletion"></a> | |
| 1302 <h4>DebugServer.remoteCompletion</h4> | |
| 1303 <b>remoteCompletion</b>(<i>text</i>) | |
| 1304 <p> | |
| 1305 Public slot to get the a list of possible commandline completions | |
| 1306 from the remote client. | |
| 1307 </p><dl> | |
| 1308 <dt><i>text</i></dt> | |
| 1309 <dd> | |
| 1310 the text to be completed (string) | |
| 1311 </dd> | |
| 1312 </dl><a NAME="DebugServer.remoteContinue" ID="DebugServer.remoteContinue"></a> | |
| 1313 <h4>DebugServer.remoteContinue</h4> | |
| 1314 <b>remoteContinue</b>(<i>special=False</i>) | |
| 1315 <p> | |
| 1316 Public method to continue the debugged program. | |
| 1317 </p><dl> | |
| 1318 <dt><i>special</i></dt> | |
| 1319 <dd> | |
| 1320 flag indicating a special continue operation | |
| 1321 </dd> | |
| 1322 </dl><a NAME="DebugServer.remoteCoverage" ID="DebugServer.remoteCoverage"></a> | |
| 1323 <h4>DebugServer.remoteCoverage</h4> | |
| 1324 <b>remoteCoverage</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>) | |
| 1325 <p> | |
| 1326 Public method to load a new program to collect coverage data. | |
| 1327 </p><dl> | |
| 1328 <dt><i>venvName</i> (str)</dt> | |
| 1329 <dd> | |
| 1330 name of the virtual environment to be used | |
| 1331 </dd><dt><i>fn</i> (str)</dt> | |
| 1332 <dd> | |
| 1333 the filename to debug | |
| 1334 </dd><dt><i>argv</i> (str)</dt> | |
| 1335 <dd> | |
| 1336 the command line arguments to pass to the program | |
| 1337 </dd><dt><i>wd</i> (str)</dt> | |
| 1338 <dd> | |
| 1339 the working directory for the program | |
| 1340 </dd><dt><i>env</i> (str)</dt> | |
| 1341 <dd> | |
| 1342 environment parameter settings | |
| 1343 </dd><dt><i>autoClearShell=</i> (bool)</dt> | |
| 1344 <dd> | |
| 1345 flag indicating, that the interpreter window | |
| 1346 should be cleared | |
| 1347 </dd><dt><i>erase=</i> (bool)</dt> | |
| 1348 <dd> | |
| 1349 flag indicating that coverage info should be | |
| 1350 cleared first | |
| 1351 </dd><dt><i>forProject=</i> (bool)</dt> | |
| 1352 <dd> | |
| 1353 flag indicating a project related action | |
| 1354 </dd><dt><i>runInConsole=</i> (bool)</dt> | |
| 1355 <dd> | |
| 1356 flag indicating to start the debugger in a | |
| 1357 console window | |
| 1358 </dd><dt><i>clientType=</i> (str)</dt> | |
| 1359 <dd> | |
| 1360 client type to be used | |
| 1361 </dd> | |
| 1362 </dl><a NAME="DebugServer.remoteEnvironment" ID="DebugServer.remoteEnvironment"></a> | |
| 1363 <h4>DebugServer.remoteEnvironment</h4> | |
| 1364 <b>remoteEnvironment</b>(<i>env</i>) | |
| 1365 <p> | |
| 1366 Public method to set the environment for a program to debug, run, ... | |
| 1367 </p><dl> | |
| 1368 <dt><i>env</i></dt> | |
| 1369 <dd> | |
| 1370 environment settings (string) | |
| 1371 </dd> | |
| 1372 </dl><a NAME="DebugServer.remoteLoad" ID="DebugServer.remoteLoad"></a> | |
| 1373 <h4>DebugServer.remoteLoad</h4> | |
| 1374 <b>remoteLoad</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, tracePython=False, autoContinue=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType="", enableCallTrace=False</i>) | |
| 1375 <p> | |
| 1376 Public method to load a new program to debug. | |
| 1377 </p><dl> | |
| 1378 <dt><i>venvName</i> (str)</dt> | |
| 1379 <dd> | |
| 1380 name of the virtual environment to be used | |
| 1381 </dd><dt><i>fn</i> (str)</dt> | |
| 1382 <dd> | |
| 1383 the filename to debug | |
| 1384 </dd><dt><i>argv</i> (str)</dt> | |
| 1385 <dd> | |
| 1386 the command line arguments to pass to the program | |
| 1387 </dd><dt><i>wd</i> (str)</dt> | |
| 1388 <dd> | |
| 1389 the working directory for the program | |
| 1390 </dd><dt><i>env</i> (str)</dt> | |
| 1391 <dd> | |
| 1392 environment parameter settings | |
| 1393 </dd><dt><i>autoClearShell=</i> (bool)</dt> | |
| 1394 <dd> | |
| 1395 flag indicating, that the interpreter window | |
| 1396 should be cleared | |
| 1397 </dd><dt><i>tracePython=</i> (bool)</dt> | |
| 1398 <dd> | |
| 1399 flag indicating if the Python library should be | |
| 1400 traced as well | |
| 1401 </dd><dt><i>autoContinue=</i> (bool)</dt> | |
| 1402 <dd> | |
| 1403 flag indicating, that the debugger should not | |
| 1404 stop at the first executable line | |
| 1405 </dd><dt><i>forProject=</i> (bool)</dt> | |
| 1406 <dd> | |
| 1407 flag indicating a project related action | |
| 1408 </dd><dt><i>runInConsole=</i> (bool)</dt> | |
| 1409 <dd> | |
| 1410 flag indicating to start the debugger in a | |
| 1411 console window | |
| 1412 </dd><dt><i>autoFork=</i> (bool)</dt> | |
| 1413 <dd> | |
| 1414 flag indicating the automatic fork mode | |
| 1415 </dd><dt><i>forkChild=</i> (bool)</dt> | |
| 1416 <dd> | |
| 1417 flag indicating to debug the child after forking | |
| 1418 </dd><dt><i>clientType=</i> (str)</dt> | |
| 1419 <dd> | |
| 1420 client type to be used | |
| 1421 </dd><dt><i>enableCallTrace=</i> (bool)</dt> | |
| 1422 <dd> | |
| 1423 flag indicating to enable the call trace | |
| 1424 function | |
| 1425 </dd> | |
| 1426 </dl><a NAME="DebugServer.remoteMoveIP" ID="DebugServer.remoteMoveIP"></a> | |
| 1427 <h4>DebugServer.remoteMoveIP</h4> | |
| 1428 <b>remoteMoveIP</b>(<i>line</i>) | |
| 1429 <p> | |
| 1430 Public method to move the instruction pointer to a different line. | |
| 1431 </p><dl> | |
| 1432 <dt><i>line</i></dt> | |
| 1433 <dd> | |
| 1434 the new line, where execution should be continued | |
| 1435 </dd> | |
| 1436 </dl><a NAME="DebugServer.remoteProfile" ID="DebugServer.remoteProfile"></a> | |
| 1437 <h4>DebugServer.remoteProfile</h4> | |
| 1438 <b>remoteProfile</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, erase=False, forProject=False, runInConsole=False, clientType=""</i>) | |
| 1439 <p> | |
| 1440 Public method to load a new program to collect profiling data. | |
| 1441 </p><dl> | |
| 1442 <dt><i>venvName</i> (str)</dt> | |
| 1443 <dd> | |
| 1444 name of the virtual environment to be used | |
| 1445 </dd><dt><i>fn</i> (str)</dt> | |
| 1446 <dd> | |
| 1447 the filename to debug | |
| 1448 </dd><dt><i>argv</i> (str)</dt> | |
| 1449 <dd> | |
| 1450 the command line arguments to pass to the program | |
| 1451 </dd><dt><i>wd</i> (str)</dt> | |
| 1452 <dd> | |
| 1453 the working directory for the program | |
| 1454 </dd><dt><i>env</i> (str)</dt> | |
| 1455 <dd> | |
| 1456 environment parameter settings | |
| 1457 </dd><dt><i>autoClearShell=</i> (bool)</dt> | |
| 1458 <dd> | |
| 1459 flag indicating, that the interpreter window | |
| 1460 should be cleared | |
| 1461 </dd><dt><i>erase=</i> (bool)</dt> | |
| 1462 <dd> | |
| 1463 flag indicating that coverage info should be | |
| 1464 cleared first | |
| 1465 </dd><dt><i>forProject=</i> (bool)</dt> | |
| 1466 <dd> | |
| 1467 flag indicating a project related action | |
| 1468 </dd><dt><i>runInConsole=</i> (bool)</dt> | |
| 1469 <dd> | |
| 1470 flag indicating to start the debugger in a | |
| 1471 console window | |
| 1472 </dd><dt><i>clientType=</i> (str)</dt> | |
| 1473 <dd> | |
| 1474 client type to be used | |
| 1475 </dd> | |
| 1476 </dl><a NAME="DebugServer.remoteRawInput" ID="DebugServer.remoteRawInput"></a> | |
| 1477 <h4>DebugServer.remoteRawInput</h4> | |
| 1478 <b>remoteRawInput</b>(<i>s</i>) | |
| 1479 <p> | |
| 1480 Public method to send the raw input to the debugged program. | |
| 1481 </p><dl> | |
| 1482 <dt><i>s</i></dt> | |
| 1483 <dd> | |
| 1484 the raw input (string) | |
| 1485 </dd> | |
| 1486 </dl><a NAME="DebugServer.remoteRun" ID="DebugServer.remoteRun"></a> | |
| 1487 <h4>DebugServer.remoteRun</h4> | |
| 1488 <b>remoteRun</b>(<i>venvName, fn, argv, wd, env, autoClearShell=True, forProject=False, runInConsole=False, autoFork=False, forkChild=False, clientType=""</i>) | |
| 1489 <p> | |
| 1490 Public method to load a new program to run. | |
| 1491 </p><dl> | |
| 1492 <dt><i>venvName</i> (str)</dt> | |
| 1493 <dd> | |
| 1494 name of the virtual environment to be used | |
| 1495 </dd><dt><i>fn</i> (str)</dt> | |
| 1496 <dd> | |
| 1497 the filename to debug | |
| 1498 </dd><dt><i>argv</i> (str)</dt> | |
| 1499 <dd> | |
| 1500 the command line arguments to pass to the program | |
| 1501 </dd><dt><i>wd</i> (str)</dt> | |
| 1502 <dd> | |
| 1503 the working directory for the program | |
| 1504 </dd><dt><i>env</i> (str)</dt> | |
| 1505 <dd> | |
| 1506 environment parameter settings | |
| 1507 </dd><dt><i>autoClearShell=</i> (bool)</dt> | |
| 1508 <dd> | |
| 1509 flag indicating, that the interpreter window | |
| 1510 should be cleared | |
| 1511 </dd><dt><i>forProject=</i> (bool)</dt> | |
| 1512 <dd> | |
| 1513 flag indicating a project related action | |
| 1514 </dd><dt><i>runInConsole=</i> (bool)</dt> | |
| 1515 <dd> | |
| 1516 flag indicating to start the debugger in a | |
| 1517 console window | |
| 1518 </dd><dt><i>autoFork=</i> (bool)</dt> | |
| 1519 <dd> | |
| 1520 flag indicating the automatic fork mode | |
| 1521 </dd><dt><i>forkChild=</i> (bool)</dt> | |
| 1522 <dd> | |
| 1523 flag indicating to debug the child after forking | |
| 1524 </dd><dt><i>clientType=</i> (str)</dt> | |
| 1525 <dd> | |
| 1526 client type to be used | |
| 1527 </dd> | |
| 1528 </dl><a NAME="DebugServer.remoteSetThread" ID="DebugServer.remoteSetThread"></a> | |
| 1529 <h4>DebugServer.remoteSetThread</h4> | |
| 1530 <b>remoteSetThread</b>(<i>tid</i>) | |
| 1531 <p> | |
| 1532 Public method to request to set the given thread as current thread. | |
| 1533 </p><dl> | |
| 1534 <dt><i>tid</i></dt> | |
| 1535 <dd> | |
| 1536 id of the thread (integer) | |
| 1537 </dd> | |
| 1538 </dl><a NAME="DebugServer.remoteStatement" ID="DebugServer.remoteStatement"></a> | |
| 1539 <h4>DebugServer.remoteStatement</h4> | |
| 1540 <b>remoteStatement</b>(<i>stmt</i>) | |
| 1541 <p> | |
| 1542 Public method to execute a Python statement. | |
| 1543 </p><dl> | |
| 1544 <dt><i>stmt</i></dt> | |
| 1545 <dd> | |
| 1546 the Python statement to execute (string). It | |
| 1547 should not have a trailing newline. | |
| 1548 </dd> | |
| 1549 </dl><a NAME="DebugServer.remoteStep" ID="DebugServer.remoteStep"></a> | |
| 1550 <h4>DebugServer.remoteStep</h4> | |
| 1551 <b>remoteStep</b>(<i></i>) | |
| 1552 <p> | |
| 1553 Public method to single step the debugged program. | |
| 1554 </p><a NAME="DebugServer.remoteStepOut" ID="DebugServer.remoteStepOut"></a> | |
| 1555 <h4>DebugServer.remoteStepOut</h4> | |
| 1556 <b>remoteStepOut</b>(<i></i>) | |
| 1557 <p> | |
| 1558 Public method to step out the debugged program. | |
| 1559 </p><a NAME="DebugServer.remoteStepOver" ID="DebugServer.remoteStepOver"></a> | |
| 1560 <h4>DebugServer.remoteStepOver</h4> | |
| 1561 <b>remoteStepOver</b>(<i></i>) | |
| 1562 <p> | |
| 1563 Public method to step over the debugged program. | |
| 1564 </p><a NAME="DebugServer.remoteStepQuit" ID="DebugServer.remoteStepQuit"></a> | |
| 1565 <h4>DebugServer.remoteStepQuit</h4> | |
| 1566 <b>remoteStepQuit</b>(<i></i>) | |
| 1567 <p> | |
| 1568 Public method to stop the debugged program. | |
| 1569 </p><a NAME="DebugServer.remoteThreadList" ID="DebugServer.remoteThreadList"></a> | |
| 1570 <h4>DebugServer.remoteThreadList</h4> | |
| 1571 <b>remoteThreadList</b>(<i></i>) | |
| 1572 <p> | |
| 1573 Public method to request the list of threads from the client. | |
| 1574 </p><a NAME="DebugServer.remoteUTDiscover" ID="DebugServer.remoteUTDiscover"></a> | |
| 1575 <h4>DebugServer.remoteUTDiscover</h4> | |
| 1576 <b>remoteUTDiscover</b>(<i>clientType, forProject, venvName, syspath, workdir, discoveryStart</i>) | |
| 1577 <p> | |
| 1578 Public method to perform a test case discovery. | |
| 1579 </p><dl> | |
| 1580 <dt><i>clientType</i> (str)</dt> | |
| 1581 <dd> | |
| 1582 client type to be used | |
| 1583 </dd><dt><i>forProject</i> (bool)</dt> | |
| 1584 <dd> | |
| 1585 flag indicating a project related action | |
| 1586 </dd><dt><i>venvName</i> (str)</dt> | |
| 1587 <dd> | |
| 1588 name of a virtual environment | |
| 1589 </dd><dt><i>syspath</i> (list of str)</dt> | |
| 1590 <dd> | |
| 1591 list of directories to be added to sys.path on the | |
| 1592 remote side | |
| 1593 </dd><dt><i>workdir</i> (str)</dt> | |
| 1594 <dd> | |
| 1595 path name of the working directory | |
| 1596 </dd><dt><i>discoveryStart</i> (str)</dt> | |
| 1597 <dd> | |
| 1598 directory to start auto-discovery at | |
| 1599 </dd> | |
| 1600 </dl><a NAME="DebugServer.remoteUTPrepare" ID="DebugServer.remoteUTPrepare"></a> | |
| 1601 <h4>DebugServer.remoteUTPrepare</h4> | |
| 1602 <b>remoteUTPrepare</b>(<i>fn, tn, tfn, failed, cov, covname, coverase, clientType="", forProject=False, venvName="", syspath=None, workdir="", discover=False, discoveryStart="", testCases=None, debug=False</i>) | |
| 1603 <p> | |
| 1604 Public method to prepare a new unittest run. | |
| 1605 </p><dl> | |
| 1606 <dt><i>fn</i> (str)</dt> | |
| 1607 <dd> | |
| 1608 the filename to load | |
| 1609 </dd><dt><i>tn</i> (str)</dt> | |
| 1610 <dd> | |
| 1611 the testname to load | |
| 1612 </dd><dt><i>tfn</i> (str)</dt> | |
| 1613 <dd> | |
| 1614 the test function name to load tests from | |
| 1615 </dd><dt><i>failed</i> (list of str)</dt> | |
| 1616 <dd> | |
| 1617 list of failed test, if only failed test should be run | |
| 1618 </dd><dt><i>cov</i> (bool)</dt> | |
| 1619 <dd> | |
| 1620 flag indicating collection of coverage data is requested | |
| 1621 </dd><dt><i>covname</i> (str)</dt> | |
| 1622 <dd> | |
| 1623 filename to be used to assemble the coverage caches | |
| 1624 filename | |
| 1625 </dd><dt><i>coverase</i> (bool)</dt> | |
| 1626 <dd> | |
| 1627 flag indicating erasure of coverage data is requested | |
| 1628 </dd><dt><i>clientType</i> (str)</dt> | |
| 1629 <dd> | |
| 1630 client type to be used | |
| 1631 </dd><dt><i>forProject</i> (bool)</dt> | |
| 1632 <dd> | |
| 1633 flag indicating a project related action | |
| 1634 </dd><dt><i>venvName</i> (str)</dt> | |
| 1635 <dd> | |
| 1636 name of a virtual environment | |
| 1637 </dd><dt><i>syspath</i> (list of str)</dt> | |
| 1638 <dd> | |
| 1639 list of directories to be added to sys.path on the | |
| 1640 remote side | |
| 1641 </dd><dt><i>workdir</i> (str)</dt> | |
| 1642 <dd> | |
| 1643 path name of the working directory | |
| 1644 </dd><dt><i>discover</i> (bool)</dt> | |
| 1645 <dd> | |
| 1646 flag indicating to discover the tests automatically | |
| 1647 </dd><dt><i>discoveryStart</i> (str)</dt> | |
| 1648 <dd> | |
| 1649 directory to start auto-discovery at | |
| 1650 </dd><dt><i>testCases</i> (list of str)</dt> | |
| 1651 <dd> | |
| 1652 list of test cases to be loaded | |
| 1653 </dd><dt><i>debug</i> (bool)</dt> | |
| 1654 <dd> | |
| 1655 flag indicating to run unittest with debugging | |
| 1656 </dd> | |
| 1657 </dl><a NAME="DebugServer.remoteUTRun" ID="DebugServer.remoteUTRun"></a> | |
| 1658 <h4>DebugServer.remoteUTRun</h4> | |
| 1659 <b>remoteUTRun</b>(<i>debug=False, failfast=False</i>) | |
| 1660 <p> | |
| 1661 Public method to start a unittest run. | |
| 1662 </p><dl> | |
| 1663 <dt><i>debug</i> (bool)</dt> | |
| 1664 <dd> | |
| 1665 flag indicating to run unittest with debugging | |
| 1666 </dd><dt><i>failfast</i> (bool)</dt> | |
| 1667 <dd> | |
| 1668 flag indicating to stop at the first error | |
| 1669 </dd> | |
| 1670 </dl><a NAME="DebugServer.remoteUTStop" ID="DebugServer.remoteUTStop"></a> | |
| 1671 <h4>DebugServer.remoteUTStop</h4> | |
| 1672 <b>remoteUTStop</b>(<i></i>) | |
| 1673 <p> | |
| 1674 public method to stop a unittest run. | |
| 1675 </p><a NAME="DebugServer.setCallTraceEnabled" ID="DebugServer.setCallTraceEnabled"></a> | |
| 1676 <h4>DebugServer.setCallTraceEnabled</h4> | |
| 1677 <b>setCallTraceEnabled</b>(<i>on</i>) | |
| 1678 <p> | |
| 1679 Public method to set the call trace state. | |
| 1680 </p><dl> | |
| 1681 <dt><i>on</i></dt> | |
| 1682 <dd> | |
| 1683 flag indicating to enable the call trace function (boolean) | |
| 1684 </dd> | |
| 1685 </dl><a NAME="DebugServer.setDebugging" ID="DebugServer.setDebugging"></a> | |
| 1686 <h4>DebugServer.setDebugging</h4> | |
| 1687 <b>setDebugging</b>(<i>on</i>) | |
| 1688 <p> | |
| 1689 Public method to set the debugging state. | |
| 1690 </p><dl> | |
| 1691 <dt><i>on</i> (bool)</dt> | |
| 1692 <dd> | |
| 1693 flag indicating the new debugging state | |
| 1694 </dd> | |
| 1695 </dl><a NAME="DebugServer.shutdownServer" ID="DebugServer.shutdownServer"></a> | |
| 1696 <h4>DebugServer.shutdownServer</h4> | |
| 1697 <b>shutdownServer</b>(<i></i>) | |
| 1698 <p> | |
| 1699 Public method to cleanly shut down. | |
| 1700 </p><p> | |
| 1701 It closes our socket and shuts down | |
| 1702 the debug client. (Needed on Win OS) | |
| 1703 </p><a NAME="DebugServer.signalClientBanner" ID="DebugServer.signalClientBanner"></a> | |
| 1704 <h4>DebugServer.signalClientBanner</h4> | |
| 1705 <b>signalClientBanner</b>(<i>version, platform, debugClient, venvName</i>) | |
| 1706 <p> | |
| 1707 Public method to process the client banner info. | |
| 1708 </p><dl> | |
| 1709 <dt><i>version</i> (str)</dt> | |
| 1710 <dd> | |
| 1711 interpreter version info | |
| 1712 </dd><dt><i>platform</i> (str)</dt> | |
| 1713 <dd> | |
| 1714 hostname of the client | |
| 1715 </dd><dt><i>debugClient</i> (str)</dt> | |
| 1716 <dd> | |
| 1717 additional debugger type info | |
| 1718 </dd><dt><i>venvName</i> (str)</dt> | |
| 1719 <dd> | |
| 1720 name of the virtual environment | |
| 1721 </dd> | |
| 1722 </dl><a NAME="DebugServer.signalClientBreakConditionError" ID="DebugServer.signalClientBreakConditionError"></a> | |
| 1723 <h4>DebugServer.signalClientBreakConditionError</h4> | |
| 1724 <b>signalClientBreakConditionError</b>(<i>filename, lineno</i>) | |
| 1725 <p> | |
| 1726 Public method to process the client breakpoint condition error info. | |
| 1727 </p><dl> | |
| 1728 <dt><i>filename</i></dt> | |
| 1729 <dd> | |
| 1730 filename of the breakpoint (string) | |
| 1731 </dd><dt><i>lineno</i></dt> | |
| 1732 <dd> | |
| 1733 line umber of the breakpoint (integer) | |
| 1734 </dd> | |
| 1735 </dl><a NAME="DebugServer.signalClientCallTrace" ID="DebugServer.signalClientCallTrace"></a> | |
| 1736 <h4>DebugServer.signalClientCallTrace</h4> | |
| 1737 <b>signalClientCallTrace</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>) | |
| 1738 <p> | |
| 1739 Public method to process the client call trace data. | |
| 1740 </p><dl> | |
| 1741 <dt><i>isCall</i></dt> | |
| 1742 <dd> | |
| 1743 flag indicating a 'call' (boolean) | |
| 1744 </dd><dt><i>fromFile</i></dt> | |
| 1745 <dd> | |
| 1746 name of the originating file (string) | |
| 1747 </dd><dt><i>fromLine</i></dt> | |
| 1748 <dd> | |
| 1749 line number in the originating file (string) | |
| 1750 </dd><dt><i>fromFunction</i></dt> | |
| 1751 <dd> | |
| 1752 name of the originating function (string) | |
| 1753 </dd><dt><i>toFile</i></dt> | |
| 1754 <dd> | |
| 1755 name of the target file (string) | |
| 1756 </dd><dt><i>toLine</i></dt> | |
| 1757 <dd> | |
| 1758 line number in the target file (string) | |
| 1759 </dd><dt><i>toFunction</i></dt> | |
| 1760 <dd> | |
| 1761 name of the target function (string) | |
| 1762 </dd> | |
| 1763 </dl><a NAME="DebugServer.signalClientCapabilities" ID="DebugServer.signalClientCapabilities"></a> | |
| 1764 <h4>DebugServer.signalClientCapabilities</h4> | |
| 1765 <b>signalClientCapabilities</b>(<i>capabilities, clientType, venvName</i>) | |
| 1766 <p> | |
| 1767 Public method to process the client capabilities info. | |
| 1768 </p><dl> | |
| 1769 <dt><i>capabilities</i> (int)</dt> | |
| 1770 <dd> | |
| 1771 bitmaks with the client capabilities | |
| 1772 </dd><dt><i>clientType</i> (str)</dt> | |
| 1773 <dd> | |
| 1774 type of the debug client | |
| 1775 </dd><dt><i>venvName</i> (str)</dt> | |
| 1776 <dd> | |
| 1777 name of the virtual environment | |
| 1778 </dd> | |
| 1779 </dl><a NAME="DebugServer.signalClientClearBreak" ID="DebugServer.signalClientClearBreak"></a> | |
| 1780 <h4>DebugServer.signalClientClearBreak</h4> | |
| 1781 <b>signalClientClearBreak</b>(<i>filename, lineno</i>) | |
| 1782 <p> | |
| 1783 Public method to process the client clear breakpoint command. | |
| 1784 </p><dl> | |
| 1785 <dt><i>filename</i></dt> | |
| 1786 <dd> | |
| 1787 filename of the breakpoint (string) | |
| 1788 </dd><dt><i>lineno</i></dt> | |
| 1789 <dd> | |
| 1790 line umber of the breakpoint (integer) | |
| 1791 </dd> | |
| 1792 </dl><a NAME="DebugServer.signalClientClearWatch" ID="DebugServer.signalClientClearWatch"></a> | |
| 1793 <h4>DebugServer.signalClientClearWatch</h4> | |
| 1794 <b>signalClientClearWatch</b>(<i>condition</i>) | |
| 1795 <p> | |
| 1796 Public slot to handle the clientClearWatch signal. | |
| 1797 </p><dl> | |
| 1798 <dt><i>condition</i></dt> | |
| 1799 <dd> | |
| 1800 expression of watch expression to clear (string) | |
| 1801 </dd> | |
| 1802 </dl><a NAME="DebugServer.signalClientCompletionList" ID="DebugServer.signalClientCompletionList"></a> | |
| 1803 <h4>DebugServer.signalClientCompletionList</h4> | |
| 1804 <b>signalClientCompletionList</b>(<i>completionList, text</i>) | |
| 1805 <p> | |
| 1806 Public method to process the client auto completion info. | |
| 1807 </p><dl> | |
| 1808 <dt><i>completionList</i></dt> | |
| 1809 <dd> | |
| 1810 list of possible completions (list of strings) | |
| 1811 </dd><dt><i>text</i></dt> | |
| 1812 <dd> | |
| 1813 the text to be completed (string) | |
| 1814 </dd> | |
| 1815 </dl><a NAME="DebugServer.signalClientException" ID="DebugServer.signalClientException"></a> | |
| 1816 <h4>DebugServer.signalClientException</h4> | |
| 1817 <b>signalClientException</b>(<i>exceptionType, exceptionMessage, stackTrace</i>) | |
| 1818 <p> | |
| 1819 Public method to process the exception info from the client. | |
| 1820 </p><dl> | |
| 1821 <dt><i>exceptionType</i></dt> | |
| 1822 <dd> | |
| 1823 type of exception raised (string) | |
| 1824 </dd><dt><i>exceptionMessage</i></dt> | |
| 1825 <dd> | |
| 1826 message given by the exception (string) | |
| 1827 </dd><dt><i>stackTrace</i></dt> | |
| 1828 <dd> | |
| 1829 list of stack entries with the exception position | |
| 1830 first. Each stack entry is a list giving the filename and the | |
| 1831 linenumber. | |
| 1832 </dd> | |
| 1833 </dl><a NAME="DebugServer.signalClientExit" ID="DebugServer.signalClientExit"></a> | |
| 1834 <h4>DebugServer.signalClientExit</h4> | |
| 1835 <b>signalClientExit</b>(<i>status, message=""</i>) | |
| 1836 <p> | |
| 1837 Public method to process the client exit status. | |
| 1838 </p><dl> | |
| 1839 <dt><i>status</i> (int)</dt> | |
| 1840 <dd> | |
| 1841 exit code | |
| 1842 </dd><dt><i>message</i> (str)</dt> | |
| 1843 <dd> | |
| 1844 message sent with the exit | |
| 1845 </dd> | |
| 1846 </dl><a NAME="DebugServer.signalClientLine" ID="DebugServer.signalClientLine"></a> | |
| 1847 <h4>DebugServer.signalClientLine</h4> | |
| 1848 <b>signalClientLine</b>(<i>filename, lineno, forStack=False</i>) | |
| 1849 <p> | |
| 1850 Public method to process client position feedback. | |
| 1851 </p><dl> | |
| 1852 <dt><i>filename</i></dt> | |
| 1853 <dd> | |
| 1854 name of the file currently being executed (string) | |
| 1855 </dd><dt><i>lineno</i></dt> | |
| 1856 <dd> | |
| 1857 line of code currently being executed (integer) | |
| 1858 </dd><dt><i>forStack</i></dt> | |
| 1859 <dd> | |
| 1860 flag indicating this is for a stack dump (boolean) | |
| 1861 </dd> | |
| 1862 </dl><a NAME="DebugServer.signalClientOutput" ID="DebugServer.signalClientOutput"></a> | |
| 1863 <h4>DebugServer.signalClientOutput</h4> | |
| 1864 <b>signalClientOutput</b>(<i>line</i>) | |
| 1865 <p> | |
| 1866 Public method to process a line of client output. | |
| 1867 </p><dl> | |
| 1868 <dt><i>line</i></dt> | |
| 1869 <dd> | |
| 1870 client output (string) | |
| 1871 </dd> | |
| 1872 </dl><a NAME="DebugServer.signalClientRawInput" ID="DebugServer.signalClientRawInput"></a> | |
| 1873 <h4>DebugServer.signalClientRawInput</h4> | |
| 1874 <b>signalClientRawInput</b>(<i>prompt, echo</i>) | |
| 1875 <p> | |
| 1876 Public method to process the client raw input command. | |
| 1877 </p><dl> | |
| 1878 <dt><i>prompt</i></dt> | |
| 1879 <dd> | |
| 1880 the input prompt (string) | |
| 1881 </dd><dt><i>echo</i></dt> | |
| 1882 <dd> | |
| 1883 flag indicating an echoing of the input (boolean) | |
| 1884 </dd> | |
| 1885 </dl><a NAME="DebugServer.signalClientSignal" ID="DebugServer.signalClientSignal"></a> | |
| 1886 <h4>DebugServer.signalClientSignal</h4> | |
| 1887 <b>signalClientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs</i>) | |
| 1888 <p> | |
| 1889 Public method to process a signal generated on the client side. | |
| 1890 </p><dl> | |
| 1891 <dt><i>message</i> (str)</dt> | |
| 1892 <dd> | |
| 1893 message of the syntax error | |
| 1894 </dd><dt><i>filename</i> (str)</dt> | |
| 1895 <dd> | |
| 1896 translated filename of the syntax error position | |
| 1897 </dd><dt><i>lineNo</i> (int)</dt> | |
| 1898 <dd> | |
| 1899 line number of the syntax error position | |
| 1900 </dd><dt><i>funcName</i> (str)</dt> | |
| 1901 <dd> | |
| 1902 name of the function causing the signal | |
| 1903 </dd><dt><i>funcArgs</i> (str)</dt> | |
| 1904 <dd> | |
| 1905 function arguments | |
| 1906 </dd> | |
| 1907 </dl><a NAME="DebugServer.signalClientStack" ID="DebugServer.signalClientStack"></a> | |
| 1908 <h4>DebugServer.signalClientStack</h4> | |
| 1909 <b>signalClientStack</b>(<i>stack</i>) | |
| 1910 <p> | |
| 1911 Public method to process a client's stack information. | |
| 1912 </p><dl> | |
| 1913 <dt><i>stack</i></dt> | |
| 1914 <dd> | |
| 1915 list of stack entries. Each entry is a tuple of three | |
| 1916 values giving the filename, linenumber and method | |
| 1917 (list of lists of (string, integer, string)) | |
| 1918 </dd> | |
| 1919 </dl><a NAME="DebugServer.signalClientStatement" ID="DebugServer.signalClientStatement"></a> | |
| 1920 <h4>DebugServer.signalClientStatement</h4> | |
| 1921 <b>signalClientStatement</b>(<i>more</i>) | |
| 1922 <p> | |
| 1923 Public method to process the input response from the client. | |
| 1924 </p><dl> | |
| 1925 <dt><i>more</i></dt> | |
| 1926 <dd> | |
| 1927 flag indicating that more user input is required | |
| 1928 </dd> | |
| 1929 </dl><a NAME="DebugServer.signalClientSyntaxError" ID="DebugServer.signalClientSyntaxError"></a> | |
| 1930 <h4>DebugServer.signalClientSyntaxError</h4> | |
| 1931 <b>signalClientSyntaxError</b>(<i>message, filename, lineNo, characterNo</i>) | |
| 1932 <p> | |
| 1933 Public method to process the syntax error info from the client. | |
| 1934 </p><dl> | |
| 1935 <dt><i>message</i></dt> | |
| 1936 <dd> | |
| 1937 message of the syntax error (string) | |
| 1938 </dd><dt><i>filename</i></dt> | |
| 1939 <dd> | |
| 1940 translated filename of the syntax error position | |
| 1941 (string) | |
| 1942 </dd><dt><i>lineNo</i></dt> | |
| 1943 <dd> | |
| 1944 line number of the syntax error position (integer) | |
| 1945 </dd><dt><i>characterNo</i></dt> | |
| 1946 <dd> | |
| 1947 character number of the syntax error position | |
| 1948 (integer) | |
| 1949 </dd> | |
| 1950 </dl><a NAME="DebugServer.signalClientThreadList" ID="DebugServer.signalClientThreadList"></a> | |
| 1951 <h4>DebugServer.signalClientThreadList</h4> | |
| 1952 <b>signalClientThreadList</b>(<i>currentId, threadList</i>) | |
| 1953 <p> | |
| 1954 Public method to process the client thread list info. | |
| 1955 </p><dl> | |
| 1956 <dt><i>currentId</i></dt> | |
| 1957 <dd> | |
| 1958 id of the current thread (integer) | |
| 1959 </dd><dt><i>threadList</i></dt> | |
| 1960 <dd> | |
| 1961 list of dictionaries containing the thread data | |
| 1962 </dd> | |
| 1963 </dl><a NAME="DebugServer.signalClientThreadSet" ID="DebugServer.signalClientThreadSet"></a> | |
| 1964 <h4>DebugServer.signalClientThreadSet</h4> | |
| 1965 <b>signalClientThreadSet</b>(<i></i>) | |
| 1966 <p> | |
| 1967 Public method to handle the change of the client thread. | |
| 1968 </p><a NAME="DebugServer.signalClientVariable" ID="DebugServer.signalClientVariable"></a> | |
| 1969 <h4>DebugServer.signalClientVariable</h4> | |
| 1970 <b>signalClientVariable</b>(<i>scope, variables</i>) | |
| 1971 <p> | |
| 1972 Public method to process the client variable info. | |
| 1973 </p><dl> | |
| 1974 <dt><i>scope</i></dt> | |
| 1975 <dd> | |
| 1976 scope of the variables (-1 = empty global, 1 = global, | |
| 1977 0 = local) | |
| 1978 </dd><dt><i>variables</i></dt> | |
| 1979 <dd> | |
| 1980 the list of members of a classvariable from the client | |
| 1981 </dd> | |
| 1982 </dl><a NAME="DebugServer.signalClientVariables" ID="DebugServer.signalClientVariables"></a> | |
| 1983 <h4>DebugServer.signalClientVariables</h4> | |
| 1984 <b>signalClientVariables</b>(<i>scope, variables</i>) | |
| 1985 <p> | |
| 1986 Public method to process the client variables info. | |
| 1987 </p><dl> | |
| 1988 <dt><i>scope</i></dt> | |
| 1989 <dd> | |
| 1990 scope of the variables (-1 = empty global, 1 = global, | |
| 1991 0 = local) | |
| 1992 </dd><dt><i>variables</i></dt> | |
| 1993 <dd> | |
| 1994 the list of variables from the client | |
| 1995 </dd> | |
| 1996 </dl><a NAME="DebugServer.signalClientWatchConditionError" ID="DebugServer.signalClientWatchConditionError"></a> | |
| 1997 <h4>DebugServer.signalClientWatchConditionError</h4> | |
| 1998 <b>signalClientWatchConditionError</b>(<i>condition</i>) | |
| 1999 <p> | |
| 2000 Public method to process the client watch expression error info. | |
| 2001 </p><dl> | |
| 2002 <dt><i>condition</i></dt> | |
| 2003 <dd> | |
| 2004 expression of watch expression to clear (string) | |
| 2005 </dd> | |
| 2006 </dl><a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a> | |
| 2007 <h4>DebugServer.startClient</h4> | |
| 2008 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir=None</i>) | |
| 2009 <p> | |
| 2010 Public method to start a debug client. | |
| 2011 </p><dl> | |
| 2012 <dt><i>unplanned=</i> (bool)</dt> | |
| 2013 <dd> | |
| 2014 flag indicating that the client has died | |
| 2015 </dd><dt><i>clType=</i> (str)</dt> | |
| 2016 <dd> | |
| 2017 type of client to be started | |
| 2018 </dd><dt><i>forProject=</i> (bool)</dt> | |
| 2019 <dd> | |
| 2020 flag indicating a project related action | |
| 2021 </dd><dt><i>runInConsole=</i> (bool)</dt> | |
| 2022 <dd> | |
| 2023 flag indicating to start the debugger in a | |
| 2024 console window | |
| 2025 </dd><dt><i>venvName=</i> (str)</dt> | |
| 2026 <dd> | |
| 2027 name of the virtual environment to be used | |
| 2028 </dd><dt><i>workingDir=</i> (str)</dt> | |
| 2029 <dd> | |
| 2030 directory to start the debugger client in | |
| 2031 </dd> | |
| 2032 </dl><a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a> | |
| 2033 <h4>DebugServer.unregisterDebuggerInterface</h4> | |
| 2034 <b>unregisterDebuggerInterface</b>(<i>interfaceName</i>) | |
| 2035 <p> | |
| 2036 Public method to unregister a debugger interface. | |
| 2037 </p><dl> | |
| 2038 <dt><i>interfaceName</i> (str)</dt> | |
| 2039 <dd> | |
| 2040 interfaceName of the debugger interface | |
| 2041 </dd> | |
| 2042 </dl> | |
| 2043 <div align="right"><a href="#top">Up</a></div> | |
| 2044 <hr /> | |
| 2045 </body></html> |
