mruby.github.io/docs/api/file.debugger.html at master · mruby/mruby.github.io

490 lines (342 loc) · 11.6 KB
<!DOCTYPE html>
    <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
  File: debugger
    &mdash; Documentation by YARD 0.9.20
  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
  <link rel="stylesheet" href="css/mruby.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
  pathId = "debugger";
  relpath = '';
  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
  <script type="text/javascript" charset="utf-8" src="js/mruby.js"></script>
    <div class="nav_wrap">
      <iframe id="nav" src="file_list.html?1"></iframe>
      <div id="resizer"></div>
    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
    <a href="_index.html">Index</a> &raquo; 
    <span class="title">File: debugger</span>
        <div id="search">
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">
        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
        <div class="clear"></div>
      </div>
      <div id="content"><div id='filecontents'><h1 id="how-to-use-the-mruby-debugger">How to Use the mruby Debugger</h1>
<p>copyright (c) 2014 Specified Non-Profit Corporation mruby Forum</p>
<h2 id="summary">1. Summary</h2>
<p>This file documents the mruby debugger (‘mrdb’) methods.</p>
<h2 id="debugging-with-mrdb">2 Debugging with mrdb</h2>
<h2 id="building-mrdb">2.1 Building mrdb</h2>
<p>The trunk of the mruby source tree, with the most recent mrdb, can be checked out with the following command:</p>
<p><code>bash
$ git clone https://github.com/mruby/mruby.git
</code></p>
<p>To run the <code>make</code> command:</p>
<p><code>bash
</code></p>
<p>By default, the <code>make</code> command will install the debugger files into mruby/bin.</p>
<p>You can add the path for mrdb on your host environment with the following command:</p>
<p><code>bash
$ echo "export PATH=\$PATH:MRUBY_ROOT/bin" &gt;&gt; ~/.bashrc
$ source ~/.bashrc
</code></p>
<p><code>*MRUBY_ROOT</code> is the directory in which mruby source code will be installed.</p>
<p>To confirm mrdb was installed properly, run mrdb with the <code>--version</code> option:</p>
<p><code>bash
$ mrdb --version
mruby 2.1.0 (2019-11-19)
</code></p>
<h2 id="basic-operation">2.2 Basic Operation</h2>
<h3 id="debugging-mruby-script-files-rb-file-with-mrdb">2.2.1 Debugging mruby Script Files (rb file) with mrdb</h3>
<p>To invoke the mruby debugger, just type <code>mrdb</code>.</p>
<p>To specify the script file:</p>
<p><code>bash
$ mrdb [option] file name
</code></p>
<p>For example: Debugging sample.rb</p>
<p><code>bash
$ mrdb sample.rb
</code></p>
<p>You can execute the shell commands listed below:</p>
      <th style="text-align: center">command</th>
      <th style="text-align: left">description</th>
      <td style="text-align: center">run</td>
      <td style="text-align: left">execute programs</td>
      <td style="text-align: center">step</td>
      <td style="text-align: left">execute stepping</td>
      <td style="text-align: center">continue</td>
      <td style="text-align: left">execute continuing program</td>
      <td style="text-align: center">break</td>
      <td style="text-align: left">configure the breaking point</td>
      <td style="text-align: center">delete</td>
      <td style="text-align: left">deleting the breaking points</td>
      <td style="text-align: center">disable</td>
      <td style="text-align: left">disabling the breaking points</td>
      <td style="text-align: center">enable</td>
      <td style="text-align: left">enabling the breaking points</td>
      <td style="text-align: center">info breakpoints</td>
      <td style="text-align: left">showing list of the breaking points</td>
      <td style="text-align: center">print</td>
      <td style="text-align: left">evaluating and printing the values of the mruby expressions in the script</td>
      <td style="text-align: center">list</td>
      <td style="text-align: left">displaying the source cords</td>
      <td style="text-align: center">help</td>
      <td style="text-align: left">showing help</td>
      <td style="text-align: center">quit</td>
      <td style="text-align: left">terminating the mruby debugger</td>
<h3 id="debugging-mruby-binary-files-mrb-file-with-mrdb">2.2.2 Debugging mruby Binary Files (mrb file) with mrdb</h3>
<p>You can debug the mruby binary files.</p>
<h4 id="debugging-the-binary-files">2.2.2.1 Debugging the binary files</h4>
  <li>notice
