jscc-parser
Version:
A LALR(1) Parser Generator for JavaScript written in JavaScript.
960 lines (264 loc) • 16 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: ioNashorn</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: ioNashorn</h1>
<section>
<header>
<h2>ioNashorn</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="ioNashorn"><span class="type-signature"></span>new ioNashorn<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="jscc.io.html">jscc.io</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="io_ioNashorn.js.html">io/ioNashorn.js</a>, <a href="io_ioNashorn.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="exit"><span class="type-signature"></span>exit<span class="signature">(exitCode<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Attempts to exit the entire process with the provided exit code if the
platform supports doing so. Callers should also ensure that all functions
exit appropriately if the platform does not support this feature.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>exitCode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The exit code to use.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="jscc.io.html#exit">jscc.io#exit</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="io_io.js.html">io/io.js</a>, <a href="io_io.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
<h4 class="name" id="read_all_input"><span class="type-signature"></span>read_all_input<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string|void}</span></h4>
<div class="description">
Reads input from the specified file or from standard input.
If chunkCallback and/or endCallback are specified, the operation
is asynchronous, and the function returns nothing. Otherwise,
the operation is synchronous, and the function returns a string
with the contents read from the file or from standard input.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">function</span>
|
<span class="param-type"><a href="global.html#ioOptions">ioOptions</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If a string, the filename to read. If an object, has optional filename, chunkCallback, and endCallback
properties. If a function, the callback function to execute for each chunk read from standard input.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="jscc.io.html#read_all_input">jscc.io#read_all_input</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="io_io.js.html">io/io.js</a>, <a href="io_io.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
When running synchronously, the text read from
the file or standard input. When running asynchronously, returns nothing.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
|
<span class="param-type">void</span>
</dd>
</dl>
<h4 class="name" id="read_template"><span class="type-signature"></span>read_template<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {string|void}</span></h4>
<div class="description">
Reads the template file into which the parser code is inserted.
If not specified, uses the default driver specified in
jscc.global.DEFAULT_DRIVER.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">function</span>
|
<span class="param-type"><a href="global.html#ioOptions">ioOptions</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If a string, specifies the template filename. If a function, specifies the callback function to be used
when reading a file chunk has completed. If an object, specifies either or both. If omitted, causes the
function to read
jscc.global.DEFAULT_DRIVER synchronously.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="jscc.io.html#read_template">jscc.io#read_template</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="io_io.js.html">io/io.js</a>, <a href="io_io.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
When running synchronously, returns the contents of
the template file as a string. When running asynchronously, returns
nothing.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
|
<span class="param-type">void</span>
</dd>
</dl>
<h4 class="name" id="write_debug"><span class="type-signature"></span>write_debug<span class="signature">(text)</span><span class="type-signature"></span></h4>
<div class="description">
Writes the provided text to a debugging output, provided that such an output
exists in the implementation of this interface.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The text to write to the debugging output.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="jscc.io.html#write_debug">jscc.io#write_debug</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="io_io.js.html">io/io.js</a>, <a href="io_io.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="write_output"><span class="type-signature"></span>write_output<span class="signature">(options)</span><span class="type-signature"></span></h4>
<div class="description">
Writes the provided text to the specified file or to standard output.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type"><a href="global.html#ioWriteOutputOptions">ioWriteOutputOptions</a></span>
</td>
<td class="description last">When a string, the text
to be written to standard output. When an object, contains text, destination, and callback properties.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="implements">Implements:</dt>
<dd class="implements"><ul>
<li><a href="jscc.io.html#write_output">jscc.io#write_output</a></li>
</ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="io_io.js.html">io/io.js</a>, <a href="io_io.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-jscc.html">jscc</a></li><li><a href="module-jscc_bitset_BitSet32.html">jscc/bitset/BitSet32</a></li><li><a href="module-jscc_bitset_BitSetBool.html">jscc/bitset/BitSetBool</a></li><li><a href="module-jscc_bitset_BitSetJava.html">jscc/bitset/BitSetJava</a></li><li><a href="module-jscc_classes_Dfa.html">jscc/classes/Dfa</a></li><li><a href="module-jscc_classes_Item.html">jscc/classes/Item</a></li><li><a href="module-jscc_classes_Nfa.html">jscc/classes/Nfa</a></li><li><a href="module-jscc_classes_Param.html">jscc/classes/Param</a></li><li><a href="module-jscc_classes_Production.html">jscc/classes/Production</a></li><li><a href="module-jscc_classes_State.html">jscc/classes/State</a></li><li><a href="module-jscc_classes_Symbol.html">jscc/classes/Symbol</a></li><li><a href="module-jscc_classes_TableEntry.html">jscc/classes/TableEntry</a></li><li><a href="module-jscc_enums_ASSOC.html">jscc/enums/ASSOC</a></li><li><a href="module-jscc_enums_EDGE.html">jscc/enums/EDGE</a></li><li><a href="module-jscc_enums_EXEC.html">jscc/enums/EXEC</a></li><li><a href="module-jscc_enums_LOG_LEVEL.html">jscc/enums/LOG_LEVEL</a></li><li><a href="module-jscc_enums_MODE_GEN.html">jscc/enums/MODE_GEN</a></li><li><a href="module-jscc_enums_SPECIAL.html">jscc/enums/SPECIAL</a></li><li><a href="module-jscc_enums_SYM.html">jscc/enums/SYM</a></li><li><a href="module-jscc_first.html">jscc/first</a></li><li><a href="module-jscc_global.html">jscc/global</a></li><li><a href="module-jscc_integrity.html">jscc/integrity</a></li><li><a href="module-jscc_io_io.html">jscc/io/io</a></li><li><a href="module-jscc_lexdbg.html">jscc/lexdbg</a></li><li><a href="module-jscc_lexdfa.html">jscc/lexdfa</a></li><li><a href="module-jscc_log_log.html">jscc/log/log</a></li><li><a href="module-jscc_parse.html">jscc/parse</a></li><li><a href="module-jscc_printtab.html">jscc/printtab</a></li><li><a href="module-jscc_regex.html">jscc/regex</a></li><li><a href="module-jscc_util.html">jscc/util</a></li></ul><h3>Classes</h3><ul><li><a href="-_anonymous_-jscc.BitSet32.html">BitSet32</a></li><li><a href="-_anonymous_-jscc.BitSetBool.html">BitSetBool</a></li><li><a href="-_anonymous_-jscc.BitSetJava.html">BitSetJava</a></li><li><a href="-_anonymous_-jscc.classes.Dfa.html">classes.Dfa</a></li><li><a href="-_anonymous_-jscc.first.html">first</a></li><li><a href="-_anonymous_-jscc.global.html">global</a></li><li><a href="-_anonymous_-jscc.integrity.html">integrity</a></li><li><a href="-_anonymous_-jscc.ioBrowser.html">ioBrowser</a></li><li><a href="-_anonymous_-jscc.ioNashorn.html">ioNashorn</a></li><li><a href="-_anonymous_-jscc.ioNode.html">ioNode</a></li><li><a href="-_anonymous_-jscc.ioRhino.html">ioRhino</a></li><li><a href="-_anonymous_-jscc.lexdbg.html">lexdbg</a></li><li><a href="-_anonymous_-jscc.lexdfa.html">lexdfa</a></li><li><a href="-_anonymous_-jscc.logBrowser.html">logBrowser</a></li><li><a href="-_anonymous_-jscc.logJava.html">logJava</a></li><li><a href="-_anonymous_-jscc.logNode.html">logNode</a></li><li><a href="-_anonymous_-jscc.printtab.html">printtab</a></li><li><a href="-_anonymous_-jscc.util.html">util</a></li><li><a href="jscc_debug.html">jscc/debug</a></li><li><a href="jscc_nfaStates.html">jscc/nfaStates</a></li><li><a href="jscc_tabgen.html">jscc/tabgen</a></li><li><a href="%257Bjscc.classes%257D.jscc.classes.State.html">jscc.classes.State</a></li></ul><h3>Namespaces</h3><ul><li><a href="jscc.debug.html">debug</a></li></ul><h3>Interfaces</h3><ul><li><a href="jscc.bitset.html">bitset</a></li><li><a href="jscc.io.html">io</a></li><li><a href="jscc.log.html">log</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Aug 01 2016 13:35:56 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>