node-gdb
Version:
Control GDB from node.js
538 lines (533 loc) • 10.8 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'>ExecState</span>
</div>
</div>
<div id='content'>
<h1>
Class:
ExecState
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/exec.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Class for managing target execution state.</p>
</div>
<div class='tags'>
</div>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#onFrameChanged-dynamic'>
#
(void)
<b>onFrameChanged</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#onStopped-dynamic'>
#
(void)
<b>onStopped</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#onRunning-dynamic'>
#
(void)
<b>onRunning</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#onExited-dynamic'>
#
(void)
<b>onExited</b><span>(cb)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#start-dynamic'>
#
(void)
<b>start</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#continue-dynamic'>
#
(void)
<b>continue</b><span>()</span>
</a>
</span>
<span class='desc'>
Resume execution.
</span>
</li>
<li>
<span class='signature'>
<a href='#next-dynamic'>
#
(void)
<b>next</b><span>()</span>
</a>
</span>
<span class='desc'>
Single step, stepping over function calls.
</span>
</li>
<li>
<span class='signature'>
<a href='#step-dynamic'>
#
(void)
<b>step</b><span>()</span>
</a>
</span>
<span class='desc'>
Single step, stepping into function calls.
</span>
</li>
<li>
<span class='signature'>
<a href='#finish-dynamic'>
#
(void)
<b>finish</b><span>()</span>
</a>
</span>
<span class='desc'>
Resume execution until frame returns.
</span>
</li>
<li>
<span class='signature'>
<a href='#interrupt-dynamic'>
#
(void)
<b>interrupt</b><span>()</span>
</a>
</span>
<span class='desc'>
Attempt to interrupt the running target.
</span>
</li>
<li>
<span class='signature'>
<a href='#getThreads-dynamic'>
#
(Promise)
<b>getThreads</b><span>()</span>
</a>
</span>
<span class='desc'>
Read a list of threads from the target
</span>
</li>
<li>
<span class='signature'>
<a href='#getFrames-dynamic'>
#
(Promise)
<b>getFrames</b><span>(thread)</span>
</a>
</span>
<span class='desc'>
Read a list of stack frames from the target
</span>
</li>
<li>
<span class='signature'>
<a href='#selectFrame-dynamic'>
#
(void)
<b>selectFrame</b><span>(level, thread)</span>
</a>
</span>
<span class='desc'>
Select a stack frame for future operations.
</span>
</li>
<li>
<span class='signature'>
<a href='#getLocals-dynamic'>
#
(Promise)
<b>getLocals</b><span>(level, thread)</span>
</a>
</span>
<span class='desc'>
Read local variables for a given frame/thread
</span>
</li>
</ul>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='onFrameChanged-dynamic'>
#
(void)
<b>onFrameChanged</b><span>(cb)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='onStopped-dynamic'>
#
(void)
<b>onStopped</b><span>(cb)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='onRunning-dynamic'>
#
(void)
<b>onRunning</b><span>(cb)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='onExited-dynamic'>
#
(void)
<b>onExited</b><span>(cb)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='start-dynamic'>
#
(void)
<b>start</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='continue-dynamic'>
#
(void)
<b>continue</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Resume execution.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='next-dynamic'>
#
(void)
<b>next</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Single step, stepping over function calls.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='step-dynamic'>
#
(void)
<b>step</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Single step, stepping into function calls.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='finish-dynamic'>
#
(void)
<b>finish</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Resume execution until frame returns.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='interrupt-dynamic'>
#
(void)
<b>interrupt</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Attempt to interrupt the running target.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getThreads-dynamic'>
#
(Promise)
<b>getThreads</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Read a list of threads from the target</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Promise</tt>
)
—
<span class='desc'>resolves to an array of thread objects </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getFrames-dynamic'>
#
(Promise)
<b>getFrames</b><span>(thread)</span>
<br>
</p>
<div class='docstring'>
<p>Read a list of stack frames from the target</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>thread</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
—
<span class='desc'>Target thread identifier (optional) </span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Promise</tt>
)
—
<span class='desc'>resolves to a list of frame objects </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='selectFrame-dynamic'>
#
(void)
<b>selectFrame</b><span>(level, thread)</span>
<br>
</p>
<div class='docstring'>
<p>Select a stack frame for future operations. Emits frameChanged signal.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>level</span>
<span class='type'>
(
<tt>Integer</tt>
)
</span>
—
<span class='desc'>Stack frame level </span>
</li>
<li>
<span class='name'>thread</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
—
<span class='desc'>Target thread identifier (optional) </span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getLocals-dynamic'>
#
(Promise)
<b>getLocals</b><span>(level, thread)</span>
<br>
</p>
<div class='docstring'>
<p>Read local variables for a given frame/thread</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>level</span>
<span class='type'>
(
<tt>Integer</tt>
)
</span>
—
<span class='desc'>Stack frame level (optional) </span>
</li>
<li>
<span class='name'>thread</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
—
<span class='desc'>Target thread identifier (optional) </span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Promise</tt>
)
—
<span class='desc'>resolves to an array of objects with <code>name</code> and <code>value</code> fields </span>
</li>
</ul>
</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>