|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Debugger.DebugViewer</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> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.Debugger.DebugViewer</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a widget containing various debug related views. |
|
27 </p> |
|
28 <p> |
|
29 The views avaliable are: |
|
30 <ul> |
|
31 <li>selector showing all connected debugger backends with associated |
|
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> |
|
36 <li>call trace viewer</li> |
|
37 <li>viewer for breakpoints</li> |
|
38 <li>viewer for watch expressions</li> |
|
39 <li>viewer for exceptions</li> |
|
40 <li>viewer for a code disassembly for an exception<li> |
|
41 </ul> |
|
42 </p> |
|
43 <h3>Global Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Classes</h3> |
|
49 |
|
50 <table> |
|
51 |
|
52 <tr> |
|
53 <td><a href="#DebugViewer">DebugViewer</a></td> |
|
54 <td>Class implementing a widget containing various debug related views.</td> |
|
55 </tr> |
|
56 </table> |
|
57 <h3>Functions</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <hr /> |
|
63 <hr /> |
|
64 <a NAME="DebugViewer" ID="DebugViewer"></a> |
|
65 <h2>DebugViewer</h2> |
|
66 |
|
67 <p> |
|
68 Class implementing a widget containing various debug related views. |
|
69 </p> |
|
70 <p> |
|
71 The individual tabs contain the interpreter shell (optional), |
|
72 the filesystem browser (optional), the two variables viewers |
|
73 (global and local), a breakpoint viewer, a watch expression viewer and |
|
74 the exception logger. Additionally a list of all threads is shown. |
|
75 </p> |
|
76 <h3>Signals</h3> |
|
77 <dl> |
|
78 |
|
79 <dt>preferencesChanged()</dt> |
|
80 <dd> |
|
81 emitted to react on changed preferences |
|
82 </dd> |
|
83 <dt>sourceFile(string, int)</dt> |
|
84 <dd> |
|
85 emitted to open a source file at a line |
|
86 </dd> |
|
87 </dl> |
|
88 <h3>Derived from</h3> |
|
89 QWidget |
|
90 <h3>Class Attributes</h3> |
|
91 |
|
92 <table> |
|
93 <tr><td>DebuggerStateRole</td></tr><tr><td>StateIcon</td></tr><tr><td>StateMessage</td></tr><tr><td>ThreadIdRole</td></tr> |
|
94 </table> |
|
95 <h3>Class Methods</h3> |
|
96 |
|
97 <table> |
|
98 <tr><td>None</td></tr> |
|
99 </table> |
|
100 <h3>Methods</h3> |
|
101 |
|
102 <table> |
|
103 |
|
104 <tr> |
|
105 <td><a href="#DebugViewer.__init__">DebugViewer</a></td> |
|
106 <td>Constructor</td> |
|
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> |
|
113 <td><a href="#DebugViewer.__callStackFrameSelected">__callStackFrameSelected</a></td> |
|
114 <td>Private slot to handle the selection of a call stack entry of the call stack viewer.</td> |
|
115 </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> |
|
141 <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td> |
|
142 <td>Private slot to handle the selection of a new stack frame number.</td> |
|
143 </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> |
|
161 <td><a href="#DebugViewer.__showSource">__showSource</a></td> |
|
162 <td>Private slot to handle the source button press to show the selected file.</td> |
|
163 </tr> |
|
164 <tr> |
|
165 <td><a href="#DebugViewer.clearCallTrace">clearCallTrace</a></td> |
|
166 <td>Public method to clear the recorded call trace.</td> |
|
167 </tr> |
|
168 <tr> |
|
169 <td><a href="#DebugViewer.currentWidget">currentWidget</a></td> |
|
170 <td>Public method to get a reference to the current widget.</td> |
|
171 </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> |
|
181 <td><a href="#DebugViewer.handleClientStack">handleClientStack</a></td> |
|
182 <td>Public slot to show the call stack of the program being debugged.</td> |
|
183 </tr> |
|
184 <tr> |
|
185 <td><a href="#DebugViewer.handleDebuggingStarted">handleDebuggingStarted</a></td> |
|
186 <td>Public slot to handle the start of a debugging session.</td> |
|
187 </tr> |
|
188 <tr> |
|
189 <td><a href="#DebugViewer.handlePreferencesChanged">handlePreferencesChanged</a></td> |
|
190 <td>Public slot to handle the preferencesChanged signal.</td> |
|
191 </tr> |
|
192 <tr> |
|
193 <td><a href="#DebugViewer.handleResetUI">handleResetUI</a></td> |
|
194 <td>Public method to reset the viewer.</td> |
|
195 </tr> |
|
196 <tr> |
|
197 <td><a href="#DebugViewer.initCallStackViewer">initCallStackViewer</a></td> |
|
198 <td>Public method to initialize the call stack viewer.</td> |
|
199 </tr> |
|
200 <tr> |
|
201 <td><a href="#DebugViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> |
|
202 <td>Public method to get the state of the call trace function.</td> |
|
203 </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> |
|
209 <td><a href="#DebugViewer.setCallTraceToProjectMode">setCallTraceToProjectMode</a></td> |
|
210 <td>Public slot to set the call trace viewer to project mode.</td> |
|
211 </tr> |
|
212 <tr> |
|
213 <td><a href="#DebugViewer.setCurrentWidget">setCurrentWidget</a></td> |
|
214 <td>Public slot to set the current page based on the given widget.</td> |
|
215 </tr> |
|
216 <tr> |
|
217 <td><a href="#DebugViewer.setDebugger">setDebugger</a></td> |
|
218 <td>Public method to set a reference to the Debug UI.</td> |
|
219 </tr> |
|
220 <tr> |
|
221 <td><a href="#DebugViewer.setGlobalsFilter">setGlobalsFilter</a></td> |
|
222 <td>Public slot to set the global variable filter.</td> |
|
223 </tr> |
|
224 <tr> |
|
225 <td><a href="#DebugViewer.setLocalsFilter">setLocalsFilter</a></td> |
|
226 <td>Public slot to set the local variable filter.</td> |
|
227 </tr> |
|
228 <tr> |
|
229 <td><a href="#DebugViewer.setVariablesFilter">setVariablesFilter</a></td> |
|
230 <td>Public slot to set the local variables filter.</td> |
|
231 </tr> |
|
232 <tr> |
|
233 <td><a href="#DebugViewer.showVariable">showVariable</a></td> |
|
234 <td>Public method to show the variables in the respective window.</td> |
|
235 </tr> |
|
236 <tr> |
|
237 <td><a href="#DebugViewer.showVariables">showVariables</a></td> |
|
238 <td>Public method to show the variables in the respective window.</td> |
|
239 </tr> |
|
240 <tr> |
|
241 <td><a href="#DebugViewer.showVariablesTab">showVariablesTab</a></td> |
|
242 <td>Public method to make a variables tab visible.</td> |
|
243 </tr> |
|
244 </table> |
|
245 <h3>Static Methods</h3> |
|
246 |
|
247 <table> |
|
248 <tr><td>None</td></tr> |
|
249 </table> |
|
250 |
|
251 <a NAME="DebugViewer.__init__" ID="DebugViewer.__init__"></a> |
|
252 <h4>DebugViewer (Constructor)</h4> |
|
253 <b>DebugViewer</b>(<i>debugServer, parent=None</i>) |
|
254 |
|
255 <p> |
|
256 Constructor |
|
257 </p> |
|
258 <dl> |
|
259 |
|
260 <dt><i>debugServer</i> (DebugServer)</dt> |
|
261 <dd> |
|
262 reference to the debug server object |
|
263 </dd> |
|
264 <dt><i>parent</i> (QWidget)</dt> |
|
265 <dd> |
|
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 |
|
289 </dd> |
|
290 </dl> |
|
291 <a NAME="DebugViewer.__callStackFrameSelected" ID="DebugViewer.__callStackFrameSelected"></a> |
|
292 <h4>DebugViewer.__callStackFrameSelected</h4> |
|
293 <b>__callStackFrameSelected</b>(<i>frameNo</i>) |
|
294 |
|
295 <p> |
|
296 Private slot to handle the selection of a call stack entry of the |
|
297 call stack viewer. |
|
298 </p> |
|
299 <dl> |
|
300 |
|
301 <dt><i>frameNo</i> (int)</dt> |
|
302 <dd> |
|
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 |
|
457 </dd> |
|
458 </dl> |
|
459 <a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a> |
|
460 <h4>DebugViewer.__frameSelected</h4> |
|
461 <b>__frameSelected</b>(<i>frmnr</i>) |
|
462 |
|
463 <p> |
|
464 Private slot to handle the selection of a new stack frame number. |
|
465 </p> |
|
466 <dl> |
|
467 |
|
468 <dt><i>frmnr</i> (int)</dt> |
|
469 <dd> |
|
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) |
|
542 </dd> |
|
543 </dl> |
|
544 <a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a> |
|
545 <h4>DebugViewer.__showSource</h4> |
|
546 <b>__showSource</b>(<i></i>) |
|
547 |
|
548 <p> |
|
549 Private slot to handle the source button press to show the selected |
|
550 file. |
|
551 </p> |
|
552 <a NAME="DebugViewer.clearCallTrace" ID="DebugViewer.clearCallTrace"></a> |
|
553 <h4>DebugViewer.clearCallTrace</h4> |
|
554 <b>clearCallTrace</b>(<i></i>) |
|
555 |
|
556 <p> |
|
557 Public method to clear the recorded call trace. |
|
558 </p> |
|
559 <a NAME="DebugViewer.currentWidget" ID="DebugViewer.currentWidget"></a> |
|
560 <h4>DebugViewer.currentWidget</h4> |
|
561 <b>currentWidget</b>(<i></i>) |
|
562 |
|
563 <p> |
|
564 Public method to get a reference to the current widget. |
|
565 </p> |
|
566 <dl> |
|
567 <dt>Return:</dt> |
|
568 <dd> |
|
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 |
|
614 </dd> |
|
615 </dl> |
|
616 <a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a> |
|
617 <h4>DebugViewer.handleClientStack</h4> |
|
618 <b>handleClientStack</b>(<i>stack, debuggerId</i>) |
|
619 |
|
620 <p> |
|
621 Public slot to show the call stack of the program being debugged. |
|
622 </p> |
|
623 <dl> |
|
624 |
|
625 <dt><i>stack</i> (list of tuples of (str, str, str, str))</dt> |
|
626 <dd> |
|
627 list of tuples with call stack data (file name, |
|
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 |
|
633 </dd> |
|
634 </dl> |
|
635 <a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a> |
|
636 <h4>DebugViewer.handleDebuggingStarted</h4> |
|
637 <b>handleDebuggingStarted</b>(<i></i>) |
|
638 |
|
639 <p> |
|
640 Public slot to handle the start of a debugging session. |
|
641 </p> |
|
642 <p> |
|
643 This slot sets the variables filter expressions. |
|
644 </p> |
|
645 <a NAME="DebugViewer.handlePreferencesChanged" ID="DebugViewer.handlePreferencesChanged"></a> |
|
646 <h4>DebugViewer.handlePreferencesChanged</h4> |
|
647 <b>handlePreferencesChanged</b>(<i></i>) |
|
648 |
|
649 <p> |
|
650 Public slot to handle the preferencesChanged signal. |
|
651 </p> |
|
652 <a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a> |
|
653 <h4>DebugViewer.handleResetUI</h4> |
|
654 <b>handleResetUI</b>(<i>fullReset</i>) |
|
655 |
|
656 <p> |
|
657 Public method to reset the viewer. |
|
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> |
|
666 <a NAME="DebugViewer.initCallStackViewer" ID="DebugViewer.initCallStackViewer"></a> |
|
667 <h4>DebugViewer.initCallStackViewer</h4> |
|
668 <b>initCallStackViewer</b>(<i>projectMode</i>) |
|
669 |
|
670 <p> |
|
671 Public method to initialize the call stack viewer. |
|
672 </p> |
|
673 <dl> |
|
674 |
|
675 <dt><i>projectMode</i> (bool)</dt> |
|
676 <dd> |
|
677 flag indicating to enable the project mode |
|
678 </dd> |
|
679 </dl> |
|
680 <a NAME="DebugViewer.isCallTraceEnabled" ID="DebugViewer.isCallTraceEnabled"></a> |
|
681 <h4>DebugViewer.isCallTraceEnabled</h4> |
|
682 <b>isCallTraceEnabled</b>(<i></i>) |
|
683 |
|
684 <p> |
|
685 Public method to get the state of the call trace function. |
|
686 </p> |
|
687 <dl> |
|
688 <dt>Return:</dt> |
|
689 <dd> |
|
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 |
|
716 </dd> |
|
717 </dl> |
|
718 <a NAME="DebugViewer.setCallTraceToProjectMode" ID="DebugViewer.setCallTraceToProjectMode"></a> |
|
719 <h4>DebugViewer.setCallTraceToProjectMode</h4> |
|
720 <b>setCallTraceToProjectMode</b>(<i>enabled</i>) |
|
721 |
|
722 <p> |
|
723 Public slot to set the call trace viewer to project mode. |
|
724 </p> |
|
725 <p> |
|
726 In project mode the call trace info is shown with project relative |
|
727 path names. |
|
728 </p> |
|
729 <dl> |
|
730 |
|
731 <dt><i>enabled</i> (bool)</dt> |
|
732 <dd> |
|
733 flag indicating to enable the project mode |
|
734 </dd> |
|
735 </dl> |
|
736 <a NAME="DebugViewer.setCurrentWidget" ID="DebugViewer.setCurrentWidget"></a> |
|
737 <h4>DebugViewer.setCurrentWidget</h4> |
|
738 <b>setCurrentWidget</b>(<i>widget</i>) |
|
739 |
|
740 <p> |
|
741 Public slot to set the current page based on the given widget. |
|
742 </p> |
|
743 <dl> |
|
744 |
|
745 <dt><i>widget</i> (QWidget)</dt> |
|
746 <dd> |
|
747 reference to the widget |
|
748 </dd> |
|
749 </dl> |
|
750 <a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a> |
|
751 <h4>DebugViewer.setDebugger</h4> |
|
752 <b>setDebugger</b>(<i>debugUI</i>) |
|
753 |
|
754 <p> |
|
755 Public method to set a reference to the Debug UI. |
|
756 </p> |
|
757 <dl> |
|
758 |
|
759 <dt><i>debugUI</i> (DebugUI)</dt> |
|
760 <dd> |
|
761 reference to the DebugUI object |
|
762 </dd> |
|
763 </dl> |
|
764 <a NAME="DebugViewer.setGlobalsFilter" ID="DebugViewer.setGlobalsFilter"></a> |
|
765 <h4>DebugViewer.setGlobalsFilter</h4> |
|
766 <b>setGlobalsFilter</b>(<i></i>) |
|
767 |
|
768 <p> |
|
769 Public slot to set the global variable filter. |
|
770 </p> |
|
771 <a NAME="DebugViewer.setLocalsFilter" ID="DebugViewer.setLocalsFilter"></a> |
|
772 <h4>DebugViewer.setLocalsFilter</h4> |
|
773 <b>setLocalsFilter</b>(<i></i>) |
|
774 |
|
775 <p> |
|
776 Public slot to set the local variable filter. |
|
777 </p> |
|
778 <a NAME="DebugViewer.setVariablesFilter" ID="DebugViewer.setVariablesFilter"></a> |
|
779 <h4>DebugViewer.setVariablesFilter</h4> |
|
780 <b>setVariablesFilter</b>(<i>globalsFilter, localsFilter</i>) |
|
781 |
|
782 <p> |
|
783 Public slot to set the local variables filter. |
|
784 </p> |
|
785 <dl> |
|
786 |
|
787 <dt><i>globalsFilter</i> (list of str)</dt> |
|
788 <dd> |
|
789 filter list for global variable types |
|
790 </dd> |
|
791 <dt><i>localsFilter</i> (list of str)</dt> |
|
792 <dd> |
|
793 filter list for local variable types |
|
794 </dd> |
|
795 </dl> |
|
796 <a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a> |
|
797 <h4>DebugViewer.showVariable</h4> |
|
798 <b>showVariable</b>(<i>vlist, showGlobals</i>) |
|
799 |
|
800 <p> |
|
801 Public method to show the variables in the respective window. |
|
802 </p> |
|
803 <dl> |
|
804 |
|
805 <dt><i>vlist</i> (list)</dt> |
|
806 <dd> |
|
807 list of variables to display |
|
808 </dd> |
|
809 <dt><i>showGlobals</i> (bool)</dt> |
|
810 <dd> |
|
811 flag indicating global/local state |
|
812 </dd> |
|
813 </dl> |
|
814 <a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a> |
|
815 <h4>DebugViewer.showVariables</h4> |
|
816 <b>showVariables</b>(<i>vlist, showGlobals</i>) |
|
817 |
|
818 <p> |
|
819 Public method to show the variables in the respective window. |
|
820 </p> |
|
821 <dl> |
|
822 |
|
823 <dt><i>vlist</i> (list)</dt> |
|
824 <dd> |
|
825 list of variables to display |
|
826 </dd> |
|
827 <dt><i>showGlobals</i> (bool)</dt> |
|
828 <dd> |
|
829 flag indicating global/local state |
|
830 </dd> |
|
831 </dl> |
|
832 <a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a> |
|
833 <h4>DebugViewer.showVariablesTab</h4> |
|
834 <b>showVariablesTab</b>(<i>showGlobals</i>) |
|
835 |
|
836 <p> |
|
837 Public method to make a variables tab visible. |
|
838 </p> |
|
839 <dl> |
|
840 |
|
841 <dt><i>showGlobals</i> (bool)</dt> |
|
842 <dd> |
|
843 flag indicating global/local state |
|
844 </dd> |
|
845 </dl> |
|
846 <div align="right"><a href="#top">Up</a></div> |
|
847 <hr /> |
|
848 </body></html> |