mingw/info/gdb/GDB-MI-Input-Syntax.html

   1 <html lang="en">
   2 <head>
   3 <title>Debugging with GDB</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="Debugging with GDB">
   6 <meta name="generator" content="makeinfo 4.3">
   7 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home">
   8 </head>
   9 <body>
  10 <div class="node">
  11 <p>
  12 Node:<a name="GDB%2fMI%20Input%20Syntax">GDB/MI Input Syntax</a>,
  13 Next:<a rel="next" accesskey="n" href="GDB-MI-Output-Syntax.html#GDB%2fMI%20Output%20Syntax">GDB/MI Output Syntax</a>,
  14 Up:<a rel="up" accesskey="u" href="GDB-MI-Command-Syntax.html#GDB%2fMI%20Command%20Syntax">GDB/MI Command Syntax</a>
  15 <hr><br>
  16 </div>
  17
  18 <h4 class="subsection"><small>GDB/MI</small> Input Syntax</h4>
  19
  20      <dl>
  21 <dt><code></code><var>command</var><code> ==&gt;</code>
  22      <dd><code></code><var>cli-command</var><code> | </code><var>mi-command</var><code></code>
  23
  24      <br><dt><code></code><var>cli-command</var><code> ==&gt;</code>
  25      <dd><code>[ </code><var>token</var><code> ] </code><var>cli-command</var><code> </code><var>nl</var><code></code>, where
  26 <var>cli-command</var> is any existing GDB CLI command.
  27
  28      <br><dt><code></code><var>mi-command</var><code> ==&gt;</code>
  29      <dd><code>[ </code><var>token</var><code> ] "-" </code><var>operation</var><code> ( " " </code><var>option</var><code> )*
  30 [ " --" ] ( " " </code><var>parameter</var><code> )* </code><var>nl</var><code></code>
  31
  32      <br><dt><code></code><var>token</var><code> ==&gt;</code>
  33      <dd>"any sequence of digits"
  34
  35      <br><dt><code></code><var>option</var><code> ==&gt;</code>
  36      <dd><code>"-" </code><var>parameter</var><code> [ " " </code><var>parameter</var><code> ]</code>
  37
  38      <br><dt><code></code><var>parameter</var><code> ==&gt;</code>
  39      <dd><code></code><var>non-blank-sequence</var><code> | </code><var>c-string</var><code></code>
  40
  41      <br><dt><code></code><var>operation</var><code> ==&gt;</code>
  42      <dd><em>any of the operations described in this chapter</em>
  43
  44      <br><dt><code></code><var>non-blank-sequence</var><code> ==&gt;</code>
  45      <dd><em>anything, provided it doesn't contain special characters such as
  46 "-", </em><var>nl</var><em>, """ and of course " "</em>
  47
  48      <br><dt><code></code><var>c-string</var><code> ==&gt;</code>
  49      <dd><code>""" </code><var>seven-bit-iso-c-string-content</var><code> """</code>
  50
  51      <br><dt><code></code><var>nl</var><code> ==&gt;</code>
  52      <dd><code>CR | CR-LF</code>
  53 </dl>
  54
  55 <p>Notes:
  56
  57      <ul>
  58 <li>The CLI commands are still handled by the <small>MI</small> interpreter; their
  59 output is described below.
  60
  61      <li>The <code></code><var>token</var><code></code>, when present, is passed back when the command
  62 finishes.
  63
  64      <li>Some <small>MI</small> commands accept optional arguments as part of the parameter
  65 list.  Each option is identified by a leading <code>-</code> (dash) and may be
  66 followed by an optional argument parameter.  Options occur first in the
  67 parameter list and can be delimited from normal parameters using
  68 <code>--</code> (this is useful when some parameters begin with a dash).
  69 </ul>
  70
  71    <p>Pragmatics:
  72
  73      <ul>
  74 <li>We want easy access to the existing CLI syntax (for debugging).
  75
  76      <li>We want it to be easy to spot a <small>MI</small> operation.
  77 </ul>
  78
  79    </body></html>
  80