89 </table> |
89 </table> |
90 <h3>Functions</h3> |
90 <h3>Functions</h3> |
91 <table> |
91 <table> |
92 <tr> |
92 <tr> |
93 <td><a href="#DebugClientBase.canEval?">canEval?</a></td> |
93 <td><a href="#DebugClientBase.canEval?">canEval?</a></td> |
94 <td>Private method to check if the buffer's contents can be evaluated.</td> |
94 <td>Private method to check if the buffer's contents can be evaluated.</td> |
95 </tr><tr> |
95 </tr><tr> |
96 <td><a href="#DebugClientBase.completionList">completionList</a></td> |
96 <td><a href="#DebugClientBase.completionList">completionList</a></td> |
97 <td>Method used to handle the command completion request</td> |
97 <td>Method used to handle the command completion request</td> |
98 </tr><tr> |
98 </tr><tr> |
99 <td><a href="#DebugClientBase.connectDebugger">connectDebugger</a></td> |
99 <td><a href="#DebugClientBase.connectDebugger">connectDebugger</a></td> |
100 <td>Public method to establish a session with the debugger.</td> |
100 <td>Public method to establish a session with the debugger.</td> |
101 </tr><tr> |
101 </tr><tr> |
102 <td><a href="#DebugClientBase.dumpVariable">dumpVariable</a></td> |
102 <td><a href="#DebugClientBase.dumpVariable">dumpVariable</a></td> |
103 <td>Private method to return the variables of a frame to the debug server.</td> |
103 <td>Private method to return the variables of a frame to the debug server.</td> |
104 </tr><tr> |
104 </tr><tr> |
105 <td><a href="#DebugClientBase.dumpVariables">dumpVariables</a></td> |
105 <td><a href="#DebugClientBase.dumpVariables">dumpVariables</a></td> |
106 <td>Private method to return the variables of a frame to the debug server.</td> |
106 <td>Private method to return the variables of a frame to the debug server.</td> |
107 </tr><tr> |
107 </tr><tr> |
108 <td><a href="#DebugClientBase.eventLoop">eventLoop</a></td> |
108 <td><a href="#DebugClientBase.eventLoop">eventLoop</a></td> |
109 <td>Private method implementing our event loop.</td> |
109 <td>Private method implementing our event loop.</td> |
110 </tr><tr> |
110 </tr><tr> |
111 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td> |
111 <td><a href="#DebugClientBase.eventPoll">eventPoll</a></td> |
112 <td>Private method to poll for events like 'set break point'.</td> |
112 <td>Private method to poll for events like 'set break point'.</td> |
113 </tr><tr> |
113 </tr><tr> |
114 <td><a href="#DebugClientBase.extractAddress">extractAddress</a></td> |
114 <td><a href="#DebugClientBase.extractAddress">extractAddress</a></td> |
115 <td>Private method to extract the address part of an object description.</td> |
115 <td>Private method to extract the address part of an object description.</td> |
116 </tr><tr> |
116 </tr><tr> |
117 <td><a href="#DebugClientBase.extractTypeAndAddress">extractTypeAndAddress</a></td> |
117 <td><a href="#DebugClientBase.extractTypeAndAddress">extractTypeAndAddress</a></td> |
118 <td>Private method to extract the address and type parts of an object description.</td> |
118 <td>Private method to extract the address and type parts of an object description.</td> |
119 </tr><tr> |
119 </tr><tr> |
120 <td><a href="#DebugClientBase.formatVariablesList">formatVariablesList</a></td> |
120 <td><a href="#DebugClientBase.formatVariablesList">formatVariablesList</a></td> |
121 <td>Private method to produce a formated variables list.</td> |
121 <td>Private method to produce a formated variables list.</td> |
122 </tr><tr> |
122 </tr><tr> |
123 <td><a href="#DebugClientBase.generateFilterObjects">generateFilterObjects</a></td> |
123 <td><a href="#DebugClientBase.generateFilterObjects">generateFilterObjects</a></td> |
124 <td>Private method to convert a filter string to a list of filter objects.</td> |
124 <td>Private method to convert a filter string to a list of filter objects.</td> |
125 </tr><tr> |
125 </tr><tr> |
126 <td><a href="#DebugClientBase.handleException">handleException</a></td> |
126 <td><a href="#DebugClientBase.handleException">handleException</a></td> |
127 <td>Private method called in the case of an exception</td> |
127 <td>Private method called in the case of an exception</td> |
128 </tr><tr> |
128 </tr><tr> |
129 <td><a href="#DebugClientBase.handleLine">handleLine</a></td> |
129 <td><a href="#DebugClientBase.handleLine">handleLine</a></td> |
130 <td>Private method to handle the receipt of a complete line.</td> |
130 <td>Private method to handle the receipt of a complete line.</td> |
131 </tr><tr> |
131 </tr><tr> |
132 <td><a href="#DebugClientBase.inFilter?">inFilter?</a></td> |
132 <td><a href="#DebugClientBase.inFilter?">inFilter?</a></td> |
133 <td>Private method to check, if a variable is to be filtered based on its type.</td> |
133 <td>Private method to check, if a variable is to be filtered based on its type.</td> |
134 </tr><tr> |
134 </tr><tr> |
135 <td><a href="#DebugClientBase.initializeDebugClient">initializeDebugClient</a></td> |
135 <td><a href="#DebugClientBase.initializeDebugClient">initializeDebugClient</a></td> |
136 <td>Method to initialize the module</td> |
136 <td>Method to initialize the module</td> |
137 </tr><tr> |
137 </tr><tr> |
138 <td><a href="#DebugClientBase.interact">interact</a></td> |
138 <td><a href="#DebugClientBase.interact">interact</a></td> |
139 <td>Private method to Interact with the debugger.</td> |
139 <td>Private method to Interact with the debugger.</td> |
140 </tr><tr> |
140 </tr><tr> |
141 <td><a href="#DebugClientBase.main">main</a></td> |
141 <td><a href="#DebugClientBase.main">main</a></td> |
142 <td>Public method implementing the main method.</td> |
142 <td>Public method implementing the main method.</td> |
143 </tr><tr> |
143 </tr><tr> |
144 <td><a href="#DebugClientBase.progTerminated">progTerminated</a></td> |
144 <td><a href="#DebugClientBase.progTerminated">progTerminated</a></td> |
145 <td>Private method to tell the debugger that the program has terminated.</td> |
145 <td>Private method to tell the debugger that the program has terminated.</td> |
146 </tr><tr> |
146 </tr><tr> |
147 <td><a href="#DebugClientBase.sessionClose">sessionClose</a></td> |
147 <td><a href="#DebugClientBase.sessionClose">sessionClose</a></td> |
148 <td>Privat method to close the session with the debugger and terminate.</td> |
148 <td>Privat method to close the session with the debugger and terminate.</td> |
149 </tr><tr> |
149 </tr><tr> |
150 <td><a href="#DebugClientBase.startProgInDebugger">startProgInDebugger</a></td> |
150 <td><a href="#DebugClientBase.startProgInDebugger">startProgInDebugger</a></td> |
151 <td>Method used to start the remote debugger.</td> |
151 <td>Method used to start the remote debugger.</td> |
152 </tr><tr> |
152 </tr><tr> |
153 <td><a href="#DebugClientBase.trace_func">trace_func</a></td> |
153 <td><a href="#DebugClientBase.trace_func">trace_func</a></td> |
154 <td>Method executed by the tracing facility.</td> |
154 <td>Method executed by the tracing facility.</td> |
155 </tr><tr> |
155 </tr><tr> |
156 <td><a href="#DebugClientBase.unhandled_exception">unhandled_exception</a></td> |
156 <td><a href="#DebugClientBase.unhandled_exception">unhandled_exception</a></td> |
157 <td>Private method to report an unhandled exception.</td> |
157 <td>Private method to report an unhandled exception.</td> |
158 </tr><tr> |
158 </tr><tr> |
159 <td><a href="#DebugClientBase.write">write</a></td> |
159 <td><a href="#DebugClientBase.write">write</a></td> |
160 <td>Private method to write data to the output stream.</td> |
160 <td>Private method to write data to the output stream.</td> |
161 </tr> |
161 </tr> |
162 </table> |
162 </table> |
163 <hr /> |
163 <hr /> |
164 |
164 |
165 <a NAME="DebugClientBase.canEval?" ID="DebugClientBase.canEval?"></a> |
165 <a NAME="DebugClientBase.canEval?" ID="DebugClientBase.canEval?"></a> |
166 <h4>DebugClientBase.canEval?</h4> |
166 <h4>DebugClientBase.canEval?</h4> |
167 <b>canEval?</b>(<i></i>) |
167 <b>canEval?</b>(<i></i>) |
168 <p> |
168 <p> |
169 Private method to check if the buffer's contents can be evaluated. |
169 Private method to check if the buffer's contents can be evaluated. |
170 </p><dl> |
170 </p><dl> |
171 <dt>Returns:</dt> |
171 <dt>Returns:</dt> |
172 <dd> |
172 <dd> |
173 flag indicating if an eval might succeed (boolean) |
173 flag indicating if an eval might succeed (boolean) |
174 </dd> |
174 </dd> |
175 </dl><a NAME="DebugClientBase.completionList" ID="DebugClientBase.completionList"></a> |
175 </dl><a NAME="DebugClientBase.completionList" ID="DebugClientBase.completionList"></a> |
176 <h4>DebugClientBase.completionList</h4> |
176 <h4>DebugClientBase.completionList</h4> |
177 <b>completionList</b>(<i></i>) |
177 <b>completionList</b>(<i></i>) |
178 <p> |
178 <p> |
179 Method used to handle the command completion request |
179 Method used to handle the command completion request |
180 </p><dl> |
180 </p><dl> |
181 <dt><i>text</i></dt> |
181 <dt><i>text</i></dt> |
182 <dd> |
182 <dd> |
183 the text to be completed (string) |
183 the text to be completed (string) |
184 </dd> |
184 </dd> |
185 </dl><a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a> |
185 </dl><a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a> |
186 <h4>DebugClientBase.connectDebugger</h4> |
186 <h4>DebugClientBase.connectDebugger</h4> |
187 <b>connectDebugger</b>(<i>remoteAddress=nil, redirect=true</i>) |
187 <b>connectDebugger</b>(<i>remoteAddress=nil, redirect=true</i>) |
188 <p> |
188 <p> |
189 Public method to establish a session with the debugger. |
189 Public method to establish a session with the debugger. |
190 </p><p> |
190 </p><p> |
191 It opens a network connection to the debugger, connects it to stdin, |
191 It opens a network connection to the debugger, connects it to stdin, |
192 stdout and stderr and saves these file objects in case the application |
192 stdout and stderr and saves these file objects in case the application |
193 being debugged redirects them itself. |
193 being debugged redirects them itself. |
194 </p><dl> |
194 </p><dl> |
195 <dt><i>port</i></dt> |
195 <dt><i>port</i></dt> |
196 <dd> |
196 <dd> |
197 the port number to connect to (int) |
197 the port number to connect to (int) |
198 </dd><dt><i>remoteAddress</i></dt> |
198 </dd><dt><i>remoteAddress</i></dt> |
199 <dd> |
199 <dd> |
200 the network address of the debug server host (string) |
200 the network address of the debug server host (string) |
201 </dd><dt><i>redirect</i></dt> |
201 </dd><dt><i>redirect</i></dt> |
202 <dd> |
202 <dd> |
203 flag indicating redirection of stdin, stdout and stderr (boolean) |
203 flag indicating redirection of stdin, stdout and stderr (boolean) |
204 </dd> |
204 </dd> |
205 </dl><a NAME="DebugClientBase.dumpVariable" ID="DebugClientBase.dumpVariable"></a> |
205 </dl><a NAME="DebugClientBase.dumpVariable" ID="DebugClientBase.dumpVariable"></a> |
206 <h4>DebugClientBase.dumpVariable</h4> |
206 <h4>DebugClientBase.dumpVariable</h4> |
207 <b>dumpVariable</b>(<i>frmnr, scope, filter</i>) |
207 <b>dumpVariable</b>(<i>frmnr, scope, filter</i>) |
208 <p> |
208 <p> |
209 Private method to return the variables of a frame to the debug server. |
209 Private method to return the variables of a frame to the debug server. |
210 </p><dl> |
210 </p><dl> |
211 <dt><i>var</i></dt> |
211 <dt><i>var</i></dt> |
212 <dd> |
212 <dd> |
213 list encoded name of the requested variable (list of strings) |
213 list encoded name of the requested variable (list of strings) |
214 </dd><dt><i>frmnr</i></dt> |
214 </dd><dt><i>frmnr</i></dt> |
215 <dd> |
215 <dd> |
216 distance of frame reported on. 0 is the current frame (int) |
216 distance of frame reported on. 0 is the current frame (int) |
217 </dd><dt><i>scope</i></dt> |
217 </dd><dt><i>scope</i></dt> |
218 <dd> |
218 <dd> |
219 1 to report global variables, 0 for local variables (int) |
219 1 to report global variables, 0 for local variables (int) |
220 </dd><dt><i>filter</i></dt> |
220 </dd><dt><i>filter</i></dt> |
221 <dd> |
221 <dd> |
222 the indices of variable types to be filtered (list of int) |
222 the indices of variable types to be filtered (list of int) |
223 </dd> |
223 </dd> |
224 </dl><a NAME="DebugClientBase.dumpVariables" ID="DebugClientBase.dumpVariables"></a> |
224 </dl><a NAME="DebugClientBase.dumpVariables" ID="DebugClientBase.dumpVariables"></a> |
225 <h4>DebugClientBase.dumpVariables</h4> |
225 <h4>DebugClientBase.dumpVariables</h4> |
226 <b>dumpVariables</b>(<i>scope, filter</i>) |
226 <b>dumpVariables</b>(<i>scope, filter</i>) |
227 <p> |
227 <p> |
228 Private method to return the variables of a frame to the debug server. |
228 Private method to return the variables of a frame to the debug server. |
229 </p><dl> |
229 </p><dl> |
230 <dt><i>frmnr</i></dt> |
230 <dt><i>frmnr</i></dt> |
231 <dd> |
231 <dd> |
232 distance of frame reported on. 0 is the current frame (int) |
232 distance of frame reported on. 0 is the current frame (int) |
233 </dd><dt><i>scope</i></dt> |
233 </dd><dt><i>scope</i></dt> |
234 <dd> |
234 <dd> |
235 1 to report global variables, 0 for local variables (int) |
235 1 to report global variables, 0 for local variables (int) |
236 </dd><dt><i>filter</i></dt> |
236 </dd><dt><i>filter</i></dt> |
237 <dd> |
237 <dd> |
238 the indices of variable types to be filtered (list of int) |
238 the indices of variable types to be filtered (list of int) |
239 </dd> |
239 </dd> |
240 </dl><a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a> |
240 </dl><a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a> |
241 <h4>DebugClientBase.eventLoop</h4> |
241 <h4>DebugClientBase.eventLoop</h4> |
242 <b>eventLoop</b>(<i></i>) |
242 <b>eventLoop</b>(<i></i>) |
243 <p> |
243 <p> |
244 Private method implementing our event loop. |
244 Private method implementing our event loop. |
245 </p><a NAME="DebugClientBase.eventPoll" ID="DebugClientBase.eventPoll"></a> |
245 </p><a NAME="DebugClientBase.eventPoll" ID="DebugClientBase.eventPoll"></a> |
246 <h4>DebugClientBase.eventPoll</h4> |
246 <h4>DebugClientBase.eventPoll</h4> |
247 <b>eventPoll</b>(<i></i>) |
247 <b>eventPoll</b>(<i></i>) |
248 <p> |
248 <p> |
249 Private method to poll for events like 'set break point'. |
249 Private method to poll for events like 'set break point'. |
250 </p><a NAME="DebugClientBase.extractAddress" ID="DebugClientBase.extractAddress"></a> |
250 </p><a NAME="DebugClientBase.extractAddress" ID="DebugClientBase.extractAddress"></a> |
251 <h4>DebugClientBase.extractAddress</h4> |
251 <h4>DebugClientBase.extractAddress</h4> |
252 <b>extractAddress</b>(<i></i>) |
252 <b>extractAddress</b>(<i></i>) |
253 <p> |
253 <p> |
254 Private method to extract the address part of an object description. |
254 Private method to extract the address part of an object description. |
255 </p><dl> |
255 </p><dl> |
256 <dt><i>var</i></dt> |
256 <dt><i>var</i></dt> |
257 <dd> |
257 <dd> |
258 object description (String) |
258 object description (String) |
259 </dd> |
259 </dd> |
260 </dl><dl> |
260 </dl><dl> |
261 <dt>Returns:</dt> |
261 <dt>Returns:</dt> |
262 <dd> |
262 <dd> |
263 the address contained in the object description (String) |
263 the address contained in the object description (String) |
264 </dd> |
264 </dd> |
265 </dl><a NAME="DebugClientBase.extractTypeAndAddress" ID="DebugClientBase.extractTypeAndAddress"></a> |
265 </dl><a NAME="DebugClientBase.extractTypeAndAddress" ID="DebugClientBase.extractTypeAndAddress"></a> |
266 <h4>DebugClientBase.extractTypeAndAddress</h4> |
266 <h4>DebugClientBase.extractTypeAndAddress</h4> |
267 <b>extractTypeAndAddress</b>(<i></i>) |
267 <b>extractTypeAndAddress</b>(<i></i>) |
268 <p> |
268 <p> |
269 Private method to extract the address and type parts of an object description. |
269 Private method to extract the address and type parts of an object description. |
270 </p><dl> |
270 </p><dl> |
271 <dt><i>var</i></dt> |
271 <dt><i>var</i></dt> |
272 <dd> |
272 <dd> |
273 object description (String) |
273 object description (String) |
274 </dd> |
274 </dd> |
275 </dl><dl> |
275 </dl><dl> |
276 <dt>Returns:</dt> |
276 <dt>Returns:</dt> |
277 <dd> |
277 <dd> |
278 list containing the type and address contained in the object |
278 list containing the type and address contained in the object |
279 description (Array of two String) |
279 description (Array of two String) |
280 </dd> |
280 </dd> |
281 </dl><a NAME="DebugClientBase.formatVariablesList" ID="DebugClientBase.formatVariablesList"></a> |
281 </dl><a NAME="DebugClientBase.formatVariablesList" ID="DebugClientBase.formatVariablesList"></a> |
282 <h4>DebugClientBase.formatVariablesList</h4> |
282 <h4>DebugClientBase.formatVariablesList</h4> |
283 <b>formatVariablesList</b>(<i>binding_, scope, filter = [], excludeSelf = false, access = nil</i>) |
283 <b>formatVariablesList</b>(<i>binding_, scope, filter = [], excludeSelf = false, access = nil</i>) |
284 <p> |
284 <p> |
285 Private method to produce a formated variables list. |
285 Private method to produce a formated variables list. |
286 </p><p> |
286 </p><p> |
287 The binding passed in to it is scanned. Variables are |
287 The binding passed in to it is scanned. Variables are |
288 only added to the list, if their type is not contained |
288 only added to the list, if their type is not contained |
289 in the filter list and their name doesn't match any of the filter expressions. |
289 in the filter list and their name doesn't match any of the filter expressions. |
290 The formated variables list (a list of lists of 3 values) is returned. |
290 The formated variables list (a list of lists of 3 values) is returned. |
291 </p><dl> |
291 </p><dl> |
292 <dt><i>keylist</i></dt> |
292 <dt><i>keylist</i></dt> |
293 <dd> |
293 <dd> |
294 keys of the dictionary |
294 keys of the dictionary |
295 </dd><dt><i>binding_</i></dt> |
295 </dd><dt><i>binding_</i></dt> |
296 <dd> |
296 <dd> |
297 the binding to be scanned |
297 the binding to be scanned |
298 </dd><dt><i>scope</i></dt> |
298 </dd><dt><i>scope</i></dt> |
299 <dd> |
299 <dd> |
300 1 to filter using the globals filter, 0 using the locals filter (int). |
300 1 to filter using the globals filter, 0 using the locals filter (int). |
301 Variables are only added to the list, if their name do not match any of the |
301 Variables are only added to the list, if their name do not match any of the |
302 filter expressions. |
302 filter expressions. |
303 </dd><dt><i>filter</i></dt> |
303 </dd><dt><i>filter</i></dt> |
304 <dd> |
304 <dd> |
305 the indices of variable types to be filtered. Variables are |
305 the indices of variable types to be filtered. Variables are |
306 only added to the list, if their type is not contained in the filter |
306 only added to the list, if their type is not contained in the filter |
307 list. |
307 list. |
308 </dd><dt><i>excludeSelf</i></dt> |
308 </dd><dt><i>excludeSelf</i></dt> |
309 <dd> |
309 <dd> |
310 flag indicating if the self object should be excluded from |
310 flag indicating if the self object should be excluded from |
311 the listing (boolean) |
311 the listing (boolean) |
312 </dd><dt><i>access</i></dt> |
312 </dd><dt><i>access</i></dt> |
313 <dd> |
313 <dd> |
314 String specifying the access path to (String) |
314 String specifying the access path to (String) |
315 </dd> |
315 </dd> |
316 </dl><dl> |
316 </dl><dl> |
317 <dt>Returns:</dt> |
317 <dt>Returns:</dt> |
318 <dd> |
318 <dd> |
319 A list consisting of a list of formatted variables. Each variable |
319 A list consisting of a list of formatted variables. Each variable |
320 entry is a list of three elements, the variable name, its type and |
320 entry is a list of three elements, the variable name, its type and |
321 value. |
321 value. |
322 </dd> |
322 </dd> |
323 </dl><a NAME="DebugClientBase.generateFilterObjects" ID="DebugClientBase.generateFilterObjects"></a> |
323 </dl><a NAME="DebugClientBase.generateFilterObjects" ID="DebugClientBase.generateFilterObjects"></a> |
324 <h4>DebugClientBase.generateFilterObjects</h4> |
324 <h4>DebugClientBase.generateFilterObjects</h4> |
325 <b>generateFilterObjects</b>(<i>filterString</i>) |
325 <b>generateFilterObjects</b>(<i>filterString</i>) |
326 <p> |
326 <p> |
327 Private method to convert a filter string to a list of filter objects. |
327 Private method to convert a filter string to a list of filter objects. |
328 </p><dl> |
328 </p><dl> |
329 <dt><i>scope</i></dt> |
329 <dt><i>scope</i></dt> |
330 <dd> |
330 <dd> |
331 1 to generate filter for global variables, 0 for local variables (int) |
331 1 to generate filter for global variables, 0 for local variables (int) |
332 </dd><dt><i>filterString</i></dt> |
332 </dd><dt><i>filterString</i></dt> |
333 <dd> |
333 <dd> |
334 string of filter patterns separated by ';' |
334 string of filter patterns separated by ';' |
335 </dd> |
335 </dd> |
336 </dl><a NAME="DebugClientBase.handleException" ID="DebugClientBase.handleException"></a> |
336 </dl><a NAME="DebugClientBase.handleException" ID="DebugClientBase.handleException"></a> |
337 <h4>DebugClientBase.handleException</h4> |
337 <h4>DebugClientBase.handleException</h4> |
338 <b>handleException</b>(<i></i>) |
338 <b>handleException</b>(<i></i>) |
339 <p> |
339 <p> |
340 Private method called in the case of an exception |
340 Private method called in the case of an exception |
341 </p><p> |
341 </p><p> |
342 It ensures that the debug server is informed of the raised exception. |
342 It ensures that the debug server is informed of the raised exception. |
343 </p><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> |
343 </p><a NAME="DebugClientBase.handleLine" ID="DebugClientBase.handleLine"></a> |
344 <h4>DebugClientBase.handleLine</h4> |
344 <h4>DebugClientBase.handleLine</h4> |
345 <b>handleLine</b>(<i></i>) |
345 <b>handleLine</b>(<i></i>) |
346 <p> |
346 <p> |
347 Private method to handle the receipt of a complete line. |
347 Private method to handle the receipt of a complete line. |
348 </p><p> |
348 </p><p> |
349 It first looks for a valid protocol token at the start of the line. Thereafter |
349 It first looks for a valid protocol token at the start of the line. Thereafter |
350 it trys to execute the lines accumulated so far. |
350 it trys to execute the lines accumulated so far. |
351 </p><dl> |
351 </p><dl> |
352 <dt><i>line</i></dt> |
352 <dt><i>line</i></dt> |
353 <dd> |
353 <dd> |
354 the received line |
354 the received line |
355 </dd> |
355 </dd> |
356 </dl><a NAME="DebugClientBase.inFilter?" ID="DebugClientBase.inFilter?"></a> |
356 </dl><a NAME="DebugClientBase.inFilter?" ID="DebugClientBase.inFilter?"></a> |
357 <h4>DebugClientBase.inFilter?</h4> |
357 <h4>DebugClientBase.inFilter?</h4> |
358 <b>inFilter?</b>(<i>otype, oval</i>) |
358 <b>inFilter?</b>(<i>otype, oval</i>) |
359 <p> |
359 <p> |
360 Private method to check, if a variable is to be filtered based on its type. |
360 Private method to check, if a variable is to be filtered based on its type. |
361 </p><dl> |
361 </p><dl> |
362 <dt><i>filter</i></dt> |
362 <dt><i>filter</i></dt> |
363 <dd> |
363 <dd> |
364 the indices of variable types to be filtered (Array of int. |
364 the indices of variable types to be filtered (Array of int. |
365 </dd><dt><i>otype</i></dt> |
365 </dd><dt><i>otype</i></dt> |
366 <dd> |
366 <dd> |
367 type of the variable to be checked (String) |
367 type of the variable to be checked (String) |
368 </dd><dt><i>oval</i></dt> |
368 </dd><dt><i>oval</i></dt> |
369 <dd> |
369 <dd> |
370 variable value to be checked (String) |
370 variable value to be checked (String) |
371 </dd> |
371 </dd> |
372 </dl><dl> |
372 </dl><dl> |
373 <dt>Returns:</dt> |
373 <dt>Returns:</dt> |
374 <dd> |
374 <dd> |
375 flag indicating, whether the variable should be filtered (boolean) |
375 flag indicating, whether the variable should be filtered (boolean) |
376 </dd> |
376 </dd> |
377 </dl><a NAME="DebugClientBase.initializeDebugClient" ID="DebugClientBase.initializeDebugClient"></a> |
377 </dl><a NAME="DebugClientBase.initializeDebugClient" ID="DebugClientBase.initializeDebugClient"></a> |
378 <h4>DebugClientBase.initializeDebugClient</h4> |
378 <h4>DebugClientBase.initializeDebugClient</h4> |
379 <b>initializeDebugClient</b>(<i></i>) |
379 <b>initializeDebugClient</b>(<i></i>) |
380 <p> |
380 <p> |
381 Method to initialize the module |
381 Method to initialize the module |
382 </p><a NAME="DebugClientBase.interact" ID="DebugClientBase.interact"></a> |
382 </p><a NAME="DebugClientBase.interact" ID="DebugClientBase.interact"></a> |
383 <h4>DebugClientBase.interact</h4> |
383 <h4>DebugClientBase.interact</h4> |
384 <b>interact</b>(<i></i>) |
384 <b>interact</b>(<i></i>) |
385 <p> |
385 <p> |
386 Private method to Interact with the debugger. |
386 Private method to Interact with the debugger. |
387 </p><a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a> |
387 </p><a NAME="DebugClientBase.main" ID="DebugClientBase.main"></a> |
388 <h4>DebugClientBase.main</h4> |
388 <h4>DebugClientBase.main</h4> |
389 <b>main</b>(<i></i>) |
389 <b>main</b>(<i></i>) |
390 <p> |
390 <p> |
391 Public method implementing the main method. |
391 Public method implementing the main method. |
392 </p><a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a> |
392 </p><a NAME="DebugClientBase.progTerminated" ID="DebugClientBase.progTerminated"></a> |
393 <h4>DebugClientBase.progTerminated</h4> |
393 <h4>DebugClientBase.progTerminated</h4> |
394 <b>progTerminated</b>(<i></i>) |
394 <b>progTerminated</b>(<i></i>) |
395 <p> |
395 <p> |
396 Private method to tell the debugger that the program has terminated. |
396 Private method to tell the debugger that the program has terminated. |
397 </p><dl> |
397 </p><dl> |
398 <dt><i>status</i></dt> |
398 <dt><i>status</i></dt> |
399 <dd> |
399 <dd> |
400 the return status |
400 the return status |
401 </dd> |
401 </dd> |
402 </dl><a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a> |
402 </dl><a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a> |
403 <h4>DebugClientBase.sessionClose</h4> |
403 <h4>DebugClientBase.sessionClose</h4> |
404 <b>sessionClose</b>(<i></i>) |
404 <b>sessionClose</b>(<i></i>) |
405 <p> |
405 <p> |
406 Privat method to close the session with the debugger and terminate. |
406 Privat method to close the session with the debugger and terminate. |
407 </p><a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a> |
407 </p><a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a> |
408 <h4>DebugClientBase.startProgInDebugger</h4> |
408 <h4>DebugClientBase.startProgInDebugger</h4> |
409 <b>startProgInDebugger</b>(<i>wd = '', host = nil, port = nil, exceptions = true, traceRuby = false, redirect=true</i>) |
409 <b>startProgInDebugger</b>(<i>wd = '', host = nil, port = nil, exceptions = true, traceRuby = false, redirect=true</i>) |
410 <p> |
410 <p> |
411 Method used to start the remote debugger. |
411 Method used to start the remote debugger. |
412 </p><dl> |
412 </p><dl> |
413 <dt><i>progargs</i></dt> |
413 <dt><i>progargs</i></dt> |
414 <dd> |
414 <dd> |
415 commandline for the program to be debugged |
415 commandline for the program to be debugged |
416 (list of strings) |
416 (list of strings) |
417 </dd><dt><i>wd</i></dt> |
417 </dd><dt><i>wd</i></dt> |
418 <dd> |
418 <dd> |
419 working directory for the program execution (string) |
419 working directory for the program execution (string) |
420 </dd><dt><i>host</i></dt> |
420 </dd><dt><i>host</i></dt> |
421 <dd> |
421 <dd> |
422 hostname of the debug server (string) |
422 hostname of the debug server (string) |
423 </dd><dt><i>port</i></dt> |
423 </dd><dt><i>port</i></dt> |
424 <dd> |
424 <dd> |
425 portnumber of the debug server (int) |
425 portnumber of the debug server (int) |
426 </dd><dt><i>exceptions</i></dt> |
426 </dd><dt><i>exceptions</i></dt> |
427 <dd> |
427 <dd> |
428 flag to enable exception reporting of the IDE (boolean) |
428 flag to enable exception reporting of the IDE (boolean) |
429 </dd><dt><i>traceRuby</i></dt> |
429 </dd><dt><i>traceRuby</i></dt> |
430 <dd> |
430 <dd> |
431 flag to enable tracing into the Ruby library |
431 flag to enable tracing into the Ruby library |
432 </dd><dt><i>redirect</i></dt> |
432 </dd><dt><i>redirect</i></dt> |
433 <dd> |
433 <dd> |
434 flag indicating redirection of stdin, stdout and stderr (boolean) |
434 flag indicating redirection of stdin, stdout and stderr (boolean) |
435 </dd> |
435 </dd> |
436 </dl><a NAME="DebugClientBase.trace_func" ID="DebugClientBase.trace_func"></a> |
436 </dl><a NAME="DebugClientBase.trace_func" ID="DebugClientBase.trace_func"></a> |
437 <h4>DebugClientBase.trace_func</h4> |
437 <h4>DebugClientBase.trace_func</h4> |
438 <b>trace_func</b>(<i>file, line, id, binding_, klass</i>) |
438 <b>trace_func</b>(<i>file, line, id, binding_, klass</i>) |
439 <p> |
439 <p> |
440 Method executed by the tracing facility. |
440 Method executed by the tracing facility. |
441 </p><p> |
441 </p><p> |
442 It is used to save the execution context of an exception. |
442 It is used to save the execution context of an exception. |
443 </p><dl> |
443 </p><dl> |
444 <dt><i>event</i></dt> |
444 <dt><i>event</i></dt> |
445 <dd> |
445 <dd> |
446 the tracing event (String) |
446 the tracing event (String) |
447 </dd><dt><i>file</i></dt> |
447 </dd><dt><i>file</i></dt> |
448 <dd> |
448 <dd> |
449 the name of the file being traced (String) |
449 the name of the file being traced (String) |
450 </dd><dt><i>line</i></dt> |
450 </dd><dt><i>line</i></dt> |
451 <dd> |
451 <dd> |
452 the line number being traced (int) |
452 the line number being traced (int) |
453 </dd><dt><i>id</i></dt> |
453 </dd><dt><i>id</i></dt> |
454 <dd> |
454 <dd> |
455 object id |
455 object id |
456 </dd><dt><i>binding_</i></dt> |
456 </dd><dt><i>binding_</i></dt> |
457 <dd> |
457 <dd> |
458 a binding object |
458 a binding object |
459 </dd><dt><i>klass</i></dt> |
459 </dd><dt><i>klass</i></dt> |
460 <dd> |
460 <dd> |
461 name of a class |
461 name of a class |
462 </dd> |
462 </dd> |
463 </dl><a NAME="DebugClientBase.unhandled_exception" ID="DebugClientBase.unhandled_exception"></a> |
463 </dl><a NAME="DebugClientBase.unhandled_exception" ID="DebugClientBase.unhandled_exception"></a> |
464 <h4>DebugClientBase.unhandled_exception</h4> |
464 <h4>DebugClientBase.unhandled_exception</h4> |
465 <b>unhandled_exception</b>(<i></i>) |
465 <b>unhandled_exception</b>(<i></i>) |
466 <p> |
466 <p> |
467 Private method to report an unhandled exception. |
467 Private method to report an unhandled exception. |
468 </p><dl> |
468 </p><dl> |
469 <dt><i>exc</i></dt> |
469 <dt><i>exc</i></dt> |
470 <dd> |
470 <dd> |
471 the exception object |
471 the exception object |
472 </dd> |
472 </dd> |
473 </dl><a NAME="DebugClientBase.write" ID="DebugClientBase.write"></a> |
473 </dl><a NAME="DebugClientBase.write" ID="DebugClientBase.write"></a> |
474 <h4>DebugClientBase.write</h4> |
474 <h4>DebugClientBase.write</h4> |
475 <b>write</b>(<i></i>) |
475 <b>write</b>(<i></i>) |
476 <p> |
476 <p> |
477 Private method to write data to the output stream. |
477 Private method to write data to the output stream. |
478 </p><dl> |
478 </p><dl> |
479 <dt><i>s</i></dt> |
479 <dt><i>s</i></dt> |
480 <dd> |
480 <dd> |
481 data to be written (string) |
481 data to be written (string) |
482 </dd> |
482 </dd> |
483 </dl> |
483 </dl> |
484 <div align="right"><a href="#top">Up</a></div> |
484 <div align="right"><a href="#top">Up</a></div> |
485 <hr /> |
485 <hr /> |
486 </body></html> |
486 </body></html> |