Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Debugger.DebugServer.html

Documentation/Source/eric4.Debugger.DebugServer.html

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

Mercurial Repository: eric

eric ide

mercurial