esther-medina-quintero-parser-nearley
Version:
1,044 lines (314 loc) • 13.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global | Global</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/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
</head>
<body>
<nav class="lnb" id="lnb">
<div class="logo" style="">
<img src="img/toast-ui.png" width="100%" height="100%">
</div>
<div class="title">
<h1><a href="index.html" class="link">Global</a></h1>
<h2><a href="./coverage/lcov-report/index.html" class="link">Coverage</a></h2>
<h3><a href="https://www.npmjs.com/package/esther-medina-quintero-parser-nearley" class="link">Package</a></h3>
</div>
<div class="search-container" id="search-container">
<input type="text" placeholder="Search">
<ul></ul>
</div>
<div class="lnb-api hidden"><h3>Externals</h3><ul><li><a href="external-Grammar.html">Grammar</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="external:Grammar_sub"></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#buildNestedApplies">buildNestedApplies</a></li><li><a href="global.html#buildNumberValue">buildNumberValue</a></li><li><a href="global.html#buildStringValue">buildStringValue</a></li><li><a href="global.html#buildWordApplies">buildWordApplies</a></li><li><a href="global.html#compile">compile</a></li><li><a href="global.html#Tokens">Tokens</a></li></ul></div>
</nav>
<div id="resizer"></div>
<div class="main" id="main">
<section>
<header>
<h2>Global</h2>
</header>
<article>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="Tokens">
<span class="type-signature"><span class="icon green">constant</span> </span>Tokens<span class="type-signature"></span>
<div class="container-source members">
<code><a href="src_lex.js.html">src/lex.js</a></code>,
<code><a href="src_lex.js.html#line3">line 3</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
Tokens object: definitions
</div>
<!--
-->
<dl class="details">
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="buildNestedApplies">
<span class="type-signature"></span>buildNestedApplies<span class="signature">(parentExp, applies)</span><span class="type-signature"> → {Array}</span>
<div class="container-source members">
<code><a href="src_build-ast.js.html">src/build-ast.js</a></code>,
<code><a href="src_build-ast.js.html#line77">line 77</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
A function that builds nested applies
</div>
<div class="container-params">
<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>parentExp</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">The parent expression to be built</td>
</tr>
<tr>
<td class="name"><code>applies</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">The applies to be built</td>
</tr>
</tbody>
</table>
</div>
<div class="container-returns">
<h5>Returns:</h5>
<span class="param-type">Array</span>
- The nested applies
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="buildNumberValue">
<span class="type-signature"></span>buildNumberValue<span class="signature">(token)</span><span class="type-signature"> → {Object}</span>
<div class="container-source members">
<code><a href="src_build-ast.js.html">src/build-ast.js</a></code>,
<code><a href="src_build-ast.js.html#line12">line 12</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
A function that builds a number value
</div>
<div class="container-params">
<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>token</code></td>
<td class="type">
<span class="param-type">Token</span>
</td>
<td class="description last">The token to be built</td>
</tr>
</tbody>
</table>
</div>
<div class="container-returns">
<h5>Returns:</h5>
<span class="param-type">Object</span>
- The number value
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="buildStringValue">
<span class="type-signature"></span>buildStringValue<span class="signature">(token)</span><span class="type-signature"> → {Object}</span>
<div class="container-source members">
<code><a href="src_build-ast.js.html">src/build-ast.js</a></code>,
<code><a href="src_build-ast.js.html#line26">line 26</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
A function that builds a string value
</div>
<div class="container-params">
<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>token</code></td>
<td class="type">
<span class="param-type">Token</span>
</td>
<td class="description last">The token to be built</td>
</tr>
</tbody>
</table>
</div>
<div class="container-returns">
<h5>Returns:</h5>
<span class="param-type">Object</span>
- The string value
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="buildWordApplies">
<span class="type-signature"></span>buildWordApplies<span class="signature">(word, applies)</span><span class="type-signature"> → {Object}</span>
<div class="container-source members">
<code><a href="src_build-ast.js.html">src/build-ast.js</a></code>,
<code><a href="src_build-ast.js.html#line40">line 40</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
A function that builds a word applies
</div>
<div class="container-params">
<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>word</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">The word to be built</td>
</tr>
<tr>
<td class="name"><code>applies</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">The applies to be built</td>
</tr>
</tbody>
</table>
</div>
<div class="container-returns">
<h5>Returns:</h5>
<span class="param-type">Object</span>
- The word applies
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="compile">
<span class="type-signature"></span>compile<span class="signature">(origin, destination)</span><span class="type-signature"></span>
<div class="container-source members">
<code><a href="bin_eggc.js.html">bin/eggc.js</a></code>,
<code><a href="bin_eggc.js.html#line23">line 23</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
A function that compiles a eggc file
</div>
<div class="container-params">
<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>origin</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The name of the origin file</td>
</tr>
<tr>
<td class="name"><code>destination</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The name of the destination file</td>
</tr>
</tbody>
</table>
</div>
<h5>Throws:</h5>
<div class="param-desc">
Will throw if there are errors in the program or if the files
can't be opened
</div>
<dl class="details">
</dl>
</dd>
</dl>
</article>
</section>
</div>
<footer>
<img class="logo" src="img/toast-ui.png" style="">
<div class="footer-text">NHN Entertainment. Frontend Development Lab</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>
<script>
var id = '_sub'.replace(/"/g, '_');
var selectedApi = document.getElementById(id); // do not use jquery selector
var $selectedApi = $(selectedApi);
$selectedApi.removeClass('hidden');
$selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
showLnbApi();
</script>
</body>
</html>