forked from kach/nearley
-
Notifications
You must be signed in to change notification settings - Fork 0
/
using-in-frontend.html
364 lines (308 loc) · 10.6 KB
/
using-in-frontend.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
<!DOCTYPE html>
<title>Compiling in browsers - nearley.js - JS Parsing Toolkit</title>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="nearley.js is a simple, fast, and powerful parser toolkit for JavaScript." />
<style>
body {
font-family: BlinkMacSystemFont, -apple-system, Helvetica Neue, Open Sans, Ubuntu, Arial, Helvetica, sans-serif;
font-weight: 300;
font-size: 15pt;
margin: 0px;
padding: 0px;
}
#main a {
color: #55a;
}
#main a:visited {
color: #55a;
}
#main a:hover {
color: #259;
}
h1 {
font-size: 1.2em;
font-weight: normal;
letter-spacing: 0.2em;
text-align: center;
margin: 0em;
padding: 1em;
}
h1 a {
color: #559;
text-decoration: none;
}
h1 a:hover {
color: orange;
cursor: pointer;
}
#version {
background: orange;
border-radius: 50%;
font-weight: bold;
color: white;
width: 3em;
height: 3em;
display: inline-block;
text-align: center;
line-height: 3em;
letter-spacing: 0em;
}
h2 {
font-size: 1.5em;
margin-top: 2em;
}
h3 {
margin-top: 3em;
}
h4 {
margin-top: 3em;
}
.center {
padding-left: 2em;
padding-right: 2em;
margin-left: auto;
margin-right: auto;
}
#main {
max-width: 35em;
}
#main p, ul, ol {
line-height: 1.5em;
margin-bottom: 1em;
}
#main li {
margin-top: 1em;
margin-bottom: 1em;
}
#main ul li {
list-style: none;
min-width: 10em;
}
#main ul li:before {
display: inline-block;
content: "\2014";
margin-left: -1.5em;
width: 1.5em;
position: absolute;
}
#main textarea {
width: 100%;
height: 20em;
resize: none;
margin-top: 5px;
margin-bottom: 5px;
font-family: menlo, monaco, monospace;
font-size: 10pt;
padding: 5px;
border: none;
border-left: solid 1px #aaa;
}
#main textarea:focus {
outline: none;
}
#main img {
display: block;
margin-left: auto;
margin-right: auto;
max-width: 100%;
}
img + .caption {
text-align: center;
font-size: 0.7em;
color: #aaa;
}
#footer {
margin-top: 10em;
color: #aaa;
font-size: 0.7em;
padding: 5em;
}
code {
margin-left: 0.2em;
margin-right: 0.2em;
padding: 0.2em;
border-radius: 0.2em;
background-color: #eee;
}
pre code {
border-radius: 0.5em;
padding: 0.5em;
display: block;
overflow: auto;
}
ol {
counter-reset: tutorial-counter;
position: relative;
}
ol li {
list-style: none;
}
ol li:before {
content: counter(tutorial-counter);
counter-increment: tutorial-counter;
font-weight: bold;
border-radius: 50%;
background-color: #559;
width: 2em;
height: 2em;
display: inline-block;
text-align: center;
line-height: 2em;
color: white;
margin-left: -2em;
position: absolute;
left: 1em;
}
input[type="text"] {
border: none;
font-family: monospace;
font-size: 1em;
color: #559;
}
input[type="text"]:focus {
outline: none;
}
nav {
border-bottom: 2px solid #559;
background: #fafafa;
}
nav ul {
padding: 0;
margin: 0;
}
nav ul a {
text-decoration: none;
color: #334;
display: block;
overflow: hidden;
text-overflow: ellipsis;
padding: 0.25em 0.5em; */
}
.page {
display: block;
}
.page-title-active,
.page-heading-active a {
color: #66f;
}
.page-heading {
display: block;
padding-left: 1.5em;
}
@media screen and (min-width: 36rem) {
nav {
position: fixed;
width: 16rem;
left: 0;
top: 0;
bottom: 0;
white-space: nowrap;
overflow-y: auto;
font-size: 1rem;
border-bottom: none;
border-right: 2px solid #559;
}
body.docs-page {
margin-left: 16rem;
}
}
/* highlight.js */
.hljs{display:block;overflow-x:auto;padding:0.5em;background:#F0F0F0}.hljs,.hljs-subst{color:#444}.hljs-comment{color:#888888}.hljs-keyword,.hljs-attribute,.hljs-selector-tag,.hljs-meta-keyword,.hljs-doctag,.hljs-name{font-weight:bold}.hljs-type,.hljs-string,.hljs-number,.hljs-selector-id,.hljs-selector-class,.hljs-quote,.hljs-template-tag,.hljs-deletion{color:#880000}.hljs-title,.hljs-section{color:#880000;font-weight:bold}.hljs-regexp,.hljs-symbol,.hljs-variable,.hljs-template-variable,.hljs-link,.hljs-selector-attr,.hljs-selector-pseudo{color:#BC6060}.hljs-literal{color:#78A960}.hljs-built_in,.hljs-bullet,.hljs-code,.hljs-addition{color:#397300}.hljs-meta{color:#1f7199}.hljs-meta-string{color:#4d99bf}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:bold}
</style>
<body class="docs-page">
<a href="https://github.com/kach/nearley" class="github-corner"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
<nav id="nav">
<h1><a href="/">nearley<span style="color: #559;">.js</span><span id="version">2.20.0</span></a></h1>
<ul>
<li class="page"><a href="/docs/index">Home</a>
<li class="page"><a href="/docs/getting-started">Getting started</a>
<li class="page"><a href="/docs/grammar">Writing a parser</a>
<li class="page"><a href="/docs/parser">Using a parser</a>
<li class="page"><a href="/docs/tokenizers">Tokenizers</a>
<li class="page"><a href="/docs/tooling">Tooling</a>
<li class="page"><a href="/docs/how-to-grammar-good">How to grammar good</a>
<li class="page">
<a href="#" class="page-title-active">Compiling in browsers</a>
</li>
<li class="page"><a href="/docs/glossary">Glossary</a>
</ul>
</nav>
<div id="main" class="center">
<h2>Compiling in browsers</h2>
<p>Both the nearley parser and compiled grammars work in browsers; simply include
<code>nearley.js</code> and your compiled <code>grammar.js</code> file in <code><script></code> tags and use
nearley as usual. However, the nearley <em>compiler</em> is not designed for the
browser – you should precompile your grammars and only serve the generated JS
files to browsers.</p>
<p>If you absolutely have to compile a grammar in a browser (for example, to
implement a nearley IDE) then you can use a tool like
<a href="https://webpack.js.org/">Webpack</a> or <a href="https://rollupjs.org/">Rollup</a> to
include the <code>nearley</code> NPM package in your browser code. Then, you can utilize
the <code>nearleyc</code> internals to compile grammars dynamically.</p>
<pre><code class="language-js">const nearley = require("nearley");
const compile = require("nearley/lib/compile");
const generate = require("nearley/lib/generate");
const nearleyGrammar = require("nearley/lib/nearley-language-bootstrapped");
function compileGrammar(sourceCode) {
// Parse the grammar source into an AST
const grammarParser = new nearley.Parser(nearleyGrammar);
grammarParser.feed(sourceCode);
const grammarAst = grammarParser.results[0]; // TODO check for errors
// Compile the AST into a set of rules
const grammarInfoObject = compile(grammarAst, {});
// Generate JavaScript code from the rules
const grammarJs = generate(grammarInfoObject, "grammar");
// Pretend this is a CommonJS environment to catch exports from the grammar.
const module = { exports: {} };
eval(grammarJs);
return module.exports;
}
const grammar = compileGrammar("main -> foo | bar");
const parser = new nearley.Parser(nearley.Grammar.fromCompiled(grammar));</code></pre>
<div id="footer"><p>nearley is MIT-licensed. It's maintained by <a
href="http://hardmath123.github.io">Hardmath123</a> (<a
href="http://github.com/Hardmath123">Github</a>). You're welcome to
leave questions, comments, advice, or ideas as Github issues. And
feel free to fork nearley with your own experiments!<br/>
<a href="https://js.org" target="_blank" title="JS.ORG | JavaScript Community">
<img src="https://logo.js.org/dark_horz.png" width="102" alt="JS.ORG Logo"/></a>
</div>
<script id="highlight-js" async src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>
document.querySelector('#highlight-js').addEventListener('load', function() {
[].slice.apply(document.querySelectorAll('pre code')).forEach(function(b) {
hljs.highlightBlock(b)
})
})
</script>
<script>
window.addEventListener('scroll', onScroll)
window.addEventListener('resize', onScroll)
var timeout
function onScroll(e) {
if (timeout) clearTimeout(timeout)
timeout = setTimeout(scrollEnd, 50)
}
function scrollEnd() {
var headings = document.querySelectorAll('h3')
var offset = 60
for (var i=headings.length; i--; ) {
var h3 = headings[i]
if (h3.offsetTop < window.scrollY + offset) {
var cur = document.querySelector('.page-heading-active')
if (cur) cur.className = 'page-heading'
document.querySelector('a[href="#' + h3.id + '"]').parentNode.className = 'page-heading page-heading-active'
return
}
}
}
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-46120535-5', 'auto');
ga('send', 'pageview');
</script>