Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DebugClients.Ruby.Debuggee.html
Documentation/Source/eric5.DebugClients.Ruby.Debuggee.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.DebugClients.Ruby.Debuggee</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.DebugClients.Ruby.Debuggee</h1> | |
| 12 <p> | |
| 13 File implementing the real debugger, which is connected to the IDE frontend. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#Client">Client</a></td> | |
| 23 <td>Class handling the connection to the IDE.</td> | |
| 24 </tr><tr> | |
| 25 <td><a href="#Context">Context</a></td> | |
| 26 <td>Class defining the current execution context.</td> | |
| 27 </tr><tr> | |
| 28 <td><a href="#DEBUGGER__">DEBUGGER__</a></td> | |
| 29 <td>Class defining a singleton object for the debugger.</td> | |
| 30 </tr><tr> | |
| 31 <td><a href="#Mutex">Mutex</a></td> | |
| 32 <td>Class implementing a mutex.</td> | |
| 33 </tr><tr> | |
| 34 <td><a href="#SilentObject">SilentObject</a></td> | |
| 35 <td>Class defining an object that ignores all messages.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Modules</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#context">context</a></td> | |
| 46 <td>Method returning the context of a thread.</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#debug_thread_info">debug_thread_info</a></td> | |
| 49 <td>Method handling the thread related debug commands.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#eventLoop">eventLoop</a></td> | |
| 52 <td>Method calling the main event loop.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#eventPoll">eventPoll</a></td> | |
| 55 <td>Method calling the main function polling for an event sent by the IDE.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#get_thread">get_thread</a></td> | |
| 58 <td>Method returning a thread by number.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#interrupt">interrupt</a></td> | |
| 61 <td>Method to stop execution at the next instruction.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#make_thread_list">make_thread_list</a></td> | |
| 64 <td>Method to create a thread list.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#thread_list">thread_list</a></td> | |
| 67 <td>Method to list the state of a thread.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#thread_list_all">thread_list_all</a></td> | |
| 70 <td>Method to list the state of all threads.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#traceRuby?">traceRuby?</a></td> | |
| 73 <td>Method to check, if we should trace into the Ruby interpreter libraries.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <hr /><hr /> | |
| 77 <a NAME="Client" ID="Client"></a> | |
| 78 <h2>Client</h2> | |
| 79 <p> | |
| 80 Class handling the connection to the IDE. | |
| 81 </p> | |
| 82 <h3>Derived from</h3> | |
| 83 None | |
| 84 <h3>Class Attributes</h3> | |
| 85 <table> | |
| 86 <tr><td>None</td></tr> | |
| 87 </table> | |
| 88 <h3>Methods</h3> | |
| 89 <table> | |
| 90 <tr> | |
| 91 <td><a href="#Client.eventLoop">eventLoop</a></td> | |
| 92 <td>Method calling the main event loop.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#Client.eventPoll">eventPoll</a></td> | |
| 95 <td>Method calling the main function polling for an event sent by the IDE.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#Client.initialize">initialize</a></td> | |
| 98 <td>Constructor</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#Client.printf">printf</a></td> | |
| 101 <td>Method to print something to the IDE.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#Client.printf_clear_breakpoint">printf_clear_breakpoint</a></td> | |
| 104 <td>Method to report the deletion of a temporary breakpoint to the IDE.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#Client.printf_clear_watchexpression">printf_clear_watchexpression</a></td> | |
| 107 <td>Method to report the deletion of a temporary watch expression to the IDE.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#Client.printf_excn">printf_excn</a></td> | |
| 110 <td>Method to report an exception to the IDE.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#Client.printf_exit">printf_exit</a></td> | |
| 113 <td>Method to report the exit status to the IDE.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#Client.printf_line">printf_line</a></td> | |
| 116 <td>Method to report the current line and the current stack trace to the IDE.</td> | |
| 117 </tr><tr> | |
| 118 <td><a href="#Client.printf_scriptExcn">printf_scriptExcn</a></td> | |
| 119 <td>Method to report a ScriptError to the IDE.</td> | |
| 120 </tr><tr> | |
| 121 <td><a href="#Client.traceRuby?">traceRuby?</a></td> | |
| 122 <td>Method to check, if we should trace into the Ruby interpreter libraries.</td> | |
| 123 </tr> | |
| 124 </table> | |
| 125 <a NAME="Client.eventLoop" ID="Client.eventLoop"></a> | |
| 126 <h4>Client.eventLoop</h4> | |
| 127 <b>eventLoop</b>(<i></i>) | |
| 128 <p> | |
| 129 Method calling the main event loop. | |
| 130 </p><a NAME="Client.eventPoll" ID="Client.eventPoll"></a> | |
| 131 <h4>Client.eventPoll</h4> | |
| 132 <b>eventPoll</b>(<i></i>) | |
| 133 <p> | |
| 134 Method calling the main function polling for an event sent by the IDE. | |
| 135 </p><a NAME="Client.initialize" ID="Client.initialize"></a> | |
| 136 <h4>Client.initialize</h4> | |
| 137 <b>initialize</b>(<i></i>) | |
| 138 <p> | |
| 139 Constructor | |
| 140 </p><dl> | |
| 141 <dt><i>debugger</i></dt> | |
| 142 <dd> | |
| 143 reference to the object having the IDE connection. | |
| 144 </dd> | |
| 145 </dl><a NAME="Client.printf" ID="Client.printf"></a> | |
| 146 <h4>Client.printf</h4> | |
| 147 <b>printf</b>(<i></i>) | |
| 148 <p> | |
| 149 Method to print something to the IDE. | |
| 150 </p><dl> | |
| 151 <dt><i>*args</i></dt> | |
| 152 <dd> | |
| 153 Arguments to be printed. | |
| 154 </dd> | |
| 155 </dl><a NAME="Client.printf_clear_breakpoint" ID="Client.printf_clear_breakpoint"></a> | |
| 156 <h4>Client.printf_clear_breakpoint</h4> | |
| 157 <b>printf_clear_breakpoint</b>(<i>line</i>) | |
| 158 <p> | |
| 159 Method to report the deletion of a temporary breakpoint to the IDE. | |
| 160 </p><dl> | |
| 161 <dt><i>file</i></dt> | |
| 162 <dd> | |
| 163 filename of the breakpoint (String) | |
| 164 </dd><dt><i>line</i></dt> | |
| 165 <dd> | |
| 166 line number of the breakpoint (int) | |
| 167 </dd> | |
| 168 </dl><a NAME="Client.printf_clear_watchexpression" ID="Client.printf_clear_watchexpression"></a> | |
| 169 <h4>Client.printf_clear_watchexpression</h4> | |
| 170 <b>printf_clear_watchexpression</b>(<i></i>) | |
| 171 <p> | |
| 172 Method to report the deletion of a temporary watch expression to the IDE. | |
| 173 </p><dl> | |
| 174 <dt><i>cond</i></dt> | |
| 175 <dd> | |
| 176 expression of the watch expression (String) | |
| 177 </dd> | |
| 178 </dl><a NAME="Client.printf_excn" ID="Client.printf_excn"></a> | |
| 179 <h4>Client.printf_excn</h4> | |
| 180 <b>printf_excn</b>(<i></i>) | |
| 181 <p> | |
| 182 Method to report an exception to the IDE. | |
| 183 </p><dl> | |
| 184 <dt><i>exclist</i></dt> | |
| 185 <dd> | |
| 186 info about the exception to be reported | |
| 187 </dd> | |
| 188 </dl><a NAME="Client.printf_exit" ID="Client.printf_exit"></a> | |
| 189 <h4>Client.printf_exit</h4> | |
| 190 <b>printf_exit</b>(<i></i>) | |
| 191 <p> | |
| 192 Method to report the exit status to the IDE. | |
| 193 </p><dl> | |
| 194 <dt><i>status</i></dt> | |
| 195 <dd> | |
| 196 exit status of the program (int) | |
| 197 </dd> | |
| 198 </dl><a NAME="Client.printf_line" ID="Client.printf_line"></a> | |
| 199 <h4>Client.printf_line</h4> | |
| 200 <b>printf_line</b>(<i></i>) | |
| 201 <p> | |
| 202 Method to report the current line and the current stack trace to the IDE. | |
| 203 </p><dl> | |
| 204 <dt><i>frames</i></dt> | |
| 205 <dd> | |
| 206 reference to the array containing the stack trace. | |
| 207 </dd> | |
| 208 </dl><a NAME="Client.printf_scriptExcn" ID="Client.printf_scriptExcn"></a> | |
| 209 <h4>Client.printf_scriptExcn</h4> | |
| 210 <b>printf_scriptExcn</b>(<i></i>) | |
| 211 <p> | |
| 212 Method to report a ScriptError to the IDE. | |
| 213 </p><dl> | |
| 214 <dt><i>exclist</i></dt> | |
| 215 <dd> | |
| 216 info about the exception to be reported | |
| 217 </dd> | |
| 218 </dl><a NAME="Client.traceRuby?" ID="Client.traceRuby?"></a> | |
| 219 <h4>Client.traceRuby?</h4> | |
| 220 <b>traceRuby?</b>(<i></i>) | |
| 221 <p> | |
| 222 Method to check, if we should trace into the Ruby interpreter libraries. | |
| 223 </p> | |
| 224 <div align="right"><a href="#top">Up</a></div> | |
| 225 <hr /><hr /> | |
| 226 <a NAME="Context" ID="Context"></a> | |
| 227 <h2>Context</h2> | |
| 228 <p> | |
| 229 Class defining the current execution context. | |
| 230 </p> | |
| 231 <h3>Derived from</h3> | |
| 232 None | |
| 233 <h3>Class Attributes</h3> | |
| 234 <table> | |
| 235 <tr><td>None</td></tr> | |
| 236 </table> | |
| 237 <h3>Methods</h3> | |
| 238 <table> | |
| 239 <tr> | |
| 240 <td><a href="#Context.clear_suspend">clear_suspend</a></td> | |
| 241 <td>Method to clear the suspend state.</td> | |
| 242 </tr><tr> | |
| 243 <td><a href="#Context.current_binding">current_binding</a></td> | |
| 244 <td>Method returning the binding object of the current execution frame.</td> | |
| 245 </tr><tr> | |
| 246 <td><a href="#Context.current_frame">current_frame</a></td> | |
| 247 <td>Method returning the current execution frame.</td> | |
| 248 </tr><tr> | |
| 249 <td><a href="#Context.eventLoop">eventLoop</a></td> | |
| 250 <td>Method calling the main event loop.</td> | |
| 251 </tr><tr> | |
| 252 <td><a href="#Context.eventPoll">eventPoll</a></td> | |
| 253 <td>Method calling the main function polling for an event sent by the IDE.</td> | |
| 254 </tr><tr> | |
| 255 <td><a href="#Context.get_binding">get_binding</a></td> | |
| 256 <td>Method returning the binding object of a specific execution frame.</td> | |
| 257 </tr><tr> | |
| 258 <td><a href="#Context.get_frame">get_frame</a></td> | |
| 259 <td>Method returning a specific execution frame.</td> | |
| 260 </tr><tr> | |
| 261 <td><a href="#Context.initialize">initialize</a></td> | |
| 262 <td>Constructor</td> | |
| 263 </tr><tr> | |
| 264 <td><a href="#Context.set_suspend">set_suspend</a></td> | |
| 265 <td>Method to suspend all threads.</td> | |
| 266 </tr><tr> | |
| 267 <td><a href="#Context.step_continue">step_continue</a></td> | |
| 268 <td>Method to continue execution until next breakpoint or watch expression.</td> | |
| 269 </tr><tr> | |
| 270 <td><a href="#Context.step_out">step_out</a></td> | |
| 271 <td>Method to set the next stop point after the function call returns.</td> | |
| 272 </tr><tr> | |
| 273 <td><a href="#Context.step_over">step_over</a></td> | |
| 274 <td>Method to set the next stop point skipping function calls.</td> | |
| 275 </tr><tr> | |
| 276 <td><a href="#Context.step_quit">step_quit</a></td> | |
| 277 <td>Method to stop debugging.</td> | |
| 278 </tr><tr> | |
| 279 <td><a href="#Context.stop_next">stop_next</a></td> | |
| 280 <td>Method to set the next stop point (i.e.</td> | |
| 281 </tr><tr> | |
| 282 <td><a href="#Context.suspend_all">suspend_all</a></td> | |
| 283 <td>Method to suspend all threads.</td> | |
| 284 </tr><tr> | |
| 285 <td><a href="#Context.traceRuby?">traceRuby?</a></td> | |
| 286 <td>Method to check, if we should trace into the Ruby interpreter libraries.</td> | |
| 287 </tr> | |
| 288 </table> | |
| 289 <a NAME="Context.clear_suspend" ID="Context.clear_suspend"></a> | |
| 290 <h4>Context.clear_suspend</h4> | |
| 291 <b>clear_suspend</b>(<i></i>) | |
| 292 <p> | |
| 293 Method to clear the suspend state. | |
| 294 </p><a NAME="Context.current_binding" ID="Context.current_binding"></a> | |
| 295 <h4>Context.current_binding</h4> | |
| 296 <b>current_binding</b>(<i></i>) | |
| 297 <p> | |
| 298 Method returning the binding object of the current execution frame. | |
| 299 </p><dl> | |
| 300 <dt>Returns:</dt> | |
| 301 <dd> | |
| 302 binding object of the current execution frame | |
| 303 </dd> | |
| 304 </dl><a NAME="Context.current_frame" ID="Context.current_frame"></a> | |
| 305 <h4>Context.current_frame</h4> | |
| 306 <b>current_frame</b>(<i></i>) | |
| 307 <p> | |
| 308 Method returning the current execution frame. | |
| 309 </p><dl> | |
| 310 <dt>Returns:</dt> | |
| 311 <dd> | |
| 312 current execution frame | |
| 313 </dd> | |
| 314 </dl><a NAME="Context.eventLoop" ID="Context.eventLoop"></a> | |
| 315 <h4>Context.eventLoop</h4> | |
| 316 <b>eventLoop</b>(<i></i>) | |
| 317 <p> | |
| 318 Method calling the main event loop. | |
| 319 </p><a NAME="Context.eventPoll" ID="Context.eventPoll"></a> | |
| 320 <h4>Context.eventPoll</h4> | |
| 321 <b>eventPoll</b>(<i></i>) | |
| 322 <p> | |
| 323 Method calling the main function polling for an event sent by the IDE. | |
| 324 </p><a NAME="Context.get_binding" ID="Context.get_binding"></a> | |
| 325 <h4>Context.get_binding</h4> | |
| 326 <b>get_binding</b>(<i></i>) | |
| 327 <p> | |
| 328 Method returning the binding object of a specific execution frame. | |
| 329 </p><dl> | |
| 330 <dt><i>frameno</i></dt> | |
| 331 <dd> | |
| 332 frame number of the frame (int) | |
| 333 </dd> | |
| 334 </dl><dl> | |
| 335 <dt>Returns:</dt> | |
| 336 <dd> | |
| 337 the requested binding object | |
| 338 </dd> | |
| 339 </dl><a NAME="Context.get_frame" ID="Context.get_frame"></a> | |
| 340 <h4>Context.get_frame</h4> | |
| 341 <b>get_frame</b>(<i></i>) | |
| 342 <p> | |
| 343 Method returning a specific execution frame. | |
| 344 </p><dl> | |
| 345 <dt><i>frameno</i></dt> | |
| 346 <dd> | |
| 347 frame number of the frame to be returned (int) | |
| 348 </dd> | |
| 349 </dl><dl> | |
| 350 <dt>Returns:</dt> | |
| 351 <dd> | |
| 352 the requested execution frame | |
| 353 </dd> | |
| 354 </dl><a NAME="Context.initialize" ID="Context.initialize"></a> | |
| 355 <h4>Context.initialize</h4> | |
| 356 <b>initialize</b>(<i></i>) | |
| 357 <p> | |
| 358 Constructor | |
| 359 </p><a NAME="Context.set_suspend" ID="Context.set_suspend"></a> | |
| 360 <h4>Context.set_suspend</h4> | |
| 361 <b>set_suspend</b>(<i></i>) | |
| 362 <p> | |
| 363 Method to suspend all threads. | |
| 364 </p><a NAME="Context.step_continue" ID="Context.step_continue"></a> | |
| 365 <h4>Context.step_continue</h4> | |
| 366 <b>step_continue</b>(<i></i>) | |
| 367 <p> | |
| 368 Method to continue execution until next breakpoint or watch expression. | |
| 369 </p><a NAME="Context.step_out" ID="Context.step_out"></a> | |
| 370 <h4>Context.step_out</h4> | |
| 371 <b>step_out</b>(<i></i>) | |
| 372 <p> | |
| 373 Method to set the next stop point after the function call returns. | |
| 374 </p><a NAME="Context.step_over" ID="Context.step_over"></a> | |
| 375 <h4>Context.step_over</h4> | |
| 376 <b>step_over</b>(<i></i>) | |
| 377 <p> | |
| 378 Method to set the next stop point skipping function calls. | |
| 379 </p><dl> | |
| 380 <dt><i>counter</i></dt> | |
| 381 <dd> | |
| 382 defining the stop point (int) | |
| 383 </dd> | |
| 384 </dl><a NAME="Context.step_quit" ID="Context.step_quit"></a> | |
| 385 <h4>Context.step_quit</h4> | |
| 386 <b>step_quit</b>(<i></i>) | |
| 387 <p> | |
| 388 Method to stop debugging. | |
| 389 </p><a NAME="Context.stop_next" ID="Context.stop_next"></a> | |
| 390 <h4>Context.stop_next</h4> | |
| 391 <b>stop_next</b>(<i></i>) | |
| 392 <p> | |
| 393 Method to set the next stop point (i.e. stop at next line). | |
| 394 </p><dl> | |
| 395 <dt><i>counter</i></dt> | |
| 396 <dd> | |
| 397 defining the stop point (int) | |
| 398 </dd> | |
| 399 </dl><a NAME="Context.suspend_all" ID="Context.suspend_all"></a> | |
| 400 <h4>Context.suspend_all</h4> | |
| 401 <b>suspend_all</b>(<i></i>) | |
| 402 <p> | |
| 403 Method to suspend all threads. | |
| 404 </p><a NAME="Context.traceRuby?" ID="Context.traceRuby?"></a> | |
| 405 <h4>Context.traceRuby?</h4> | |
| 406 <b>traceRuby?</b>(<i></i>) | |
| 407 <p> | |
| 408 Method to check, if we should trace into the Ruby interpreter libraries. | |
| 409 </p> | |
| 410 <div align="right"><a href="#top">Up</a></div> | |
| 411 <hr /><hr /> | |
| 412 <a NAME="DEBUGGER__" ID="DEBUGGER__"></a> | |
| 413 <h2>DEBUGGER__</h2> | |
| 414 <p> | |
| 415 Class defining a singleton object for the debugger. | |
| 416 </p> | |
| 417 <h3>Derived from</h3> | |
| 418 None | |
| 419 <h3>Class Attributes</h3> | |
| 420 <table> | |
| 421 <tr><td>MUTEX</td></tr><tr><td>SilentClient</td></tr> | |
| 422 </table> | |
| 423 <h3>Methods</h3> | |
| 424 <table> | |
| 425 <tr> | |
| 426 <td><a href="#DEBUGGER__.add_break_point">add_break_point</a></td> | |
| 427 <td>Method to add a breakpoint.</td> | |
| 428 </tr><tr> | |
| 429 <td><a href="#DEBUGGER__.add_watch_point">add_watch_point</a></td> | |
| 430 <td>Method to add a watch expression.</td> | |
| 431 </tr><tr> | |
| 432 <td><a href="#DEBUGGER__.attach">attach</a></td> | |
| 433 <td>Method to connect the debugger to the IDE.</td> | |
| 434 </tr><tr> | |
| 435 <td><a href="#DEBUGGER__.attached?">attached?</a></td> | |
| 436 <td>Method returning the attached state.</td> | |
| 437 </tr><tr> | |
| 438 <td><a href="#DEBUGGER__.break_points">break_points</a></td> | |
| 439 <td>Method to return the list of breakpoints</td> | |
| 440 </tr><tr> | |
| 441 <td><a href="#DEBUGGER__.check_break_points">check_break_points</a></td> | |
| 442 <td>Method to check, if the given position contains an active breakpoint.</td> | |
| 443 </tr><tr> | |
| 444 <td><a href="#DEBUGGER__.check_suspend">check_suspend</a></td> | |
| 445 <td>Method to check the suspend state.</td> | |
| 446 </tr><tr> | |
| 447 <td><a href="#DEBUGGER__.clear_break_point">clear_break_point</a></td> | |
| 448 <td>Method to delete a specific breakpoint.</td> | |
| 449 </tr><tr> | |
| 450 <td><a href="#DEBUGGER__.clear_watch_point">clear_watch_point</a></td> | |
| 451 <td>Method to delete a specific watch expression.</td> | |
| 452 </tr><tr> | |
| 453 <td><a href="#DEBUGGER__.client">client</a></td> | |
| 454 <td>Method returning a reference to the client object.</td> | |
| 455 </tr><tr> | |
| 456 <td><a href="#DEBUGGER__.context">context</a></td> | |
| 457 <td>Method returning the context of a thread.</td> | |
| 458 </tr><tr> | |
| 459 <td><a href="#DEBUGGER__.debug_command">debug_command</a></td> | |
| 460 <td>Method to execute the next debug command.</td> | |
| 461 </tr><tr> | |
| 462 <td><a href="#DEBUGGER__.debug_silent_eval">debug_silent_eval</a></td> | |
| 463 <td>Method to eval a string without output.</td> | |
| 464 </tr><tr> | |
| 465 <td><a href="#DEBUGGER__.delete_break_point">delete_break_point</a></td> | |
| 466 <td>Method to delete a breakpoint.</td> | |
| 467 </tr><tr> | |
| 468 <td><a href="#DEBUGGER__.delete_watch_point">delete_watch_point</a></td> | |
| 469 <td>Method to delete a watch expression.</td> | |
| 470 </tr><tr> | |
| 471 <td><a href="#DEBUGGER__.enable_break_point">enable_break_point</a></td> | |
| 472 <td>Method to set the enabled state of a breakpoint.</td> | |
| 473 </tr><tr> | |
| 474 <td><a href="#DEBUGGER__.enable_watch_point">enable_watch_point</a></td> | |
| 475 <td>Method to set the enabled state of a watch expression.</td> | |
| 476 </tr><tr> | |
| 477 <td><a href="#DEBUGGER__.excn_handle">excn_handle</a></td> | |
| 478 <td>Method to handle an exception</td> | |
| 479 </tr><tr> | |
| 480 <td><a href="#DEBUGGER__.frame_set_pos">frame_set_pos</a></td> | |
| 481 <td>Method to set the frame position of the current frame.</td> | |
| 482 </tr><tr> | |
| 483 <td><a href="#DEBUGGER__.ignore_break_point">ignore_break_point</a></td> | |
| 484 <td>Method to set the ignore count of a breakpoint.</td> | |
| 485 </tr><tr> | |
| 486 <td><a href="#DEBUGGER__.ignore_watch_point">ignore_watch_point</a></td> | |
| 487 <td>Method to set the ignore count of a watch expression.</td> | |
| 488 </tr><tr> | |
| 489 <td><a href="#DEBUGGER__.last_thread">last_thread</a></td> | |
| 490 <td>Method returning the last active thread.</td> | |
| 491 </tr><tr> | |
| 492 <td><a href="#DEBUGGER__.quit">quit</a></td> | |
| 493 <td>Method to quit the debugger.</td> | |
| 494 </tr><tr> | |
| 495 <td><a href="#DEBUGGER__.resume">resume</a></td> | |
| 496 <td>Method to resume the program being debugged.</td> | |
| 497 </tr><tr> | |
| 498 <td><a href="#DEBUGGER__.resume_all">resume_all</a></td> | |
| 499 <td>Method to resume all threads.</td> | |
| 500 </tr><tr> | |
| 501 <td><a href="#DEBUGGER__.set_client">set_client</a></td> | |
| 502 <td>Method to set the client handling the connection.</td> | |
| 503 </tr><tr> | |
| 504 <td><a href="#DEBUGGER__.set_last_thread">set_last_thread</a></td> | |
| 505 <td>Method to remember the last thread.</td> | |
| 506 </tr><tr> | |
| 507 <td><a href="#DEBUGGER__.skip_it?">skip_it?</a></td> | |
| 508 <td>Method to filter out debugger files.</td> | |
| 509 </tr><tr> | |
| 510 <td><a href="#DEBUGGER__.stdout">stdout</a></td> | |
| 511 <td>Method returning the stdout object.</td> | |
| 512 </tr><tr> | |
| 513 <td><a href="#DEBUGGER__.stdout=">stdout=</a></td> | |
| 514 <td>Method to set the stdout object.</td> | |
| 515 </tr><tr> | |
| 516 <td><a href="#DEBUGGER__.suspend">suspend</a></td> | |
| 517 <td>Method to suspend the program being debugged.</td> | |
| 518 </tr><tr> | |
| 519 <td><a href="#DEBUGGER__.thnum">thnum</a></td> | |
| 520 <td>Method returning the thread number of the current thread.</td> | |
| 521 </tr><tr> | |
| 522 <td><a href="#DEBUGGER__.trace_func">trace_func</a></td> | |
| 523 <td>Method executed by the tracing facility.</td> | |
| 524 </tr><tr> | |
| 525 <td><a href="#DEBUGGER__.waiting">waiting</a></td> | |
| 526 <td>Method returning the waiting list.</td> | |
| 527 </tr> | |
| 528 </table> | |
| 529 <a NAME="DEBUGGER__.add_break_point" ID="DEBUGGER__.add_break_point"></a> | |
| 530 <h4>DEBUGGER__.add_break_point</h4> | |
| 531 <b>add_break_point</b>(<i>pos, temp = false, cond = nil</i>) | |
| 532 <p> | |
| 533 Method to add a breakpoint. | |
| 534 </p><dl> | |
| 535 <dt><i>file</i></dt> | |
| 536 <dd> | |
| 537 filename for the breakpoint (String) | |
| 538 </dd><dt><i>pos</i></dt> | |
| 539 <dd> | |
| 540 line number for the breakpoint (int) | |
| 541 </dd><dt><i>temp</i></dt> | |
| 542 <dd> | |
| 543 flag indicating a temporary breakpoint (boolean) | |
| 544 </dd><dt><i>cond</i></dt> | |
| 545 <dd> | |
| 546 condition of a conditional breakpoint (String) | |
| 547 </dd> | |
| 548 </dl><a NAME="DEBUGGER__.add_watch_point" ID="DEBUGGER__.add_watch_point"></a> | |
| 549 <h4>DEBUGGER__.add_watch_point</h4> | |
| 550 <b>add_watch_point</b>(<i>temp = false</i>) | |
| 551 <p> | |
| 552 Method to add a watch expression. | |
| 553 </p><dl> | |
| 554 <dt><i>cond</i></dt> | |
| 555 <dd> | |
| 556 expression of the watch expression (String) | |
| 557 </dd><dt><i>temp</i></dt> | |
| 558 <dd> | |
| 559 flag indicating a temporary watch expression (boolean) | |
| 560 </dd> | |
| 561 </dl><a NAME="DEBUGGER__.attach" ID="DEBUGGER__.attach"></a> | |
| 562 <h4>DEBUGGER__.attach</h4> | |
| 563 <b>attach</b>(<i></i>) | |
| 564 <p> | |
| 565 Method to connect the debugger to the IDE. | |
| 566 </p><dl> | |
| 567 <dt><i>debugger</i></dt> | |
| 568 <dd> | |
| 569 reference to the object handling the | |
| 570 communication with the IDE. | |
| 571 </dd> | |
| 572 </dl><a NAME="DEBUGGER__.attached?" ID="DEBUGGER__.attached?"></a> | |
| 573 <h4>DEBUGGER__.attached?</h4> | |
| 574 <b>attached?</b>(<i></i>) | |
| 575 <p> | |
| 576 Method returning the attached state. | |
| 577 </p><dl> | |
| 578 <dt>Returns:</dt> | |
| 579 <dd> | |
| 580 flag indicating, whether the debugger is attached to the IDE. | |
| 581 </dd> | |
| 582 </dl><a NAME="DEBUGGER__.break_points" ID="DEBUGGER__.break_points"></a> | |
| 583 <h4>DEBUGGER__.break_points</h4> | |
| 584 <b>break_points</b>(<i></i>) | |
| 585 <p> | |
| 586 Method to return the list of breakpoints | |
| 587 </p><dl> | |
| 588 <dt>Returns:</dt> | |
| 589 <dd> | |
| 590 Array containing all breakpoints. | |
| 591 </dd> | |
| 592 </dl><a NAME="DEBUGGER__.check_break_points" ID="DEBUGGER__.check_break_points"></a> | |
| 593 <h4>DEBUGGER__.check_break_points</h4> | |
| 594 <b>check_break_points</b>(<i>pos, binding_, id</i>) | |
| 595 <p> | |
| 596 Method to check, if the given position contains an active breakpoint. | |
| 597 </p><dl> | |
| 598 <dt><i>file</i></dt> | |
| 599 <dd> | |
| 600 filename containing the currently executed line (String) | |
| 601 </dd><dt><i>pos</i></dt> | |
| 602 <dd> | |
| 603 line number currently executed (int) | |
| 604 </dd><dt><i>binding_</i></dt> | |
| 605 <dd> | |
| 606 current binding object | |
| 607 </dd><dt><i>id</i></dt> | |
| 608 <dd> | |
| 609 (ignored) | |
| 610 </dd> | |
| 611 </dl><dl> | |
| 612 <dt>Returns:</dt> | |
| 613 <dd> | |
| 614 flag indicating an active breakpoint (boolean) | |
| 615 </dd> | |
| 616 </dl><a NAME="DEBUGGER__.check_suspend" ID="DEBUGGER__.check_suspend"></a> | |
| 617 <h4>DEBUGGER__.check_suspend</h4> | |
| 618 <b>check_suspend</b>(<i></i>) | |
| 619 <p> | |
| 620 Method to check the suspend state. | |
| 621 </p><a NAME="DEBUGGER__.clear_break_point" ID="DEBUGGER__.clear_break_point"></a> | |
| 622 <h4>DEBUGGER__.clear_break_point</h4> | |
| 623 <b>clear_break_point</b>(<i>pos</i>) | |
| 624 <p> | |
| 625 Method to delete a specific breakpoint. | |
| 626 </p><dl> | |
| 627 <dt><i>file</i></dt> | |
| 628 <dd> | |
| 629 filename containing the breakpoint (String) | |
| 630 </dd><dt><i>pos</i></dt> | |
| 631 <dd> | |
| 632 line number containing the breakpoint (int) | |
| 633 </dd> | |
| 634 </dl><a NAME="DEBUGGER__.clear_watch_point" ID="DEBUGGER__.clear_watch_point"></a> | |
| 635 <h4>DEBUGGER__.clear_watch_point</h4> | |
| 636 <b>clear_watch_point</b>(<i></i>) | |
| 637 <p> | |
| 638 Method to delete a specific watch expression. | |
| 639 </p><dl> | |
| 640 <dt><i>cond</i></dt> | |
| 641 <dd> | |
| 642 expression specifying the watch expression (String) | |
| 643 </dd> | |
| 644 </dl><a NAME="DEBUGGER__.client" ID="DEBUGGER__.client"></a> | |
| 645 <h4>DEBUGGER__.client</h4> | |
| 646 <b>client</b>(<i></i>) | |
| 647 <p> | |
| 648 Method returning a reference to the client object. | |
| 649 </p><dl> | |
| 650 <dt>Returns:</dt> | |
| 651 <dd> | |
| 652 reference to the client object. | |
| 653 </dd> | |
| 654 </dl><a NAME="DEBUGGER__.context" ID="DEBUGGER__.context"></a> | |
| 655 <h4>DEBUGGER__.context</h4> | |
| 656 <b>context</b>(<i></i>) | |
| 657 <p> | |
| 658 Method returning the context of a thread. | |
| 659 </p><dl> | |
| 660 <dt><i>th</i></dt> | |
| 661 <dd> | |
| 662 thread object to get the context for | |
| 663 </dd> | |
| 664 </dl><dl> | |
| 665 <dt>Returns:</dt> | |
| 666 <dd> | |
| 667 the context for the thread | |
| 668 </dd> | |
| 669 </dl><a NAME="DEBUGGER__.debug_command" ID="DEBUGGER__.debug_command"></a> | |
| 670 <h4>DEBUGGER__.debug_command</h4> | |
| 671 <b>debug_command</b>(<i>line, id, binding_</i>) | |
| 672 <p> | |
| 673 Method to execute the next debug command. | |
| 674 </p><a NAME="DEBUGGER__.debug_silent_eval" ID="DEBUGGER__.debug_silent_eval"></a> | |
| 675 <h4>DEBUGGER__.debug_silent_eval</h4> | |
| 676 <b>debug_silent_eval</b>(<i>binding_</i>) | |
| 677 <p> | |
| 678 Method to eval a string without output. | |
| 679 </p><dl> | |
| 680 <dt><i>str</i></dt> | |
| 681 <dd> | |
| 682 String containing the expression to be evaluated | |
| 683 </dd><dt><i>binding_</i></dt> | |
| 684 <dd> | |
| 685 the binding for the evaluation | |
| 686 </dd> | |
| 687 </dl><dl> | |
| 688 <dt>Returns:</dt> | |
| 689 <dd> | |
| 690 the result of the evaluation | |
| 691 </dd> | |
| 692 </dl><a NAME="DEBUGGER__.delete_break_point" ID="DEBUGGER__.delete_break_point"></a> | |
| 693 <h4>DEBUGGER__.delete_break_point</h4> | |
| 694 <b>delete_break_point</b>(<i>pos</i>) | |
| 695 <p> | |
| 696 Method to delete a breakpoint. | |
| 697 </p><dl> | |
| 698 <dt><i>file</i></dt> | |
| 699 <dd> | |
| 700 filename of the breakpoint (String) | |
| 701 </dd><dt><i>pos</i></dt> | |
| 702 <dd> | |
| 703 line number of the breakpoint (int) | |
| 704 </dd> | |
| 705 </dl><a NAME="DEBUGGER__.delete_watch_point" ID="DEBUGGER__.delete_watch_point"></a> | |
| 706 <h4>DEBUGGER__.delete_watch_point</h4> | |
| 707 <b>delete_watch_point</b>(<i></i>) | |
| 708 <p> | |
| 709 Method to delete a watch expression. | |
| 710 </p><dl> | |
| 711 <dt><i>cond</i></dt> | |
| 712 <dd> | |
| 713 expression of the watch expression (String) | |
| 714 </dd> | |
| 715 </dl><a NAME="DEBUGGER__.enable_break_point" ID="DEBUGGER__.enable_break_point"></a> | |
| 716 <h4>DEBUGGER__.enable_break_point</h4> | |
| 717 <b>enable_break_point</b>(<i>pos, enable</i>) | |
| 718 <p> | |
| 719 Method to set the enabled state of a breakpoint. | |
| 720 </p><dl> | |
| 721 <dt><i>file</i></dt> | |
| 722 <dd> | |
| 723 filename of the breakpoint (String) | |
| 724 </dd><dt><i>pos</i></dt> | |
| 725 <dd> | |
| 726 line number of the breakpoint (int) | |
| 727 </dd><dt><i>enable</i></dt> | |
| 728 <dd> | |
| 729 flag indicating the new enabled state (boolean) | |
| 730 </dd> | |
| 731 </dl><a NAME="DEBUGGER__.enable_watch_point" ID="DEBUGGER__.enable_watch_point"></a> | |
| 732 <h4>DEBUGGER__.enable_watch_point</h4> | |
| 733 <b>enable_watch_point</b>(<i>enable</i>) | |
| 734 <p> | |
| 735 Method to set the enabled state of a watch expression. | |
| 736 </p><dl> | |
| 737 <dt><i>cond</i></dt> | |
| 738 <dd> | |
| 739 expression of the watch expression (String) | |
| 740 </dd><dt><i>enable</i></dt> | |
| 741 <dd> | |
| 742 flag indicating the new enabled state (boolean) | |
| 743 </dd> | |
| 744 </dl><a NAME="DEBUGGER__.excn_handle" ID="DEBUGGER__.excn_handle"></a> | |
| 745 <h4>DEBUGGER__.excn_handle</h4> | |
| 746 <b>excn_handle</b>(<i>line, id, binding_</i>) | |
| 747 <p> | |
| 748 Method to handle an exception | |
| 749 </p><dl> | |
| 750 <dt><i>file</i></dt> | |
| 751 <dd> | |
| 752 filename containing the currently executed line (String) | |
| 753 </dd><dt><i>pos</i></dt> | |
| 754 <dd> | |
| 755 line number currently executed (int) | |
| 756 </dd><dt><i>id</i></dt> | |
| 757 <dd> | |
| 758 (ignored) | |
| 759 </dd><dt><i>binding_</i></dt> | |
| 760 <dd> | |
| 761 current binding object | |
| 762 </dd> | |
| 763 </dl><a NAME="DEBUGGER__.frame_set_pos" ID="DEBUGGER__.frame_set_pos"></a> | |
| 764 <h4>DEBUGGER__.frame_set_pos</h4> | |
| 765 <b>frame_set_pos</b>(<i>line</i>) | |
| 766 <p> | |
| 767 Method to set the frame position of the current frame. | |
| 768 </p><a NAME="DEBUGGER__.ignore_break_point" ID="DEBUGGER__.ignore_break_point"></a> | |
| 769 <h4>DEBUGGER__.ignore_break_point</h4> | |
| 770 <b>ignore_break_point</b>(<i>pos, count</i>) | |
| 771 <p> | |
| 772 Method to set the ignore count of a breakpoint. | |
| 773 </p><dl> | |
| 774 <dt><i>file</i></dt> | |
| 775 <dd> | |
| 776 filename of the breakpoint (String) | |
| 777 </dd><dt><i>pos</i></dt> | |
| 778 <dd> | |
| 779 line number of the breakpoint (int) | |
| 780 </dd><dt><i>count</i></dt> | |
| 781 <dd> | |
| 782 ignore count to be set (int) | |
| 783 </dd> | |
| 784 </dl><a NAME="DEBUGGER__.ignore_watch_point" ID="DEBUGGER__.ignore_watch_point"></a> | |
| 785 <h4>DEBUGGER__.ignore_watch_point</h4> | |
| 786 <b>ignore_watch_point</b>(<i>count</i>) | |
| 787 <p> | |
| 788 Method to set the ignore count of a watch expression. | |
| 789 </p><dl> | |
| 790 <dt><i>cond</i></dt> | |
| 791 <dd> | |
| 792 expression of the watch expression (String) | |
| 793 </dd><dt><i>count</i></dt> | |
| 794 <dd> | |
| 795 ignore count to be set (int) | |
| 796 </dd> | |
| 797 </dl><a NAME="DEBUGGER__.last_thread" ID="DEBUGGER__.last_thread"></a> | |
| 798 <h4>DEBUGGER__.last_thread</h4> | |
| 799 <b>last_thread</b>(<i></i>) | |
| 800 <p> | |
| 801 Method returning the last active thread. | |
| 802 </p><dl> | |
| 803 <dt>Returns:</dt> | |
| 804 <dd> | |
| 805 active thread | |
| 806 </dd> | |
| 807 </dl><a NAME="DEBUGGER__.quit" ID="DEBUGGER__.quit"></a> | |
| 808 <h4>DEBUGGER__.quit</h4> | |
| 809 <b>quit</b>(<i></i>) | |
| 810 <p> | |
| 811 Method to quit the debugger. | |
| 812 </p><dl> | |
| 813 <dt><i>status</i></dt> | |
| 814 <dd> | |
| 815 exit status of the program | |
| 816 </dd> | |
| 817 </dl><a NAME="DEBUGGER__.resume" ID="DEBUGGER__.resume"></a> | |
| 818 <h4>DEBUGGER__.resume</h4> | |
| 819 <b>resume</b>(<i></i>) | |
| 820 <p> | |
| 821 Method to resume the program being debugged. | |
| 822 </p><a NAME="DEBUGGER__.resume_all" ID="DEBUGGER__.resume_all"></a> | |
| 823 <h4>DEBUGGER__.resume_all</h4> | |
| 824 <b>resume_all</b>(<i></i>) | |
| 825 <p> | |
| 826 Method to resume all threads. | |
| 827 </p><a NAME="DEBUGGER__.set_client" ID="DEBUGGER__.set_client"></a> | |
| 828 <h4>DEBUGGER__.set_client</h4> | |
| 829 <b>set_client</b>(<i></i>) | |
| 830 <p> | |
| 831 Method to set the client handling the connection. | |
| 832 </p><dl> | |
| 833 <dt><i>debugger</i></dt> | |
| 834 <dd> | |
| 835 reference to the object handling the connection | |
| 836 </dd> | |
| 837 </dl><a NAME="DEBUGGER__.set_last_thread" ID="DEBUGGER__.set_last_thread"></a> | |
| 838 <h4>DEBUGGER__.set_last_thread</h4> | |
| 839 <b>set_last_thread</b>(<i></i>) | |
| 840 <p> | |
| 841 Method to remember the last thread. | |
| 842 </p><dl> | |
| 843 <dt><i>th</i></dt> | |
| 844 <dd> | |
| 845 thread to be remembered. | |
| 846 </dd> | |
| 847 </dl><a NAME="DEBUGGER__.skip_it?" ID="DEBUGGER__.skip_it?"></a> | |
| 848 <h4>DEBUGGER__.skip_it?</h4> | |
| 849 <b>skip_it?</b>(<i></i>) | |
| 850 <p> | |
| 851 Method to filter out debugger files. | |
| 852 </p><p> | |
| 853 Tracing is turned off for files that are part of the | |
| 854 debugger that are called from the application being debugged. | |
| 855 </p><dl> | |
| 856 <dt><i>file</i></dt> | |
| 857 <dd> | |
| 858 name of the file to be checked (String) | |
| 859 </dd> | |
| 860 </dl><dl> | |
| 861 <dt>Returns:</dt> | |
| 862 <dd> | |
| 863 flag indicating, whether the file should be skipped (boolean) | |
| 864 </dd> | |
| 865 </dl><a NAME="DEBUGGER__.stdout" ID="DEBUGGER__.stdout"></a> | |
| 866 <h4>DEBUGGER__.stdout</h4> | |
| 867 <b>stdout</b>(<i></i>) | |
| 868 <p> | |
| 869 Method returning the stdout object. | |
| 870 </p><dl> | |
| 871 <dt>Returns:</dt> | |
| 872 <dd> | |
| 873 reference to the stdout object | |
| 874 </dd> | |
| 875 </dl><a NAME="DEBUGGER__.stdout=" ID="DEBUGGER__.stdout="></a> | |
| 876 <h4>DEBUGGER__.stdout=</h4> | |
| 877 <b>stdout=</b>(<i></i>) | |
| 878 <p> | |
| 879 Method to set the stdout object. | |
| 880 </p><dl> | |
| 881 <dt><i>s</i></dt> | |
| 882 <dd> | |
| 883 reference to the stdout object | |
| 884 </dd> | |
| 885 </dl><a NAME="DEBUGGER__.suspend" ID="DEBUGGER__.suspend"></a> | |
| 886 <h4>DEBUGGER__.suspend</h4> | |
| 887 <b>suspend</b>(<i></i>) | |
| 888 <p> | |
| 889 Method to suspend the program being debugged. | |
| 890 </p><a NAME="DEBUGGER__.thnum" ID="DEBUGGER__.thnum"></a> | |
| 891 <h4>DEBUGGER__.thnum</h4> | |
| 892 <b>thnum</b>(<i></i>) | |
| 893 <p> | |
| 894 Method returning the thread number of the current thread. | |
| 895 </p><dl> | |
| 896 <dt>Returns:</dt> | |
| 897 <dd> | |
| 898 thread number of the current thread. | |
| 899 </dd> | |
| 900 </dl><a NAME="DEBUGGER__.trace_func" ID="DEBUGGER__.trace_func"></a> | |
| 901 <h4>DEBUGGER__.trace_func</h4> | |
| 902 <b>trace_func</b>(<i>file, line, id, binding_, klass</i>) | |
| 903 <p> | |
| 904 Method executed by the tracing facility. | |
| 905 </p><dl> | |
| 906 <dt><i>event</i></dt> | |
| 907 <dd> | |
| 908 the tracing event (String) | |
| 909 </dd><dt><i>file</i></dt> | |
| 910 <dd> | |
| 911 the name of the file being traced (String) | |
| 912 </dd><dt><i>line</i></dt> | |
| 913 <dd> | |
| 914 the line number being traced (int) | |
| 915 </dd><dt><i>id</i></dt> | |
| 916 <dd> | |
| 917 object id | |
| 918 </dd><dt><i>binding_</i></dt> | |
| 919 <dd> | |
| 920 a binding object | |
| 921 </dd><dt><i>klass</i></dt> | |
| 922 <dd> | |
| 923 name of a class | |
| 924 </dd> | |
| 925 </dl><a NAME="DEBUGGER__.waiting" ID="DEBUGGER__.waiting"></a> | |
| 926 <h4>DEBUGGER__.waiting</h4> | |
| 927 <b>waiting</b>(<i></i>) | |
| 928 <p> | |
| 929 Method returning the waiting list. | |
| 930 </p><dl> | |
| 931 <dt>Returns:</dt> | |
| 932 <dd> | |
| 933 the waiting list | |
| 934 </dd> | |
| 935 </dl> | |
| 936 <div align="right"><a href="#top">Up</a></div> | |
| 937 <hr /><hr /> | |
| 938 <a NAME="Mutex" ID="Mutex"></a> | |
| 939 <h2>Mutex</h2> | |
| 940 <p> | |
| 941 Class implementing a mutex. | |
| 942 </p> | |
| 943 <h3>Derived from</h3> | |
| 944 None | |
| 945 <h3>Class Attributes</h3> | |
| 946 <table> | |
| 947 <tr><td>None</td></tr> | |
| 948 </table> | |
| 949 <h3>Methods</h3> | |
| 950 <table> | |
| 951 <tr> | |
| 952 <td><a href="#Mutex.initialize">initialize</a></td> | |
| 953 <td>Constructor</td> | |
| 954 </tr><tr> | |
| 955 <td><a href="#Mutex.lock">lock</a></td> | |
| 956 <td>Method to lock the mutex.</td> | |
| 957 </tr><tr> | |
| 958 <td><a href="#Mutex.locked?">locked?</a></td> | |
| 959 <td>Method returning the locked state.</td> | |
| 960 </tr><tr> | |
| 961 <td><a href="#Mutex.unlock">unlock</a></td> | |
| 962 <td>Method to unlock the mutex.</td> | |
| 963 </tr> | |
| 964 </table> | |
| 965 <a NAME="Mutex.initialize" ID="Mutex.initialize"></a> | |
| 966 <h4>Mutex.initialize</h4> | |
| 967 <b>initialize</b>(<i></i>) | |
| 968 <p> | |
| 969 Constructor | |
| 970 </p><a NAME="Mutex.lock" ID="Mutex.lock"></a> | |
| 971 <h4>Mutex.lock</h4> | |
| 972 <b>lock</b>(<i></i>) | |
| 973 <p> | |
| 974 Method to lock the mutex. | |
| 975 </p><dl> | |
| 976 <dt>Returns:</dt> | |
| 977 <dd> | |
| 978 the mutex | |
| 979 </dd> | |
| 980 </dl><a NAME="Mutex.locked?" ID="Mutex.locked?"></a> | |
| 981 <h4>Mutex.locked?</h4> | |
| 982 <b>locked?</b>(<i></i>) | |
| 983 <p> | |
| 984 Method returning the locked state. | |
| 985 </p><dl> | |
| 986 <dt>Returns:</dt> | |
| 987 <dd> | |
| 988 flag indicating the locked state (boolean) | |
| 989 </dd> | |
| 990 </dl><a NAME="Mutex.unlock" ID="Mutex.unlock"></a> | |
| 991 <h4>Mutex.unlock</h4> | |
| 992 <b>unlock</b>(<i></i>) | |
| 993 <p> | |
| 994 Method to unlock the mutex. | |
| 995 </p><dl> | |
| 996 <dt>Returns:</dt> | |
| 997 <dd> | |
| 998 the mutex | |
| 999 </dd> | |
| 1000 </dl> | |
| 1001 <div align="right"><a href="#top">Up</a></div> | |
| 1002 <hr /><hr /> | |
| 1003 <a NAME="SilentObject" ID="SilentObject"></a> | |
| 1004 <h2>SilentObject</h2> | |
| 1005 <p> | |
| 1006 Class defining an object that ignores all messages. | |
| 1007 </p> | |
| 1008 <h3>Derived from</h3> | |
| 1009 None | |
| 1010 <h3>Class Attributes</h3> | |
| 1011 <table> | |
| 1012 <tr><td>None</td></tr> | |
| 1013 </table> | |
| 1014 <h3>Methods</h3> | |
| 1015 <table> | |
| 1016 <tr> | |
| 1017 <td><a href="#SilentObject.method_missing">method_missing</a></td> | |
| 1018 <td>Method invoked for all messages it cannot handle.</td> | |
| 1019 </tr> | |
| 1020 </table> | |
| 1021 <a NAME="SilentObject.method_missing" ID="SilentObject.method_missing"></a> | |
| 1022 <h4>SilentObject.method_missing</h4> | |
| 1023 <b>method_missing</b>(<i>*a, &b</i>) | |
| 1024 <p> | |
| 1025 Method invoked for all messages it cannot handle. | |
| 1026 </p><dl> | |
| 1027 <dt><i>msg_id</i></dt> | |
| 1028 <dd> | |
| 1029 symbol for the method called | |
| 1030 </dd><dt><i>*a</i></dt> | |
| 1031 <dd> | |
| 1032 arguments passed to the missing method | |
| 1033 </dd><dt><i>&b</i></dt> | |
| 1034 <dd> | |
| 1035 unknown | |
| 1036 </dd> | |
| 1037 </dl> | |
| 1038 <div align="right"><a href="#top">Up</a></div> | |
| 1039 <hr /><hr /> | |
| 1040 <a NAME="context" ID="context"></a> | |
| 1041 <h2>context</h2> | |
| 1042 <b>context</b>(<i>thread=Thread.current</i>) | |
| 1043 <p> | |
| 1044 Method returning the context of a thread. | |
| 1045 </p><dl> | |
| 1046 <dt><i>th</i></dt> | |
| 1047 <dd> | |
| 1048 threat the context is requested for | |
| 1049 </dd> | |
| 1050 </dl><dl> | |
| 1051 <dt>Returns:</dt> | |
| 1052 <dd> | |
| 1053 context object for the thread | |
| 1054 </dd> | |
| 1055 </dl> | |
| 1056 <div align="right"><a href="#top">Up</a></div> | |
| 1057 <hr /><hr /> | |
| 1058 <a NAME="debug_thread_info" ID="debug_thread_info"></a> | |
| 1059 <h2>debug_thread_info</h2> | |
| 1060 <b>debug_thread_info</b>(<i>input, binding_</i>) | |
| 1061 <p> | |
| 1062 Method handling the thread related debug commands. | |
| 1063 </p><dl> | |
| 1064 <dt><i>input</i></dt> | |
| 1065 <dd> | |
| 1066 debug command (String) | |
| 1067 </dd><dt><i>binding_</i></dt> | |
| 1068 <dd> | |
| 1069 reference to the binding object | |
| 1070 </dd> | |
| 1071 </dl> | |
| 1072 <div align="right"><a href="#top">Up</a></div> | |
| 1073 <hr /><hr /> | |
| 1074 <a NAME="eventLoop" ID="eventLoop"></a> | |
| 1075 <h2>eventLoop</h2> | |
| 1076 <b>eventLoop</b>(<i></i>) | |
| 1077 <p> | |
| 1078 Method calling the main event loop. | |
| 1079 </p> | |
| 1080 <div align="right"><a href="#top">Up</a></div> | |
| 1081 <hr /><hr /> | |
| 1082 <a NAME="eventPoll" ID="eventPoll"></a> | |
| 1083 <h2>eventPoll</h2> | |
| 1084 <b>eventPoll</b>(<i></i>) | |
| 1085 <p> | |
| 1086 Method calling the main function polling for an event sent by the IDE. | |
| 1087 </p> | |
| 1088 <div align="right"><a href="#top">Up</a></div> | |
| 1089 <hr /><hr /> | |
| 1090 <a NAME="get_thread" ID="get_thread"></a> | |
| 1091 <h2>get_thread</h2> | |
| 1092 <b>get_thread</b>(<i>num</i>) | |
| 1093 <p> | |
| 1094 Method returning a thread by number. | |
| 1095 </p><dl> | |
| 1096 <dt><i>num</i></dt> | |
| 1097 <dd> | |
| 1098 thread number (int) | |
| 1099 </dd> | |
| 1100 </dl><dl> | |
| 1101 <dt>Returns:</dt> | |
| 1102 <dd> | |
| 1103 thread with the requested number | |
| 1104 </dd> | |
| 1105 </dl> | |
| 1106 <div align="right"><a href="#top">Up</a></div> | |
| 1107 <hr /><hr /> | |
| 1108 <a NAME="interrupt" ID="interrupt"></a> | |
| 1109 <h2>interrupt</h2> | |
| 1110 <b>interrupt</b>(<i></i>) | |
| 1111 <p> | |
| 1112 Method to stop execution at the next instruction. | |
| 1113 </p> | |
| 1114 <div align="right"><a href="#top">Up</a></div> | |
| 1115 <hr /><hr /> | |
| 1116 <a NAME="make_thread_list" ID="make_thread_list"></a> | |
| 1117 <h2>make_thread_list</h2> | |
| 1118 <b>make_thread_list</b>(<i></i>) | |
| 1119 <p> | |
| 1120 Method to create a thread list. | |
| 1121 </p> | |
| 1122 <div align="right"><a href="#top">Up</a></div> | |
| 1123 <hr /><hr /> | |
| 1124 <a NAME="thread_list" ID="thread_list"></a> | |
| 1125 <h2>thread_list</h2> | |
| 1126 <b>thread_list</b>(<i>num</i>) | |
| 1127 <p> | |
| 1128 Method to list the state of a thread. | |
| 1129 </p><dl> | |
| 1130 <dt><i>num</i></dt> | |
| 1131 <dd> | |
| 1132 thread number (int) | |
| 1133 </dd> | |
| 1134 </dl> | |
| 1135 <div align="right"><a href="#top">Up</a></div> | |
| 1136 <hr /><hr /> | |
| 1137 <a NAME="thread_list_all" ID="thread_list_all"></a> | |
| 1138 <h2>thread_list_all</h2> | |
| 1139 <b>thread_list_all</b>(<i></i>) | |
| 1140 <p> | |
| 1141 Method to list the state of all threads. | |
| 1142 </p> | |
| 1143 <div align="right"><a href="#top">Up</a></div> | |
| 1144 <hr /><hr /> | |
| 1145 <a NAME="traceRuby?" ID="traceRuby?"></a> | |
| 1146 <h2>traceRuby?</h2> | |
| 1147 <b>traceRuby?</b>(<i></i>) | |
| 1148 <p> | |
| 1149 Method to check, if we should trace into the Ruby interpreter libraries. | |
| 1150 </p> | |
| 1151 <div align="right"><a href="#top">Up</a></div> | |
| 1152 <hr /> | |
| 1153 </body></html> |
