Parsle NPM | npm.io

parsle

A parser toolkit for JavaScript based off of RegExps

Installation

$ npm install parsle

Getting Started

Parsle is a Req module, which means you can use Req to require it:

Req.module("myModule",
  $$ => $$.depend("parsle", "a parsing toolkit"),
  $$ => {

  const Parsle = $$.get("parsle", {});

  // ...
})

Or, if you prefer, you can require it normally like so:

const Parsle = require("parsle")();

// ...

Usage

To create a parser, use the Parsle constructor:

var parser = new Parsle($ => {
	// ...
});

In the above code, $ is a Matcher - a class which performs matching operations on text.

Matcher API

`Matcher.MATCH(regex, transform, gate)`

The Matcher.MATCH function matches a regex against the current string. It takes the regex to match, a transform function, and a gate.

The regex must match at the first character (i.e. as if it had ^ prepended to it). If this behavior is not desired then use Matcher.MATCH_AHEAD.

The transform function takes an info object with keys:

pos: The 0-based index of the character the match started at.
line, col: The 1-based line and column of the character the match started at.
match: The result of calling string.match(regex) where string is the current string ...and returns an object to be added to the results. Think of it as a post-proccesor function. The default behavior is to return the match property of the info object. If the transform function is the special Matcher.IGNORED or Matcher.prototype.IGNORED, or if the function returns either of those, then the results aren't even added to the this.result array

The gate function takes an info object as described above, and if it returns false, the match is discarded and a parse error is thrown.

After the match is successful, the matched string is removed from the current string.

`Matcher.MATCH_AHEAD(regex, transform, gate)`

Does the same as above, but does not require the match to be on the first character and instead removes all the way up to the part of the string actually matched.

`Matcher.PUSHSTATE()`

Saves the state of the matcher on the stack to be loaded later with Matcher.POPSTATE() (or accessed with the Matcher.states property)

`Matcher.POPSTATE()`

Pops a state from the stack and loads it.

`Matcher.OPTIONAL(fn)`

Runs fn. If a parse error occurs, set this.error to the error, go back to before fn was called and return false. Otherwise, return true.

`Matcher.TRY(fn)`

Returns whether fn would succeed (i.e. not throw a parse error when run). If any error occurs, it is also saved in this.error.

`Matcher.GROUP(fn, transform)`

Runs fn, but instead of pushing the results to the Matcher.result array, it passes an array of results* to the transform function and the return value of that is pushed instead.

* Those results are still obtained by using the transform function on Matcher.MATCH / Matcher.MATCH_AHEAD, so they might be info objects and might not.