16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.Debugger.CallTraceViewer</h1> |
23 <h1>eric6.Debugger.CallTraceViewer</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing the Call Trace viewer widget. |
26 Module implementing the Call Trace viewer widget. |
25 </p> |
27 </p> |
26 <h3>Global Attributes</h3> |
28 <h3>Global Attributes</h3> |
|
29 |
27 <table> |
30 <table> |
28 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
29 </table> |
32 </table> |
30 <h3>Classes</h3> |
33 <h3>Classes</h3> |
31 <table> |
34 |
|
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#CallTraceViewer">CallTraceViewer</a></td> |
38 <td><a href="#CallTraceViewer">CallTraceViewer</a></td> |
34 <td>Class implementing the Call Trace viewer widget.</td> |
39 <td>Class implementing the Call Trace viewer widget.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
38 <table> |
43 |
39 <tr><td>None</td></tr> |
44 <table> |
40 </table> |
45 <tr><td>None</td></tr> |
41 <hr /><hr /> |
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
42 <a NAME="CallTraceViewer" ID="CallTraceViewer"></a> |
49 <a NAME="CallTraceViewer" ID="CallTraceViewer"></a> |
43 <h2>CallTraceViewer</h2> |
50 <h2>CallTraceViewer</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing the Call Trace viewer widget. |
53 Class implementing the Call Trace viewer widget. |
46 </p><h3>Signals</h3> |
54 </p> |
47 <dl> |
55 <h3>Signals</h3> |
|
56 <dl> |
|
57 |
48 <dt>sourceFile(str, int)</dt> |
58 <dt>sourceFile(str, int)</dt> |
49 <dd> |
59 <dd> |
50 emitted to show the source of a call/return |
60 emitted to show the source of a call/return |
51 point |
61 point |
52 </dd> |
62 </dd> |
53 </dl> |
63 </dl> |
54 <h3>Derived from</h3> |
64 <h3>Derived from</h3> |
55 QWidget, Ui_CallTraceViewer |
65 QWidget, Ui_CallTraceViewer |
56 <h3>Class Attributes</h3> |
66 <h3>Class Attributes</h3> |
|
67 |
57 <table> |
68 <table> |
58 <tr><td>None</td></tr> |
69 <tr><td>None</td></tr> |
59 </table> |
70 </table> |
60 <h3>Class Methods</h3> |
71 <h3>Class Methods</h3> |
|
72 |
61 <table> |
73 <table> |
62 <tr><td>None</td></tr> |
74 <tr><td>None</td></tr> |
63 </table> |
75 </table> |
64 <h3>Methods</h3> |
76 <h3>Methods</h3> |
65 <table> |
77 |
|
78 <table> |
|
79 |
66 <tr> |
80 <tr> |
67 <td><a href="#CallTraceViewer.__init__">CallTraceViewer</a></td> |
81 <td><a href="#CallTraceViewer.__init__">CallTraceViewer</a></td> |
68 <td>Constructor</td> |
82 <td>Constructor</td> |
69 </tr><tr> |
83 </tr> |
|
84 <tr> |
70 <td><a href="#CallTraceViewer.__addCallTraceInfo">__addCallTraceInfo</a></td> |
85 <td><a href="#CallTraceViewer.__addCallTraceInfo">__addCallTraceInfo</a></td> |
71 <td>Private method to add an entry to the call trace viewer.</td> |
86 <td>Private method to add an entry to the call trace viewer.</td> |
72 </tr><tr> |
87 </tr> |
|
88 <tr> |
73 <td><a href="#CallTraceViewer.__clientExit">__clientExit</a></td> |
89 <td><a href="#CallTraceViewer.__clientExit">__clientExit</a></td> |
74 <td>Private slot handling a client exiting.</td> |
90 <td>Private slot handling a client exiting.</td> |
75 </tr><tr> |
91 </tr> |
|
92 <tr> |
76 <td><a href="#CallTraceViewer.__setCallTraceEnabled">__setCallTraceEnabled</a></td> |
93 <td><a href="#CallTraceViewer.__setCallTraceEnabled">__setCallTraceEnabled</a></td> |
77 <td>Private slot to set the call trace enabled status.</td> |
94 <td>Private slot to set the call trace enabled status.</td> |
78 </tr><tr> |
95 </tr> |
|
96 <tr> |
79 <td><a href="#CallTraceViewer.clear">clear</a></td> |
97 <td><a href="#CallTraceViewer.clear">clear</a></td> |
80 <td>Public slot to clear the call trace info.</td> |
98 <td>Public slot to clear the call trace info.</td> |
81 </tr><tr> |
99 </tr> |
|
100 <tr> |
82 <td><a href="#CallTraceViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> |
101 <td><a href="#CallTraceViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> |
83 <td>Public method to get the state of the call trace function.</td> |
102 <td>Public method to get the state of the call trace function.</td> |
84 </tr><tr> |
103 </tr> |
|
104 <tr> |
85 <td><a href="#CallTraceViewer.on_callTrace_itemDoubleClicked">on_callTrace_itemDoubleClicked</a></td> |
105 <td><a href="#CallTraceViewer.on_callTrace_itemDoubleClicked">on_callTrace_itemDoubleClicked</a></td> |
86 <td>Private slot to open the double clicked file in an editor.</td> |
106 <td>Private slot to open the double clicked file in an editor.</td> |
87 </tr><tr> |
107 </tr> |
|
108 <tr> |
88 <td><a href="#CallTraceViewer.on_clearButton_clicked">on_clearButton_clicked</a></td> |
109 <td><a href="#CallTraceViewer.on_clearButton_clicked">on_clearButton_clicked</a></td> |
89 <td>Private slot to clear the call trace.</td> |
110 <td>Private slot to clear the call trace.</td> |
90 </tr><tr> |
111 </tr> |
|
112 <tr> |
91 <td><a href="#CallTraceViewer.on_resizeButton_clicked">on_resizeButton_clicked</a></td> |
113 <td><a href="#CallTraceViewer.on_resizeButton_clicked">on_resizeButton_clicked</a></td> |
92 <td>Private slot to resize the columns of the call trace to their contents.</td> |
114 <td>Private slot to resize the columns of the call trace to their contents.</td> |
93 </tr><tr> |
115 </tr> |
|
116 <tr> |
94 <td><a href="#CallTraceViewer.on_saveButton_clicked">on_saveButton_clicked</a></td> |
117 <td><a href="#CallTraceViewer.on_saveButton_clicked">on_saveButton_clicked</a></td> |
95 <td>Private slot to save the call trace info to a file.</td> |
118 <td>Private slot to save the call trace info to a file.</td> |
96 </tr><tr> |
119 </tr> |
|
120 <tr> |
97 <td><a href="#CallTraceViewer.on_startTraceButton_clicked">on_startTraceButton_clicked</a></td> |
121 <td><a href="#CallTraceViewer.on_startTraceButton_clicked">on_startTraceButton_clicked</a></td> |
98 <td>Private slot to start call tracing.</td> |
122 <td>Private slot to start call tracing.</td> |
99 </tr><tr> |
123 </tr> |
|
124 <tr> |
100 <td><a href="#CallTraceViewer.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> |
125 <td><a href="#CallTraceViewer.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> |
101 <td>Private slot to handle a click on the stop check box.</td> |
126 <td>Private slot to handle a click on the stop check box.</td> |
102 </tr><tr> |
127 </tr> |
|
128 <tr> |
103 <td><a href="#CallTraceViewer.on_stopTraceButton_clicked">on_stopTraceButton_clicked</a></td> |
129 <td><a href="#CallTraceViewer.on_stopTraceButton_clicked">on_stopTraceButton_clicked</a></td> |
104 <td>Private slot to start call tracing.</td> |
130 <td>Private slot to start call tracing.</td> |
105 </tr><tr> |
131 </tr> |
|
132 <tr> |
106 <td><a href="#CallTraceViewer.setProjectMode">setProjectMode</a></td> |
133 <td><a href="#CallTraceViewer.setProjectMode">setProjectMode</a></td> |
107 <td>Public slot to set the call trace viewer to project mode.</td> |
134 <td>Public slot to set the call trace viewer to project mode.</td> |
108 </tr> |
135 </tr> |
109 </table> |
136 </table> |
110 <h3>Static Methods</h3> |
137 <h3>Static Methods</h3> |
111 <table> |
138 |
112 <tr><td>None</td></tr> |
139 <table> |
113 </table> |
140 <tr><td>None</td></tr> |
|
141 </table> |
|
142 |
114 <a NAME="CallTraceViewer.__init__" ID="CallTraceViewer.__init__"></a> |
143 <a NAME="CallTraceViewer.__init__" ID="CallTraceViewer.__init__"></a> |
115 <h4>CallTraceViewer (Constructor)</h4> |
144 <h4>CallTraceViewer (Constructor)</h4> |
116 <b>CallTraceViewer</b>(<i>debugServer, parent=None</i>) |
145 <b>CallTraceViewer</b>(<i>debugServer, parent=None</i>) |
|
146 |
117 <p> |
147 <p> |
118 Constructor |
148 Constructor |
119 </p><dl> |
149 </p> |
|
150 <dl> |
|
151 |
120 <dt><i>debugServer</i></dt> |
152 <dt><i>debugServer</i></dt> |
121 <dd> |
153 <dd> |
122 reference to the debug server object (DebugServer) |
154 reference to the debug server object (DebugServer) |
123 </dd><dt><i>parent</i></dt> |
155 </dd> |
|
156 <dt><i>parent</i></dt> |
124 <dd> |
157 <dd> |
125 reference to the parent widget (QWidget) |
158 reference to the parent widget (QWidget) |
126 </dd> |
159 </dd> |
127 </dl><a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a> |
160 </dl> |
|
161 <a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a> |
128 <h4>CallTraceViewer.__addCallTraceInfo</h4> |
162 <h4>CallTraceViewer.__addCallTraceInfo</h4> |
129 <b>__addCallTraceInfo</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>) |
163 <b>__addCallTraceInfo</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>) |
|
164 |
130 <p> |
165 <p> |
131 Private method to add an entry to the call trace viewer. |
166 Private method to add an entry to the call trace viewer. |
132 </p><dl> |
167 </p> |
|
168 <dl> |
|
169 |
133 <dt><i>isCall</i></dt> |
170 <dt><i>isCall</i></dt> |
134 <dd> |
171 <dd> |
135 flag indicating a 'call' (boolean) |
172 flag indicating a 'call' (boolean) |
136 </dd><dt><i>fromFile</i></dt> |
173 </dd> |
|
174 <dt><i>fromFile</i></dt> |
137 <dd> |
175 <dd> |
138 name of the originating file (string) |
176 name of the originating file (string) |
139 </dd><dt><i>fromLine</i></dt> |
177 </dd> |
|
178 <dt><i>fromLine</i></dt> |
140 <dd> |
179 <dd> |
141 line number in the originating file (string) |
180 line number in the originating file (string) |
142 </dd><dt><i>fromFunction</i></dt> |
181 </dd> |
|
182 <dt><i>fromFunction</i></dt> |
143 <dd> |
183 <dd> |
144 name of the originating function (string) |
184 name of the originating function (string) |
145 </dd><dt><i>toFile</i></dt> |
185 </dd> |
|
186 <dt><i>toFile</i></dt> |
146 <dd> |
187 <dd> |
147 name of the target file (string) |
188 name of the target file (string) |
148 </dd><dt><i>toLine</i></dt> |
189 </dd> |
|
190 <dt><i>toLine</i></dt> |
149 <dd> |
191 <dd> |
150 line number in the target file (string) |
192 line number in the target file (string) |
151 </dd><dt><i>toFunction</i></dt> |
193 </dd> |
|
194 <dt><i>toFunction</i></dt> |
152 <dd> |
195 <dd> |
153 name of the target function (string) |
196 name of the target function (string) |
154 </dd> |
197 </dd> |
155 </dl><a NAME="CallTraceViewer.__clientExit" ID="CallTraceViewer.__clientExit"></a> |
198 </dl> |
|
199 <a NAME="CallTraceViewer.__clientExit" ID="CallTraceViewer.__clientExit"></a> |
156 <h4>CallTraceViewer.__clientExit</h4> |
200 <h4>CallTraceViewer.__clientExit</h4> |
157 <b>__clientExit</b>(<i></i>) |
201 <b>__clientExit</b>(<i></i>) |
|
202 |
158 <p> |
203 <p> |
159 Private slot handling a client exiting. |
204 Private slot handling a client exiting. |
160 </p><a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a> |
205 </p> |
|
206 <a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a> |
161 <h4>CallTraceViewer.__setCallTraceEnabled</h4> |
207 <h4>CallTraceViewer.__setCallTraceEnabled</h4> |
162 <b>__setCallTraceEnabled</b>(<i>enabled</i>) |
208 <b>__setCallTraceEnabled</b>(<i>enabled</i>) |
|
209 |
163 <p> |
210 <p> |
164 Private slot to set the call trace enabled status. |
211 Private slot to set the call trace enabled status. |
165 </p><dl> |
212 </p> |
|
213 <dl> |
|
214 |
166 <dt><i>enabled</i></dt> |
215 <dt><i>enabled</i></dt> |
167 <dd> |
216 <dd> |
168 flag indicating the new state (boolean) |
217 flag indicating the new state (boolean) |
169 </dd> |
218 </dd> |
170 </dl><a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a> |
219 </dl> |
|
220 <a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a> |
171 <h4>CallTraceViewer.clear</h4> |
221 <h4>CallTraceViewer.clear</h4> |
172 <b>clear</b>(<i></i>) |
222 <b>clear</b>(<i></i>) |
|
223 |
173 <p> |
224 <p> |
174 Public slot to clear the call trace info. |
225 Public slot to clear the call trace info. |
175 </p><a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a> |
226 </p> |
|
227 <a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a> |
176 <h4>CallTraceViewer.isCallTraceEnabled</h4> |
228 <h4>CallTraceViewer.isCallTraceEnabled</h4> |
177 <b>isCallTraceEnabled</b>(<i></i>) |
229 <b>isCallTraceEnabled</b>(<i></i>) |
|
230 |
178 <p> |
231 <p> |
179 Public method to get the state of the call trace function. |
232 Public method to get the state of the call trace function. |
180 </p><dl> |
233 </p> |
|
234 <dl> |
181 <dt>Returns:</dt> |
235 <dt>Returns:</dt> |
182 <dd> |
236 <dd> |
183 flag indicating the state of the call trace function (boolean) |
237 flag indicating the state of the call trace function (boolean) |
184 </dd> |
238 </dd> |
185 </dl><a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a> |
239 </dl> |
|
240 <a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a> |
186 <h4>CallTraceViewer.on_callTrace_itemDoubleClicked</h4> |
241 <h4>CallTraceViewer.on_callTrace_itemDoubleClicked</h4> |
187 <b>on_callTrace_itemDoubleClicked</b>(<i>item, column</i>) |
242 <b>on_callTrace_itemDoubleClicked</b>(<i>item, column</i>) |
|
243 |
188 <p> |
244 <p> |
189 Private slot to open the double clicked file in an editor. |
245 Private slot to open the double clicked file in an editor. |
190 </p><dl> |
246 </p> |
|
247 <dl> |
|
248 |
191 <dt><i>item</i></dt> |
249 <dt><i>item</i></dt> |
192 <dd> |
250 <dd> |
193 reference to the double clicked item (QTreeWidgetItem) |
251 reference to the double clicked item (QTreeWidgetItem) |
194 </dd><dt><i>column</i></dt> |
252 </dd> |
|
253 <dt><i>column</i></dt> |
195 <dd> |
254 <dd> |
196 column that was double clicked (integer) |
255 column that was double clicked (integer) |
197 </dd> |
256 </dd> |
198 </dl><a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a> |
257 </dl> |
|
258 <a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a> |
199 <h4>CallTraceViewer.on_clearButton_clicked</h4> |
259 <h4>CallTraceViewer.on_clearButton_clicked</h4> |
200 <b>on_clearButton_clicked</b>(<i></i>) |
260 <b>on_clearButton_clicked</b>(<i></i>) |
|
261 |
201 <p> |
262 <p> |
202 Private slot to clear the call trace. |
263 Private slot to clear the call trace. |
203 </p><a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a> |
264 </p> |
|
265 <a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a> |
204 <h4>CallTraceViewer.on_resizeButton_clicked</h4> |
266 <h4>CallTraceViewer.on_resizeButton_clicked</h4> |
205 <b>on_resizeButton_clicked</b>(<i></i>) |
267 <b>on_resizeButton_clicked</b>(<i></i>) |
|
268 |
206 <p> |
269 <p> |
207 Private slot to resize the columns of the call trace to their contents. |
270 Private slot to resize the columns of the call trace to their contents. |
208 </p><a NAME="CallTraceViewer.on_saveButton_clicked" ID="CallTraceViewer.on_saveButton_clicked"></a> |
271 </p> |
|
272 <a NAME="CallTraceViewer.on_saveButton_clicked" ID="CallTraceViewer.on_saveButton_clicked"></a> |
209 <h4>CallTraceViewer.on_saveButton_clicked</h4> |
273 <h4>CallTraceViewer.on_saveButton_clicked</h4> |
210 <b>on_saveButton_clicked</b>(<i></i>) |
274 <b>on_saveButton_clicked</b>(<i></i>) |
|
275 |
211 <p> |
276 <p> |
212 Private slot to save the call trace info to a file. |
277 Private slot to save the call trace info to a file. |
213 </p><a NAME="CallTraceViewer.on_startTraceButton_clicked" ID="CallTraceViewer.on_startTraceButton_clicked"></a> |
278 </p> |
|
279 <a NAME="CallTraceViewer.on_startTraceButton_clicked" ID="CallTraceViewer.on_startTraceButton_clicked"></a> |
214 <h4>CallTraceViewer.on_startTraceButton_clicked</h4> |
280 <h4>CallTraceViewer.on_startTraceButton_clicked</h4> |
215 <b>on_startTraceButton_clicked</b>(<i></i>) |
281 <b>on_startTraceButton_clicked</b>(<i></i>) |
|
282 |
216 <p> |
283 <p> |
217 Private slot to start call tracing. |
284 Private slot to start call tracing. |
218 </p><a NAME="CallTraceViewer.on_stopCheckBox_clicked" ID="CallTraceViewer.on_stopCheckBox_clicked"></a> |
285 </p> |
|
286 <a NAME="CallTraceViewer.on_stopCheckBox_clicked" ID="CallTraceViewer.on_stopCheckBox_clicked"></a> |
219 <h4>CallTraceViewer.on_stopCheckBox_clicked</h4> |
287 <h4>CallTraceViewer.on_stopCheckBox_clicked</h4> |
220 <b>on_stopCheckBox_clicked</b>(<i>checked</i>) |
288 <b>on_stopCheckBox_clicked</b>(<i>checked</i>) |
|
289 |
221 <p> |
290 <p> |
222 Private slot to handle a click on the stop check box. |
291 Private slot to handle a click on the stop check box. |
223 </p><dl> |
292 </p> |
|
293 <dl> |
|
294 |
224 <dt><i>checked</i> (bool)</dt> |
295 <dt><i>checked</i> (bool)</dt> |
225 <dd> |
296 <dd> |
226 state of the check box |
297 state of the check box |
227 </dd> |
298 </dd> |
228 </dl><a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a> |
299 </dl> |
|
300 <a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a> |
229 <h4>CallTraceViewer.on_stopTraceButton_clicked</h4> |
301 <h4>CallTraceViewer.on_stopTraceButton_clicked</h4> |
230 <b>on_stopTraceButton_clicked</b>(<i></i>) |
302 <b>on_stopTraceButton_clicked</b>(<i></i>) |
|
303 |
231 <p> |
304 <p> |
232 Private slot to start call tracing. |
305 Private slot to start call tracing. |
233 </p><a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a> |
306 </p> |
|
307 <a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a> |
234 <h4>CallTraceViewer.setProjectMode</h4> |
308 <h4>CallTraceViewer.setProjectMode</h4> |
235 <b>setProjectMode</b>(<i>enabled</i>) |
309 <b>setProjectMode</b>(<i>enabled</i>) |
|
310 |
236 <p> |
311 <p> |
237 Public slot to set the call trace viewer to project mode. |
312 Public slot to set the call trace viewer to project mode. |
238 </p><p> |
313 </p> |
|
314 <p> |
239 In project mode the call trace info is shown with project relative |
315 In project mode the call trace info is shown with project relative |
240 path names. |
316 path names. |
241 </p><dl> |
317 </p> |
|
318 <dl> |
|
319 |
242 <dt><i>enabled</i></dt> |
320 <dt><i>enabled</i></dt> |
243 <dd> |
321 <dd> |
244 flag indicating to enable the project mode (boolean) |
322 flag indicating to enable the project mode (boolean) |
245 </dd> |
323 </dd> |
246 </dl> |
324 </dl> |