Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Debugger.DebuggerInterfaceRuby.html

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

Mercurial Repository: eric

eric ide

mercurial