Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Debugger.DebuggerInterfaceRuby.html

Documentation/Source/eric4.Debugger.DebuggerInterfaceRuby.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Debugger.DebuggerInterfaceRuby</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Debugger.DebuggerInterfaceRuby</h1>
24 <p>
25 Module implementing the Ruby debugger interface for the debug server.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>ClientDefaultCapabilities</td></tr><tr><td>ClientTypeAssociations</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#DebuggerInterfaceRuby">DebuggerInterfaceRuby</a></td>
35 <td>Class implementing the Ruby debugger interface for the debug server.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr>
41 <td><a href="#getRegistryData">getRegistryData</a></td>
42 <td>Module function to get characterising data for the debugger interface.</td>
43 </tr>
44 </table>
45 <hr /><hr />
46 <a NAME="DebuggerInterfaceRuby" ID="DebuggerInterfaceRuby"></a>
47 <h2>DebuggerInterfaceRuby</h2>
48 <p>
49 Class implementing the Ruby debugger interface for the debug server.
50 </p>
51 <h3>Derived from</h3>
52 QObject
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#DebuggerInterfaceRuby.__init__">DebuggerInterfaceRuby</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#DebuggerInterfaceRuby.__identityTranslation">__identityTranslation</a></td>
64 <td>Private method to perform the identity path translation.</td>
65 </tr><tr>
66 <td><a href="#DebuggerInterfaceRuby.__parseClientLine">__parseClientLine</a></td>
67 <td>Private method to handle data from the client.</td>
68 </tr><tr>
69 <td><a href="#DebuggerInterfaceRuby.__remoteTranslation">__remoteTranslation</a></td>
70 <td>Private method to perform the path translation.</td>
71 </tr><tr>
72 <td><a href="#DebuggerInterfaceRuby.__sendCommand">__sendCommand</a></td>
73 <td>Private method to send a single line command to the client.</td>
74 </tr><tr>
75 <td><a href="#DebuggerInterfaceRuby.__startProcess">__startProcess</a></td>
76 <td>Private method to start the debugger client process.</td>
77 </tr><tr>
78 <td><a href="#DebuggerInterfaceRuby.flush">flush</a></td>
79 <td>Public slot to flush the queue.</td>
80 </tr><tr>
81 <td><a href="#DebuggerInterfaceRuby.getClientCapabilities">getClientCapabilities</a></td>
82 <td>Public method to retrieve the debug clients capabilities.</td>
83 </tr><tr>
84 <td><a href="#DebuggerInterfaceRuby.isConnected">isConnected</a></td>
85 <td>Public method to test, if a debug client has connected.</td>
86 </tr><tr>
87 <td><a href="#DebuggerInterfaceRuby.newConnection">newConnection</a></td>
88 <td>Public slot to handle a new connection.</td>
89 </tr><tr>
90 <td><a href="#DebuggerInterfaceRuby.remoteBanner">remoteBanner</a></td>
91 <td>Public slot to get the banner info of the remote client.</td>
92 </tr><tr>
93 <td><a href="#DebuggerInterfaceRuby.remoteBreakpoint">remoteBreakpoint</a></td>
94 <td>Public method to set or clear a breakpoint.</td>
95 </tr><tr>
96 <td><a href="#DebuggerInterfaceRuby.remoteBreakpointEnable">remoteBreakpointEnable</a></td>
97 <td>Public method to enable or disable a breakpoint.</td>
98 </tr><tr>
99 <td><a href="#DebuggerInterfaceRuby.remoteBreakpointIgnore">remoteBreakpointIgnore</a></td>
100 <td>Public method to ignore a breakpoint the next couple of occurrences.</td>
101 </tr><tr>
102 <td><a href="#DebuggerInterfaceRuby.remoteCapabilities">remoteCapabilities</a></td>
103 <td>Public slot to get the debug clients capabilities.</td>
104 </tr><tr>
105 <td><a href="#DebuggerInterfaceRuby.remoteClientSetFilter">remoteClientSetFilter</a></td>
106 <td>Public method to set a variables filter list.</td>
107 </tr><tr>
108 <td><a href="#DebuggerInterfaceRuby.remoteClientVariable">remoteClientVariable</a></td>
109 <td>Public method to request the variables of the debugged program.</td>
110 </tr><tr>
111 <td><a href="#DebuggerInterfaceRuby.remoteClientVariables">remoteClientVariables</a></td>
112 <td>Public method to request the variables of the debugged program.</td>
113 </tr><tr>
114 <td><a href="#DebuggerInterfaceRuby.remoteCompletion">remoteCompletion</a></td>
115 <td>Public slot to get the a list of possible commandline completions from the remote client.</td>
116 </tr><tr>
117 <td><a href="#DebuggerInterfaceRuby.remoteContinue">remoteContinue</a></td>
118 <td>Public method to continue the debugged program.</td>
119 </tr><tr>
120 <td><a href="#DebuggerInterfaceRuby.remoteCoverage">remoteCoverage</a></td>
121 <td>Public method to load a new program to collect coverage data.</td>
122 </tr><tr>
123 <td><a href="#DebuggerInterfaceRuby.remoteEnvironment">remoteEnvironment</a></td>
124 <td>Public method to set the environment for a program to debug, run, ...</td>
125 </tr><tr>
126 <td><a href="#DebuggerInterfaceRuby.remoteEval">remoteEval</a></td>
127 <td>Public method to evaluate arg in the current context of the debugged program.</td>
128 </tr><tr>
129 <td><a href="#DebuggerInterfaceRuby.remoteExec">remoteExec</a></td>
130 <td>Public method to execute stmt in the current context of the debugged program.</td>
131 </tr><tr>
132 <td><a href="#DebuggerInterfaceRuby.remoteLoad">remoteLoad</a></td>
133 <td>Public method to load a new program to debug.</td>
134 </tr><tr>
135 <td><a href="#DebuggerInterfaceRuby.remoteProfile">remoteProfile</a></td>
136 <td>Public method to load a new program to collect profiling data.</td>
137 </tr><tr>
138 <td><a href="#DebuggerInterfaceRuby.remoteRawInput">remoteRawInput</a></td>
139 <td>Public method to send the raw input to the debugged program.</td>
140 </tr><tr>
141 <td><a href="#DebuggerInterfaceRuby.remoteRun">remoteRun</a></td>
142 <td>Public method to load a new program to run.</td>
143 </tr><tr>
144 <td><a href="#DebuggerInterfaceRuby.remoteSetThread">remoteSetThread</a></td>
145 <td>Public method to request to set the given thread as current thread.</td>
146 </tr><tr>
147 <td><a href="#DebuggerInterfaceRuby.remoteStatement">remoteStatement</a></td>
148 <td>Public method to execute a Ruby statement.</td>
149 </tr><tr>
150 <td><a href="#DebuggerInterfaceRuby.remoteStep">remoteStep</a></td>
151 <td>Public method to single step the debugged program.</td>
152 </tr><tr>
153 <td><a href="#DebuggerInterfaceRuby.remoteStepOut">remoteStepOut</a></td>
154 <td>Public method to step out the debugged program.</td>
155 </tr><tr>
156 <td><a href="#DebuggerInterfaceRuby.remoteStepOver">remoteStepOver</a></td>
157 <td>Public method to step over the debugged program.</td>
158 </tr><tr>
159 <td><a href="#DebuggerInterfaceRuby.remoteStepQuit">remoteStepQuit</a></td>
160 <td>Public method to stop the debugged program.</td>
161 </tr><tr>
162 <td><a href="#DebuggerInterfaceRuby.remoteThreadList">remoteThreadList</a></td>
163 <td>Public method to request the list of threads from the client.</td>
164 </tr><tr>
165 <td><a href="#DebuggerInterfaceRuby.remoteUTPrepare">remoteUTPrepare</a></td>
166 <td>Public method to prepare a new unittest run.</td>
167 </tr><tr>
168 <td><a href="#DebuggerInterfaceRuby.remoteUTRun">remoteUTRun</a></td>
169 <td>Public method to start a unittest run.</td>
170 </tr><tr>
171 <td><a href="#DebuggerInterfaceRuby.remoteUTStop">remoteUTStop</a></td>
172 <td>public method to stop a unittest run.</td>
173 </tr><tr>
174 <td><a href="#DebuggerInterfaceRuby.remoteWatchpoint">remoteWatchpoint</a></td>
175 <td>Public method to set or clear a watch expression.</td>
176 </tr><tr>
177 <td><a href="#DebuggerInterfaceRuby.remoteWatchpointEnable">remoteWatchpointEnable</a></td>
178 <td>Public method to enable or disable a watch expression.</td>
179 </tr><tr>
180 <td><a href="#DebuggerInterfaceRuby.remoteWatchpointIgnore">remoteWatchpointIgnore</a></td>
181 <td>Public method to ignore a watch expression the next couple of occurrences.</td>
182 </tr><tr>
183 <td><a href="#DebuggerInterfaceRuby.shutdown">shutdown</a></td>
184 <td>Public method to cleanly shut down.</td>
185 </tr><tr>
186 <td><a href="#DebuggerInterfaceRuby.startRemote">startRemote</a></td>
187 <td>Public method to start a remote Ruby interpreter.</td>
188 </tr><tr>
189 <td><a href="#DebuggerInterfaceRuby.startRemoteForProject">startRemoteForProject</a></td>
190 <td>Public method to start a remote Ruby interpreter for a project.</td>
191 </tr>
192 </table>
193 <a NAME="DebuggerInterfaceRuby.__init__" ID="DebuggerInterfaceRuby.__init__"></a>
194 <h4>DebuggerInterfaceRuby (Constructor)</h4>
195 <b>DebuggerInterfaceRuby</b>(<i>debugServer, passive</i>)
196 <p>
197 Constructor
198 </p><dl>
199 <dt><i>debugServer</i></dt>
200 <dd>
201 reference to the debug server (DebugServer)
202 </dd><dt><i>passive</i></dt>
203 <dd>
204 flag indicating passive connection mode (boolean)
205 </dd>
206 </dl><a NAME="DebuggerInterfaceRuby.__identityTranslation" ID="DebuggerInterfaceRuby.__identityTranslation"></a>
207 <h4>DebuggerInterfaceRuby.__identityTranslation</h4>
208 <b>__identityTranslation</b>(<i>fn, remote2local = True</i>)
209 <p>
210 Private method to perform the identity path translation.
211 </p><dl>
212 <dt><i>fn</i></dt>
213 <dd>
214 filename to be translated (string)
215 </dd><dt><i>remote2local</i></dt>
216 <dd>
217 flag indicating the direction of translation
218 (False = local to remote, True = remote to local [default])
219 </dd>
220 </dl><dl>
221 <dt>Returns:</dt>
222 <dd>
223 translated filename (string)
224 </dd>
225 </dl><a NAME="DebuggerInterfaceRuby.__parseClientLine" ID="DebuggerInterfaceRuby.__parseClientLine"></a>
226 <h4>DebuggerInterfaceRuby.__parseClientLine</h4>
227 <b>__parseClientLine</b>(<i></i>)
228 <p>
229 Private method to handle data from the client.
230 </p><a NAME="DebuggerInterfaceRuby.__remoteTranslation" ID="DebuggerInterfaceRuby.__remoteTranslation"></a>
231 <h4>DebuggerInterfaceRuby.__remoteTranslation</h4>
232 <b>__remoteTranslation</b>(<i>fn, remote2local = True</i>)
233 <p>
234 Private method to perform the path translation.
235 </p><dl>
236 <dt><i>fn</i></dt>
237 <dd>
238 filename to be translated (string)
239 </dd><dt><i>remote2local</i></dt>
240 <dd>
241 flag indicating the direction of translation
242 (False = local to remote, True = remote to local [default])
243 </dd>
244 </dl><dl>
245 <dt>Returns:</dt>
246 <dd>
247 translated filename (string)
248 </dd>
249 </dl><a NAME="DebuggerInterfaceRuby.__sendCommand" ID="DebuggerInterfaceRuby.__sendCommand"></a>
250 <h4>DebuggerInterfaceRuby.__sendCommand</h4>
251 <b>__sendCommand</b>(<i>cmd</i>)
252 <p>
253 Private method to send a single line command to the client.
254 </p><dl>
255 <dt><i>cmd</i></dt>
256 <dd>
257 command to send to the debug client (string)
258 </dd>
259 </dl><a NAME="DebuggerInterfaceRuby.__startProcess" ID="DebuggerInterfaceRuby.__startProcess"></a>
260 <h4>DebuggerInterfaceRuby.__startProcess</h4>
261 <b>__startProcess</b>(<i>program, arguments, environment = None</i>)
262 <p>
263 Private method to start the debugger client process.
264 </p><dl>
265 <dt><i>program</i></dt>
266 <dd>
267 name of the executable to start (string)
268 </dd><dt><i>arguments</i></dt>
269 <dd>
270 arguments to be passed to the program (list of string)
271 </dd><dt><i>environment</i></dt>
272 <dd>
273 dictionary of environment settings to pass (dict of string)
274 </dd>
275 </dl><dl>
276 <dt>Returns:</dt>
277 <dd>
278 the process object (QProcess) or None
279 </dd>
280 </dl><a NAME="DebuggerInterfaceRuby.flush" ID="DebuggerInterfaceRuby.flush"></a>
281 <h4>DebuggerInterfaceRuby.flush</h4>
282 <b>flush</b>(<i></i>)
283 <p>
284 Public slot to flush the queue.
285 </p><a NAME="DebuggerInterfaceRuby.getClientCapabilities" ID="DebuggerInterfaceRuby.getClientCapabilities"></a>
286 <h4>DebuggerInterfaceRuby.getClientCapabilities</h4>
287 <b>getClientCapabilities</b>(<i></i>)
288 <p>
289 Public method to retrieve the debug clients capabilities.
290 </p><dl>
291 <dt>Returns:</dt>
292 <dd>
293 debug client capabilities (integer)
294 </dd>
295 </dl><a NAME="DebuggerInterfaceRuby.isConnected" ID="DebuggerInterfaceRuby.isConnected"></a>
296 <h4>DebuggerInterfaceRuby.isConnected</h4>
297 <b>isConnected</b>(<i></i>)
298 <p>
299 Public method to test, if a debug client has connected.
300 </p><dl>
301 <dt>Returns:</dt>
302 <dd>
303 flag indicating the connection status (boolean)
304 </dd>
305 </dl><a NAME="DebuggerInterfaceRuby.newConnection" ID="DebuggerInterfaceRuby.newConnection"></a>
306 <h4>DebuggerInterfaceRuby.newConnection</h4>
307 <b>newConnection</b>(<i>sock</i>)
308 <p>
309 Public slot to handle a new connection.
310 </p><dl>
311 <dt><i>sockreference</i></dt>
312 <dd>
313 to the socket object (QTcpSocket)
314 </dd>
315 </dl><dl>
316 <dt>Returns:</dt>
317 <dd>
318 flag indicating success (boolean)
319 </dd>
320 </dl><a NAME="DebuggerInterfaceRuby.remoteBanner" ID="DebuggerInterfaceRuby.remoteBanner"></a>
321 <h4>DebuggerInterfaceRuby.remoteBanner</h4>
322 <b>remoteBanner</b>(<i></i>)
323 <p>
324 Public slot to get the banner info of the remote client.
325 </p><a NAME="DebuggerInterfaceRuby.remoteBreakpoint" ID="DebuggerInterfaceRuby.remoteBreakpoint"></a>
326 <h4>DebuggerInterfaceRuby.remoteBreakpoint</h4>
327 <b>remoteBreakpoint</b>(<i>fn, line, set, cond = None, temp = False</i>)
328 <p>
329 Public method to set or clear a breakpoint.
330 </p><dl>
331 <dt><i>fn</i></dt>
332 <dd>
333 filename the breakpoint belongs to (string)
334 </dd><dt><i>line</i></dt>
335 <dd>
336 linenumber of the breakpoint (int)
337 </dd><dt><i>set</i></dt>
338 <dd>
339 flag indicating setting or resetting a breakpoint (boolean)
340 </dd><dt><i>cond</i></dt>
341 <dd>
342 condition of the breakpoint (string)
343 </dd><dt><i>temp</i></dt>
344 <dd>
345 flag indicating a temporary breakpoint (boolean)
346 </dd>
347 </dl><a NAME="DebuggerInterfaceRuby.remoteBreakpointEnable" ID="DebuggerInterfaceRuby.remoteBreakpointEnable"></a>
348 <h4>DebuggerInterfaceRuby.remoteBreakpointEnable</h4>
349 <b>remoteBreakpointEnable</b>(<i>fn, line, enable</i>)
350 <p>
351 Public method to enable or disable a breakpoint.
352 </p><dl>
353 <dt><i>fn</i></dt>
354 <dd>
355 filename the breakpoint belongs to (string)
356 </dd><dt><i>line</i></dt>
357 <dd>
358 linenumber of the breakpoint (int)
359 </dd><dt><i>enable</i></dt>
360 <dd>
361 flag indicating enabling or disabling a breakpoint (boolean)
362 </dd>
363 </dl><a NAME="DebuggerInterfaceRuby.remoteBreakpointIgnore" ID="DebuggerInterfaceRuby.remoteBreakpointIgnore"></a>
364 <h4>DebuggerInterfaceRuby.remoteBreakpointIgnore</h4>
365 <b>remoteBreakpointIgnore</b>(<i>fn, line, count</i>)
366 <p>
367 Public method to ignore a breakpoint the next couple of occurrences.
368 </p><dl>
369 <dt><i>fn</i></dt>
370 <dd>
371 filename the breakpoint belongs to (string)
372 </dd><dt><i>line</i></dt>
373 <dd>
374 linenumber of the breakpoint (int)
375 </dd><dt><i>count</i></dt>
376 <dd>
377 number of occurrences to ignore (int)
378 </dd>
379 </dl><a NAME="DebuggerInterfaceRuby.remoteCapabilities" ID="DebuggerInterfaceRuby.remoteCapabilities"></a>
380 <h4>DebuggerInterfaceRuby.remoteCapabilities</h4>
381 <b>remoteCapabilities</b>(<i></i>)
382 <p>
383 Public slot to get the debug clients capabilities.
384 </p><a NAME="DebuggerInterfaceRuby.remoteClientSetFilter" ID="DebuggerInterfaceRuby.remoteClientSetFilter"></a>
385 <h4>DebuggerInterfaceRuby.remoteClientSetFilter</h4>
386 <b>remoteClientSetFilter</b>(<i>scope, filter</i>)
387 <p>
388 Public method to set a variables filter list.
389 </p><dl>
390 <dt><i>scope</i></dt>
391 <dd>
392 the scope of the variables (0 = local, 1 = global)
393 </dd><dt><i>filter</i></dt>
394 <dd>
395 regexp string for variable names to filter out (string)
396 </dd>
397 </dl><a NAME="DebuggerInterfaceRuby.remoteClientVariable" ID="DebuggerInterfaceRuby.remoteClientVariable"></a>
398 <h4>DebuggerInterfaceRuby.remoteClientVariable</h4>
399 <b>remoteClientVariable</b>(<i>scope, filter, var, framenr = 0</i>)
400 <p>
401 Public method to request the variables of the debugged program.
402 </p><dl>
403 <dt><i>scope</i></dt>
404 <dd>
405 the scope of the variables (0 = local, 1 = global)
406 </dd><dt><i>filter</i></dt>
407 <dd>
408 list of variable types to filter out (list of int)
409 </dd><dt><i>var</i></dt>
410 <dd>
411 list encoded name of variable to retrieve (string)
412 </dd><dt><i>framenr</i></dt>
413 <dd>
414 framenumber of the variables to retrieve (int)
415 </dd>
416 </dl><a NAME="DebuggerInterfaceRuby.remoteClientVariables" ID="DebuggerInterfaceRuby.remoteClientVariables"></a>
417 <h4>DebuggerInterfaceRuby.remoteClientVariables</h4>
418 <b>remoteClientVariables</b>(<i>scope, filter, framenr = 0</i>)
419 <p>
420 Public method to request the variables of the debugged program.
421 </p><dl>
422 <dt><i>scope</i></dt>
423 <dd>
424 the scope of the variables (0 = local, 1 = global)
425 </dd><dt><i>filter</i></dt>
426 <dd>
427 list of variable types to filter out (list of int)
428 </dd><dt><i>framenr</i></dt>
429 <dd>
430 framenumber of the variables to retrieve (int)
431 </dd>
432 </dl><a NAME="DebuggerInterfaceRuby.remoteCompletion" ID="DebuggerInterfaceRuby.remoteCompletion"></a>
433 <h4>DebuggerInterfaceRuby.remoteCompletion</h4>
434 <b>remoteCompletion</b>(<i>text</i>)
435 <p>
436 Public slot to get the a list of possible commandline completions
437 from the remote client.
438 </p><dl>
439 <dt><i>text</i></dt>
440 <dd>
441 the text to be completed (string)
442 </dd>
443 </dl><a NAME="DebuggerInterfaceRuby.remoteContinue" ID="DebuggerInterfaceRuby.remoteContinue"></a>
444 <h4>DebuggerInterfaceRuby.remoteContinue</h4>
445 <b>remoteContinue</b>(<i>special = False</i>)
446 <p>
447 Public method to continue the debugged program.
448 </p><dl>
449 <dt><i>special</i></dt>
450 <dd>
451 flag indicating a special continue operation (boolean)
452 </dd>
453 </dl><a NAME="DebuggerInterfaceRuby.remoteCoverage" ID="DebuggerInterfaceRuby.remoteCoverage"></a>
454 <h4>DebuggerInterfaceRuby.remoteCoverage</h4>
455 <b>remoteCoverage</b>(<i>fn, argv, wd, erase = False</i>)
456 <p>
457 Public method to load a new program to collect coverage data.
458 </p><dl>
459 <dt><i>fn</i></dt>
460 <dd>
461 the filename to run (string)
462 </dd><dt><i>argv</i></dt>
463 <dd>
464 the commandline arguments to pass to the program (string)
465 </dd><dt><i>wd</i></dt>
466 <dd>
467 the working directory for the program (string)
468 </dd><dt><i>erase=</i></dt>
469 <dd>
470 flag indicating that coverage info should be
471 cleared first (boolean)
472 </dd>
473 </dl><a NAME="DebuggerInterfaceRuby.remoteEnvironment" ID="DebuggerInterfaceRuby.remoteEnvironment"></a>
474 <h4>DebuggerInterfaceRuby.remoteEnvironment</h4>
475 <b>remoteEnvironment</b>(<i>env</i>)
476 <p>
477 Public method to set the environment for a program to debug, run, ...
478 </p><dl>
479 <dt><i>env</i></dt>
480 <dd>
481 environment settings (dictionary)
482 </dd>
483 </dl><a NAME="DebuggerInterfaceRuby.remoteEval" ID="DebuggerInterfaceRuby.remoteEval"></a>
484 <h4>DebuggerInterfaceRuby.remoteEval</h4>
485 <b>remoteEval</b>(<i>arg</i>)
486 <p>
487 Public method to evaluate arg in the current context of the debugged program.
488 </p><dl>
489 <dt><i>arg</i></dt>
490 <dd>
491 the arguments to evaluate (string)
492 </dd>
493 </dl><a NAME="DebuggerInterfaceRuby.remoteExec" ID="DebuggerInterfaceRuby.remoteExec"></a>
494 <h4>DebuggerInterfaceRuby.remoteExec</h4>
495 <b>remoteExec</b>(<i>stmt</i>)
496 <p>
497 Public method to execute stmt in the current context of the debugged program.
498 </p><dl>
499 <dt><i>stmt</i></dt>
500 <dd>
501 statement to execute (string)
502 </dd>
503 </dl><a NAME="DebuggerInterfaceRuby.remoteLoad" ID="DebuggerInterfaceRuby.remoteLoad"></a>
504 <h4>DebuggerInterfaceRuby.remoteLoad</h4>
505 <b>remoteLoad</b>(<i>fn, argv, wd, traceInterpreter = False, autoContinue = True, autoFork = False, forkChild = False</i>)
506 <p>
507 Public method to load a new program to debug.
508 </p><dl>
509 <dt><i>fn</i></dt>
510 <dd>
511 the filename to debug (string)
512 </dd><dt><i>argv</i></dt>
513 <dd>
514 the commandline arguments to pass to the program (string)
515 </dd><dt><i>wd</i></dt>
516 <dd>
517 the working directory for the program (string)
518 </dd><dt><i>traceInterpreter=</i></dt>
519 <dd>
520 flag indicating if the interpreter library should be
521 traced as well (boolean)
522 </dd><dt><i>autoContinue=</i></dt>
523 <dd>
524 flag indicating, that the debugger should not stop
525 at the first executable line (boolean)
526 </dd><dt><i>autoFork=</i></dt>
527 <dd>
528 flag indicating the automatic fork mode (boolean) (ignored)
529 </dd><dt><i>forkChild=</i></dt>
530 <dd>
531 flag indicating to debug the child after forking
532 (boolean) (ignored)
533 </dd>
534 </dl><a NAME="DebuggerInterfaceRuby.remoteProfile" ID="DebuggerInterfaceRuby.remoteProfile"></a>
535 <h4>DebuggerInterfaceRuby.remoteProfile</h4>
536 <b>remoteProfile</b>(<i>fn, argv, wd, erase = False</i>)
537 <p>
538 Public method to load a new program to collect profiling data.
539 </p><dl>
540 <dt><i>fn</i></dt>
541 <dd>
542 the filename to run (string)
543 </dd><dt><i>argv</i></dt>
544 <dd>
545 the commandline arguments to pass to the program (string)
546 </dd><dt><i>wd</i></dt>
547 <dd>
548 the working directory for the program (string)
549 </dd><dt><i>erase=</i></dt>
550 <dd>
551 flag indicating that timing info should be cleared first (boolean)
552 </dd>
553 </dl><a NAME="DebuggerInterfaceRuby.remoteRawInput" ID="DebuggerInterfaceRuby.remoteRawInput"></a>
554 <h4>DebuggerInterfaceRuby.remoteRawInput</h4>
555 <b>remoteRawInput</b>(<i>s</i>)
556 <p>
557 Public method to send the raw input to the debugged program.
558 </p><dl>
559 <dt><i>s</i></dt>
560 <dd>
561 the raw input (string)
562 </dd>
563 </dl><a NAME="DebuggerInterfaceRuby.remoteRun" ID="DebuggerInterfaceRuby.remoteRun"></a>
564 <h4>DebuggerInterfaceRuby.remoteRun</h4>
565 <b>remoteRun</b>(<i>fn, argv, wd</i>)
566 <p>
567 Public method to load a new program to run.
568 </p><dl>
569 <dt><i>fn</i></dt>
570 <dd>
571 the filename to run (string)
572 </dd><dt><i>argv</i></dt>
573 <dd>
574 the commandline arguments to pass to the program (string)
575 </dd><dt><i>wd</i></dt>
576 <dd>
577 the working directory for the program (string)
578 </dd>
579 </dl><a NAME="DebuggerInterfaceRuby.remoteSetThread" ID="DebuggerInterfaceRuby.remoteSetThread"></a>
580 <h4>DebuggerInterfaceRuby.remoteSetThread</h4>
581 <b>remoteSetThread</b>(<i>tid</i>)
582 <p>
583 Public method to request to set the given thread as current thread.
584 </p><dl>
585 <dt><i>tid</i></dt>
586 <dd>
587 id of the thread (integer)
588 </dd>
589 </dl><a NAME="DebuggerInterfaceRuby.remoteStatement" ID="DebuggerInterfaceRuby.remoteStatement"></a>
590 <h4>DebuggerInterfaceRuby.remoteStatement</h4>
591 <b>remoteStatement</b>(<i>stmt</i>)
592 <p>
593 Public method to execute a Ruby statement.
594 </p><dl>
595 <dt><i>stmt</i></dt>
596 <dd>
597 the Ruby statement to execute (string). It
598 should not have a trailing newline.
599 </dd>
600 </dl><a NAME="DebuggerInterfaceRuby.remoteStep" ID="DebuggerInterfaceRuby.remoteStep"></a>
601 <h4>DebuggerInterfaceRuby.remoteStep</h4>
602 <b>remoteStep</b>(<i></i>)
603 <p>
604 Public method to single step the debugged program.
605 </p><a NAME="DebuggerInterfaceRuby.remoteStepOut" ID="DebuggerInterfaceRuby.remoteStepOut"></a>
606 <h4>DebuggerInterfaceRuby.remoteStepOut</h4>
607 <b>remoteStepOut</b>(<i></i>)
608 <p>
609 Public method to step out the debugged program.
610 </p><a NAME="DebuggerInterfaceRuby.remoteStepOver" ID="DebuggerInterfaceRuby.remoteStepOver"></a>
611 <h4>DebuggerInterfaceRuby.remoteStepOver</h4>
612 <b>remoteStepOver</b>(<i></i>)
613 <p>
614 Public method to step over the debugged program.
615 </p><a NAME="DebuggerInterfaceRuby.remoteStepQuit" ID="DebuggerInterfaceRuby.remoteStepQuit"></a>
616 <h4>DebuggerInterfaceRuby.remoteStepQuit</h4>
617 <b>remoteStepQuit</b>(<i></i>)
618 <p>
619 Public method to stop the debugged program.
620 </p><a NAME="DebuggerInterfaceRuby.remoteThreadList" ID="DebuggerInterfaceRuby.remoteThreadList"></a>
621 <h4>DebuggerInterfaceRuby.remoteThreadList</h4>
622 <b>remoteThreadList</b>(<i></i>)
623 <p>
624 Public method to request the list of threads from the client.
625 </p><a NAME="DebuggerInterfaceRuby.remoteUTPrepare" ID="DebuggerInterfaceRuby.remoteUTPrepare"></a>
626 <h4>DebuggerInterfaceRuby.remoteUTPrepare</h4>
627 <b>remoteUTPrepare</b>(<i>fn, tn, tfn, cov, covname, coverase</i>)
628 <p>
629 Public method to prepare a new unittest run.
630 </p><dl>
631 <dt><i>fn</i></dt>
632 <dd>
633 the filename to load (string)
634 </dd><dt><i>tn</i></dt>
635 <dd>
636 the testname to load (string)
637 </dd><dt><i>tfn</i></dt>
638 <dd>
639 the test function name to load tests from (string)
640 </dd><dt><i>cov</i></dt>
641 <dd>
642 flag indicating collection of coverage data is requested
643 </dd><dt><i>covname</i></dt>
644 <dd>
645 filename to be used to assemble the coverage caches
646 filename
647 </dd><dt><i>coverase</i></dt>
648 <dd>
649 flag indicating erasure of coverage data is requested
650 </dd>
651 </dl><a NAME="DebuggerInterfaceRuby.remoteUTRun" ID="DebuggerInterfaceRuby.remoteUTRun"></a>
652 <h4>DebuggerInterfaceRuby.remoteUTRun</h4>
653 <b>remoteUTRun</b>(<i></i>)
654 <p>
655 Public method to start a unittest run.
656 </p><a NAME="DebuggerInterfaceRuby.remoteUTStop" ID="DebuggerInterfaceRuby.remoteUTStop"></a>
657 <h4>DebuggerInterfaceRuby.remoteUTStop</h4>
658 <b>remoteUTStop</b>(<i></i>)
659 <p>
660 public method to stop a unittest run.
661 </p><a NAME="DebuggerInterfaceRuby.remoteWatchpoint" ID="DebuggerInterfaceRuby.remoteWatchpoint"></a>
662 <h4>DebuggerInterfaceRuby.remoteWatchpoint</h4>
663 <b>remoteWatchpoint</b>(<i>cond, set, temp = False</i>)
664 <p>
665 Public method to set or clear a watch expression.
666 </p><dl>
667 <dt><i>cond</i></dt>
668 <dd>
669 expression of the watch expression (string)
670 </dd><dt><i>set</i></dt>
671 <dd>
672 flag indicating setting or resetting a watch expression (boolean)
673 </dd><dt><i>temp</i></dt>
674 <dd>
675 flag indicating a temporary watch expression (boolean)
676 </dd>
677 </dl><a NAME="DebuggerInterfaceRuby.remoteWatchpointEnable" ID="DebuggerInterfaceRuby.remoteWatchpointEnable"></a>
678 <h4>DebuggerInterfaceRuby.remoteWatchpointEnable</h4>
679 <b>remoteWatchpointEnable</b>(<i>cond, enable</i>)
680 <p>
681 Public method to enable or disable a watch expression.
682 </p><dl>
683 <dt><i>cond</i></dt>
684 <dd>
685 expression of the watch expression (string)
686 </dd><dt><i>enable</i></dt>
687 <dd>
688 flag indicating enabling or disabling a watch expression (boolean)
689 </dd>
690 </dl><a NAME="DebuggerInterfaceRuby.remoteWatchpointIgnore" ID="DebuggerInterfaceRuby.remoteWatchpointIgnore"></a>
691 <h4>DebuggerInterfaceRuby.remoteWatchpointIgnore</h4>
692 <b>remoteWatchpointIgnore</b>(<i>cond, count</i>)
693 <p>
694 Public method to ignore a watch expression the next couple of occurrences.
695 </p><dl>
696 <dt><i>cond</i></dt>
697 <dd>
698 expression of the watch expression (string)
699 </dd><dt><i>count</i></dt>
700 <dd>
701 number of occurrences to ignore (int)
702 </dd>
703 </dl><a NAME="DebuggerInterfaceRuby.shutdown" ID="DebuggerInterfaceRuby.shutdown"></a>
704 <h4>DebuggerInterfaceRuby.shutdown</h4>
705 <b>shutdown</b>(<i></i>)
706 <p>
707 Public method to cleanly shut down.
708 </p><p>
709 It closes our socket and shuts down
710 the debug client. (Needed on Win OS)
711 </p><a NAME="DebuggerInterfaceRuby.startRemote" ID="DebuggerInterfaceRuby.startRemote"></a>
712 <h4>DebuggerInterfaceRuby.startRemote</h4>
713 <b>startRemote</b>(<i>port, runInConsole</i>)
714 <p>
715 Public method to start a remote Ruby interpreter.
716 </p><dl>
717 <dt><i>port</i></dt>
718 <dd>
719 portnumber the debug server is listening on (integer)
720 </dd><dt><i>runInConsole</i></dt>
721 <dd>
722 flag indicating to start the debugger in a
723 console window (boolean)
724 </dd>
725 </dl><dl>
726 <dt>Returns:</dt>
727 <dd>
728 client process object (QProcess) and a flag to indicate
729 a network connection (boolean)
730 </dd>
731 </dl><a NAME="DebuggerInterfaceRuby.startRemoteForProject" ID="DebuggerInterfaceRuby.startRemoteForProject"></a>
732 <h4>DebuggerInterfaceRuby.startRemoteForProject</h4>
733 <b>startRemoteForProject</b>(<i>port, runInConsole</i>)
734 <p>
735 Public method to start a remote Ruby interpreter for a project.
736 </p><dl>
737 <dt><i>port</i></dt>
738 <dd>
739 portnumber the debug server is listening on (integer)
740 </dd><dt><i>runInConsole</i></dt>
741 <dd>
742 flag indicating to start the debugger in a
743 console window (boolean)
744 </dd>
745 </dl><dl>
746 <dt>Returns:</dt>
747 <dd>
748 pid of the client process (integer) and a flag to indicate
749 a network connection (boolean)
750 </dd>
751 </dl>
752 <div align="right"><a href="#top">Up</a></div>
753 <hr /><hr />
754 <a NAME="getRegistryData" ID="getRegistryData"></a>
755 <h2>getRegistryData</h2>
756 <b>getRegistryData</b>(<i></i>)
757 <p>
758 Module function to get characterising data for the debugger interface.
759 </p><dl>
760 <dt>Returns:</dt>
761 <dd>
762 list of the following data. Client type (string), client
763 capabilities (integer), client type association (list of strings)
764 </dd>
765 </dl>
766 <div align="right"><a href="#top">Up</a></div>
767 <hr />
768 </body></html>

Mercurial Repository: eric

eric ide

mercurial