node-gdb
Version:
Control GDB from node.js
501 lines (496 loc) • 10.4 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript API Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='Node-gdb'>
Node-gdb
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>GDB</span>
</div>
</div>
<div id='content'>
<h1>
Class:
GDB
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/index.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Public: A class to control an instance of GDB running as a child process.
The child is not spawned on construction, but only when calling <code>.connect</code></p>
</div>
<div class='tags'>
</div>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='breaks-variable'>
breaks
=
</dt>
<dd>
<pre><code class='coffeescript'>null</code></pre>
<div class='docstring'>
<p>A <a href='../class/BreakpointManager.html'>BreakpointManager</a> instance.</p>
</div>
<div class='tags'>
</div>
</dd>
<dt id='exec-variable'>
exec
=
</dt>
<dd>
<pre><code class='coffeescript'>null</code></pre>
<div class='docstring'>
<p>An <a href='../class/ExecState.html'>ExecState</a> instance.</p>
</div>
<div class='tags'>
</div>
</dd>
<dt id='vars-variable'>
vars
=
</dt>
<dd>
<pre><code class='coffeescript'>null</code></pre>
<div class='docstring'>
<p>A <a href='../class/VariableManager.html'>VariableManager</a> instance. API not finalised.</p>
</div>
<div class='tags'>
</div>
</dd>
<dt id='command-variable'>
command
=
</dt>
<dd>
<pre><code class='coffeescript'>'gdb'</code></pre>
</dd>
</dl>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#onConsoleOutput-dynamic'>
#
(void)
<b>onConsoleOutput</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#onConnect-dynamic'>
#
(void)
<b>onConnect</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
Invoke the given function when GDB starts.
</span>
</li>
<li>
<span class='signature'>
<a href='#onDisconnect-dynamic'>
#
(void)
<b>onDisconnect</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
Invoke the given function when GDB exits.
</span>
</li>
<li>
<span class='signature'>
<a href='#connect-dynamic'>
#
(Promise)
<b>connect</b><span>(command)</span>
</a>
</span>
<span class='desc'>
Spawn the GDB child process, and set up with our config.
</span>
</li>
<li>
<span class='signature'>
<a href='#disconnect-dynamic'>
#
(void)
<b>disconnect</b><span>()</span>
</a>
</span>
<span class='desc'>
Politely request the GDB child process to exit
</span>
</li>
<li>
<span class='signature'>
<a href='#send_mi-dynamic'>
#
(Promise)
<b>send_mi</b><span>(cmd, quiet)</span>
</a>
</span>
<span class='desc'>
Send a gdb/mi command.
</span>
</li>
<li>
<span class='signature'>
<a href='#send_cli-dynamic'>
#
(Promise)
<b>send_cli</b><span>(cmd)</span>
</a>
</span>
<span class='desc'>
Send a gdb/cli command.
</span>
</li>
<li>
<span class='signature'>
<a href='#set-dynamic'>
#
(void)
<b>set</b><span>(name, value)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#show-dynamic'>
#
(void)
<b>show</b><span>(name)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#setCwd-dynamic'>
#
(void)
<b>setCwd</b><span>(path)</span>
</a>
</span>
<span class='desc'>
Set current working directory.
</span>
</li>
<li>
<span class='signature'>
<a href='#setFile-dynamic'>
#
(void)
<b>setFile</b><span>(path)</span>
</a>
</span>
<span class='desc'>
Set current file for target execution and symbols.
</span>
</li>
<li>
<span class='signature'>
<a href='#destroy-dynamic'>
#
(void)
<b>destroy</b><span>()</span>
</a>
</span>
<span class='desc'>
Tear down the object and free associated resources.
</span>
</li>
</ul>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>(command)</span>
<br>
</p>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='onConsoleOutput-dynamic'>
#
(void)
<b>onConsoleOutput</b><span>(cb)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='onConnect-dynamic'>
#
(void)
<b>onConnect</b><span>(cb)</span>
<br>
</p>
<div class='docstring'>
<p>Invoke the given function when GDB starts.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='onDisconnect-dynamic'>
#
(void)
<b>onDisconnect</b><span>(cb)</span>
<br>
</p>
<div class='docstring'>
<p>Invoke the given function when GDB exits.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='connect-dynamic'>
#
(Promise)
<b>connect</b><span>(command)</span>
<br>
</p>
<div class='docstring'>
<p>Spawn the GDB child process, and set up with our config.</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Promise</tt>
)
—
<span class='desc'>resolves when GDB is running. </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='disconnect-dynamic'>
#
(void)
<b>disconnect</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Politely request the GDB child process to exit</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='send_mi-dynamic'>
#
(Promise)
<b>send_mi</b><span>(cmd, quiet)</span>
<br>
</p>
<div class='docstring'>
<p>Send a gdb/mi command. This is used internally by sub-modules.</p><p>reply or rejected in the case of an error reply.</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Promise</tt>
)
—
<span class='desc'>resolves to the results part of the result record </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='send_cli-dynamic'>
#
(Promise)
<b>send_cli</b><span>(cmd)</span>
<br>
</p>
<div class='docstring'>
<p>Send a gdb/cli command. This may be used to implement a CLI
window in a GUI frontend tool, or to send monitor or other commands for
which no equivalent MI commands exist.</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Promise</tt>
)
—
<span class='desc'>resolves on success. </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='set-dynamic'>
#
(void)
<b>set</b><span>(name, value)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='show-dynamic'>
#
(void)
<b>show</b><span>(name)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='setCwd-dynamic'>
#
(void)
<b>setCwd</b><span>(path)</span>
<br>
</p>
<div class='docstring'>
<p>Set current working directory.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='setFile-dynamic'>
#
(void)
<b>setFile</b><span>(path)</span>
<br>
</p>
<div class='docstring'>
<p>Set current file for target execution and symbols.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='destroy-dynamic'>
#
(void)
<b>destroy</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Tear down the object and free associated resources.</p>
</div>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
✲
Press H to see the keyboard shortcuts
✲
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
✲
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>