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