|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Debugger.CallTraceViewer</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Debugger.CallTraceViewer</h1> |
|
23 <p> |
|
24 Module implementing the Call Trace viewer widget. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#CallTraceViewer">CallTraceViewer</a></td> |
|
34 <td>Class implementing the Call Trace viewer widget.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="CallTraceViewer" ID="CallTraceViewer"></a> |
|
43 <h2>CallTraceViewer</h2> |
|
44 <p> |
|
45 Class implementing the Call Trace viewer widget. |
|
46 </p><h3>Signals</h3> |
|
47 <dl> |
|
48 <dt>sourceFile(str, int)</dt> |
|
49 <dd> |
|
50 emitted to show the source of a call/return |
|
51 point |
|
52 </dd> |
|
53 </dl> |
|
54 <h3>Derived from</h3> |
|
55 QWidget, Ui_CallTraceViewer |
|
56 <h3>Class Attributes</h3> |
|
57 <table> |
|
58 <tr><td>None</td></tr> |
|
59 </table> |
|
60 <h3>Class Methods</h3> |
|
61 <table> |
|
62 <tr><td>None</td></tr> |
|
63 </table> |
|
64 <h3>Methods</h3> |
|
65 <table> |
|
66 <tr> |
|
67 <td><a href="#CallTraceViewer.__init__">CallTraceViewer</a></td> |
|
68 <td>Constructor</td> |
|
69 </tr><tr> |
|
70 <td><a href="#CallTraceViewer.__addCallTraceInfo">__addCallTraceInfo</a></td> |
|
71 <td>Private method to add an entry to the call trace viewer.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#CallTraceViewer.__clientExit">__clientExit</a></td> |
|
74 <td>Private slot handling a client exiting.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#CallTraceViewer.__setCallTraceEnabled">__setCallTraceEnabled</a></td> |
|
77 <td>Private slot to set the call trace enabled status.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#CallTraceViewer.clear">clear</a></td> |
|
80 <td>Public slot to clear the call trace info.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#CallTraceViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> |
|
83 <td>Public method to get the state of the call trace function.</td> |
|
84 </tr><tr> |
|
85 <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> |
|
87 </tr><tr> |
|
88 <td><a href="#CallTraceViewer.on_clearButton_clicked">on_clearButton_clicked</a></td> |
|
89 <td>Private slot to clear the call trace.</td> |
|
90 </tr><tr> |
|
91 <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> |
|
93 </tr><tr> |
|
94 <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> |
|
96 </tr><tr> |
|
97 <td><a href="#CallTraceViewer.on_startTraceButton_clicked">on_startTraceButton_clicked</a></td> |
|
98 <td>Private slot to start call tracing.</td> |
|
99 </tr><tr> |
|
100 <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> |
|
102 </tr><tr> |
|
103 <td><a href="#CallTraceViewer.on_stopTraceButton_clicked">on_stopTraceButton_clicked</a></td> |
|
104 <td>Private slot to start call tracing.</td> |
|
105 </tr><tr> |
|
106 <td><a href="#CallTraceViewer.setProjectMode">setProjectMode</a></td> |
|
107 <td>Public slot to set the call trace viewer to project mode.</td> |
|
108 </tr> |
|
109 </table> |
|
110 <h3>Static Methods</h3> |
|
111 <table> |
|
112 <tr><td>None</td></tr> |
|
113 </table> |
|
114 <a NAME="CallTraceViewer.__init__" ID="CallTraceViewer.__init__"></a> |
|
115 <h4>CallTraceViewer (Constructor)</h4> |
|
116 <b>CallTraceViewer</b>(<i>debugServer, parent=None</i>) |
|
117 <p> |
|
118 Constructor |
|
119 </p><dl> |
|
120 <dt><i>debugServer</i></dt> |
|
121 <dd> |
|
122 reference to the debug server object (DebugServer) |
|
123 </dd><dt><i>parent</i></dt> |
|
124 <dd> |
|
125 reference to the parent widget (QWidget) |
|
126 </dd> |
|
127 </dl><a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a> |
|
128 <h4>CallTraceViewer.__addCallTraceInfo</h4> |
|
129 <b>__addCallTraceInfo</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>) |
|
130 <p> |
|
131 Private method to add an entry to the call trace viewer. |
|
132 </p><dl> |
|
133 <dt><i>isCall</i></dt> |
|
134 <dd> |
|
135 flag indicating a 'call' (boolean) |
|
136 </dd><dt><i>fromFile</i></dt> |
|
137 <dd> |
|
138 name of the originating file (string) |
|
139 </dd><dt><i>fromLine</i></dt> |
|
140 <dd> |
|
141 line number in the originating file (string) |
|
142 </dd><dt><i>fromFunction</i></dt> |
|
143 <dd> |
|
144 name of the originating function (string) |
|
145 </dd><dt><i>toFile</i></dt> |
|
146 <dd> |
|
147 name of the target file (string) |
|
148 </dd><dt><i>toLine</i></dt> |
|
149 <dd> |
|
150 line number in the target file (string) |
|
151 </dd><dt><i>toFunction</i></dt> |
|
152 <dd> |
|
153 name of the target function (string) |
|
154 </dd> |
|
155 </dl><a NAME="CallTraceViewer.__clientExit" ID="CallTraceViewer.__clientExit"></a> |
|
156 <h4>CallTraceViewer.__clientExit</h4> |
|
157 <b>__clientExit</b>(<i></i>) |
|
158 <p> |
|
159 Private slot handling a client exiting. |
|
160 </p><a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a> |
|
161 <h4>CallTraceViewer.__setCallTraceEnabled</h4> |
|
162 <b>__setCallTraceEnabled</b>(<i>enabled</i>) |
|
163 <p> |
|
164 Private slot to set the call trace enabled status. |
|
165 </p><dl> |
|
166 <dt><i>enabled</i></dt> |
|
167 <dd> |
|
168 flag indicating the new state (boolean) |
|
169 </dd> |
|
170 </dl><a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a> |
|
171 <h4>CallTraceViewer.clear</h4> |
|
172 <b>clear</b>(<i></i>) |
|
173 <p> |
|
174 Public slot to clear the call trace info. |
|
175 </p><a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a> |
|
176 <h4>CallTraceViewer.isCallTraceEnabled</h4> |
|
177 <b>isCallTraceEnabled</b>(<i></i>) |
|
178 <p> |
|
179 Public method to get the state of the call trace function. |
|
180 </p><dl> |
|
181 <dt>Returns:</dt> |
|
182 <dd> |
|
183 flag indicating the state of the call trace function (boolean) |
|
184 </dd> |
|
185 </dl><a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a> |
|
186 <h4>CallTraceViewer.on_callTrace_itemDoubleClicked</h4> |
|
187 <b>on_callTrace_itemDoubleClicked</b>(<i>item, column</i>) |
|
188 <p> |
|
189 Private slot to open the double clicked file in an editor. |
|
190 </p><dl> |
|
191 <dt><i>item</i></dt> |
|
192 <dd> |
|
193 reference to the double clicked item (QTreeWidgetItem) |
|
194 </dd><dt><i>column</i></dt> |
|
195 <dd> |
|
196 column that was double clicked (integer) |
|
197 </dd> |
|
198 </dl><a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a> |
|
199 <h4>CallTraceViewer.on_clearButton_clicked</h4> |
|
200 <b>on_clearButton_clicked</b>(<i></i>) |
|
201 <p> |
|
202 Private slot to clear the call trace. |
|
203 </p><a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a> |
|
204 <h4>CallTraceViewer.on_resizeButton_clicked</h4> |
|
205 <b>on_resizeButton_clicked</b>(<i></i>) |
|
206 <p> |
|
207 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> |
|
209 <h4>CallTraceViewer.on_saveButton_clicked</h4> |
|
210 <b>on_saveButton_clicked</b>(<i></i>) |
|
211 <p> |
|
212 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> |
|
214 <h4>CallTraceViewer.on_startTraceButton_clicked</h4> |
|
215 <b>on_startTraceButton_clicked</b>(<i></i>) |
|
216 <p> |
|
217 Private slot to start call tracing. |
|
218 </p><a NAME="CallTraceViewer.on_stopCheckBox_clicked" ID="CallTraceViewer.on_stopCheckBox_clicked"></a> |
|
219 <h4>CallTraceViewer.on_stopCheckBox_clicked</h4> |
|
220 <b>on_stopCheckBox_clicked</b>(<i>checked</i>) |
|
221 <p> |
|
222 Private slot to handle a click on the stop check box. |
|
223 </p><dl> |
|
224 <dt><i>checked</i> (bool)</dt> |
|
225 <dd> |
|
226 state of the check box |
|
227 </dd> |
|
228 </dl><a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a> |
|
229 <h4>CallTraceViewer.on_stopTraceButton_clicked</h4> |
|
230 <b>on_stopTraceButton_clicked</b>(<i></i>) |
|
231 <p> |
|
232 Private slot to start call tracing. |
|
233 </p><a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a> |
|
234 <h4>CallTraceViewer.setProjectMode</h4> |
|
235 <b>setProjectMode</b>(<i>enabled</i>) |
|
236 <p> |
|
237 Public slot to set the call trace viewer to project mode. |
|
238 </p><p> |
|
239 In project mode the call trace info is shown with project relative |
|
240 path names. |
|
241 </p><dl> |
|
242 <dt><i>enabled</i></dt> |
|
243 <dd> |
|
244 flag indicating to enable the project mode (boolean) |
|
245 </dd> |
|
246 </dl> |
|
247 <div align="right"><a href="#top">Up</a></div> |
|
248 <hr /> |
|
249 </body></html> |