Tree @debian/0.10.0-3 (Download .tar.gz)
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 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 | [![Build status](https://img.shields.io/travis/pegjs/pegjs.svg)](https://travis-ci.org/pegjs/pegjs) [![npm version](https://img.shields.io/npm/v/pegjs.svg)](https://www.npmjs.com/package/pegjs) [![Bower version](https://img.shields.io/bower/v/pegjs.svg)](https://github.com/pegjs/bower) [![License](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT) PEG.js ====== PEG.js is a simple parser generator for JavaScript that produces fast parsers with excellent error reporting. You can use it to process complex data or computer languages and build transformers, interpreters, compilers and other tools easily. Features -------- * Simple and expressive grammar syntax * Integrates both lexical and syntactical analysis * Parsers have excellent error reporting out of the box * Based on [parsing expression grammar](http://en.wikipedia.org/wiki/Parsing_expression_grammar) formalism — more powerful than traditional LL(*k*) and LR(*k*) parsers * Usable [from your browser](http://pegjs.org/online), from the command line, or via JavaScript API Getting Started --------------- [Online version](http://pegjs.org/online) is the easiest way to generate a parser. Just enter your grammar, try parsing few inputs, and download generated parser code. Installation ------------ ### Node.js To use the `pegjs` command, install PEG.js globally: ```console $ npm install -g pegjs ``` To use the JavaScript API, install PEG.js locally: ```console $ npm install pegjs ``` If you need both the `pegjs` command and the JavaScript API, install PEG.js both ways. ### Browser [Download](http://pegjs.org/#download) the PEG.js library (regular or minified version) or install it using Bower: ```console $ bower install pegjs ``` Generating a Parser ------------------- PEG.js generates parser from a grammar that describes expected input and can specify what the parser returns (using semantic actions on matched parts of the input). Generated parser itself is a JavaScript object with a simple API. ### Command Line To generate a parser from your grammar, use the `pegjs` command: ```console $ pegjs arithmetics.pegjs ``` This writes parser source code into a file with the same name as the grammar file but with “.js” extension. You can also specify the output file explicitly: ```console $ pegjs -o arithmetics-parser.js arithmetics.pegjs ``` If you omit both input and output file, standard input and output are used. By default, the generated parser is in the Node.js module format. You can override this using the `--format` option. You can tweak the generated parser with several options: * `--allowed-start-rules` — comma-separated list of rules the parser will be allowed to start parsing from (default: the first rule in the grammar) * `--cache` — makes the parser cache results, avoiding exponential parsing time in pathological cases but making the parser slower * `--dependency` — makes the parser require a specified dependency (can be specified multiple times) * `--export-var` — name of a global variable into which the parser object is assigned to when no module loader is detected * `--extra-options` — additional options (in JSON format) to pass to `peg.generate` * `--extra-options-file` — file with additional options (in JSON format) to pass to `peg.generate` * `--format` — format of the generated parser: `amd`, `commonjs`, `globals`, `umd` (default: `commonjs`) * `--optimize` — selects between optimizing the generated parser for parsing speed (`speed`) or code size (`size`) (default: `speed`) * `--plugin` — makes PEG.js use a specified plugin (can be specified multiple times) * `--trace` — makes the parser trace its progress ### JavaScript API In Node.js, require the PEG.js parser generator module: ```javascript var peg = require("pegjs"); ``` In browser, include the PEG.js library in your web page or application using the `<script>` tag. If PEG.js detects an AMD loader, it will define itself as a module, otherwise the API will be available in the `peg` global object. To generate a parser, call the `peg.generate` method and pass your grammar as a parameter: ```javascript var parser = peg.generate("start = ('a' / 'b')+"); ``` The method will return generated parser object or its source code as a string (depending on the value of the `output` option — see below). It will throw an exception if the grammar is invalid. The exception will contain `message` property with more details about the error. You can tweak the generated parser by passing a second parameter with an options object to `peg.generate`. The following options are supported: * `allowedStartRules` — rules the parser will be allowed to start parsing from (default: the first rule in the grammar) * `cache` — if `true`, makes the parser cache results, avoiding exponential parsing time in pathological cases but making the parser slower (default: `false`) * `dependencies` — parser dependencies, the value is an object which maps variables used to access the dependencies in the parser to module IDs used to load them; valid only when `format` is set to `"amd"`, `"commonjs"`, or `"umd"` (default: `{}`) * `exportVar` — name of a global variable into which the parser object is assigned to when no module loader is detected; valid only when `format` is set to `"globals"` or `"umd"` (default: `null`) * `format` — format of the genreated parser (`"amd"`, `"bare"`, `"commonjs"`, `"globals"`, or `"umd"`); valid only when `output` is set to `"source"` (default: `"bare"`) * `optimize`— selects between optimizing the generated parser for parsing speed (`"speed"`) or code size (`"size"`) (default: `"speed"`) * `output` — if set to `"parser"`, the method will return generated parser object; if set to `"source"`, it will return parser source code as a string (default: `"parser"`) * `plugins` — plugins to use * `trace` — makes the parser trace its progress (default: `false`) Using the Parser ---------------- Using the generated parser is simple — just call its `parse` method and pass an input string as a parameter. The method will return a parse result (the exact value depends on the grammar used to generate the parser) or throw an exception if the input is invalid. The exception will contain `location`, `expected`, `found`, and `message` properties with more details about the error. ```javascript parser.parse("abba"); // returns ["a", "b", "b", "a"] parser.parse("abcd"); // throws an exception ``` You can tweak parser behavior by passing a second parameter with an options object to the `parse` method. The following options are supported: * `startRule` — name of the rule to start parsing from * `tracer` — tracer to use Parsers can also support their own custom options. Grammar Syntax and Semantics ---------------------------- The grammar syntax is similar to JavaScript in that it is not line-oriented and ignores whitespace between tokens. You can also use JavaScript-style comments (`// ...` and `/* ... */`). Let's look at example grammar that recognizes simple arithmetic expressions like `2*(3+4)`. A parser generated from this grammar computes their values. ```pegjs start = additive additive = left:multiplicative "+" right:additive { return left + right; } / multiplicative multiplicative = left:primary "*" right:multiplicative { return left * right; } / primary primary = integer / "(" additive:additive ")" { return additive; } integer "integer" = digits:[0-9]+ { return parseInt(digits.join(""), 10); } ``` On the top level, the grammar consists of *rules* (in our example, there are five of them). Each rule has a *name* (e.g. `integer`) that identifies the rule, and a *parsing expression* (e.g. `digits:[0-9]+ { return parseInt(digits.join(""), 10); }`) that defines a pattern to match against the input text and possibly contains some JavaScript code that determines what happens when the pattern matches successfully. A rule can also contain *human-readable name* that is used in error messages (in our example, only the `integer` rule has a human-readable name). The parsing starts at the first rule, which is also called the *start rule*. A rule name must be a JavaScript identifier. It is followed by an equality sign (“=”) and a parsing expression. If the rule has a human-readable name, it is written as a JavaScript string between the name and separating equality sign. Rules need to be separated only by whitespace (their beginning is easily recognizable), but a semicolon (“;”) after the parsing expression is allowed. The first rule can be preceded by an *initializer* — a piece of JavaScript code in curly braces (“{” and “}”). This code is executed before the generated parser starts parsing. All variables and functions defined in the initializer are accessible in rule actions and semantic predicates. The code inside the initializer can access options passed to the parser using the `options` variable. Curly braces in the initializer code must be balanced. Let's look at the example grammar from above using a simple initializer. ```pegjs { function makeInteger(o) { return parseInt(o.join(""), 10); } } start = additive additive = left:multiplicative "+" right:additive { return left + right; } / multiplicative multiplicative = left:primary "*" right:multiplicative { return left * right; } / primary primary = integer / "(" additive:additive ")" { return additive; } integer "integer" = digits:[0-9]+ { return makeInteger(digits); } ``` The parsing expressions of the rules are used to match the input text to the grammar. There are various types of expressions — matching characters or character classes, indicating optional parts and repetition, etc. Expressions can also contain references to other rules. See detailed description below. If an expression successfully matches a part of the text when running the generated parser, it produces a *match result*, which is a JavaScript value. For example: * An expression matching a literal string produces a JavaScript string containing matched text. * An expression matching repeated occurrence of some subexpression produces a JavaScript array with all the matches. The match results propagate through the rules when the rule names are used in expressions, up to the start rule. The generated parser returns start rule's match result when parsing is successful. One special case of parser expression is a *parser action* — a piece of JavaScript code inside curly braces (“{” and “}”) that takes match results of some of the the preceding expressions and returns a JavaScript value. This value is considered match result of the preceding expression (in other words, the parser action is a match result transformer). In our arithmetics example, there are many parser actions. Consider the action in expression `digits:[0-9]+ { return parseInt(digits.join(""), 10); }`. It takes the match result of the expression [0-9]+, which is an array of strings containing digits, as its parameter. It joins the digits together to form a number and converts it to a JavaScript `number` object. ### Parsing Expression Types There are several types of parsing expressions, some of them containing subexpressions and thus forming a recursive structure: #### "*literal*"<br>'*literal*' Match exact literal string and return it. The string syntax is the same as in JavaScript. Appending `i` right after the literal makes the match case-insensitive. #### . Match exactly one character and return it as a string. #### [*characters*] Match one character from a set and return it as a string. The characters in the list can be escaped in exactly the same way as in JavaScript string. The list of characters can also contain ranges (e.g. `[a-z]` means “all lowercase letters”). Preceding the characters with `^` inverts the matched set (e.g. `[^a-z]` means “all character but lowercase letters”). Appending `i` right after the right bracket makes the match case-insensitive. #### *rule* Match a parsing expression of a rule recursively and return its match result. #### ( *expression* ) Match a subexpression and return its match result. #### *expression* \* Match zero or more repetitions of the expression and return their match results in an array. The matching is greedy, i.e. the parser tries to match the expression as many times as possible. Unlike in regular expressions, there is no backtracking. #### *expression* + Match one or more repetitions of the expression and return their match results in an array. The matching is greedy, i.e. the parser tries to match the expression as many times as possible. Unlike in regular expressions, there is no backtracking. #### *expression* ? Try to match the expression. If the match succeeds, return its match result, otherwise return `null`. Unlike in regular expressions, there is no backtracking. #### & *expression* Try to match the expression. If the match succeeds, just return `undefined` and do not consume any input, otherwise consider the match failed. #### ! *expression* Try to match the expression. If the match does not succeed, just return `undefined` and do not consume any input, otherwise consider the match failed. #### & { *predicate* } The predicate is a piece of JavaScript code that is executed as if it was inside a function. It gets the match results of labeled expressions in preceding expression as its arguments. It should return some JavaScript value using the `return` statement. If the returned value evaluates to `true` in boolean context, just return `undefined` and do not consume any input; otherwise consider the match failed. The code inside the predicate can access all variables and functions defined in the initializer at the beginning of the grammar. The code inside the predicate can also access location information using the `location` function. It returns an object like this: ```javascript { start: { offset: 23, line: 5, column: 6 }, end: { offset: 23, line: 5, column: 6 } } ``` The `start` and `end` properties both refer to the current parse position. The `offset` property contains an offset as a zero-based index and `line` and `column` properties contain a line and a column as one-based indices. The code inside the predicate can also access options passed to the parser using the `options` variable. Note that curly braces in the predicate code must be balanced. #### ! { *predicate* } The predicate is a piece of JavaScript code that is executed as if it was inside a function. It gets the match results of labeled expressions in preceding expression as its arguments. It should return some JavaScript value using the `return` statement. If the returned value evaluates to `false` in boolean context, just return `undefined` and do not consume any input; otherwise consider the match failed. The code inside the predicate can access all variables and functions defined in the initializer at the beginning of the grammar. The code inside the predicate can also access location information using the `location` function. It returns an object like this: ```javascript { start: { offset: 23, line: 5, column: 6 }, end: { offset: 23, line: 5, column: 6 } } ``` The `start` and `end` properties both refer to the current parse position. The `offset` property contains an offset as a zero-based index and `line` and `column` properties contain a line and a column as one-based indices. The code inside the predicate can also access options passed to the parser using the `options` variable. Note that curly braces in the predicate code must be balanced. #### $ *expression* Try to match the expression. If the match succeeds, return the matched text instead of the match result. #### *label* : *expression* Match the expression and remember its match result under given label. The label must be a JavaScript identifier. Labeled expressions are useful together with actions, where saved match results can be accessed by action's JavaScript code. #### *expression<sub>1</sub>* *expression<sub>2</sub>* ... *expression<sub>n</sub>* Match a sequence of expressions and return their match results in an array. #### *expression* { *action* } Match the expression. If the match is successful, run the action, otherwise consider the match failed. The action is a piece of JavaScript code that is executed as if it was inside a function. It gets the match results of labeled expressions in preceding expression as its arguments. The action should return some JavaScript value using the `return` statement. This value is considered match result of the preceding expression. To indicate an error, the code inside the action can invoke the `expected` function, which makes the parser throw an exception. The function takes two parameters — a description of what was expected at the current position and optional location information (the default is what `location` would return — see below). The description will be used as part of a message of the thrown exception. The code inside an action can also invoke the `error` function, which also makes the parser throw an exception. The function takes two parameters — an error message and optional location information (the default is what `location` would return — see below). The message will be used by the thrown exception. The code inside the action can access all variables and functions defined in the initializer at the beginning of the grammar. Curly braces in the action code must be balanced. The code inside the action can also access the text matched by the expression using the `text` function. The code inside the action can also access location information using the `location` function. It returns an object like this: ```javascript { start: { offset: 23, line: 5, column: 6 }, end: { offset: 25, line: 5, column: 8 } } ``` The `start` property refers to the position at the beginning of the expression, the `end` property refers to position after the end of the expression. The `offset` property contains an offset as a zero-based index and `line` and `column` properties contain a line and a column as one-based indices. The code inside the action can also access options passed to the parser using the `options` variable. Note that curly braces in the action code must be balanced. #### *expression<sub>1</sub>* / *expression<sub>2</sub>* / ... / *expression<sub>n</sub>* Try to match the first expression, if it does not succeed, try the second one, etc. Return the match result of the first successfully matched expression. If no expression matches, consider the match failed. Compatibility ------------- Both the parser generator and generated parsers should run well in the following environments: * Node.js 0.10.0+ * Internet Explorer 8+ * Edge * Firefox * Chrome * Safari * Opera Development ----------- * [Project website](http://pegjs.org/) * [Wiki](https://github.com/pegjs/pegjs/wiki) * [Source code](https://github.com/pegjs/pegjs) * [Issue tracker](https://github.com/pegjs/pegjs/issues) * [Google Group](http://groups.google.com/group/pegjs) * [Twitter](http://twitter.com/peg_js) PEG.js is developed by [David Majda](http://majda.cz/) ([@dmajda](http://twitter.com/dmajda)). The [Bower package](https://github.com/pegjs/bower) is maintained by [Michel Krämer](http://www.michel-kraemer.com/) ([@michelkraemer](https://twitter.com/michelkraemer)). You are welcome to contribute code. Unless your contribution is really trivial you should get in touch with me first — this can prevent wasted effort on both sides. You can send code both as a patch or a GitHub pull request. Note that PEG.js is still very much work in progress. There are no compatibility guarantees until version 1.0. |
Commit History @debian/0.10.0-3
0
»»
- Use pkg-js-tools auto install Xavier Guimard 4 years ago
- refresh patches Xavier Guimard 4 years ago
- Set myself as uploader Xavier Guimard 4 years ago
- Update upstream source from tag 'upstream/0.10.0' Xavier Guimard 4 years ago
- New upstream version 0.10.0 Xavier Guimard 4 years ago
- Fix copyright Xavier Guimard 4 years ago
- Update VCS fields to salsa Xavier Guimard 4 years ago
- Add upstream/metadata Xavier Guimard 4 years ago
- Add debian/gbp.conf Xavier Guimard 4 years ago
- Change section to javascript Xavier Guimard 4 years ago
- Add "Rules-Requires-Root: no" Xavier Guimard 4 years ago
- Declare compliance with policy 4.5.0 Xavier Guimard 4 years ago
- Bump debhelper compatibility level to 12 Xavier Guimard 4 years ago
- Continue to provide node-peg Daniel Pocock 9 years ago
- Add README.source Daniel Pocock 9 years ago
- Update for v0.7.0-2 Daniel Pocock 9 years ago
- Change binary package name to node-pegjs Daniel Pocock 9 years ago
- Update standards-version to 3.9.5 Daniel Pocock 9 years ago
- Update VCS URLs Daniel Pocock 9 years ago
- Uploaders: update my email ID Daniel Pocock 10 years ago
- Initial Debian artifacts Daniel Pocock 10 years ago
- Imported Upstream version 0.7.0 Daniel Pocock 10 years ago
0
»»