pegjs-util

pegjs-util

Utility class for the PEG.js parser generator.

About

This is a small utility class for the excellent PEG.js parser generator. It wraps around PEG.js's central parse function and provides three distinct convenience features:

Parser Tree Token Unrolling

...

Abstract Syntax Tree Node Generation

...

Cooked Error Reporting

...

Installation

Node/NPM environments:

npm install pegjs --save-dev
npm install pegjs-util --save-dev

Browser/Bower environments:

bower install pegjs
bower install pegjs-util

Usage

{
    /*  import PEGUtil methods into parser scope  */
    var unroll = options.util.makeUnroll(line, column, offset, SyntaxError);
    var ast    = options.util.makeAST(line, column, offset);
}

start
    = ...

var result = PEGUtil.parse(parser, source, "start");
if (result.error !== null) {
    ...
}
else {
    ...
}

License

Copyright (c) 2014 Ralf S. Engelschall (http://engelschall.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.