GDB_002fMI-Input-Syntax.html 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Free Software" and "Free Software Needs
  8. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"
  9. and with the Back-Cover Texts as in (a) below.
  10. (a) The FSF's Back-Cover Text is: "You are free to copy and modify
  11. this GNU Manual. Buying copies from GNU Press supports the FSF in
  12. developing GNU and promoting software freedom." -->
  13. <!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <title>Debugging with GDB: GDB/MI Input Syntax</title>
  16. <meta name="description" content="Debugging with GDB: GDB/MI Input Syntax">
  17. <meta name="keywords" content="Debugging with GDB: GDB/MI Input Syntax">
  18. <meta name="resource-type" content="document">
  19. <meta name="distribution" content="global">
  20. <meta name="Generator" content="makeinfo">
  21. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  22. <link href="index.html#Top" rel="start" title="Top">
  23. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
  24. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  25. <link href="GDB_002fMI-Command-Syntax.html#GDB_002fMI-Command-Syntax" rel="up" title="GDB/MI Command Syntax">
  26. <link href="GDB_002fMI-Output-Syntax.html#GDB_002fMI-Output-Syntax" rel="next" title="GDB/MI Output Syntax">
  27. <link href="GDB_002fMI-Command-Syntax.html#GDB_002fMI-Command-Syntax" rel="previous" title="GDB/MI Command Syntax">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.smallquotation {font-size: smaller}
  32. div.display {margin-left: 3.2em}
  33. div.example {margin-left: 3.2em}
  34. div.indentedblock {margin-left: 3.2em}
  35. div.lisp {margin-left: 3.2em}
  36. div.smalldisplay {margin-left: 3.2em}
  37. div.smallexample {margin-left: 3.2em}
  38. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  39. div.smalllisp {margin-left: 3.2em}
  40. kbd {font-style:oblique}
  41. pre.display {font-family: inherit}
  42. pre.format {font-family: inherit}
  43. pre.menu-comment {font-family: serif}
  44. pre.menu-preformatted {font-family: serif}
  45. pre.smalldisplay {font-family: inherit; font-size: smaller}
  46. pre.smallexample {font-size: smaller}
  47. pre.smallformat {font-family: inherit; font-size: smaller}
  48. pre.smalllisp {font-size: smaller}
  49. span.nocodebreak {white-space:nowrap}
  50. span.nolinebreak {white-space:nowrap}
  51. span.roman {font-family:serif; font-weight:normal}
  52. span.sansserif {font-family:sans-serif; font-weight:normal}
  53. ul.no-bullet {list-style: none}
  54. -->
  55. </style>
  56. </head>
  57. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  58. <a name="GDB_002fMI-Input-Syntax"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="GDB_002fMI-Output-Syntax.html#GDB_002fMI-Output-Syntax" accesskey="n" rel="next">GDB/MI Output Syntax</a>, Up: <a href="GDB_002fMI-Command-Syntax.html#GDB_002fMI-Command-Syntax" accesskey="u" rel="up">GDB/MI Command Syntax</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  62. </div>
  63. <hr>
  64. <a name="GDB_002fMI-Input-Syntax-1"></a>
  65. <h4 class="subsection">27.2.1 <small>GDB/MI</small> Input Syntax</h4>
  66. <a name="index-input-syntax-for-GDB_002fMI"></a>
  67. <a name="index-GDB_002fMI_002c-input-syntax"></a>
  68. <dl compact="compact">
  69. <dt><code><var>command</var> &rarr;</code></dt>
  70. <dd><p><code><var>cli-command</var> | <var>mi-command</var></code>
  71. </p>
  72. </dd>
  73. <dt><code><var>cli-command</var> &rarr;</code></dt>
  74. <dd><p><code>[ <var>token</var> ] <var>cli-command</var> <var>nl</var></code>, where
  75. <var>cli-command</var> is any existing <small>GDB</small> CLI command.
  76. </p>
  77. </dd>
  78. <dt><code><var>mi-command</var> &rarr;</code></dt>
  79. <dd><p><code>[ <var>token</var> ] &quot;-&quot; <var>operation</var> ( &quot; &quot; <var>option</var> )*
  80. <code>[</code> &quot; --&quot; <code>]</code> ( &quot; &quot; <var>parameter</var> )* <var>nl</var></code>
  81. </p>
  82. </dd>
  83. <dt><code><var>token</var> &rarr;</code></dt>
  84. <dd><p>&quot;any sequence of digits&quot;
  85. </p>
  86. </dd>
  87. <dt><code><var>option</var> &rarr;</code></dt>
  88. <dd><p><code>&quot;-&quot; <var>parameter</var> [ &quot; &quot; <var>parameter</var> ]</code>
  89. </p>
  90. </dd>
  91. <dt><code><var>parameter</var> &rarr;</code></dt>
  92. <dd><p><code><var>non-blank-sequence</var> | <var>c-string</var></code>
  93. </p>
  94. </dd>
  95. <dt><code><var>operation</var> &rarr;</code></dt>
  96. <dd><p><em>any of the operations described in this chapter</em>
  97. </p>
  98. </dd>
  99. <dt><code><var>non-blank-sequence</var> &rarr;</code></dt>
  100. <dd><p><em>anything, provided it doesn&rsquo;t contain special characters such as
  101. &quot;-&quot;, <var>nl</var>, &quot;&quot;&quot; and of course &quot; &quot;</em>
  102. </p>
  103. </dd>
  104. <dt><code><var>c-string</var> &rarr;</code></dt>
  105. <dd><p><code>&quot;&quot;&quot; <var>seven-bit-iso-c-string-content</var> &quot;&quot;&quot;</code>
  106. </p>
  107. </dd>
  108. <dt><code><var>nl</var> &rarr;</code></dt>
  109. <dd><p><code>CR | CR-LF</code>
  110. </p></dd>
  111. </dl>
  112. <p>Notes:
  113. </p>
  114. <ul>
  115. <li> The CLI commands are still handled by the <small>MI</small> interpreter; their
  116. output is described below.
  117. </li><li> The <code><var>token</var></code>, when present, is passed back when the command
  118. finishes.
  119. </li><li> Some <small>MI</small> commands accept optional arguments as part of the parameter
  120. list. Each option is identified by a leading &lsquo;<samp>-</samp>&rsquo; (dash) and may be
  121. followed by an optional argument parameter. Options occur first in the
  122. parameter list and can be delimited from normal parameters using
  123. &lsquo;<samp>--</samp>&rsquo; (this is useful when some parameters begin with a dash).
  124. </li></ul>
  125. <p>Pragmatics:
  126. </p>
  127. <ul>
  128. <li> We want easy access to the existing CLI syntax (for debugging).
  129. </li><li> We want it to be easy to spot a <small>MI</small> operation.
  130. </li></ul>
  131. </body>
  132. </html>