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