To debug mruby binary files, you need to compile mruby files with option <code>-g</code>.</li>
<p><code>bash
$ mrbc -g sample.rb
</code></p>
<p>You can debug the mruby binary files with following command and the option <code>-b</code>.</p>
<p><code>bash
$ mrdb -b sample.mrb
</code></p>
<p>Then you can execute all debugger shell commands.</p>
<h4 id="break-command">Break Command</h4>
<p>You can use any breakpoint to stop the program by specifying the line number and method name.
The breakpoint list will be displayed after you have set the breakpoint successfully.</p>
<p>Usage:</p>
break [file:]linenum
b [file:]linenum
break [class:]method
b [class:]method
</code></p>
<p>The breakpoint will be ordered in serial from 1.
The number, which was given to the deleted breakpoint, will never be given to another breakpoint again.</p>
<p>You can give multiple breakpoints to specified the line number and method.
Be ware that breakpoint command will not check the validity of the class name and method name.</p>
<p>You can get the current breakpoint information by the following options.</p>
<p>breakpoint breakpoint number : file name. line number</p>
<p>breakpoint breakpoint number : [class name,] method name</p>
<h4 id="continue-command">Continue Command</h4>
<p>Usage:</p>
continue [N]
</code></p>
<p>N: the next breakpoint number</p>
<p>When resuming the program, it will stop at breakpoint N (N-1 breakpoint will be ignored).</p>
<p>When you run the <code>continue</code> command without specifying N, the program will be stopped at the next breakpoint.</p>
<p>Example:</p>
(foo.rb:1) continue 3
</code></p>
<p>This will resume the program and stop it at the third breakpoint.</p>
<h4 id="delete-command">Delete Command</h4>
<p>This will delete the specified breakpoint.</p>
<p>Usage:</p>
delete [breakpoint-no]
d [breakpoint-no]
</code></p>
<p>breakpoint-no: breakpoint number</p>
<p>Example:</p>
(foo.rb:1) delete
</code></p>
<p>This will delete all of the breakpoints.</p>
(foo.rb:1) delete 1 3
</code></p>
<p>This will delete the breakpoint at 1 and 3.</p>
<h4 id="disable-command">Disable Command</h4>
<p>This will disable the specified breakpoint.</p>
<p>Usage:</p>
disable [breakpoint-no]
dis [breakpoint-no]
</code></p>
<p>reappointing: breakpoint number</p>
<p>Example:</p>
(foo.rb:1) disable
</code></p>
<p>Use <code>disable</code> if you would like to disable all of the breakpoints.</p>
(foo.rb:1) disable 1 3
</code></p>
<p>This will disable the breakpoints at 1 and 3.</p>
<h4 id="enable-command">Enable Command</h4>
<p>This will enable the specified breakpoints.</p>
<p>Usage:</p>
enable [breakpoint-no]
e [breakpoint-no]
</code></p>
<p>breakpoint-no: breakpoint number</p>
<p>Example:</p>
(foo.rb:1) enable
</code></p>
<p>Enabling all breakpoints
(foo.rb:1) enable 1 3
</code></p>
<p>Enabling the breakpoint 1 and 3</p>
<h4 id="eval-command">eval command</h4>
<p>Evaluating the string as source code and printing the value.</p>
<p>Same as print command, please see print command.</p>
<h4 id="help-command">help command</h4>
<p>Displaying the help message.</p>
<p>Usage:</p>
help [command]
h [command]
</code></p>
<p>Typing <code>help</code> without any options will display the command list.</p>
<h4 id="info-breakpoints-command">Info Breakpoints Command</h4>
<p>Displaying the specified breakpoint information.</p>
<p>Usage:</p>
info breakpoints [breakpoint-no]
i b [breakpoint-no]
</code></p>
<p>breakpoint-no: breakpoint number</p>
<p>Typing “info breakpoints” without ant option will display all breakpoint information.
Example:</p>
(sample.rb:1) info breakpoints
Num     Type           Enb What  
1       breakpoint     y   at sample.rb:3                      -&gt; file name,line number
2       breakpoint     n   in Sample_class:sample_class_method -&gt; [class:]method name
3       breakpoint     y   in sample_global_method
</code></p>
<p>Displaying the specified breakpoint number:</p>
(foo.rb:1) info breakpoints 1 3
Num     Type           Enb What  
1       breakpoint     y   at sample.rb:3  
3       breakpoint     y   in sample_global_method
</code></p>
<h4 id="list-command">List Command</h4>
<p>To display the code of the source file.</p>
<p>Usage:</p>
list [filename:]first[,last]
l [filename]:first[,last]
</code></p>
<p>first: the opening row number
last : the closing row number</p>
<p>When you specify the <code>first</code>, but not the <code>last</code> option, you will receive 10 rows.
When you do not specify both the <code>first</code> and <code>last</code> options, you will receive the next 10 rows.</p>
<p>Example:</p>
Specifying file name and first row number
sample.rb:1) list sample2.rb:5
</code></p>
<p>Specifying the file name and the first and last row number:</p>
(sample.rb:1) list sample2.rb:6,7
</code></p>
<h4 id="print-command">Print Command</h4>
<p>Evaluating the string as source code and printing the value.</p>
<p>Usage:</p>
print [expr]
</code></p>
<p>expr: expression</p>
<p>The expression is mandatory.
The displayed expressions will be serially ordered from 1.
If an exception occurs, the exception information will be displayed and the debugging will be continued.</p>
<p>Example:</p>
(sample.rb:1) print 1+2
(sample.rb:1) print self
</code></p>
<p>Below is the case of the exception:</p>
(sample.rb:1) print (1+2
$1 =  SyntaxError: line 1: syntax error, unexpected $end, expecting ')'
</code></p>
<h4 id="quit-command">Quit Command</h4>
<p>Quitting the debugger.</p>
<p>Usage:</p>
</code></p>
<h4 id="run-command">Run Command</h4>
<p>Running the program and stopping at the first breakpoint.</p>
<p>Usage:</p>
</code></p>
<h4 id="step-command">Step Command</h4>
<p>This will run the program step by step.
When the method and the block are invoked, the program will be stop at the first row.
The program, which is developed in C, will be ignored.</p>
</div></div>
      <div id="footer">
  Generated on Wed Nov 27 22:35:07 2019 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.9.20 in <a href="https://github.com/sagmor/yard-mruby">mruby mode</a> 0.3.0 (ruby-2.5.5).
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

file.debugger.html

Latest commit

History

file.debugger.html

File metadata and controls
