Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Debugger.DebugViewer.html

eric6/Documentation/Source/eric6.Debugger.DebugViewer.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
26 Module implementing a widget containing various debug related views. 26 Module implementing a widget containing various debug related views.
27 </p> 27 </p>
28 <p> 28 <p>
29 The views avaliable are: 29 The views avaliable are:
30 <ul> 30 <ul>
31 <li>variables viewer for global variables</li> 31 <li>selector showing all connected debugger backends with associated
32 <li>variables viewer for local variables</li> 32 threads</li>
33 <li>variables viewer for global variables for the selected debug client</li>
34 <li>variables viewer for local variables for the selected debug client</li>
35 <li>call stack viewer for the selected debug client</li>
33 <li>call trace viewer</li> 36 <li>call trace viewer</li>
34 <li>viewer for breakpoints</li> 37 <li>viewer for breakpoints</li>
35 <li>viewer for watch expressions</li> 38 <li>viewer for watch expressions</li>
36 <li>viewer for exceptions</li> 39 <li>viewer for exceptions</li>
37 <li>viewer for threads</li> 40 <li>viewer for a code disassembly for an exception<li>
38 <li>a file browser (optional)</li>
39 <li>an interpreter shell (optional)</li>
40 </ul> 41 </ul>
41 </p> 42 </p>
42 <h3>Global Attributes</h3> 43 <h3>Global Attributes</h3>
43 44
44 <table> 45 <table>
87 <h3>Derived from</h3> 88 <h3>Derived from</h3>
88 QWidget 89 QWidget
89 <h3>Class Attributes</h3> 90 <h3>Class Attributes</h3>
90 91
91 <table> 92 <table>
92 <tr><td>None</td></tr> 93 <tr><td>DebuggerStateRole</td></tr><tr><td>StateIcon</td></tr><tr><td>StateMessage</td></tr><tr><td>ThreadIdRole</td></tr>
93 </table> 94 </table>
94 <h3>Class Methods</h3> 95 <h3>Class Methods</h3>
95 96
96 <table> 97 <table>
97 <tr><td>None</td></tr> 98 <tr><td>None</td></tr>
103 <tr> 104 <tr>
104 <td><a href="#DebugViewer.__init__">DebugViewer</a></td> 105 <td><a href="#DebugViewer.__init__">DebugViewer</a></td>
105 <td>Constructor</td> 106 <td>Constructor</td>
106 </tr> 107 </tr>
107 <tr> 108 <tr>
109 <td><a href="#DebugViewer.__addThreadList">__addThreadList</a></td>
110 <td>Private method to add the list of threads to a debugger entry.</td>
111 </tr>
112 <tr>
108 <td><a href="#DebugViewer.__callStackFrameSelected">__callStackFrameSelected</a></td> 113 <td><a href="#DebugViewer.__callStackFrameSelected">__callStackFrameSelected</a></td>
109 <td>Private slot to handle the selection of a call stack entry of the call stack viewer.</td> 114 <td>Private slot to handle the selection of a call stack entry of the call stack viewer.</td>
110 </tr> 115 </tr>
111 <tr> 116 <tr>
117 <td><a href="#DebugViewer.__clientDebuggerId">__clientDebuggerId</a></td>
118 <td>Private slot to receive the ID of a newly connected debugger backend.</td>
119 </tr>
120 <tr>
121 <td><a href="#DebugViewer.__clientException">__clientException</a></td>
122 <td>Private method to handle an exception of the debugged program.</td>
123 </tr>
124 <tr>
125 <td><a href="#DebugViewer.__clientExit">__clientExit</a></td>
126 <td>Private method to handle the debugged program terminating.</td>
127 </tr>
128 <tr>
129 <td><a href="#DebugViewer.__clientLine">__clientLine</a></td>
130 <td>Private method to handle a change to the current line.</td>
131 </tr>
132 <tr>
133 <td><a href="#DebugViewer.__clientSyntaxError">__clientSyntaxError</a></td>
134 <td>Private method to handle a syntax error in the debugged program.</td>
135 </tr>
136 <tr>
137 <td><a href="#DebugViewer.__debuggerSelected">__debuggerSelected</a></td>
138 <td>Private slot to handle the selection of a debugger backend in the debuggers list.</td>
139 </tr>
140 <tr>
112 <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td> 141 <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td>
113 <td>Private slot to handle the selection of a new stack frame number.</td> 142 <td>Private slot to handle the selection of a new stack frame number.</td>
114 </tr> 143 </tr>
115 <tr> 144 <tr>
145 <td><a href="#DebugViewer.__removeDebugger">__removeDebugger</a></td>
146 <td>Private method to remove a debugger given its ID.</td>
147 </tr>
148 <tr>
149 <td><a href="#DebugViewer.__setCurrentDebugger">__setCurrentDebugger</a></td>
150 <td>Private method to set the current debugger based on the given ID.</td>
151 </tr>
152 <tr>
153 <td><a href="#DebugViewer.__setDebuggerIconAndState">__setDebuggerIconAndState</a></td>
154 <td>Private method to set the icon for a specific debugger ID.</td>
155 </tr>
156 <tr>
157 <td><a href="#DebugViewer.__setThreadIconAndState">__setThreadIconAndState</a></td>
158 <td>Private method to set the icon for a specific thread name and debugger ID.</td>
159 </tr>
160 <tr>
116 <td><a href="#DebugViewer.__showSource">__showSource</a></td> 161 <td><a href="#DebugViewer.__showSource">__showSource</a></td>
117 <td>Private slot to handle the source button press to show the selected file.</td> 162 <td>Private slot to handle the source button press to show the selected file.</td>
118 </tr> 163 </tr>
119 <tr> 164 <tr>
120 <td><a href="#DebugViewer.__threadSelected">__threadSelected</a></td>
121 <td>Private slot to handle the selection of a thread in the thread list.</td>
122 </tr>
123 <tr>
124 <td><a href="#DebugViewer.clearCallTrace">clearCallTrace</a></td> 165 <td><a href="#DebugViewer.clearCallTrace">clearCallTrace</a></td>
125 <td>Public method to clear the recorded call trace.</td> 166 <td>Public method to clear the recorded call trace.</td>
126 </tr> 167 </tr>
127 <tr> 168 <tr>
128 <td><a href="#DebugViewer.currentWidget">currentWidget</a></td> 169 <td><a href="#DebugViewer.currentWidget">currentWidget</a></td>
129 <td>Public method to get a reference to the current widget.</td> 170 <td>Public method to get a reference to the current widget.</td>
130 </tr> 171 </tr>
131 <tr> 172 <tr>
173 <td><a href="#DebugViewer.getSelectedDebuggerId">getSelectedDebuggerId</a></td>
174 <td>Public method to get the currently selected debugger ID.</td>
175 </tr>
176 <tr>
177 <td><a href="#DebugViewer.getSelectedDebuggerState">getSelectedDebuggerState</a></td>
178 <td>Public method to get the currently selected debugger's state.</td>
179 </tr>
180 <tr>
132 <td><a href="#DebugViewer.handleClientStack">handleClientStack</a></td> 181 <td><a href="#DebugViewer.handleClientStack">handleClientStack</a></td>
133 <td>Public slot to show the call stack of the program being debugged.</td> 182 <td>Public slot to show the call stack of the program being debugged.</td>
134 </tr> 183 </tr>
135 <tr> 184 <tr>
136 <td><a href="#DebugViewer.handleDebuggingStarted">handleDebuggingStarted</a></td> 185 <td><a href="#DebugViewer.handleDebuggingStarted">handleDebuggingStarted</a></td>
140 <td><a href="#DebugViewer.handlePreferencesChanged">handlePreferencesChanged</a></td> 189 <td><a href="#DebugViewer.handlePreferencesChanged">handlePreferencesChanged</a></td>
141 <td>Public slot to handle the preferencesChanged signal.</td> 190 <td>Public slot to handle the preferencesChanged signal.</td>
142 </tr> 191 </tr>
143 <tr> 192 <tr>
144 <td><a href="#DebugViewer.handleResetUI">handleResetUI</a></td> 193 <td><a href="#DebugViewer.handleResetUI">handleResetUI</a></td>
145 <td>Public method to reset the SBVviewer.</td> 194 <td>Public method to reset the viewer.</td>
146 </tr> 195 </tr>
147 <tr> 196 <tr>
148 <td><a href="#DebugViewer.initCallStackViewer">initCallStackViewer</a></td> 197 <td><a href="#DebugViewer.initCallStackViewer">initCallStackViewer</a></td>
149 <td>Public method to initialize the call stack viewer.</td> 198 <td>Public method to initialize the call stack viewer.</td>
150 </tr> 199 </tr>
151 <tr> 200 <tr>
152 <td><a href="#DebugViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> 201 <td><a href="#DebugViewer.isCallTraceEnabled">isCallTraceEnabled</a></td>
153 <td>Public method to get the state of the call trace function.</td> 202 <td>Public method to get the state of the call trace function.</td>
154 </tr> 203 </tr>
155 <tr> 204 <tr>
205 <td><a href="#DebugViewer.isOnlyDebugger">isOnlyDebugger</a></td>
206 <td>Public method to test, if only one debugger is connected.</td>
207 </tr>
208 <tr>
156 <td><a href="#DebugViewer.setCallTraceToProjectMode">setCallTraceToProjectMode</a></td> 209 <td><a href="#DebugViewer.setCallTraceToProjectMode">setCallTraceToProjectMode</a></td>
157 <td>Public slot to set the call trace viewer to project mode.</td> 210 <td>Public slot to set the call trace viewer to project mode.</td>
158 </tr> 211 </tr>
159 <tr> 212 <tr>
160 <td><a href="#DebugViewer.setCurrentWidget">setCurrentWidget</a></td> 213 <td><a href="#DebugViewer.setCurrentWidget">setCurrentWidget</a></td>
173 <td>Public slot to set the local variable filter.</td> 226 <td>Public slot to set the local variable filter.</td>
174 </tr> 227 </tr>
175 <tr> 228 <tr>
176 <td><a href="#DebugViewer.setVariablesFilter">setVariablesFilter</a></td> 229 <td><a href="#DebugViewer.setVariablesFilter">setVariablesFilter</a></td>
177 <td>Public slot to set the local variables filter.</td> 230 <td>Public slot to set the local variables filter.</td>
178 </tr>
179 <tr>
180 <td><a href="#DebugViewer.showThreadList">showThreadList</a></td>
181 <td>Public method to show the thread list.</td>
182 </tr> 231 </tr>
183 <tr> 232 <tr>
184 <td><a href="#DebugViewer.showVariable">showVariable</a></td> 233 <td><a href="#DebugViewer.showVariable">showVariable</a></td>
185 <td>Public method to show the variables in the respective window.</td> 234 <td>Public method to show the variables in the respective window.</td>
186 </tr> 235 </tr>
206 <p> 255 <p>
207 Constructor 256 Constructor
208 </p> 257 </p>
209 <dl> 258 <dl>
210 259
211 <dt><i>debugServer</i></dt> 260 <dt><i>debugServer</i> (DebugServer)</dt>
212 <dd> 261 <dd>
213 reference to the debug server object (DebugServer) 262 reference to the debug server object
214 </dd> 263 </dd>
215 <dt><i>parent</i></dt> 264 <dt><i>parent</i> (QWidget)</dt>
216 <dd> 265 <dd>
217 parent widget (QWidget) 266 parent widget
267 </dd>
268 </dl>
269 <a NAME="DebugViewer.__addThreadList" ID="DebugViewer.__addThreadList"></a>
270 <h4>DebugViewer.__addThreadList</h4>
271 <b>__addThreadList</b>(<i>currentID, threadList, debuggerId</i>)
272
273 <p>
274 Private method to add the list of threads to a debugger entry.
275 </p>
276 <dl>
277
278 <dt><i>currentID</i> (int)</dt>
279 <dd>
280 id of the current thread
281 </dd>
282 <dt><i>threadList</i> (list of dict)</dt>
283 <dd>
284 list of dictionaries containing the thread data
285 </dd>
286 <dt><i>debuggerId</i> (str)</dt>
287 <dd>
288 ID of the debugger backend
218 </dd> 289 </dd>
219 </dl> 290 </dl>
220 <a NAME="DebugViewer.__callStackFrameSelected" ID="DebugViewer.__callStackFrameSelected"></a> 291 <a NAME="DebugViewer.__callStackFrameSelected" ID="DebugViewer.__callStackFrameSelected"></a>
221 <h4>DebugViewer.__callStackFrameSelected</h4> 292 <h4>DebugViewer.__callStackFrameSelected</h4>
222 <b>__callStackFrameSelected</b>(<i>frameNo</i>) 293 <b>__callStackFrameSelected</b>(<i>frameNo</i>)
225 Private slot to handle the selection of a call stack entry of the 296 Private slot to handle the selection of a call stack entry of the
226 call stack viewer. 297 call stack viewer.
227 </p> 298 </p>
228 <dl> 299 <dl>
229 300
230 <dt><i>frameNo</i></dt> 301 <dt><i>frameNo</i> (int)</dt>
231 <dd> 302 <dd>
232 frame number (index) of the selected entry (integer) 303 frame number (index) of the selected entry
304 </dd>
305 </dl>
306 <a NAME="DebugViewer.__clientDebuggerId" ID="DebugViewer.__clientDebuggerId"></a>
307 <h4>DebugViewer.__clientDebuggerId</h4>
308 <b>__clientDebuggerId</b>(<i>debuggerId</i>)
309
310 <p>
311 Private slot to receive the ID of a newly connected debugger backend.
312 </p>
313 <dl>
314
315 <dt><i>debuggerId</i> (str)</dt>
316 <dd>
317 ID of a newly connected debugger backend
318 </dd>
319 </dl>
320 <a NAME="DebugViewer.__clientException" ID="DebugViewer.__clientException"></a>
321 <h4>DebugViewer.__clientException</h4>
322 <b>__clientException</b>(<i>exceptionType, exceptionMessage, stackTrace, debuggerId, threadName</i>)
323
324 <p>
325 Private method to handle an exception of the debugged program.
326 </p>
327 <dl>
328
329 <dt><i>exceptionType</i> (str)</dt>
330 <dd>
331 type of exception raised
332 </dd>
333 <dt><i>exceptionMessage</i> ((str)</dt>
334 <dd>
335 message given by the exception
336 </dd>
337 <dt><i>stackTrace</i> (list of str)</dt>
338 <dd>
339 list of stack entries
340 </dd>
341 <dt><i>debuggerId</i> (str)</dt>
342 <dd>
343 ID of the debugger backend
344 </dd>
345 <dt><i>threadName</i> (str)</dt>
346 <dd>
347 name of the thread signaling the event
348 </dd>
349 </dl>
350 <a NAME="DebugViewer.__clientExit" ID="DebugViewer.__clientExit"></a>
351 <h4>DebugViewer.__clientExit</h4>
352 <b>__clientExit</b>(<i>program, status, message, quiet, debuggerId</i>)
353
354 <p>
355 Private method to handle the debugged program terminating.
356 </p>
357 <dl>
358
359 <dt><i>program</i> (str)</dt>
360 <dd>
361 name of the exited program
362 </dd>
363 <dt><i>status</i> (int)</dt>
364 <dd>
365 exit code of the debugged program
366 </dd>
367 <dt><i>message</i> (str)</dt>
368 <dd>
369 exit message of the debugged program
370 </dd>
371 <dt><i>quiet</i> (bool)</dt>
372 <dd>
373 flag indicating to suppress exit info display
374 </dd>
375 <dt><i>debuggerId</i> (str)</dt>
376 <dd>
377 ID of the debugger backend
378 </dd>
379 </dl>
380 <a NAME="DebugViewer.__clientLine" ID="DebugViewer.__clientLine"></a>
381 <h4>DebugViewer.__clientLine</h4>
382 <b>__clientLine</b>(<i>fn, line, debuggerId, threadName</i>)
383
384 <p>
385 Private method to handle a change to the current line.
386 </p>
387 <dl>
388
389 <dt><i>fn</i> (str)</dt>
390 <dd>
391 filename
392 </dd>
393 <dt><i>line</i> (int)</dt>
394 <dd>
395 linenumber
396 </dd>
397 <dt><i>debuggerId</i> (str)</dt>
398 <dd>
399 ID of the debugger backend
400 </dd>
401 <dt><i>threadName</i> (str)</dt>
402 <dd>
403 name of the thread signaling the event
404 </dd>
405 </dl>
406 <a NAME="DebugViewer.__clientSyntaxError" ID="DebugViewer.__clientSyntaxError"></a>
407 <h4>DebugViewer.__clientSyntaxError</h4>
408 <b>__clientSyntaxError</b>(<i>message, filename, lineNo, characterNo, debuggerId, threadName</i>)
409
410 <p>
411 Private method to handle a syntax error in the debugged program.
412 </p>
413 <dl>
414
415 <dt><i>message</i> (str)</dt>
416 <dd>
417 message of the syntax error
418 </dd>
419 <dt><i>filename</i> (str)</dt>
420 <dd>
421 translated filename of the syntax error position
422 </dd>
423 <dt><i>lineNo</i> (int)</dt>
424 <dd>
425 line number of the syntax error position
426 </dd>
427 <dt><i>characterNo</i> (int)</dt>
428 <dd>
429 character number of the syntax error position
430 </dd>
431 <dt><i>debuggerId</i> (str)</dt>
432 <dd>
433 ID of the debugger backend
434 </dd>
435 <dt><i>threadName</i> (str)</dt>
436 <dd>
437 name of the thread signaling the event
438 </dd>
439 </dl>
440 <a NAME="DebugViewer.__debuggerSelected" ID="DebugViewer.__debuggerSelected"></a>
441 <h4>DebugViewer.__debuggerSelected</h4>
442 <b>__debuggerSelected</b>(<i>current, previous</i>)
443
444 <p>
445 Private slot to handle the selection of a debugger backend in the
446 debuggers list.
447 </p>
448 <dl>
449
450 <dt><i>current</i> (QTreeWidgetItem)</dt>
451 <dd>
452 reference to the new current item
453 </dd>
454 <dt><i>previous</i> (QTreeWidgetItem)</dt>
455 <dd>
456 reference to the previous current item
233 </dd> 457 </dd>
234 </dl> 458 </dl>
235 <a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a> 459 <a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a>
236 <h4>DebugViewer.__frameSelected</h4> 460 <h4>DebugViewer.__frameSelected</h4>
237 <b>__frameSelected</b>(<i>frmnr</i>) 461 <b>__frameSelected</b>(<i>frmnr</i>)
239 <p> 463 <p>
240 Private slot to handle the selection of a new stack frame number. 464 Private slot to handle the selection of a new stack frame number.
241 </p> 465 </p>
242 <dl> 466 <dl>
243 467
244 <dt><i>frmnr</i></dt> 468 <dt><i>frmnr</i> (int)</dt>
245 <dd> 469 <dd>
246 frame number (0 is the current frame) (int) 470 frame number (0 is the current frame)
471 </dd>
472 </dl>
473 <a NAME="DebugViewer.__removeDebugger" ID="DebugViewer.__removeDebugger"></a>
474 <h4>DebugViewer.__removeDebugger</h4>
475 <b>__removeDebugger</b>(<i>debuggerId</i>)
476
477 <p>
478 Private method to remove a debugger given its ID.
479 </p>
480 <dl>
481
482 <dt><i>debuggerId</i> (str)</dt>
483 <dd>
484 ID of the debugger to be removed from the list
485 </dd>
486 </dl>
487 <a NAME="DebugViewer.__setCurrentDebugger" ID="DebugViewer.__setCurrentDebugger"></a>
488 <h4>DebugViewer.__setCurrentDebugger</h4>
489 <b>__setCurrentDebugger</b>(<i>debuggerId</i>)
490
491 <p>
492 Private method to set the current debugger based on the given ID.
493 </p>
494 <dl>
495
496 <dt><i>debuggerId</i> (str)</dt>
497 <dd>
498 ID of the debugger to set as current debugger
499 </dd>
500 </dl>
501 <a NAME="DebugViewer.__setDebuggerIconAndState" ID="DebugViewer.__setDebuggerIconAndState"></a>
502 <h4>DebugViewer.__setDebuggerIconAndState</h4>
503 <b>__setDebuggerIconAndState</b>(<i>debuggerId, state</i>)
504
505 <p>
506 Private method to set the icon for a specific debugger ID.
507 </p>
508 <dl>
509
510 <dt><i>debuggerId</i> (str)</dt>
511 <dd>
512 ID of the debugger backend (empty ID means the
513 currently selected one)
514 </dd>
515 <dt><i>state</i> (str)</dt>
516 <dd>
517 state of the debugger (broken, exception, running)
518 </dd>
519 </dl>
520 <a NAME="DebugViewer.__setThreadIconAndState" ID="DebugViewer.__setThreadIconAndState"></a>
521 <h4>DebugViewer.__setThreadIconAndState</h4>
522 <b>__setThreadIconAndState</b>(<i>debuggerId, threadName, state</i>)
523
524 <p>
525 Private method to set the icon for a specific thread name and
526 debugger ID.
527 </p>
528 <dl>
529
530 <dt><i>debuggerId</i> (str)</dt>
531 <dd>
532 ID of the debugger backend (empty ID means the
533 currently selected one)
534 </dd>
535 <dt><i>threadName</i> (str)</dt>
536 <dd>
537 name of the thread signaling the event
538 </dd>
539 <dt><i>state</i> (str)</dt>
540 <dd>
541 state of the debugger (broken, exception, running)
247 </dd> 542 </dd>
248 </dl> 543 </dl>
249 <a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a> 544 <a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a>
250 <h4>DebugViewer.__showSource</h4> 545 <h4>DebugViewer.__showSource</h4>
251 <b>__showSource</b>(<i></i>) 546 <b>__showSource</b>(<i></i>)
252 547
253 <p> 548 <p>
254 Private slot to handle the source button press to show the selected 549 Private slot to handle the source button press to show the selected
255 file. 550 file.
256 </p> 551 </p>
257 <a NAME="DebugViewer.__threadSelected" ID="DebugViewer.__threadSelected"></a>
258 <h4>DebugViewer.__threadSelected</h4>
259 <b>__threadSelected</b>(<i>current, previous</i>)
260
261 <p>
262 Private slot to handle the selection of a thread in the thread list.
263 </p>
264 <dl>
265
266 <dt><i>current</i></dt>
267 <dd>
268 reference to the new current item (QTreeWidgetItem)
269 </dd>
270 <dt><i>previous</i></dt>
271 <dd>
272 reference to the previous current item
273 (QTreeWidgetItem)
274 </dd>
275 </dl>
276 <a NAME="DebugViewer.clearCallTrace" ID="DebugViewer.clearCallTrace"></a> 552 <a NAME="DebugViewer.clearCallTrace" ID="DebugViewer.clearCallTrace"></a>
277 <h4>DebugViewer.clearCallTrace</h4> 553 <h4>DebugViewer.clearCallTrace</h4>
278 <b>clearCallTrace</b>(<i></i>) 554 <b>clearCallTrace</b>(<i></i>)
279 555
280 <p> 556 <p>
286 562
287 <p> 563 <p>
288 Public method to get a reference to the current widget. 564 Public method to get a reference to the current widget.
289 </p> 565 </p>
290 <dl> 566 <dl>
291 <dt>Returns:</dt> 567 <dt>Return:</dt>
292 <dd> 568 <dd>
293 reference to the current widget (QWidget) 569 reference to the current widget
570 </dd>
571 </dl>
572 <dl>
573 <dt>Return Type:</dt>
574 <dd>
575 QWidget
576 </dd>
577 </dl>
578 <a NAME="DebugViewer.getSelectedDebuggerId" ID="DebugViewer.getSelectedDebuggerId"></a>
579 <h4>DebugViewer.getSelectedDebuggerId</h4>
580 <b>getSelectedDebuggerId</b>(<i></i>)
581
582 <p>
583 Public method to get the currently selected debugger ID.
584 </p>
585 <dl>
586 <dt>Return:</dt>
587 <dd>
588 selected debugger ID
589 </dd>
590 </dl>
591 <dl>
592 <dt>Return Type:</dt>
593 <dd>
594 str
595 </dd>
596 </dl>
597 <a NAME="DebugViewer.getSelectedDebuggerState" ID="DebugViewer.getSelectedDebuggerState"></a>
598 <h4>DebugViewer.getSelectedDebuggerState</h4>
599 <b>getSelectedDebuggerState</b>(<i></i>)
600
601 <p>
602 Public method to get the currently selected debugger's state.
603 </p>
604 <dl>
605 <dt>Return:</dt>
606 <dd>
607 selected debugger's state (broken, exception, running)
608 </dd>
609 </dl>
610 <dl>
611 <dt>Return Type:</dt>
612 <dd>
613 str
294 </dd> 614 </dd>
295 </dl> 615 </dl>
296 <a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a> 616 <a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a>
297 <h4>DebugViewer.handleClientStack</h4> 617 <h4>DebugViewer.handleClientStack</h4>
298 <b>handleClientStack</b>(<i>stack</i>) 618 <b>handleClientStack</b>(<i>stack, debuggerId</i>)
299 619
300 <p> 620 <p>
301 Public slot to show the call stack of the program being debugged. 621 Public slot to show the call stack of the program being debugged.
302 </p> 622 </p>
303 <dl> 623 <dl>
304 624
305 <dt><i>stack</i></dt> 625 <dt><i>stack</i> (list of tuples of (str, str, str, str))</dt>
306 <dd> 626 <dd>
307 list of tuples with call stack data (file name, 627 list of tuples with call stack data (file name,
308 line number, function name, formatted argument/values list) 628 line number, function name, formatted argument/values list)
629 </dd>
630 <dt><i>debuggerId</i> (str)</dt>
631 <dd>
632 ID of the debugger backend
309 </dd> 633 </dd>
310 </dl> 634 </dl>
311 <a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a> 635 <a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a>
312 <h4>DebugViewer.handleDebuggingStarted</h4> 636 <h4>DebugViewer.handleDebuggingStarted</h4>
313 <b>handleDebuggingStarted</b>(<i></i>) 637 <b>handleDebuggingStarted</b>(<i></i>)
325 <p> 649 <p>
326 Public slot to handle the preferencesChanged signal. 650 Public slot to handle the preferencesChanged signal.
327 </p> 651 </p>
328 <a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a> 652 <a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a>
329 <h4>DebugViewer.handleResetUI</h4> 653 <h4>DebugViewer.handleResetUI</h4>
330 <b>handleResetUI</b>(<i></i>) 654 <b>handleResetUI</b>(<i>fullReset</i>)
331 655
332 <p> 656 <p>
333 Public method to reset the SBVviewer. 657 Public method to reset the viewer.
334 </p> 658 </p>
659 <dl>
660
661 <dt><i>fullReset</i> (bool)</dt>
662 <dd>
663 flag indicating a full reset is required
664 </dd>
665 </dl>
335 <a NAME="DebugViewer.initCallStackViewer" ID="DebugViewer.initCallStackViewer"></a> 666 <a NAME="DebugViewer.initCallStackViewer" ID="DebugViewer.initCallStackViewer"></a>
336 <h4>DebugViewer.initCallStackViewer</h4> 667 <h4>DebugViewer.initCallStackViewer</h4>
337 <b>initCallStackViewer</b>(<i>projectMode</i>) 668 <b>initCallStackViewer</b>(<i>projectMode</i>)
338 669
339 <p> 670 <p>
340 Public method to initialize the call stack viewer. 671 Public method to initialize the call stack viewer.
341 </p> 672 </p>
342 <dl> 673 <dl>
343 674
344 <dt><i>projectMode</i></dt> 675 <dt><i>projectMode</i> (bool)</dt>
345 <dd> 676 <dd>
346 flag indicating to enable the project mode (boolean) 677 flag indicating to enable the project mode
347 </dd> 678 </dd>
348 </dl> 679 </dl>
349 <a NAME="DebugViewer.isCallTraceEnabled" ID="DebugViewer.isCallTraceEnabled"></a> 680 <a NAME="DebugViewer.isCallTraceEnabled" ID="DebugViewer.isCallTraceEnabled"></a>
350 <h4>DebugViewer.isCallTraceEnabled</h4> 681 <h4>DebugViewer.isCallTraceEnabled</h4>
351 <b>isCallTraceEnabled</b>(<i></i>) 682 <b>isCallTraceEnabled</b>(<i></i>)
352 683
353 <p> 684 <p>
354 Public method to get the state of the call trace function. 685 Public method to get the state of the call trace function.
355 </p> 686 </p>
356 <dl> 687 <dl>
357 <dt>Returns:</dt> 688 <dt>Return:</dt>
358 <dd> 689 <dd>
359 flag indicating the state of the call trace function (boolean) 690 flag indicating the state of the call trace function
691 </dd>
692 </dl>
693 <dl>
694 <dt>Return Type:</dt>
695 <dd>
696 bool
697 </dd>
698 </dl>
699 <a NAME="DebugViewer.isOnlyDebugger" ID="DebugViewer.isOnlyDebugger"></a>
700 <h4>DebugViewer.isOnlyDebugger</h4>
701 <b>isOnlyDebugger</b>(<i></i>)
702
703 <p>
704 Public method to test, if only one debugger is connected.
705 </p>
706 <dl>
707 <dt>Return:</dt>
708 <dd>
709 flag indicating that only one debugger is connected
710 </dd>
711 </dl>
712 <dl>
713 <dt>Return Type:</dt>
714 <dd>
715 bool
360 </dd> 716 </dd>
361 </dl> 717 </dl>
362 <a NAME="DebugViewer.setCallTraceToProjectMode" ID="DebugViewer.setCallTraceToProjectMode"></a> 718 <a NAME="DebugViewer.setCallTraceToProjectMode" ID="DebugViewer.setCallTraceToProjectMode"></a>
363 <h4>DebugViewer.setCallTraceToProjectMode</h4> 719 <h4>DebugViewer.setCallTraceToProjectMode</h4>
364 <b>setCallTraceToProjectMode</b>(<i>enabled</i>) 720 <b>setCallTraceToProjectMode</b>(<i>enabled</i>)
370 In project mode the call trace info is shown with project relative 726 In project mode the call trace info is shown with project relative
371 path names. 727 path names.
372 </p> 728 </p>
373 <dl> 729 <dl>
374 730
375 <dt><i>enabled</i></dt> 731 <dt><i>enabled</i> (bool)</dt>
376 <dd> 732 <dd>
377 flag indicating to enable the project mode (boolean) 733 flag indicating to enable the project mode
378 </dd> 734 </dd>
379 </dl> 735 </dl>
380 <a NAME="DebugViewer.setCurrentWidget" ID="DebugViewer.setCurrentWidget"></a> 736 <a NAME="DebugViewer.setCurrentWidget" ID="DebugViewer.setCurrentWidget"></a>
381 <h4>DebugViewer.setCurrentWidget</h4> 737 <h4>DebugViewer.setCurrentWidget</h4>
382 <b>setCurrentWidget</b>(<i>widget</i>) 738 <b>setCurrentWidget</b>(<i>widget</i>)
384 <p> 740 <p>
385 Public slot to set the current page based on the given widget. 741 Public slot to set the current page based on the given widget.
386 </p> 742 </p>
387 <dl> 743 <dl>
388 744
389 <dt><i>widget</i></dt> 745 <dt><i>widget</i> (QWidget)</dt>
390 <dd> 746 <dd>
391 reference to the widget (QWidget) 747 reference to the widget
392 </dd> 748 </dd>
393 </dl> 749 </dl>
394 <a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a> 750 <a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a>
395 <h4>DebugViewer.setDebugger</h4> 751 <h4>DebugViewer.setDebugger</h4>
396 <b>setDebugger</b>(<i>debugUI</i>) 752 <b>setDebugger</b>(<i>debugUI</i>)
398 <p> 754 <p>
399 Public method to set a reference to the Debug UI. 755 Public method to set a reference to the Debug UI.
400 </p> 756 </p>
401 <dl> 757 <dl>
402 758
403 <dt><i>debugUI</i></dt> 759 <dt><i>debugUI</i> (DebugUI)</dt>
404 <dd> 760 <dd>
405 reference to the DebugUI object (DebugUI) 761 reference to the DebugUI object
406 </dd> 762 </dd>
407 </dl> 763 </dl>
408 <a NAME="DebugViewer.setGlobalsFilter" ID="DebugViewer.setGlobalsFilter"></a> 764 <a NAME="DebugViewer.setGlobalsFilter" ID="DebugViewer.setGlobalsFilter"></a>
409 <h4>DebugViewer.setGlobalsFilter</h4> 765 <h4>DebugViewer.setGlobalsFilter</h4>
410 <b>setGlobalsFilter</b>(<i></i>) 766 <b>setGlobalsFilter</b>(<i></i>)
426 <p> 782 <p>
427 Public slot to set the local variables filter. 783 Public slot to set the local variables filter.
428 </p> 784 </p>
429 <dl> 785 <dl>
430 786
431 <dt><i>globalsFilter</i></dt> 787 <dt><i>globalsFilter</i> (list of str)</dt>
432 <dd> 788 <dd>
433 filter list for global variable types 789 filter list for global variable types
434 (list of int) 790 </dd>
435 </dd> 791 <dt><i>localsFilter</i> (list of str)</dt>
436 <dt><i>localsFilter</i></dt> 792 <dd>
437 <dd> 793 filter list for local variable types
438 filter list for local variable types (list of int)
439 </dd>
440 </dl>
441 <a NAME="DebugViewer.showThreadList" ID="DebugViewer.showThreadList"></a>
442 <h4>DebugViewer.showThreadList</h4>
443 <b>showThreadList</b>(<i>currentID, threadList</i>)
444
445 <p>
446 Public method to show the thread list.
447 </p>
448 <dl>
449
450 <dt><i>currentID</i></dt>
451 <dd>
452 id of the current thread (integer)
453 </dd>
454 <dt><i>threadList</i></dt>
455 <dd>
456 list of dictionaries containing the thread data
457 </dd> 794 </dd>
458 </dl> 795 </dl>
459 <a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a> 796 <a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a>
460 <h4>DebugViewer.showVariable</h4> 797 <h4>DebugViewer.showVariable</h4>
461 <b>showVariable</b>(<i>vlist, showGlobals</i>) 798 <b>showVariable</b>(<i>vlist, showGlobals</i>)
463 <p> 800 <p>
464 Public method to show the variables in the respective window. 801 Public method to show the variables in the respective window.
465 </p> 802 </p>
466 <dl> 803 <dl>
467 804
468 <dt><i>vlist</i></dt> 805 <dt><i>vlist</i> (list)</dt>
469 <dd> 806 <dd>
470 list of variables to display 807 list of variables to display
471 </dd> 808 </dd>
472 <dt><i>showGlobals</i></dt> 809 <dt><i>showGlobals</i> (bool)</dt>
473 <dd> 810 <dd>
474 flag indicating global/local state 811 flag indicating global/local state
475 </dd> 812 </dd>
476 </dl> 813 </dl>
477 <a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a> 814 <a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a>
481 <p> 818 <p>
482 Public method to show the variables in the respective window. 819 Public method to show the variables in the respective window.
483 </p> 820 </p>
484 <dl> 821 <dl>
485 822
486 <dt><i>vlist</i></dt> 823 <dt><i>vlist</i> (list)</dt>
487 <dd> 824 <dd>
488 list of variables to display 825 list of variables to display
489 </dd> 826 </dd>
490 <dt><i>showGlobals</i></dt> 827 <dt><i>showGlobals</i> (bool)</dt>
491 <dd> 828 <dd>
492 flag indicating global/local state 829 flag indicating global/local state
493 </dd> 830 </dd>
494 </dl> 831 </dl>
495 <a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a> 832 <a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a>
499 <p> 836 <p>
500 Public method to make a variables tab visible. 837 Public method to make a variables tab visible.
501 </p> 838 </p>
502 <dl> 839 <dl>
503 840
504 <dt><i>showGlobals</i></dt> 841 <dt><i>showGlobals</i> (bool)</dt>
505 <dd> 842 <dd>
506 flag indicating global/local state 843 flag indicating global/local state
507 </dd> 844 </dd>
508 </dl> 845 </dl>
509 <div align="right"><a href="#top">Up</a></div> 846 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial