Update code format and style

This is related to my last commit. I've updated all the JavaScript files to satisfy 'eslint-config-futagozaryuu', my eslint configuration.

I'm sure I've probally missed something, but I've run all NPM scripts and Gulp tasks, fixed any bugs that cropped up, and updated some stuff (mainly related to generated messages), so as far as I can, tell this conversion is over (I know I've probally jixed it just by saying this ;P).
master
Futago-za Ryuu 7 years ago
parent 3c6523ff83
commit e6d018a88d

@ -3,6 +3,11 @@
module.exports = { module.exports = {
"extends": "futagozaryuu/node-v4", "extends": "futagozaryuu/node-v4",
"root": true "root": true,
"rules": {
"prefer-rest-params": 0,
},
}; };

@ -1,15 +1,15 @@
"use strict"; "use strict";
let fs = require("fs"); const fs = require( "fs" );
let path = require("path"); const path = require( "path" );
let peg = require("../"); const peg = require( "../" );
// Options // Options
let inputFile = null; let inputFile = null;
let outputFile = null; let outputFile = null;
let options = { const options = {
"--": [], "--": [],
"cache": false, "cache": false,
"dependencies": {}, "dependencies": {},
@ -21,96 +21,119 @@ let options = {
"trace": false "trace": false
}; };
const EXPORT_VAR_FORMATS = ["globals", "umd"]; const EXPORT_VAR_FORMATS = [ "globals", "umd" ];
const DEPENDENCY_FORMATS = ["amd", "commonjs", "es", "umd"]; const DEPENDENCY_FORMATS = [ "amd", "commonjs", "es", "umd" ];
const MODULE_FORMATS = ["amd", "bare", "commonjs", "es", "globals", "umd"]; const MODULE_FORMATS = [ "amd", "bare", "commonjs", "es", "globals", "umd" ];
const OPTIMIZATION_GOALS = ["size", "speed"]; const OPTIMIZATION_GOALS = [ "size", "speed" ];
// Helpers // Helpers
function abort(message) { function abort( message ) {
console.error(message);
process.exit(1); console.error( message );
process.exit( 1 );
} }
function addExtraOptions(json) { function addExtraOptions( json ) {
let extraOptions; let extraOptions;
try { try {
extraOptions = JSON.parse(json);
} catch (e) {
if (!(e instanceof SyntaxError)) { throw e; }
abort("Error parsing JSON: " + e.message); extraOptions = JSON.parse( json );
} catch ( e ) {
if ( ! ( e instanceof SyntaxError ) ) throw e;
abort( "Error parsing JSON: " + e.message );
} }
if (typeof extraOptions !== "object") { if ( typeof extraOptions !== "object" ) {
abort("The JSON with extra options has to represent an object.");
abort( "The JSON with extra options has to represent an object." );
} }
Object Object
.keys(extraOptions) .keys( extraOptions )
.forEach(key => { .forEach( key => {
options[key] = extraOptions[key];
}); options[ key ] = extraOptions[ key ];
} );
} }
function formatChoicesList(list) { function formatChoicesList( list ) {
list = list.map(entry => `"${entry}"`);
let lastOption = list.pop(); list = list.map( entry => `"${ entry }"` );
const lastOption = list.pop();
return list.length === 0 return list.length === 0
? lastOption ? lastOption
: list.join(", ") + " or " + lastOption; : list.join( ", " ) + " or " + lastOption;
} }
function updateList(list, string) { function updateList( list, string ) {
string string
.split(",") .split( "," )
.forEach(entry => { .forEach( entry => {
entry = entry.trim(); entry = entry.trim();
if (list.indexOf(entry) === -1) { if ( list.indexOf( entry ) === -1 ) {
list.push(entry);
list.push( entry );
} }
});
} );
} }
// Arguments // Arguments
let args = process.argv.slice(2); let args = process.argv.slice( 2 );
function nextArg(option) { function nextArg( option ) {
if (args.length === 0) {
abort(`Missing parameter of the ${option} option.`);
}
if ( args.length === 0 ) {
abort( `Missing parameter of the ${ option } option.` );
}
return args.shift(); return args.shift();
} }
// Parse Arguments // Parse Arguments
while (args.length > 0) { while ( args.length > 0 ) {
let json, mod; let json, mod;
let argument = args.shift(); let argument = args.shift();
if (argument.indexOf("-") === 0 && argument.indexOf("=") > 1) { if ( argument.indexOf( "-" ) === 0 && argument.indexOf( "=" ) > 1 ) {
argument = argument.split("=");
args.unshift(argument.length > 2 ? argument.slice(1) : argument[1]); argument = argument.split( "=" );
argument = argument[0]; args.unshift( argument.length > 2 ? argument.slice( 1 ) : argument[ 1 ] );
argument = argument[ 0 ];
} }
switch (argument) { switch ( argument ) {
case "--": case "--":
options["--"] = args; options[ "--" ] = args;
args = []; args = [];
break; break;
case "-a": case "-a":
case "--allowed-start-rules": case "--allowed-start-rules":
if (!options.allowedStartRules) { if ( ! options.allowedStartRules ) options.allowedStartRules = [];
options.allowedStartRules = []; updateList( options.allowedStartRules, nextArg( "--allowed-start-rules" ) );
}
updateList(options.allowedStartRules, nextArg("--allowed-start-rules"));
break; break;
case "--cache": case "--cache":
@ -123,85 +146,96 @@ while (args.length > 0) {
case "-d": case "-d":
case "--dependency": case "--dependency":
argument = nextArg("-d/--dependency"); argument = nextArg( "-d/--dependency" );
if (argument.indexOf(":") === -1) { mod = argument.split( ":" );
mod = [argument, argument];
} else { if ( mod.length === 1 ) mod = [ argument, argument ];
mod = argument.split(":"); else if ( mod.length > 2 ) mod[ 1 ] = mod.slice( 1 );
if (mod.length > 2) {
mod[1] = mod.slice(1); options.dependencies[ mod[ 0 ] ] = mod[ 1 ];
}
}
options.dependencies[mod[0]] = mod[1];
break; break;
case "-e": case "-e":
case "--export-var": case "--export-var":
options.exportVar = nextArg("-e/--export-var"); options.exportVar = nextArg( "-e/--export-var" );
break; break;
case "--extra-options": case "--extra-options":
addExtraOptions(nextArg("--extra-options")); addExtraOptions( nextArg( "--extra-options" ) );
break; break;
case "-c": case "-c":
case "--config": case "--config":
case "--extra-options-file": case "--extra-options-file":
argument = nextArg("-c/--config/--extra-options-file"); argument = nextArg( "-c/--config/--extra-options-file" );
try { try {
json = fs.readFileSync(argument, "utf8");
} catch (e) { json = fs.readFileSync( argument, "utf8" );
abort(`Can't read from file "${argument}".`);
} catch ( e ) {
abort( `Can't read from file "${ argument }".` );
} }
addExtraOptions(json); addExtraOptions( json );
break; break;
case "-f": case "-f":
case "--format": case "--format":
argument = nextArg("-f/--format"); argument = nextArg( "-f/--format" );
if (MODULE_FORMATS.indexOf(argument) === -1) { if ( MODULE_FORMATS.indexOf( argument ) === -1 ) {
abort(`Module format must be either ${formatChoicesList(MODULE_FORMATS)}.`);
abort( `Module format must be either ${ formatChoicesList( MODULE_FORMATS ) }.` );
} }
options.format = argument; options.format = argument;
break; break;
case "-h": case "-h":
case "--help": case "--help":
console.log(fs.readFileSync(path.join(__dirname, "usage.txt"), "utf8").trim()); console.log( fs.readFileSync( path.join( __dirname, "usage.txt" ), "utf8" ).trim() );
process.exit(); process.exit();
break; break;
case "-O": case "-O":
case "--optimize": case "--optimize":
argument = nextArg("-O/--optimize"); argument = nextArg( "-O/--optimize" );
if (OPTIMIZATION_GOALS.indexOf(argument) === -1) { if ( OPTIMIZATION_GOALS.indexOf( argument ) === -1 ) {
abort(`Optimization goal must be either ${formatChoicesList(OPTIMIZATION_GOALS)}.`);
abort( `Optimization goal must be either ${ formatChoicesList( OPTIMIZATION_GOALS ) }.` );
} }
options.optimize = argument; options.optimize = argument;
break; break;
case "-o": case "-o":
case "--output": case "--output":
outputFile = nextArg("-o/--output"); outputFile = nextArg( "-o/--output" );
break; break;
case "-p": case "-p":
case "--plugin": case "--plugin":
argument = nextArg("-p/--plugin"); argument = nextArg( "-p/--plugin" );
try { try {
mod = require(argument);
} catch (ex1) {
if (ex1.code !== "MODULE_NOT_FOUND") { throw ex1; }
mod = require( argument );
} catch ( ex1 ) {
if ( ex1.code !== "MODULE_NOT_FOUND" ) throw ex1;
try { try {
mod = require(path.resolve(argument));
} catch (ex2) {
if (ex2.code !== "MODULE_NOT_FOUND") { throw ex2; }
abort(`Can't load module "${argument}".`); mod = require( path.resolve( argument ) );
} catch ( ex2 ) {
if ( ex2.code !== "MODULE_NOT_FOUND" ) throw ex2;
abort( `Can't load module "${ argument }".` );
} }
} }
options.plugins.push(mod); options.plugins.push( mod );
break; break;
case "--trace": case "--trace":
@ -214,42 +248,57 @@ while (args.length > 0) {
case "-v": case "-v":
case "--version": case "--version":
console.log("PEG.js v" + peg.VERSION); console.log( "PEG.js v" + peg.VERSION );
process.exit(); process.exit();
break; break;
default: default:
if (inputFile !== null) { if ( inputFile !== null ) {
abort(`Unknown option: "${argument}".`);
abort( `Unknown option: "${ argument }".` );
} }
inputFile = argument; inputFile = argument;
} }
} }
// Validation and defaults // Validation and defaults
if (Object.keys(options.dependencies).length > 0) { if ( Object.keys( options.dependencies ).length > 0 ) {
if (DEPENDENCY_FORMATS.indexOf(options.format) === -1) {
abort(`Can't use the -d/--dependency option with the "${options.format}" module format.`); if ( DEPENDENCY_FORMATS.indexOf( options.format ) === -1 ) {
abort( `Can't use the -d/--dependency option with the "${ options.format }" module format.` );
} }
} }
if (options.exportVar !== null) { if ( options.exportVar !== null ) {
if (EXPORT_VAR_FORMATS.indexOf(options.format) === -1) {
abort(`Can't use the -e/--export-var option with the "${options.format}" module format.`); if ( EXPORT_VAR_FORMATS.indexOf( options.format ) === -1 ) {
abort( `Can't use the -e/--export-var option with the "${ options.format }" module format.` );
} }
}
if (inputFile === null) {
inputFile = "-";
} }
if (outputFile === null) { if ( inputFile === null ) inputFile = "-";
if (inputFile === "-") {
outputFile = "-"; if ( outputFile === null ) {
} else if (inputFile) {
outputFile = inputFile.substr(0, inputFile.length - path.extname(inputFile).length) + ".js"; if ( inputFile === "-" ) outputFile = "-";
else if ( inputFile ) {
outputFile = inputFile
.substr( 0, inputFile.length - path.extname( inputFile ).length )
+ ".js";
} }
} }
// Export // Export

@ -2,63 +2,100 @@
"use strict"; "use strict";
let fs = require("fs"); const fs = require( "fs" );
let peg = require("../lib/peg"); const peg = require( "../lib/peg" );
let options = require("./options"); const options = require( "./options" );
// Helpers // Helpers
function readStream(inputStream, callback) { function readStream( inputStream, callback ) {
let input = ""; let input = "";
inputStream.on("data", data => { input += data; }); inputStream.on( "data", data => {
inputStream.on("end", () => { callback(input); });
input += data;
} );
inputStream.on( "end", () => {
callback( input );
} );
} }
function abort(message) { function abort( message ) {
console.error(message);
process.exit(1); console.error( message );
process.exit( 1 );
} }
// Main // Main
let inputStream, outputStream; let inputStream, outputStream;
if (options.inputFile === "-") { if ( options.inputFile === "-" ) {
process.stdin.resume(); process.stdin.resume();
inputStream = process.stdin; inputStream = process.stdin;
inputStream.on("error", () => { inputStream.on( "error", () => {
abort(`Can't read from file "${options.inputFile}".`);
}); abort( `Can't read from file "${ options.inputFile }".` );
} );
} else { } else {
inputStream = fs.createReadStream(options.inputFile);
inputStream = fs.createReadStream( options.inputFile );
} }
if (options.outputFile === "-") { if ( options.outputFile === "-" ) {
outputStream = process.stdout; outputStream = process.stdout;
} else { } else {
outputStream = fs.createWriteStream(options.outputFile);
outputStream.on("error", () => { outputStream = fs.createWriteStream( options.outputFile );
abort(`Can't write to file "${options.outputFile}".`); outputStream.on( "error", () => {
});
abort( `Can't write to file "${ options.outputFile }".` );
} );
} }
readStream(inputStream, input => { readStream( inputStream, input => {
let location, source; let location, source;
try { try {
source = peg.generate(input, options);
} catch (e) { source = peg.generate( input, options );
if (e.location !== undefined) {
} catch ( e ) {
if ( typeof e.location === "object" ) {
location = e.location.start; location = e.location.start;
abort(location.line + ":" + location.column + ": " + e.message); if ( typeof location === "object" ) {
} else {
abort(e.message); return abort( location.line + ":" + location.column + ": " + e.message );
}
} }
return abort( e.message );
} }
outputStream.write(source); outputStream.write( source );
if (outputStream !== process.stdout) { if ( outputStream !== process.stdout ) {
outputStream.end(); outputStream.end();
} }
});
} );

@ -1,26 +1,32 @@
"use strict"; "use strict";
let babelify = require("babelify"); const version = require( "./package" ).version;
let browserify = require("browserify"); const spawn = require( "child_process" ).spawn;
let buffer = require("vinyl-buffer"); const gulp = require( "gulp" );
let del = require("del"); const task = gulp.task.bind( gulp );
let eslint = require("gulp-eslint"); const eslint = require( "gulp-eslint" );
let gulp = require("gulp"); const mocha = require( "gulp-mocha" );
let header = require("gulp-header"); const dedent = require( "dedent" );
let mocha = require("gulp-mocha"); const browserify = require( "browserify" );
let rename = require("gulp-rename"); const babelify = require( "babelify" );
let runSequence = require("run-sequence"); const source = require( "vinyl-source-stream" );
let source = require("vinyl-source-stream"); const rename = require( "gulp-rename" );
let spawn = require("child_process").spawn; const buffer = require( "vinyl-buffer" );
let uglify = require("gulp-uglify"); const uglify = require( "gulp-uglify" );
const header = require( "gulp-header" );
function execFile(args) { const del = require( "del" );
return spawn("node", args.split(" "), { stdio: "inherit" }); const runSequence = require( "run-sequence" );
function node( args ) {
return spawn( "node", args.split( " " ), { stdio: "inherit" } );
} }
// Run ESLint on all JavaScript files. // Run ESLint on all JavaScript files.
gulp.task("lint", () => task( "lint", () => gulp
gulp.src([ .src( [
"**/.*rc.js",
"lib/**/*.js", "lib/**/*.js",
"!lib/parser.js", "!lib/parser.js",
"test/benchmark/**/*.js", "test/benchmark/**/*.js",
@ -30,60 +36,61 @@ gulp.task("lint", () =>
"test/server/run", "test/server/run",
"bin/*.js", "bin/*.js",
"gulpfile.js" "gulpfile.js"
]) ] )
.pipe(eslint()) .pipe( eslint( { dotfiles: true } ) )
.pipe(eslint.format()) .pipe( eslint.format() )
.pipe(eslint.failAfterError()) .pipe( eslint.failAfterError() )
); );
// Run tests. // Run tests.
gulp.task("test", () => task( "test", () => gulp
gulp.src("test/spec/**/*.spec.js", { read: false }) .src( "test/spec/**/*.spec.js", { read: false } )
.pipe(mocha()) .pipe( mocha() )
); );
// Run benchmarks. // Run benchmarks.
gulp.task("benchmark", () => execFile("test/benchmark/run")); task( "benchmark", () => node( "test/benchmark/run" ) );
// Create the browser build. // Create the browser build.
gulp.task("browser:build", () => { task( "browser:build", () => {
const HEADER = [
"//", const HEADER = dedent`
"// PEG.js v" + require("./package").version,
"// https://pegjs.org/", /**
"//", * PEG.js v${ version }
"// Copyright (c) 2010-2016 David Majda", * https://pegjs.org/
"// Copyright (c) 2017+ Futago-za Ryuu", *
"//", * Copyright (c) 2010-2016 David Majda
"// Licensed under the MIT License.", * Copyright (c) 2017+ Futago-za Ryuu
"//", *
"" * Released under the MIT License.
] */\n\n
.map(line => `${line}\n`)
.join(""); `;
return browserify("lib/peg.js", { standalone: "peg" }) return browserify( "lib/peg.js", { standalone: "peg" } )
.transform(babelify, { presets: "es2015", compact: false }) .transform( babelify, { presets: "es2015", compact: false } )
.bundle() .bundle()
.pipe(source("peg.js")) .pipe( source( "peg.js" ) )
.pipe(header(HEADER)) .pipe( header( HEADER ) )
.pipe(gulp.dest("browser")) .pipe( gulp.dest( "browser" ) )
.pipe(rename({ suffix: ".min" })) .pipe( rename( { suffix: ".min" } ) )
.pipe(buffer()) .pipe( buffer() )
.pipe(uglify()) .pipe( uglify() )
.pipe(header(HEADER)) .pipe( header( HEADER ) )
.pipe(gulp.dest("browser")); .pipe( gulp.dest( "browser" ) );
});
} );
// Delete the browser build. // Delete the browser build.
gulp.task("browser:clean", () => del("browser")); task( "browser:clean", () => del( "browser" ) );
// Generate the grammar parser. // Generate the grammar parser.
gulp.task("parser", () => task( "parser", () =>
execFile("bin/peg src/parser.pegjs -o lib/parser.js") node( "bin/peg src/parser.pegjs -o lib/parser.js" )
); );
// Default task. // Default task.
gulp.task("default", cb => task( "default", cb =>
runSequence("lint", "test", cb) runSequence( "benchmark", "test", cb )
); );

@ -4,8 +4,16 @@ module.exports = {
"extends": "futagozaryuu/es2015", "extends": "futagozaryuu/es2015",
"env": { "env": {
"commonjs": true
"commonjs": true,
},
"root": true,
"rules": {
"prefer-rest-params": 0,
"strict": 0,
}, },
"root": true
}; };

@ -1,49 +1,70 @@
"use strict"; "use strict";
let visitor = require("./visitor"); const visitor = require( "./visitor" );
// AST utilities. // AST utilities.
let asts = { const asts = {
findRule(ast, name) { findRule( ast, name ) {
for (let i = 0; i < ast.rules.length; i++) {
if (ast.rules[i].name === name) { for ( let i = 0; i < ast.rules.length; i++ ) {
return ast.rules[i];
} if ( ast.rules[ i ].name === name ) return ast.rules[ i ];
} }
return undefined; return void 0;
}, },
indexOfRule(ast, name) { indexOfRule( ast, name ) {
for (let i = 0; i < ast.rules.length; i++) {
if (ast.rules[i].name === name) { for ( let i = 0; i < ast.rules.length; i++ ) {
return i;
} if ( ast.rules[ i ].name === name ) return i;
} }
return -1; return -1;
}, },
alwaysConsumesOnSuccess(ast, node) { alwaysConsumesOnSuccess( ast, node ) {
function consumesTrue() { return true; }
function consumesFalse() { return false; } let consumes;
function consumesTrue() {
return true;
function consumesExpression(node) {
return consumes(node.expression);
} }
function consumesFalse() {
return false;
let consumes = visitor.build({ }
function consumesExpression( node ) {
return consumes( node.expression );
}
consumes = visitor.build( {
rule: consumesExpression, rule: consumesExpression,
named: consumesExpression, named: consumesExpression,
choice(node) { choice( node ) {
return node.alternatives.every(consumes);
return node.alternatives.every( consumes );
}, },
action: consumesExpression, action: consumesExpression,
sequence(node) { sequence( node ) {
return node.elements.some(consumes);
return node.elements.some( consumes );
}, },
labeled: consumesExpression, labeled: consumesExpression,
@ -57,19 +78,24 @@ let asts = {
semantic_and: consumesFalse, semantic_and: consumesFalse,
semantic_not: consumesFalse, semantic_not: consumesFalse,
rule_ref(node) { rule_ref( node ) {
return consumes(asts.findRule(ast, node.name));
return consumes( asts.findRule( ast, node.name ) );
}, },
literal(node) { literal( node ) {
return node.value !== ""; return node.value !== "";
}, },
class: consumesTrue, class: consumesTrue,
any: consumesTrue any: consumesTrue
}); } );
return consumes( node );
return consumes(node);
} }
}; };

@ -1,32 +1,40 @@
"use strict"; "use strict";
let generateBytecode = require("./passes/generate-bytecode"); const generateBytecode = require( "./passes/generate-bytecode" );
let generateJS = require("./passes/generate-js"); const generateJS = require( "./passes/generate-js" );
let removeProxyRules = require("./passes/remove-proxy-rules"); const removeProxyRules = require( "./passes/remove-proxy-rules" );
let reportDuplicateLabels = require("./passes/report-duplicate-labels"); const reportDuplicateLabels = require( "./passes/report-duplicate-labels" );
let reportDuplicateRules = require("./passes/report-duplicate-rules"); const reportDuplicateRules = require( "./passes/report-duplicate-rules" );
let reportInfiniteRecursion = require("./passes/report-infinite-recursion"); const reportInfiniteRecursion = require( "./passes/report-infinite-recursion" );
let reportInfiniteRepetition = require("./passes/report-infinite-repetition"); const reportInfiniteRepetition = require( "./passes/report-infinite-repetition" );
let reportUndefinedRules = require("./passes/report-undefined-rules"); const reportUndefinedRules = require( "./passes/report-undefined-rules" );
let visitor = require("./visitor"); const visitor = require( "./visitor" );
function processOptions(options, defaults) { function processOptions( options, defaults ) {
let processedOptions = {};
const processedOptions = {};
Object.keys(options).forEach(name => {
processedOptions[name] = options[name]; Object.keys( options ).forEach( name => {
});
processedOptions[ name ] = options[ name ];
Object.keys(defaults).forEach(name => {
if (!Object.prototype.hasOwnProperty.call(processedOptions, name)) { } );
processedOptions[name] = defaults[name];
Object.keys( defaults ).forEach( name => {
if ( ! Object.prototype.hasOwnProperty.call( processedOptions, name ) ) {
processedOptions[ name ] = defaults[ name ];
} }
});
} );
return processedOptions; return processedOptions;
} }
let compiler = { const compiler = {
// AST node visitor builder. Useful mainly for plugins which manipulate the // AST node visitor builder. Useful mainly for plugins which manipulate the
// AST. // AST.
visitor: visitor, visitor: visitor,
@ -57,11 +65,12 @@ let compiler = {
// if the AST contains a semantic error. Note that not all errors are detected // if the AST contains a semantic error. Note that not all errors are detected
// during the generation and some may protrude to the generated parser and // during the generation and some may protrude to the generated parser and
// cause its malfunction. // cause its malfunction.
compile(ast, passes, options) { compile( ast, passes, options ) {
options = options !== undefined ? options : {};
options = typeof options !== "undefined" ? options : {};
options = processOptions(options, { options = processOptions( options, {
allowedStartRules: [ast.rules[0].name], allowedStartRules: [ ast.rules[ 0 ].name ],
cache: false, cache: false,
dependencies: {}, dependencies: {},
exportVar: null, exportVar: null,
@ -69,22 +78,31 @@ let compiler = {
optimize: "speed", optimize: "speed",
output: "parser", output: "parser",
trace: false trace: false
}); } );
Object.keys( passes ).forEach( stage => {
passes[ stage ].forEach( pass => {
pass( ast, options );
Object.keys(passes).forEach(stage => { } );
passes[stage].forEach(p => { p(ast, options); });
}); } );
switch ( options.output ) {
switch (options.output) {
case "parser": case "parser":
return eval(ast.code); return eval( ast.code );
case "source": case "source":
return ast.code; return ast.code;
default: default:
throw new Error("Invalid output format: " + options.output + "."); throw new Error( `Invalid output format: ${ options.output }.` );
} }
} }
}; };

@ -1,10 +1,15 @@
"use strict"; "use strict";
function hex(ch) { return ch.charCodeAt(0).toString(16).toUpperCase(); } function hex( ch ) {
return ch.charCodeAt( 0 ).toString( 16 ).toUpperCase();
}
// JavaScript code generation helpers. // JavaScript code generation helpers.
let js = { const js = {
stringEscape(s) { stringEscape( s ) {
// ECMA-262, 5th ed., 7.8.4: All characters may appear literally in a string // ECMA-262, 5th ed., 7.8.4: All characters may appear literally in a string
// literal except for the closing quote character, backslash, carriage // literal except for the closing quote character, backslash, carriage
// return, line separator, paragraph separator, and line feed. Any character // return, line separator, paragraph separator, and line feed. Any character
@ -12,42 +17,45 @@ let js = {
// //
// For portability, we also escape all control and non-ASCII characters. // For portability, we also escape all control and non-ASCII characters.
return s return s
.replace(/\\/g, "\\\\") // backslash .replace( /\\/g, "\\\\" ) // backslash
.replace(/"/g, "\\\"") // closing double quote .replace( /"/g, "\\\"" ) // closing double quote
.replace(/\0/g, "\\0") // null .replace( /\0/g, "\\0" ) // null
.replace(/\x08/g, "\\b") // backspace .replace( /\x08/g, "\\b" ) // backspace
.replace(/\t/g, "\\t") // horizontal tab .replace( /\t/g, "\\t" ) // horizontal tab
.replace(/\n/g, "\\n") // line feed .replace( /\n/g, "\\n" ) // line feed
.replace(/\v/g, "\\v") // vertical tab .replace( /\v/g, "\\v" ) // vertical tab
.replace(/\f/g, "\\f") // form feed .replace( /\f/g, "\\f" ) // form feed
.replace(/\r/g, "\\r") // carriage return .replace( /\r/g, "\\r" ) // carriage return
.replace(/[\x00-\x0F]/g, ch => "\\x0" + hex(ch)) .replace( /[\x00-\x0F]/g, ch => "\\x0" + hex( ch ) )
.replace(/[\x10-\x1F\x7F-\xFF]/g, ch => "\\x" + hex(ch)) .replace( /[\x10-\x1F\x7F-\xFF]/g, ch => "\\x" + hex( ch ) )
.replace(/[\u0100-\u0FFF]/g, ch => "\\u0" + hex(ch)) .replace( /[\u0100-\u0FFF]/g, ch => "\\u0" + hex( ch ) )
.replace(/[\u1000-\uFFFF]/g, ch => "\\u" + hex(ch)); .replace( /[\u1000-\uFFFF]/g, ch => "\\u" + hex( ch ) );
}, },
regexpClassEscape(s) { regexpClassEscape( s ) {
// Based on ECMA-262, 5th ed., 7.8.5 & 15.10.1. // Based on ECMA-262, 5th ed., 7.8.5 & 15.10.1.
// //
// For portability, we also escape all control and non-ASCII characters. // For portability, we also escape all control and non-ASCII characters.
return s return s
.replace(/\\/g, "\\\\") // backslash .replace( /\\/g, "\\\\" ) // backslash
.replace(/\//g, "\\/") // closing slash .replace( /\//g, "\\/" ) // closing slash
.replace(/]/g, "\\]") // closing bracket .replace( /]/g, "\\]" ) // closing bracket
.replace(/\^/g, "\\^") // caret .replace( /\^/g, "\\^" ) // caret
.replace(/-/g, "\\-") // dash .replace( /-/g, "\\-" ) // dash
.replace(/\0/g, "\\0") // null .replace( /\0/g, "\\0" ) // null
.replace(/\x08/g, "\\b") // backspace .replace( /\x08/g, "\\b" ) // backspace
.replace(/\t/g, "\\t") // horizontal tab .replace( /\t/g, "\\t" ) // horizontal tab
.replace(/\n/g, "\\n") // line feed .replace( /\n/g, "\\n" ) // line feed
.replace(/\v/g, "\\v") // vertical tab .replace( /\v/g, "\\v" ) // vertical tab
.replace(/\f/g, "\\f") // form feed .replace( /\f/g, "\\f" ) // form feed
.replace(/\r/g, "\\r") // carriage return .replace( /\r/g, "\\r" ) // carriage return
.replace(/[\x00-\x0F]/g, ch => "\\x0" + hex(ch)) .replace( /[\x00-\x0F]/g, ch => "\\x0" + hex( ch ) )
.replace(/[\x10-\x1F\x7F-\xFF]/g, ch => "\\x" + hex(ch)) .replace( /[\x10-\x1F\x7F-\xFF]/g, ch => "\\x" + hex( ch ) )
.replace(/[\u0100-\u0FFF]/g, ch => "\\u0" + hex(ch)) .replace( /[\u0100-\u0FFF]/g, ch => "\\u0" + hex( ch ) )
.replace(/[\u1000-\uFFFF]/g, ch => "\\u" + hex(ch)); .replace( /[\u1000-\uFFFF]/g, ch => "\\u" + hex( ch ) );
} }
}; };

@ -1,7 +1,8 @@
"use strict"; "use strict";
// Bytecode instruction opcodes. // Bytecode instruction opcodes.
let opcodes = { const opcodes = {
// Stack Manipulation // Stack Manipulation
PUSH: 0, // PUSH c PUSH: 0, // PUSH c
@ -49,6 +50,7 @@ let opcodes = {
SILENT_FAILS_ON: 28, // SILENT_FAILS_ON SILENT_FAILS_ON: 28, // SILENT_FAILS_ON
SILENT_FAILS_OFF: 29 // SILENT_FAILS_OFF SILENT_FAILS_OFF: 29 // SILENT_FAILS_OFF
}; };
module.exports = opcodes; module.exports = opcodes;

@ -1,9 +1,9 @@
"use strict"; "use strict";
let asts = require("../asts"); const asts = require( "../asts" );
let js = require("../js"); const js = require( "../js" );
let op = require("../opcodes"); const op = require( "../opcodes" );
let visitor = require("../visitor"); const visitor = require( "../visitor" );
// Generates bytecode. // Generates bytecode.
// //
@ -187,124 +187,142 @@ let visitor = require("../visitor");
// [29] SILENT_FAILS_OFF // [29] SILENT_FAILS_OFF
// //
// silentFails--; // silentFails--;
function generateBytecode(ast) { function generateBytecode( ast ) {
let consts = [];
function addConst(value) { const consts = [];
let index = consts.indexOf(value); let generate;
function addConst( value ) {
const index = consts.indexOf( value );
return index === -1 ? consts.push( value ) - 1 : index;
return index === -1 ? consts.push(value) - 1 : index;
} }
function addFunctionConst(params, code) { function addFunctionConst( params, code ) {
return addConst(
"function(" + params.join(", ") + ") {" + code + "}" return addConst( `function(${ params.join( ", " ) }) {${ code }}` );
);
} }
function cloneEnv(env) { function cloneEnv( env ) {
let clone = {};
const clone = {};
Object.keys(env).forEach(name => { Object.keys( env ).forEach( name => {
clone[name] = env[name];
}); clone[ name ] = env[ name ];
} );
return clone; return clone;
} }
function buildSequence() { function buildSequence() {
return Array.prototype.concat.apply([], arguments);
return Array.prototype.concat.apply( [], arguments );
} }
function buildCondition(condCode, thenCode, elseCode) { function buildCondition( condCode, thenCode, elseCode ) {
return condCode.concat( return condCode.concat(
[thenCode.length, elseCode.length], [ thenCode.length, elseCode.length ],
thenCode, thenCode,
elseCode elseCode
); );
} }
function buildLoop(condCode, bodyCode) { function buildLoop( condCode, bodyCode ) {
return condCode.concat([bodyCode.length], bodyCode);
return condCode.concat( [ bodyCode.length ], bodyCode );
} }
function buildCall(functionIndex, delta, env, sp) { function buildCall( functionIndex, delta, env, sp ) {
let params = Object.keys(env).map(name => sp - env[name]);
const params = Object.keys( env ).map( name => sp - env[ name ] );
return [ op.CALL, functionIndex, delta, params.length ].concat( params );
return [op.CALL, functionIndex, delta, params.length].concat(params);
} }
function buildSimplePredicate(expression, negative, context) { function buildSimplePredicate( expression, negative, context ) {
return buildSequence( return buildSequence(
[op.PUSH_CURR_POS], [ op.PUSH_CURR_POS ],
[op.SILENT_FAILS_ON], [ op.SILENT_FAILS_ON ],
generate(expression, { generate( expression, {
sp: context.sp + 1, sp: context.sp + 1,
env: cloneEnv(context.env), env: cloneEnv( context.env ),
action: null action: null
}), } ),
[op.SILENT_FAILS_OFF], [ op.SILENT_FAILS_OFF ],
buildCondition( buildCondition(
[negative ? op.IF_ERROR : op.IF_NOT_ERROR], [ negative ? op.IF_ERROR : op.IF_NOT_ERROR ],
buildSequence( buildSequence(
[op.POP], [ op.POP ],
[negative ? op.POP : op.POP_CURR_POS], [ negative ? op.POP : op.POP_CURR_POS ],
[op.PUSH_UNDEFINED] [ op.PUSH_UNDEFINED ]
), ),
buildSequence( buildSequence(
[op.POP], [ op.POP ],
[negative ? op.POP_CURR_POS : op.POP], [ negative ? op.POP_CURR_POS : op.POP ],
[op.PUSH_FAILED] [ op.PUSH_FAILED ]
) )
) )
); );
} }
function buildSemanticPredicate(code, negative, context) { function buildSemanticPredicate( code, negative, context ) {
let functionIndex = addFunctionConst(Object.keys(context.env), code);
const functionIndex = addFunctionConst( Object.keys( context.env ), code );
return buildSequence( return buildSequence(
[op.UPDATE_SAVED_POS], [ op.UPDATE_SAVED_POS ],
buildCall(functionIndex, 0, context.env, context.sp), buildCall( functionIndex, 0, context.env, context.sp ),
buildCondition( buildCondition(
[op.IF], [ op.IF ],
buildSequence( buildSequence( [ op.POP ], negative ? [ op.PUSH_FAILED ] : [ op.PUSH_UNDEFINED ] ),
[op.POP], buildSequence( [ op.POP ], negative ? [ op.PUSH_UNDEFINED ] : [ op.PUSH_FAILED ] )
negative ? [op.PUSH_FAILED] : [op.PUSH_UNDEFINED]
),
buildSequence(
[op.POP],
negative ? [op.PUSH_UNDEFINED] : [op.PUSH_FAILED]
)
) )
); );
} }
function buildAppendLoop(expressionCode) { function buildAppendLoop( expressionCode ) {
return buildLoop( return buildLoop(
[op.WHILE_NOT_ERROR], [ op.WHILE_NOT_ERROR ],
buildSequence([op.APPEND], expressionCode) buildSequence( [ op.APPEND ], expressionCode )
); );
} }
let generate = visitor.build({ generate = visitor.build( {
grammar(node) { grammar( node ) {
node.rules.forEach(generate);
node.rules.forEach( generate );
node.consts = consts; node.consts = consts;
}, },
rule(node) { rule( node ) {
node.bytecode = generate(node.expression, {
node.bytecode = generate( node.expression, {
sp: -1, // stack pointer sp: -1, // stack pointer
env: { }, // mapping of label names to stack positions env: { }, // mapping of label names to stack positions
action: null // action nodes pass themselves to children here action: null // action nodes pass themselves to children here
}); } );
}, },
named(node, context) { named( node, context ) {
let nameIndex = addConst(
"peg$otherExpectation(\"" + js.stringEscape(node.name) + "\")" const nameIndex = addConst(
`peg$otherExpectation("${ js.stringEscape( node.name ) }")`
); );
// The code generated below is slightly suboptimal because |FAIL| pushes // The code generated below is slightly suboptimal because |FAIL| pushes
@ -312,99 +330,109 @@ function generateBytecode(ast) {
// dedicated instruction that would just report the failure and not touch // dedicated instruction that would just report the failure and not touch
// the stack. // the stack.
return buildSequence( return buildSequence(
[op.SILENT_FAILS_ON], [ op.SILENT_FAILS_ON ],
generate(node.expression, context), generate( node.expression, context ),
[op.SILENT_FAILS_OFF], [ op.SILENT_FAILS_OFF ],
buildCondition([op.IF_ERROR], [op.FAIL, nameIndex], []) buildCondition( [ op.IF_ERROR ], [ op.FAIL, nameIndex ], [] )
); );
}, },
choice(node, context) { choice( node, context ) {
function buildAlternativesCode(alternatives, context) {
function buildAlternativesCode( alternatives, context ) {
return buildSequence( return buildSequence(
generate(alternatives[0], { generate( alternatives[ 0 ], {
sp: context.sp, sp: context.sp,
env: cloneEnv(context.env), env: cloneEnv( context.env ),
action: null action: null
}), } ),
alternatives.length > 1 alternatives.length < 2
? buildCondition( ? []
[op.IF_ERROR], : buildCondition(
[ op.IF_ERROR ],
buildSequence( buildSequence(
[op.POP], [ op.POP ],
buildAlternativesCode(alternatives.slice(1), context) buildAlternativesCode( alternatives.slice( 1 ), context )
), ),
[] []
) )
: []
); );
} }
return buildAlternativesCode(node.alternatives, context); return buildAlternativesCode( node.alternatives, context );
}, },
action(node, context) { action( node, context ) {
let env = cloneEnv(context.env);
let emitCall = node.expression.type !== "sequence" const env = cloneEnv( context.env );
|| node.expression.elements.length === 0; const emitCall = node.expression.type !== "sequence" || node.expression.elements.length === 0;
let expressionCode = generate(node.expression, { const expressionCode = generate( node.expression, {
sp: context.sp + (emitCall ? 1 : 0), sp: context.sp + ( emitCall ? 1 : 0 ),
env: env, env: env,
action: node action: node
}); } );
let functionIndex = addFunctionConst(Object.keys(env), node.code); const functionIndex = addFunctionConst( Object.keys( env ), node.code );
return emitCall return emitCall === false
? buildSequence( ? expressionCode
[op.PUSH_CURR_POS], : buildSequence(
[ op.PUSH_CURR_POS ],
expressionCode, expressionCode,
buildCondition( buildCondition(
[op.IF_NOT_ERROR], [ op.IF_NOT_ERROR ],
buildSequence( buildSequence(
[op.LOAD_SAVED_POS, 1], [ op.LOAD_SAVED_POS, 1 ],
buildCall(functionIndex, 1, env, context.sp + 2) buildCall( functionIndex, 1, env, context.sp + 2 )
), ),
[] []
), ),
[op.NIP] [ op.NIP ]
) );
: expressionCode;
}, },
sequence(node, context) { sequence( node, context ) {
function buildElementsCode(elements, context) {
if (elements.length > 0) { function buildElementsCode( elements, context ) {
let processedCount = node.elements.length - elements.slice(1).length;
if ( elements.length > 0 ) {
const processedCount = node.elements.length - elements.slice( 1 ).length;
return buildSequence( return buildSequence(
generate(elements[0], { generate( elements[ 0 ], {
sp: context.sp, sp: context.sp,
env: context.env, env: context.env,
action: null action: null
}), } ),
buildCondition( buildCondition(
[op.IF_NOT_ERROR], [ op.IF_NOT_ERROR ],
buildElementsCode(elements.slice(1), { buildElementsCode( elements.slice( 1 ), {
sp: context.sp + 1, sp: context.sp + 1,
env: context.env, env: context.env,
action: context.action action: context.action
}), } ),
buildSequence( buildSequence(
processedCount > 1 ? [op.POP_N, processedCount] : [op.POP], processedCount > 1 ? [ op.POP_N, processedCount ] : [ op.POP ],
[op.POP_CURR_POS], [ op.POP_CURR_POS ],
[op.PUSH_FAILED] [ op.PUSH_FAILED ]
) )
) )
); );
} else {
if (context.action) { } else if ( context.action ) {
let functionIndex = addFunctionConst(
Object.keys(context.env), const functionIndex = addFunctionConst(
Object.keys( context.env ),
context.action.code context.action.code
); );
return buildSequence( return buildSequence(
[op.LOAD_SAVED_POS, node.elements.length], [ op.LOAD_SAVED_POS, node.elements.length ],
buildCall( buildCall(
functionIndex, functionIndex,
node.elements.length + 1, node.elements.length + 1,
@ -412,137 +440,159 @@ function generateBytecode(ast) {
context.sp context.sp
) )
); );
} else {
return buildSequence([op.WRAP, node.elements.length], [op.NIP]);
}
} }
return buildSequence( [ op.WRAP, node.elements.length ], [ op.NIP ] );
} }
return buildSequence( return buildSequence(
[op.PUSH_CURR_POS], [ op.PUSH_CURR_POS ],
buildElementsCode(node.elements, { buildElementsCode( node.elements, {
sp: context.sp + 1, sp: context.sp + 1,
env: context.env, env: context.env,
action: context.action action: context.action
}) } )
); );
}, },
labeled(node, context) { labeled( node, context ) {
let env = cloneEnv(context.env);
context.env[node.label] = context.sp + 1; const env = cloneEnv( context.env );
return generate(node.expression, { context.env[ node.label ] = context.sp + 1;
return generate( node.expression, {
sp: context.sp, sp: context.sp,
env: env, env: env,
action: null action: null
}); } );
}, },
text(node, context) { text( node, context ) {
return buildSequence( return buildSequence(
[op.PUSH_CURR_POS], [ op.PUSH_CURR_POS ],
generate(node.expression, { generate( node.expression, {
sp: context.sp + 1, sp: context.sp + 1,
env: cloneEnv(context.env), env: cloneEnv( context.env ),
action: null action: null
}), } ),
buildCondition( buildCondition(
[op.IF_NOT_ERROR], [ op.IF_NOT_ERROR ],
buildSequence([op.POP], [op.TEXT]), buildSequence( [ op.POP ], [ op.TEXT ] ),
[op.NIP] [ op.NIP ]
) )
); );
}, },
simple_and(node, context) { simple_and( node, context ) {
return buildSimplePredicate(node.expression, false, context);
return buildSimplePredicate( node.expression, false, context );
}, },
simple_not(node, context) { simple_not( node, context ) {
return buildSimplePredicate(node.expression, true, context);
return buildSimplePredicate( node.expression, true, context );
}, },
optional(node, context) { optional( node, context ) {
return buildSequence( return buildSequence(
generate(node.expression, { generate( node.expression, {
sp: context.sp, sp: context.sp,
env: cloneEnv(context.env), env: cloneEnv( context.env ),
action: null action: null
}), } ),
buildCondition( buildCondition(
[op.IF_ERROR], [ op.IF_ERROR ],
buildSequence([op.POP], [op.PUSH_NULL]), buildSequence( [ op.POP ], [ op.PUSH_NULL ] ),
[] []
) )
); );
}, },
zero_or_more(node, context) { zero_or_more( node, context ) {
let expressionCode = generate(node.expression, {
const expressionCode = generate( node.expression, {
sp: context.sp + 1, sp: context.sp + 1,
env: cloneEnv(context.env), env: cloneEnv( context.env ),
action: null action: null
}); } );
return buildSequence( return buildSequence(
[op.PUSH_EMPTY_ARRAY], [ op.PUSH_EMPTY_ARRAY ],
expressionCode, expressionCode,
buildAppendLoop(expressionCode), buildAppendLoop( expressionCode ),
[op.POP] [ op.POP ]
); );
}, },
one_or_more(node, context) { one_or_more( node, context ) {
let expressionCode = generate(node.expression, {
const expressionCode = generate( node.expression, {
sp: context.sp + 1, sp: context.sp + 1,
env: cloneEnv(context.env), env: cloneEnv( context.env ),
action: null action: null
}); } );
return buildSequence( return buildSequence(
[op.PUSH_EMPTY_ARRAY], [ op.PUSH_EMPTY_ARRAY ],
expressionCode, expressionCode,
buildCondition( buildCondition(
[op.IF_NOT_ERROR], [ op.IF_NOT_ERROR ],
buildSequence(buildAppendLoop(expressionCode), [op.POP]), buildSequence( buildAppendLoop( expressionCode ), [ op.POP ] ),
buildSequence([op.POP], [op.POP], [op.PUSH_FAILED]) buildSequence( [ op.POP ], [ op.POP ], [ op.PUSH_FAILED ] )
) )
); );
}, },
group(node, context) { group( node, context ) {
return generate(node.expression, {
return generate( node.expression, {
sp: context.sp, sp: context.sp,
env: cloneEnv(context.env), env: cloneEnv( context.env ),
action: null action: null
}); } );
}, },
semantic_and(node, context) { semantic_and( node, context ) {
return buildSemanticPredicate(node.code, false, context);
return buildSemanticPredicate( node.code, false, context );
}, },
semantic_not(node, context) { semantic_not( node, context ) {
return buildSemanticPredicate(node.code, true, context);
return buildSemanticPredicate( node.code, true, context );
}, },
rule_ref(node) { rule_ref( node ) {
return [op.RULE, asts.indexOfRule(ast, node.name)];
return [ op.RULE, asts.indexOfRule( ast, node.name ) ];
}, },
literal(node) { literal( node ) {
if (node.value.length > 0) {
let stringIndex = addConst("\"" if ( node.value.length > 0 ) {
+ js.stringEscape(
const stringIndex = addConst( `"${ js.stringEscape(
node.ignoreCase ? node.value.toLowerCase() : node.value node.ignoreCase ? node.value.toLowerCase() : node.value
) ) }"` );
+ "\"" const expectedIndex = addConst(
);
let expectedIndex = addConst(
"peg$literalExpectation(" "peg$literalExpectation("
+ "\"" + js.stringEscape(node.value) + "\", " + `"${ js.stringEscape( node.value ) }", `
+ node.ignoreCase + node.ignoreCase
+ ")" + ")"
); );
@ -552,40 +602,49 @@ function generateBytecode(ast) {
// save one |substr| call that would be needed if we used |ACCEPT_N|. // save one |substr| call that would be needed if we used |ACCEPT_N|.
return buildCondition( return buildCondition(
node.ignoreCase node.ignoreCase
? [op.MATCH_STRING_IC, stringIndex] ? [ op.MATCH_STRING_IC, stringIndex ]
: [op.MATCH_STRING, stringIndex], : [ op.MATCH_STRING, stringIndex ],
node.ignoreCase node.ignoreCase
? [op.ACCEPT_N, node.value.length] ? [ op.ACCEPT_N, node.value.length ]
: [op.ACCEPT_STRING, stringIndex], : [ op.ACCEPT_STRING, stringIndex ],
[op.FAIL, expectedIndex] [ op.FAIL, expectedIndex ]
); );
} else {
let stringIndex = addConst("\"\"");
return [op.PUSH, stringIndex];
} }
const stringIndex = addConst( "\"\"" );
return [ op.PUSH, stringIndex ];
}, },
class(node) { class( node ) {
let regexp = "/^["
+ (node.inverted ? "^" : "") const regexp = "/^["
+ node.parts.map(part => + ( node.inverted ? "^" : "" )
Array.isArray(part) + node.parts
? js.regexpClassEscape(part[0]) .map( part =>
( Array.isArray( part )
? js.regexpClassEscape( part[ 0 ] )
+ "-" + "-"
+ js.regexpClassEscape(part[1]) + js.regexpClassEscape( part[ 1 ] )
: js.regexpClassEscape(part) : js.regexpClassEscape( part ) )
).join("") )
+ "]/" + (node.ignoreCase ? "i" : ""); .join( "" )
let parts = "[" + "]/"
+ node.parts.map(part => + ( node.ignoreCase ? "i" : "" );
Array.isArray(part)
? "[\"" + js.stringEscape(part[0]) + "\", \"" + js.stringEscape(part[1]) + "\"]" const parts = "["
: "\"" + js.stringEscape(part) + "\"" + node.parts
).join(", ") .map( part =>
( Array.isArray( part )
? `["${ js.stringEscape( part[ 0 ] ) }", "${ js.stringEscape( part[ 1 ] ) }"]`
: "\"" + js.stringEscape( part ) + "\"" )
)
.join( ", " )
+ "]"; + "]";
let regexpIndex = addConst(regexp);
let expectedIndex = addConst( const regexpIndex = addConst( regexp );
const expectedIndex = addConst(
"peg$classExpectation(" "peg$classExpectation("
+ parts + ", " + parts + ", "
+ node.inverted + ", " + node.inverted + ", "
@ -594,24 +653,28 @@ function generateBytecode(ast) {
); );
return buildCondition( return buildCondition(
[op.MATCH_REGEXP, regexpIndex], [ op.MATCH_REGEXP, regexpIndex ],
[op.ACCEPT_N, 1], [ op.ACCEPT_N, 1 ],
[op.FAIL, expectedIndex] [ op.FAIL, expectedIndex ]
); );
}, },
any() { any() {
let expectedIndex = addConst("peg$anyExpectation()");
const expectedIndex = addConst( "peg$anyExpectation()" );
return buildCondition( return buildCondition(
[op.MATCH_ANY], [ op.MATCH_ANY ],
[op.ACCEPT_N, 1], [ op.ACCEPT_N, 1 ],
[op.FAIL, expectedIndex] [ op.FAIL, expectedIndex ]
); );
} }
}); } );
generate( ast );
generate(ast);
} }
module.exports = generateBytecode; module.exports = generateBytecode;

File diff suppressed because it is too large Load Diff

@ -1,39 +1,59 @@
"use strict"; "use strict";
let visitor = require("../visitor"); const visitor = require( "../visitor" );
// Removes proxy rules -- that is, rules that only delegate to other rule. // Removes proxy rules -- that is, rules that only delegate to other rule.
function removeProxyRules(ast, options) { function removeProxyRules( ast, options ) {
function isProxyRule(node) {
function isProxyRule( node ) {
return node.type === "rule" && node.expression.type === "rule_ref"; return node.type === "rule" && node.expression.type === "rule_ref";
} }
function replaceRuleRefs(ast, from, to) { function replaceRuleRefs( ast, from, to ) {
let replace = visitor.build({
rule_ref(node) { const replace = visitor.build( {
if (node.name === from) { rule_ref( node ) {
if ( node.name === from ) {
node.name = to; node.name = to;
} }
} }
}); } );
replace( ast );
replace(ast);
} }
let indices = []; const indices = [];
ast.rules.forEach( ( rule, i ) => {
if ( isProxyRule( rule ) ) {
replaceRuleRefs( ast, rule.name, rule.expression.name );
if ( options.allowedStartRules.indexOf( rule.name ) === -1 ) {
indices.push( i );
ast.rules.forEach((rule, i) => {
if (isProxyRule(rule)) {
replaceRuleRefs(ast, rule.name, rule.expression.name);
if (options.allowedStartRules.indexOf(rule.name) === -1) {
indices.push(i);
} }
} }
});
} );
indices.reverse(); indices.reverse();
indices.forEach(i => { ast.rules.splice(i, 1); }); indices.forEach( i => {
ast.rules.splice( i, 1 );
} );
} }
module.exports = removeProxyRules; module.exports = removeProxyRules;

@ -1,50 +1,70 @@
"use strict"; "use strict";
let GrammarError = require("../../grammar-error"); const GrammarError = require( "../../grammar-error" );
let visitor = require("../visitor"); const visitor = require( "../visitor" );
// Checks that each label is defined only once within each scope. // Checks that each label is defined only once within each scope.
function reportDuplicateLabels(ast) { function reportDuplicateLabels( ast ) {
function cloneEnv(env) {
let clone = {};
Object.keys(env).forEach(name => { let check;
clone[name] = env[name];
}); function cloneEnv( env ) {
const clone = {};
Object.keys( env ).forEach( name => {
clone[ name ] = env[ name ];
} );
return clone; return clone;
} }
function checkExpressionWithClonedEnv(node, env) { function checkExpressionWithClonedEnv( node, env ) {
check(node.expression, cloneEnv(env));
check( node.expression, cloneEnv( env ) );
} }
let check = visitor.build({ check = visitor.build( {
rule(node) { rule( node ) {
check(node.expression, { });
check( node.expression, {} );
}, },
choice(node, env) { choice( node, env ) {
node.alternatives.forEach(alternative => {
check(alternative, cloneEnv(env)); node.alternatives.forEach( alternative => {
});
check( alternative, cloneEnv( env ) );
} );
}, },
action: checkExpressionWithClonedEnv, action: checkExpressionWithClonedEnv,
labeled(node, env) { labeled( node, env ) {
if (Object.prototype.hasOwnProperty.call(env, node.label)) {
const label = node.label;
if ( Object.prototype.hasOwnProperty.call( env, label ) ) {
const start = env[ label ].start;
throw new GrammarError( throw new GrammarError(
"Label \"" + node.label + "\" is already defined " `Label "${ label }" is already defined at line ${ start.line }, column ${ start.column }.`,
+ "at line " + env[node.label].start.line + ", "
+ "column " + env[node.label].start.column + ".",
node.location node.location
); );
} }
check(node.expression, env); check( node.expression, env );
env[ label ] = node.location;
env[node.label] = node.location;
}, },
text: checkExpressionWithClonedEnv, text: checkExpressionWithClonedEnv,
@ -54,9 +74,10 @@ function reportDuplicateLabels(ast) {
zero_or_more: checkExpressionWithClonedEnv, zero_or_more: checkExpressionWithClonedEnv,
one_or_more: checkExpressionWithClonedEnv, one_or_more: checkExpressionWithClonedEnv,
group: checkExpressionWithClonedEnv group: checkExpressionWithClonedEnv
}); } );
check( ast );
check(ast);
} }
module.exports = reportDuplicateLabels; module.exports = reportDuplicateLabels;

@ -1,28 +1,36 @@
"use strict"; "use strict";
let GrammarError = require("../../grammar-error"); const GrammarError = require( "../../grammar-error" );
let visitor = require("../visitor"); const visitor = require( "../visitor" );
// Checks that each rule is defined only once. // Checks that each rule is defined only once.
function reportDuplicateRules(ast) { function reportDuplicateRules( ast ) {
let rules = {};
const rules = {};
const check = visitor.build( {
rule( node ) {
const name = node.name;
if ( Object.prototype.hasOwnProperty.call( rules, name ) ) {
const start = rules[ name ].start;
let check = visitor.build({
rule(node) {
if (Object.prototype.hasOwnProperty.call(rules, node.name)) {
throw new GrammarError( throw new GrammarError(
"Rule \"" + node.name + "\" is already defined " `Rule "${ name }" is already defined at line ${ start.line }, column ${ start.column }.`,
+ "at line " + rules[node.name].start.line + ", "
+ "column " + rules[node.name].start.column + ".",
node.location node.location
); );
} }
rules[node.name] = node.location; rules[ node.name ] = node.location;
} }
}); } );
check( ast );
check(ast);
} }
module.exports = reportDuplicateRules; module.exports = reportDuplicateRules;

@ -1,8 +1,8 @@
"use strict"; "use strict";
let GrammarError = require("../../grammar-error"); const GrammarError = require( "../../grammar-error" );
let asts = require("../asts"); const asts = require( "../asts" );
let visitor = require("../visitor"); const visitor = require( "../visitor" );
// Reports left recursion in the grammar, which prevents infinite recursion in // Reports left recursion in the grammar, which prevents infinite recursion in
// the generated parser. // the generated parser.
@ -14,41 +14,52 @@ let visitor = require("../visitor");
// //
// In general, if a rule reference can be reached without consuming any input, // In general, if a rule reference can be reached without consuming any input,
// it can lead to left recursion. // it can lead to left recursion.
function reportInfiniteRecursion(ast) { function reportInfiniteRecursion( ast ) {
let visitedRules = [];
const visitedRules = [];
let check = visitor.build({
rule(node) { const check = visitor.build( {
visitedRules.push(node.name); rule( node ) {
check(node.expression);
visitedRules.pop(node.name); visitedRules.push( node.name );
check( node.expression );
visitedRules.pop( node.name );
}, },
sequence(node) { sequence( node ) {
node.elements.every(element => {
check(element); node.elements.every( element => {
check( element );
return ! asts.alwaysConsumesOnSuccess( ast, element );
} );
return !asts.alwaysConsumesOnSuccess(ast, element);
});
}, },
rule_ref(node) { rule_ref( node ) {
if (visitedRules.indexOf(node.name) !== -1) {
visitedRules.push(node.name); if ( visitedRules.indexOf( node.name ) !== -1 ) {
visitedRules.push( node.name );
const rulePath = visitedRules.join( " -> " );
throw new GrammarError( throw new GrammarError(
"Possible infinite loop when parsing (left recursion: " `Possible infinite loop when parsing (left recursion: ${ rulePath }).`,
+ visitedRules.join(" -> ")
+ ").",
node.location node.location
); );
} }
check(asts.findRule(ast, node.name)); check( asts.findRule( ast, node.name ) );
} }
}); } );
check( ast );
check(ast);
} }
module.exports = reportInfiniteRecursion; module.exports = reportInfiniteRecursion;

@ -1,33 +1,43 @@
"use strict"; "use strict";
let GrammarError = require("../../grammar-error"); const GrammarError = require( "../../grammar-error" );
let asts = require("../asts"); const asts = require( "../asts" );
let visitor = require("../visitor"); const visitor = require( "../visitor" );
// Reports expressions that don't consume any input inside |*| or |+| in the // Reports expressions that don't consume any input inside |*| or |+| in the
// grammar, which prevents infinite loops in the generated parser. // grammar, which prevents infinite loops in the generated parser.
function reportInfiniteRepetition(ast) { function reportInfiniteRepetition( ast ) {
let check = visitor.build({
zero_or_more(node) { const check = visitor.build( {
if (!asts.alwaysConsumesOnSuccess(ast, node.expression)) { zero_or_more( node ) {
if ( ! asts.alwaysConsumesOnSuccess( ast, node.expression ) ) {
throw new GrammarError( throw new GrammarError(
"Possible infinite loop when parsing (repetition used with an expression that may not consume any input).", "Possible infinite loop when parsing (repetition used with an expression that may not consume any input).",
node.location node.location
); );
} }
}, },
one_or_more(node) { one_or_more( node ) {
if (!asts.alwaysConsumesOnSuccess(ast, node.expression)) {
if ( ! asts.alwaysConsumesOnSuccess( ast, node.expression ) ) {
throw new GrammarError( throw new GrammarError(
"Possible infinite loop when parsing (repetition used with an expression that may not consume any input).", "Possible infinite loop when parsing (repetition used with an expression that may not consume any input).",
node.location node.location
); );
} }
} }
}); } );
check( ast );
check(ast);
} }
module.exports = reportInfiniteRepetition; module.exports = reportInfiniteRepetition;

@ -1,32 +1,43 @@
"use strict"; "use strict";
let GrammarError = require("../../grammar-error"); const GrammarError = require( "../../grammar-error" );
let asts = require("../asts"); const asts = require( "../asts" );
let visitor = require("../visitor"); const visitor = require( "../visitor" );
// Checks that all referenced rules exist. // Checks that all referenced rules exist.
function reportUndefinedRules(ast, options) { function reportUndefinedRules( ast, options ) {
let check = visitor.build({
rule_ref(node) { const check = visitor.build( {
if (!asts.findRule(ast, node.name)) { rule_ref( node ) {
if ( ! asts.findRule( ast, node.name ) ) {
throw new GrammarError( throw new GrammarError(
"Rule \"" + node.name + "\" is not defined.", `Rule "${ node.name }" is not defined.`,
node.location node.location
); );
} }
} }
}); } );
check(ast); check( ast );
if ( options.allowedStartRules ) {
options.allowedStartRules.forEach( rule => {
if ( ! asts.findRule( ast, rule ) ) {
throw new GrammarError( `Start rule "${ rule }" is not defined.` );
if (options.allowedStartRules) {
options.allowedStartRules.forEach(rule => {
if (!asts.findRule(ast, rule)) {
throw new GrammarError(
"Start rule \"" + rule + "\" is not defined.");
} }
});
} );
} }
} }
module.exports = reportUndefinedRules; module.exports = reportUndefinedRules;

@ -1,51 +1,68 @@
"use strict"; "use strict";
// Simple AST node visitor builder. // Simple AST node visitor builder.
let visitor = { const visitor = {
build(functions) { build( functions ) {
function visit(node) {
return functions[node.type].apply(null, arguments); function visit( node ) {
return functions[ node.type ].apply( null, arguments );
} }
function visitNop() { function visitNop() {
// Do nothing. // Do nothing.
} }
function visitExpression(node) { function visitExpression( node ) {
let extraArgs = Array.prototype.slice.call(arguments, 1);
const extraArgs = Array.prototype.slice.call( arguments, 1 );
visit( ...[ node.expression ].concat( extraArgs ) );
visit.apply(null, [node.expression].concat(extraArgs));
} }
function visitChildren(property) { function visitChildren( property ) {
return function(node) {
let extraArgs = Array.prototype.slice.call(arguments, 1); return function visitProperty( node ) {
const extraArgs = Array.prototype.slice.call( arguments, 1 );
node[ property ].forEach( child => {
visit( ...[ child ].concat( extraArgs ) );
} );
node[property].forEach(child => {
visit.apply(null, [child].concat(extraArgs));
});
}; };
} }
const DEFAULT_FUNCTIONS = { const DEFAULT_FUNCTIONS = {
grammar(node) { grammar( node ) {
let extraArgs = Array.prototype.slice.call(arguments, 1);
const extraArgs = Array.prototype.slice.call( arguments, 1 );
if ( node.initializer ) {
visit( ...[ node.initializer ].concat( extraArgs ) );
if (node.initializer) {
visit.apply(null, [node.initializer].concat(extraArgs));
} }
node.rules.forEach(rule => { node.rules.forEach( rule => {
visit.apply(null, [rule].concat(extraArgs));
}); visit( ...[ rule ].concat( extraArgs ) );
} );
}, },
initializer: visitNop, initializer: visitNop,
rule: visitExpression, rule: visitExpression,
named: visitExpression, named: visitExpression,
choice: visitChildren("alternatives"), choice: visitChildren( "alternatives" ),
action: visitExpression, action: visitExpression,
sequence: visitChildren("elements"), sequence: visitChildren( "elements" ),
labeled: visitExpression, labeled: visitExpression,
text: visitExpression, text: visitExpression,
simple_and: visitExpression, simple_and: visitExpression,
@ -62,13 +79,18 @@ let visitor = {
any: visitNop any: visitNop
}; };
Object.keys(DEFAULT_FUNCTIONS).forEach(type => { Object.keys( DEFAULT_FUNCTIONS ).forEach( type => {
if (!Object.prototype.hasOwnProperty.call(functions, type)) {
functions[type] = DEFAULT_FUNCTIONS[type]; if ( ! Object.prototype.hasOwnProperty.call( functions, type ) ) {
functions[ type ] = DEFAULT_FUNCTIONS[ type ];
} }
});
} );
return visit; return visit;
} }
}; };

@ -2,15 +2,21 @@
// Thrown when the grammar contains an error. // Thrown when the grammar contains an error.
class GrammarError { class GrammarError {
constructor(message, location) {
constructor( message, location ) {
this.name = "GrammarError"; this.name = "GrammarError";
this.message = message; this.message = message;
this.location = location; this.location = location;
if (typeof Error.captureStackTrace === "function") { if ( typeof Error.captureStackTrace === "function" ) {
Error.captureStackTrace(this, GrammarError);
Error.captureStackTrace( this, GrammarError );
} }
} }
} }
module.exports = GrammarError; module.exports = GrammarError;

@ -1,10 +1,10 @@
"use strict"; "use strict";
let GrammarError = require("./grammar-error"); const GrammarError = require( "./grammar-error" );
let compiler = require("./compiler"); const compiler = require( "./compiler" );
let parser = require("./parser"); const parser = require( "./parser" );
let peg = { const peg = {
// PEG.js version (uses semantic versioning). // PEG.js version (uses semantic versioning).
VERSION: "0.10.0", VERSION: "0.10.0",
@ -21,33 +21,43 @@ let peg = {
// |peg.GrammarError| if it contains a semantic error. Note that not all // |peg.GrammarError| if it contains a semantic error. Note that not all
// errors are detected during the generation and some may protrude to the // errors are detected during the generation and some may protrude to the
// generated parser and cause its malfunction. // generated parser and cause its malfunction.
generate(grammar, options) { generate( grammar, options ) {
options = options !== undefined ? options : {};
function convertPasses(passes) { options = typeof options !== "undefined" ? options : {};
let converted = {};
Object.keys(passes).forEach(stage => { function convertPasses( passes ) {
converted[stage] = Object.keys(passes[stage])
.map(name => passes[stage][name]); const converted = {};
});
Object.keys( passes ).forEach( stage => {
converted[ stage ] = Object.keys( passes[ stage ] )
.map( name => passes[ stage ][ name ] );
} );
return converted; return converted;
} }
let plugins = "plugins" in options ? options.plugins : []; const plugins = "plugins" in options ? options.plugins : [];
let config = { const config = {
parser: peg.parser, parser: peg.parser,
passes: convertPasses(peg.compiler.passes) passes: convertPasses( peg.compiler.passes )
}; };
plugins.forEach(p => { p.use(config, options); }); plugins.forEach( p => {
p.use( config, options );
} );
return peg.compiler.compile( return peg.compiler.compile(
config.parser.parse(grammar), config.parser.parse( grammar ),
config.passes, config.passes,
options options
); );
} }
}; };

@ -59,6 +59,7 @@
"devDependencies": { "devDependencies": {
"babel-preset-es2015": "6.24.1", "babel-preset-es2015": "6.24.1",
"babel-core": "6.26.0", "babel-core": "6.26.0",
"dedent": "0.7.0",
"babelify": "8.0.0", "babelify": "8.0.0",
"browserify": "14.5.0", "browserify": "14.5.0",
"chai": "4.1.2", "chai": "4.1.2",

@ -5,8 +5,10 @@ module.exports = {
"extends": "futagozaryuu/test", "extends": "futagozaryuu/test",
"rules": { "rules": {
"node/shebang": 0 "node/shebang": 0,
"func-names": 0,
"no-mixed-operators": 0,
} },
}; };

@ -1,6 +1,6 @@
"use strict"; "use strict";
let benchmarks = [ const benchmarks = [
{ {
id: "json", id: "json",
title: "JSON", title: "JSON",

@ -2,45 +2,48 @@
/* eslint-env browser, jquery */ /* eslint-env browser, jquery */
let Runner = require("./runner.js"); const Runner = require( "./runner.js" );
let benchmarks = require("./benchmarks.js"); const benchmarks = require( "./benchmarks.js" );
$( "#run" ).click( () => {
$("#run").click(() => {
// Results Table Manipulation // Results Table Manipulation
let resultsTable = $("#results-table"); const resultsTable = $( "#results-table" );
function appendResult( klass, title, url, inputSize, parseTime ) {
function appendResult(klass, title, url, inputSize, parseTime) {
const KB = 1024; const KB = 1024;
const MS_IN_S = 1000; const MS_IN_S = 1000;
resultsTable.append( resultsTable.append(
"<tr class='" + klass + "'>" "<tr class='" + klass + "'>"
+ "<td class='title'>" + "<td class='title'>"
+ (url !== null ? "<a href='" + url + "'>" : "") + ( url !== null ? "<a href='" + url + "'>" : "" )
+ title + title
+ (url !== null ? "</a>" : "") + ( url !== null ? "</a>" : "" )
+ "</td>" + "</td>"
+ "<td class='input-size'>" + "<td class='input-size'>"
+ "<span class='value'>" + "<span class='value'>"
+ (inputSize / KB).toFixed(2) + ( inputSize / KB ).toFixed( 2 )
+ "</span>" + "</span>"
+ "&nbsp;<span class='unit'>kB</span>" + "&nbsp;<span class='unit'>kB</span>"
+ "</td>" + "</td>"
+ "<td class='parse-time'>" + "<td class='parse-time'>"
+ "<span class='value'>" + "<span class='value'>"
+ parseTime.toFixed(2) + parseTime.toFixed( 2 )
+ "</span>" + "</span>"
+ "&nbsp;<span class='unit'>ms</span>" + "&nbsp;<span class='unit'>ms</span>"
+ "</td>" + "</td>"
+ "<td class='parse-speed'>" + "<td class='parse-speed'>"
+ "<span class='value'>" + "<span class='value'>"
+ ((inputSize / KB) / (parseTime / MS_IN_S)).toFixed(2) + ( ( inputSize / KB ) / ( parseTime / MS_IN_S ) ).toFixed( 2 )
+ "</span>" + "</span>"
+ "&nbsp;<span class='unit'>kB/s</span>" + "&nbsp;<span class='unit'>kB/s</span>"
+ "</td>" + "</td>"
+ "</tr>" + "</tr>"
); );
} }
// Main // Main
@ -54,33 +57,38 @@ $("#run").click(() => {
// //
// 2. To minimize random errors. // 2. To minimize random errors.
let runCount = parseInt($("#run-count").val(), 10); const runCount = parseInt( $( "#run-count" ).val(), 10 );
let options = { const options = {
cache: $("#cache").is(":checked"), cache: $( "#cache" ).is( ":checked" ),
optimize: $("#optimize").val() optimize: $( "#optimize" ).val()
}; };
if (isNaN(runCount) || runCount <= 0) { if ( isNaN( runCount ) || runCount <= 0 ) {
alert("Number of runs must be a positive integer.");
alert( "Number of runs must be a positive integer." );
return; return;
} }
Runner.run(benchmarks, runCount, options, { Runner.run( benchmarks, runCount, options, {
readFile(file) { readFile( file ) {
return $.ajax({
return $.ajax( {
type: "GET", type: "GET",
url: "benchmark/" + file, url: "benchmark/" + file,
dataType: "text", dataType: "text",
async: false async: false
}).responseText; } ).responseText;
}, },
testStart() { testStart() {
// Nothing to do. // Nothing to do.
}, },
testFinish(benchmark, test, inputSize, parseTime) { testFinish( benchmark, test, inputSize, parseTime ) {
appendResult( appendResult(
"individual", "individual",
test.title, test.title,
@ -88,9 +96,11 @@ $("#run").click(() => {
inputSize, inputSize,
parseTime parseTime
); );
}, },
benchmarkStart(benchmark) { benchmarkStart( benchmark ) {
resultsTable.append( resultsTable.append(
"<tr class='heading'><th colspan='4'>" "<tr class='heading'><th colspan='4'>"
+ "<a href='../../examples/" + benchmark.id + ".pegjs'>" + "<a href='../../examples/" + benchmark.id + ".pegjs'>"
@ -98,9 +108,11 @@ $("#run").click(() => {
+ "</a>" + "</a>"
+ "</th></tr>" + "</th></tr>"
); );
}, },
benchmarkFinish(benchmark, inputSize, parseTime) { benchmarkFinish( benchmark, inputSize, parseTime ) {
appendResult( appendResult(
"benchmark-total", "benchmark-total",
benchmark.title + " total", benchmark.title + " total",
@ -108,16 +120,20 @@ $("#run").click(() => {
inputSize, inputSize,
parseTime parseTime
); );
}, },
start() { start() {
$("#run-count, #cache, #run").attr("disabled", "disabled");
$( "#run-count, #cache, #run" ).attr( "disabled", "disabled" );
resultsTable.show(); resultsTable.show();
$("#results-table tr").slice(1).remove(); $( "#results-table tr" ).slice( 1 ).remove();
}, },
finish(inputSize, parseTime) { finish( inputSize, parseTime ) {
appendResult( appendResult(
"total", "total",
"Total", "Total",
@ -126,13 +142,12 @@ $("#run").click(() => {
parseTime parseTime
); );
$.scrollTo("max", { axis: "y", duration: 500 }); $.scrollTo( "max", { axis: "y", duration: 500 } );
$( "#run-count, #cache, #run" ).removeAttr( "disabled" );
$("#run-count, #cache, #run").removeAttr("disabled");
} }
}); } );
});
} );
$(document).ready(() => { $( document ).ready( () => $( "#run" ).focus() );
$("#run").focus();
});

@ -2,131 +2,167 @@
"use strict"; "use strict";
let Runner = require("./runner.js"); const Runner = require( "./runner.js" );
let benchmarks = require("./benchmarks.js"); const benchmarks = require( "./benchmarks.js" );
let fs = require("fs"); const fs = require( "fs" );
const path = require( "path" );
// Results Table Manipulation // Results Table Manipulation
function dup(text, count) { function dup( text, count ) {
let result = ""; let result = "";
for (let i = 1; i <= count; i++) { for ( let i = 1; i <= count; i++ ) result += text;
result += text;
}
return result; return result;
} }
function padLeft(text, length) { function padLeft( text, length ) {
return dup(" ", length - text.length) + text;
return dup( " ", length - text.length ) + text;
} }
function padRight(text, length) { function padRight( text, length ) {
return text + dup(" ", length - text.length);
return text + dup( " ", length - text.length );
} }
function center(text, length) { function center( text, length ) {
let padLength = (length - text.length) / 2;
const padLength = ( length - text.length ) / 2;
return dup(" ", Math.floor(padLength)) return dup( " ", Math.floor( padLength ) )
+ text + text
+ dup(" ", Math.ceil(padLength)); + dup( " ", Math.ceil( padLength ) );
} }
function writeTableHeader() { function writeTableHeader() {
console.log("┌─────────────────────────────────────┬───────────┬────────────┬──────────────┐");
console.log("│ Test │ Inp. size │ Avg. time │ Avg. speed │"); console.log( "┌─────────────────────────────────────┬───────────┬────────────┬──────────────┐" );
console.log( "│ Test │ Inp. size │ Avg. time │ Avg. speed │" );
} }
function writeHeading(heading) { function writeHeading( heading ) {
console.log("├─────────────────────────────────────┴───────────┴────────────┴──────────────┤");
console.log("│ " + center(heading, 75) + " │"); console.log( "├─────────────────────────────────────┴───────────┴────────────┴──────────────┤" );
console.log("├─────────────────────────────────────┬───────────┬────────────┬──────────────┤"); console.log( "│ " + center( heading, 75 ) + " │" );
console.log( "├─────────────────────────────────────┬───────────┬────────────┬──────────────┤" );
} }
function writeResult(title, inputSize, parseTime) { function writeResult( title, inputSize, parseTime ) {
const KB = 1024; const KB = 1024;
const MS_IN_S = 1000; const MS_IN_S = 1000;
console.log("│ " console.log(
+ padRight(title, 35) "│ " +
+ " │ " padRight( title, 35 ) +
+ padLeft((inputSize / KB).toFixed(2), 6) " │ " +
+ " kB │ " padLeft( ( inputSize / KB ).toFixed( 2 ), 6 ) +
+ padLeft(parseTime.toFixed(2), 7) " kB │ " +
+ " ms │ " padLeft( parseTime.toFixed( 2 ), 7 ) +
+ padLeft(((inputSize / KB) / (parseTime / MS_IN_S)).toFixed(2), 7) " ms │ " +
+ " kB/s │" padLeft( ( ( inputSize / KB ) / ( parseTime / MS_IN_S ) ).toFixed( 2 ), 7 ) +
" kB/s │"
); );
} }
function writeSeparator() { function writeSeparator() {
console.log("├─────────────────────────────────────┼───────────┼────────────┼──────────────┤");
console.log( "├─────────────────────────────────────┼───────────┼────────────┼──────────────┤" );
} }
function writeTableFooter() { function writeTableFooter() {
console.log("└─────────────────────────────────────┴───────────┴────────────┴──────────────┘");
console.log( "└─────────────────────────────────────┴───────────┴────────────┴──────────────┘" );
} }
// Helpers // Helpers
function printHelp() { function printHelp() {
console.log("Usage: run [options]");
console.log(""); console.log( "Usage: run [options]" );
console.log("Runs PEG.js benchmark suite."); console.log( "" );
console.log(""); console.log( "Runs PEG.js benchmark suite." );
console.log("Options:"); console.log( "" );
console.log(" -n, --run-count <n> number of runs (default: 10)"); console.log( "Options:" );
console.log(" --cache make tested parsers cache results"); console.log( " -n, --run-count <n> number of runs (default: 10)" );
console.log(" -o, --optimize <goal> select optimization for speed or size (default:"); console.log( " --cache make tested parsers cache results" );
console.log(" speed)"); console.log( " -o, --optimize <goal> select optimization for speed or size (default:" );
console.log( " speed)" );
} }
function exitSuccess() { function exitSuccess() {
process.exit(0);
process.exit( 0 );
} }
function exitFailure() { function exitFailure() {
process.exit(1);
process.exit( 1 );
} }
function abort(message) { function abort( message ) {
console.error(message);
console.error( message );
exitFailure(); exitFailure();
} }
// Arguments // Arguments
let args = process.argv.slice(2); // Trim "node" and the script path. const args = process.argv.slice( 2 ); // Trim "node" and the script path.
function isOption( arg ) {
return ( /^-/ ).test( arg );
function isOption(arg) {
return (/^-/).test(arg);
} }
function nextArg() { function nextArg() {
args.shift(); args.shift();
} }
// Main // Main
let runCount = 10; let runCount = 10;
let options = { const options = {
cache: false, cache: false,
optimize: "speed" optimize: "speed"
}; };
while (args.length > 0 && isOption(args[0])) { while ( args.length > 0 && isOption( args[ 0 ] ) ) {
switch (args[0]) {
switch ( args[ 0 ] ) {
case "-n": case "-n":
case "--run-count": case "--run-count":
nextArg(); nextArg();
if (args.length === 0) { if ( args.length === 0 ) {
abort("Missing parameter of the -n/--run-count option.");
abort( "Missing parameter of the -n/--run-count option." );
} }
runCount = parseInt(args[0], 10); runCount = parseInt( args[ 0 ], 10 );
if (isNaN(runCount) || runCount <= 0) { if ( isNaN( runCount ) || runCount <= 0 ) {
abort("Number of runs must be a positive integer.");
abort( "Number of runs must be a positive integer." );
} }
break; break;
@ -137,13 +173,17 @@ while (args.length > 0 && isOption(args[0])) {
case "-o": case "-o":
case "--optimize": case "--optimize":
nextArg(); nextArg();
if (args.length === 0) { if ( args.length === 0 ) {
abort("Missing parameter of the -o/--optimize option.");
abort( "Missing parameter of the -o/--optimize option." );
} }
if (args[0] !== "speed" && args[0] !== "size") { if ( args[ 0 ] !== "speed" && args[ 0 ] !== "size" ) {
abort("Optimization goal must be either \"speed\" or \"size\".");
abort( "Optimization goal must be either \"speed\" or \"size\"." );
} }
options.optimize = args[0]; options.optimize = args[ 0 ];
break; break;
case "-h": case "-h":
@ -153,44 +193,60 @@ while (args.length > 0 && isOption(args[0])) {
break; break;
default: default:
abort("Unknown option: " + args[0] + "."); abort( "Unknown option: " + args[ 0 ] + "." );
} }
nextArg(); nextArg();
} }
if (args.length > 0) { if ( args.length > 0 ) {
abort("No arguments are allowed.");
abort( "No arguments are allowed." );
} }
Runner.run(benchmarks, runCount, options, { Runner.run( benchmarks, runCount, options, {
readFile(file) { readFile( file ) {
return fs.readFileSync(__dirname + "/" + file, "utf8");
return fs.readFileSync( path.join( __dirname, file ), "utf8" );
}, },
testStart() { testStart() {
// Nothing to do. // Nothing to do.
}, },
testFinish(benchmark, test, inputSize, parseTime) { testFinish( benchmark, test, inputSize, parseTime ) {
writeResult(test.title, inputSize, parseTime);
writeResult( test.title, inputSize, parseTime );
}, },
benchmarkStart(benchmark) { benchmarkStart( benchmark ) {
writeHeading(benchmark.title);
writeHeading( benchmark.title );
}, },
benchmarkFinish(benchmark, inputSize, parseTime) { benchmarkFinish( benchmark, inputSize, parseTime ) {
writeSeparator(); writeSeparator();
writeResult(benchmark.title + " total", inputSize, parseTime); writeResult( benchmark.title + " total", inputSize, parseTime );
}, },
start() { start() {
writeTableHeader(); writeTableHeader();
}, },
finish(inputSize, parseTime) { finish( inputSize, parseTime ) {
writeSeparator(); writeSeparator();
writeResult("Total", inputSize, parseTime); writeResult( "Total", inputSize, parseTime );
writeTableFooter(); writeTableFooter();
} }
}); } );

@ -1,28 +1,37 @@
"use strict"; "use strict";
/* global setTimeout */ const peg = require( "../../lib/peg" );
let peg = require("../../lib/peg"); const Runner = {
run( benchmarks, runCount, options, callbacks ) {
let Runner = {
run(benchmarks, runCount, options, callbacks) {
// Queue // Queue
let Q = { const Q = {
functions: [], functions: [],
add(f) { add( f ) {
this.functions.push(f);
this.functions.push( f );
}, },
run() { run() {
if (this.functions.length > 0) {
if ( this.functions.length > 0 ) {
this.functions.shift()(); this.functions.shift()();
// We can't use |arguments.callee| here because |this| would get // We can't use |arguments.callee| here because |this| would get
// messed-up in that case. // messed-up in that case.
setTimeout(() => { Q.run(); }, 0); setTimeout( () => {
Q.run();
}, 0 );
} }
} }
}; };
@ -39,51 +48,65 @@ let Runner = {
// The enqueued functions share state, which is all stored in the properties // The enqueued functions share state, which is all stored in the properties
// of the |state| object. // of the |state| object.
let state = {}; const state = {};
function initialize() { function initialize() {
callbacks.start(); callbacks.start();
state.totalInputSize = 0; state.totalInputSize = 0;
state.totalParseTime = 0; state.totalParseTime = 0;
} }
function benchmarkInitializer(benchmark) { function benchmarkInitializer( benchmark ) {
return function() {
callbacks.benchmarkStart(benchmark); return function () {
callbacks.benchmarkStart( benchmark );
state.parser = peg.generate( state.parser = peg.generate(
callbacks.readFile("../../examples/" + benchmark.id + ".pegjs"), callbacks.readFile( "../../examples/" + benchmark.id + ".pegjs" ),
options options
); );
state.benchmarkInputSize = 0; state.benchmarkInputSize = 0;
state.benchmarkParseTime = 0; state.benchmarkParseTime = 0;
}; };
} }
function testRunner(benchmark, test) { function testRunner( benchmark, test ) {
return function() {
callbacks.testStart(benchmark, test); return function () {
let input = callbacks.readFile(benchmark.id + "/" + test.file); callbacks.testStart( benchmark, test );
const input = callbacks.readFile( benchmark.id + "/" + test.file );
let parseTime = 0; let parseTime = 0;
for (let i = 0; i < runCount; i++) { for ( let i = 0; i < runCount; i++ ) {
let t = (new Date()).getTime();
state.parser.parse(input); const t = ( new Date() ).getTime();
parseTime += (new Date()).getTime() - t; state.parser.parse( input );
parseTime += ( new Date() ).getTime() - t;
} }
let averageParseTime = parseTime / runCount; const averageParseTime = parseTime / runCount;
callbacks.testFinish(benchmark, test, input.length, averageParseTime); callbacks.testFinish( benchmark, test, input.length, averageParseTime );
state.benchmarkInputSize += input.length; state.benchmarkInputSize += input.length;
state.benchmarkParseTime += averageParseTime; state.benchmarkParseTime += averageParseTime;
}; };
} }
function benchmarkFinalizer(benchmark) { function benchmarkFinalizer( benchmark ) {
return function() {
return function () {
callbacks.benchmarkFinish( callbacks.benchmarkFinish(
benchmark, benchmark,
state.benchmarkInputSize, state.benchmarkInputSize,
@ -92,26 +115,35 @@ let Runner = {
state.totalInputSize += state.benchmarkInputSize; state.totalInputSize += state.benchmarkInputSize;
state.totalParseTime += state.benchmarkParseTime; state.totalParseTime += state.benchmarkParseTime;
}; };
} }
function finalize() { function finalize() {
callbacks.finish(state.totalInputSize, state.totalParseTime);
callbacks.finish( state.totalInputSize, state.totalParseTime );
} }
// Main // Main
Q.add(initialize); Q.add( initialize );
benchmarks.forEach(benchmark => { benchmarks.forEach( benchmark => {
Q.add(benchmarkInitializer(benchmark));
benchmark.tests.forEach(test => { Q.add( benchmarkInitializer( benchmark ) );
Q.add(testRunner(benchmark, test)); benchmark.tests.forEach( test => {
});
Q.add(benchmarkFinalizer(benchmark)); Q.add( testRunner( benchmark, test ) );
});
Q.add(finalize); } );
Q.add( benchmarkFinalizer( benchmark ) );
} );
Q.add( finalize );
Q.run(); Q.run();
} }
}; };

@ -1,150 +1,179 @@
#!/usr/bin/env node #!/usr/bin/env node
/* eslint camelcase:0, max-len:0, one-var:0 */
// //
// Measures impact of a Git commit (or multiple commits) on generated parsers // Measures impact of a Git commit (or multiple commits) on generated parsers
// speed and size. Makes sense to use only on PEG.js git repository checkout. // speed and size. Makes sense to use only on PEG.js git repository checkout.
// //
/* eslint prefer-const: 0 */
"use strict"; "use strict";
let child_process = require("child_process"); const child_process = require( "child_process" );
let fs = require("fs"); const fs = require( "fs" );
let os = require("os"); const os = require( "os" );
let path = require("path"); const path = require( "path" );
let glob = require("glob"); const dedent = require( "dedent" );
const glob = require( "glob" );
// Current Working Directory // Current Working Directory
let cwd = path.join(__dirname, ".."); const cwd = path.join( __dirname, ".." );
if ( process.cwd() !== cwd ) process.chdir( cwd );
if (process.cwd() !== cwd) {
process.chdir(cwd);
}
// Execution Files // Execution Files
let PEGJS_BIN = "bin/peg.js"; let PEGJS_BIN = "bin/peg.js";
let BENCHMARK_BIN = "test/benchmark/run"; let BENCHMARK_BIN = "test/benchmark/run";
if (!fs.existsSync(PEGJS_BIN)) { if ( ! fs.existsSync( PEGJS_BIN ) ) {
PEGJS_BIN = "bin/pegjs"; PEGJS_BIN = "bin/pegjs";
} }
if (!fs.existsSync(BENCHMARK_BIN)) { if ( ! fs.existsSync( BENCHMARK_BIN ) ) {
BENCHMARK_BIN = "benchmark/run"; BENCHMARK_BIN = "benchmark/run";
} }
// Utils // Utils
let print = console.log; function echo( message ) {
process.stdout.write( message );
function echo(message) {
process.stdout.write(message);
} }
function exec(command) { function exec( command ) {
return child_process.execSync(command, { encoding: "utf8" });
return child_process.execSync( command, { encoding: "utf8" } );
} }
function prepare(commit) { function prepare( commit ) {
exec(`git checkout --quiet "${commit}"`);
exec( `git checkout --quiet "${ commit }"` );
} }
function runBenchmark() { function runBenchmark() {
return parseFloat( return parseFloat(
exec("node " + BENCHMARK_BIN) exec( "node " + BENCHMARK_BIN )
// Split by table seprator, reverse and return the total bytes per second // Split by table seprator, reverse and return the total bytes per second
.split("│") .split( "│" )
.reverse()[1] .reverse()[ 1 ]
// Trim the whitespaces and remove ` kB/s` from the end // Trim the whitespaces and remove ` kB/s` from the end
.trim() .trim()
.slice(0, -5) .slice( 0, -5 )
); );
} }
function measureSpeed() { function measureSpeed() {
return (runBenchmark() + runBenchmark() + runBenchmark() + runBenchmark() + runBenchmark() / 5).toFixed(2);
return ( runBenchmark() + runBenchmark() + runBenchmark() + runBenchmark() + runBenchmark() / 5 ).toFixed( 2 );
} }
function measureSize() { function measureSize() {
let size = 0; let size = 0;
glob.sync("examples/*.pegjs") glob.sync( "examples/*.pegjs" )
.forEach(example => { .forEach( example => {
exec(`node ${PEGJS_BIN} ${example}`);
example = example.slice(0, -5) + "js"; exec( `node ${ PEGJS_BIN } ${ example }` );
size += fs.statSync(example).size; example = example.slice( 0, -5 ) + "js";
fs.unlinkSync(example); size += fs.statSync( example ).size;
}); fs.unlinkSync( example );
} );
return size; return size;
} }
function difference($1, $2) { function difference( $1, $2 ) {
return (($2 / $1 - 1) * 100).toFixed(4);
return ( ( $2 / $1 - 1 ) * 100 ).toFixed( 4 );
} }
// Prepare // Prepare
let argv = process.argv.slice(2); const argv = process.argv.slice( 2 );
let commit_before, commit_after; let commit_before, commit_after;
if (argv.length === 1) { if ( argv.length === 1 ) {
commit_before = argv[0] + "~1";
commit_after = argv[0]; commit_before = argv[ 0 ] + "~1";
} else if (argv.length === 2) { commit_after = argv[ 0 ];
commit_before = argv[0];
commit_after = argv[1]; } else if ( argv.length === 2 ) {
commit_before = argv[ 0 ];
commit_after = argv[ 1 ];
} else { } else {
print("Usage:");
print(""); console.log( dedent`
print(" test/impact <commit>");
print(" test/impact <commit_before> <commit_after>"); Usage:
print("");
print("Measures impact of a Git commit (or multiple commits) on generated parsers'"); test/impact <commit>
print("speed and size. Makes sense to use only on PEG.js Git repository checkout."); test/impact <commit_before> <commit_after>
print("");
process.exit(1); Measures impact of a Git commit (or multiple commits) on generated parser's
speed and size. Makes sense to use only on PEG.js Git repository checkout.
` );
process.exit( 1 );
} }
// Measure // Measure
let branch = exec("git rev-parse --abbrev-ref HEAD"); const branch = exec( "git rev-parse --abbrev-ref HEAD" );
let speed1, size1, speed2, size2; let speed1, size1, speed2, size2;
echo(`Measuring commit ${commit_before}...`); echo( `Measuring commit ${ commit_before }...` );
prepare(commit_before); prepare( commit_before );
speed1 = measureSpeed(); speed1 = measureSpeed();
size1 = measureSize(); size1 = measureSize();
echo(" OK" + os.EOL); echo( " OK" + os.EOL );
echo(`Measuring commit ${commit_after}...`); echo( `Measuring commit ${ commit_after }...` );
prepare(commit_after); prepare( commit_after );
speed2 = measureSpeed(); speed2 = measureSpeed();
size2 = measureSize(); size2 = measureSize();
echo(" OK" + os.EOL); echo( " OK" + os.EOL );
// Finish // Finish
prepare(branch); prepare( branch );
print(` console.log( dedent`
test/impact ${commit_before} ${commit_after}
test/impact ${ commit_before } ${ commit_after }
Speed impact Speed impact
------------ ------------
Before: ${speed1} kB/s Before: ${ speed1 } kB/s
After: ${speed2} kB/s After: ${ speed2 } kB/s
Difference: ${difference(parseFloat(speed1), parseFloat(speed2))}% Difference: ${ difference( parseFloat( speed1 ), parseFloat( speed2 ) ) }%
Size impact Size impact
----------- -----------
Before: ${size1} b Before: ${ size1 } b
After: ${size2} b After: ${ size2 } b
Difference: ${difference(size1, size2)}% Difference: ${ difference( size1, size2 ) }%
- Measured by /test/impact with Node.js ${ process.version }
- Your system: ${ os.type() } ${ os.release() } ${ os.arch() }.
- Measured by /test/impact with Node.js ${process.version} ` );
- Your system: ${os.type()} ${os.release()} ${os.arch()}.
`);

@ -2,31 +2,35 @@
"use strict"; "use strict";
let babelify = require("babelify"); const babelify = require( "babelify" );
let browserify = require("browserify"); const browserify = require( "browserify" );
let express = require("express"); const express = require( "express" );
let glob = require("glob"); const glob = require( "glob" );
let logger = require("morgan"); const logger = require( "morgan" );
let app = express(); const app = express();
app.use(logger("dev")); app.use( logger( "dev" ) );
app.use(express.static(__dirname)); app.use( express.static( __dirname ) );
app.use("/benchmark", express.static(`${__dirname}/../benchmark`)); app.use( "/benchmark", express.static( `${ __dirname }/../benchmark` ) );
app.use("/examples", express.static(`${__dirname}/../../examples`)); app.use( "/examples", express.static( `${ __dirname }/../../examples` ) );
app.get("/:dir/bundle.js", (req, res) => { app.get( "/:dir/bundle.js", ( req, res ) => {
browserify(glob.sync(
`${__dirname}/../${req.params.dir}/**/*.js` browserify( glob.sync(
)) `${ __dirname }/../${ req.params.dir }/**/*.js`
.transform(babelify, { ) )
.transform( babelify, {
presets: "es2015", presets: "es2015",
compact: false compact: false
}) } )
.bundle() .bundle()
.pipe(res); .pipe( res );
});
} );
app.listen( 8000, () => {
console.log( "Test server running at: http://localhost:8000/" );
app.listen(8000, () => { } );
console.log("Test server running at: http://localhost:8000/");
});

@ -1,64 +1,95 @@
"use strict"; "use strict";
/* global console */ const chai = require( "chai" );
const peg = require( "../../../lib/peg" );
let chai = require("chai"); const sinon = require( "sinon" );
let peg = require("../../../lib/peg");
let sinon = require("sinon"); const expect = chai.expect;
let expect = chai.expect; describe( "generated parser API", function () {
describe("generated parser API", function() { describe( "parse", function () {
describe("parse", function() {
it("parses input", function() { it( "parses input", function () {
let parser = peg.generate("start = 'a'");
const parser = peg.generate( "start = 'a'" );
expect(parser.parse("a")).to.equal("a"); expect( parser.parse( "a" ) ).to.equal( "a" );
});
} );
it("throws an exception on syntax error", function() {
let parser = peg.generate("start = 'a'"); it( "throws an exception on syntax error", function () {
expect(() => { parser.parse("b"); }).to.throw(); const parser = peg.generate( "start = 'a'" );
}); expect( () => {
describe("start rule", function() { parser.parse( "b" );
let parser = peg.generate([
"a = 'x' { return 'a'; }", } ).to.throw();
"b = 'x' { return 'b'; }",
"c = 'x' { return 'c'; }" } );
].join("\n"), { allowedStartRules: ["b", "c"] });
describe( "start rule", function () {
describe("when |startRule| is not set", function() {
it("starts parsing from the first allowed rule", function() { const parser = peg.generate( `
expect(parser.parse("x")).to.equal("b");
}); a = 'x' { return 'a'; }
}); b = 'x' { return 'b'; }
c = 'x' { return 'c'; }
describe("when |startRule| is set to an allowed rule", function() {
it("starts parsing from specified rule", function() { `, { allowedStartRules: [ "b", "c" ] } );
expect(parser.parse("x", { startRule: "b" })).to.equal("b");
expect(parser.parse("x", { startRule: "c" })).to.equal("c"); describe( "when |startRule| is not set", function () {
});
}); it( "starts parsing from the first allowed rule", function () {
describe("when |startRule| is set to a disallowed start rule", function() { expect( parser.parse( "x" ) ).to.equal( "b" );
it("throws an exception", function() {
expect(() => { parser.parse("x", { startRule: "a" }); }).to.throw(); } );
});
}); } );
});
describe( "when |startRule| is set to an allowed rule", function () {
describe("tracing", function() {
let parser = peg.generate([ it( "starts parsing from specified rule", function () {
"start = a / b",
"a = 'a'", expect( parser.parse( "x", { startRule: "b" } ) ).to.equal( "b" );
"b = 'b'" expect( parser.parse( "x", { startRule: "c" } ) ).to.equal( "c" );
].join("\n"), { trace: true });
} );
describe("default tracer", function() {
it("traces using console.log (if console is defined)", function() { } );
let messages = [
describe( "when |startRule| is set to a disallowed start rule", function () {
it( "throws an exception", function () {
expect( () => {
parser.parse( "x", { startRule: "a" } );
} ).to.throw();
} );
} );
} );
describe( "tracing", function () {
const parser = peg.generate( `
start = a / b
a = 'a'
b = 'b'
`, { trace: true } );
describe( "default tracer", function () {
it( "traces using console.log (if console is defined)", function () {
const messages = [
"1:1-1:1 rule.enter start", "1:1-1:1 rule.enter start",
"1:1-1:1 rule.enter a", "1:1-1:1 rule.enter a",
"1:1-1:1 rule.fail a", "1:1-1:1 rule.fail a",
@ -67,32 +98,41 @@ describe("generated parser API", function() {
"1:1-1:2 rule.match start" "1:1-1:2 rule.match start"
]; ];
if (typeof console === "object") { if ( typeof console === "object" ) sinon.stub( console, "log" );
sinon.stub(console, "log");
}
try { try {
parser.parse("b");
parser.parse( "b" );
if (typeof console === "object") {
expect(console.log.callCount).to.equal(messages.length); if ( typeof console === "object" ) {
messages.forEach((message, index) => {
let call = console.log.getCall(index); expect( console.log.callCount ).to.equal( messages.length );
expect(call.calledWithExactly(message)).to.equal(true); messages.forEach( ( message, index ) => {
});
const call = console.log.getCall( index );
expect( call.calledWithExactly( message ) ).to.equal( true );
} );
} }
} finally { } finally {
if (typeof console === "object") {
console.log.restore(); if ( typeof console === "object" ) console.log.restore();
}
} }
});
});
describe("custom tracers", function() { } );
describe("trace", function() {
it("receives tracing events", function() { } );
let events = [
describe( "custom tracers", function () {
describe( "trace", function () {
it( "receives tracing events", function () {
const events = [
{ {
type: "rule.enter", type: "rule.enter",
rule: "start", rule: "start",
@ -145,24 +185,32 @@ describe("generated parser API", function() {
} }
]; ];
let tracer = { trace: sinon.spy() }; const tracer = { trace: sinon.spy() };
parser.parse( "b", { tracer: tracer } );
expect( tracer.trace.callCount ).to.equal( events.length );
events.forEach( ( event, index ) => {
const call = tracer.trace.getCall( index );
expect( call.calledWithExactly( event ) ).to.equal( true );
} );
} );
} );
} );
} );
it( "accepts custom options", function () {
parser.parse("b", { tracer: tracer }); const parser = peg.generate( "start = 'a'" );
parser.parse( "a", { foo: 42 } );
expect(tracer.trace.callCount).to.equal(events.length); } );
events.forEach((event, index) => {
let call = tracer.trace.getCall(index);
expect(call.calledWithExactly(event)).to.equal(true);
});
});
});
});
});
it("accepts custom options", function() { } );
let parser = peg.generate("start = 'a'");
parser.parse("a", { foo: 42 }); } );
});
});
});

@ -1,197 +1,306 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let peg = require("../../../lib/peg"); const peg = require( "../../../lib/peg" );
let sinon = require("sinon"); const sinon = require( "sinon" );
let expect = chai.expect; const expect = chai.expect;
describe("PEG.js API", function() { describe( "PEG.js API", function () {
describe("generate", function() {
it("generates a parser", function() { describe( "generate", function () {
let parser = peg.generate("start = 'a'");
it( "generates a parser", function () {
expect(parser).to.be.an("object");
expect(parser.parse("a")).to.equal("a"); const parser = peg.generate( "start = 'a'" );
});
expect( parser ).to.be.an( "object" );
it("throws an exception on syntax error", function() { expect( parser.parse( "a" ) ).to.equal( "a" );
expect(() => { peg.generate("start = @"); }).to.throw();
}); } );
it("throws an exception on semantic error", function() { it( "throws an exception on syntax error", function () {
expect(() => { peg.generate("start = undefined"); }).to.throw();
}); expect( () => {
describe("allowed start rules", function() { peg.generate( "start = @" );
let grammar = [
"a = 'x'", } ).to.throw();
"b = 'x'",
"c = 'x'" } );
].join("\n");
it( "throws an exception on semantic error", function () {
it("throws an error on missing rule", function() {
expect(() => peg.generate(grammar, { expect( () => {
allowedStartRules: ["missing"]
})).to.throw(); peg.generate( "start = undefined" );
});
} ).to.throw();
} );
describe( "allowed start rules", function () {
const grammar = `
a = 'x'
b = 'x'
c = 'x'
`;
it( "throws an error on missing rule", function () {
expect( () => {
peg.generate( grammar, { allowedStartRules: [ "missing" ] } );
} ).to.throw();
} );
// The |allowedStartRules| option is implemented separately for each // The |allowedStartRules| option is implemented separately for each
// optimization mode, so we need to test it in both. // optimization mode, so we need to test it in both.
describe("when optimizing for parsing speed", function() { describe( "when optimizing for parsing speed", function () {
describe("when |allowedStartRules| is not set", function() {
it("generated parser can start only from the first rule", function() { describe( "when |allowedStartRules| is not set", function () {
let parser = peg.generate(grammar, { optimize: "speed" });
it( "generated parser can start only from the first rule", function () {
const parser = peg.generate( grammar, { optimize: "speed" } );
expect( parser.parse( "x", { startRule: "a" } ) ).to.equal( "x" );
expect( () => {
parser.parse( "x", { startRule: "b" } );
} ).to.throw();
expect( () => {
expect(parser.parse("x", { startRule: "a" })).to.equal("x"); parser.parse( "x", { startRule: "c" } );
expect(() => { parser.parse("x", { startRule: "b" }); }).to.throw();
expect(() => { parser.parse("x", { startRule: "c" }); }).to.throw();
});
});
describe("when |allowedStartRules| is set", function() { } ).to.throw();
it("generated parser can start only from specified rules", function() {
let parser = peg.generate(grammar, { } );
} );
describe( "when |allowedStartRules| is set", function () {
it( "generated parser can start only from specified rules", function () {
const parser = peg.generate( grammar, {
optimize: "speed", optimize: "speed",
allowedStartRules: ["b", "c"] allowedStartRules: [ "b", "c" ]
}); } );
expect(() => { parser.parse("x", { startRule: "a" }); }).to.throw(); expect( () => {
expect(parser.parse("x", { startRule: "b" })).to.equal("x");
expect(parser.parse("x", { startRule: "c" })).to.equal("x"); parser.parse( "x", { startRule: "a" } );
});
}); } ).to.throw();
}); expect( parser.parse( "x", { startRule: "b" } ) ).to.equal( "x" );
expect( parser.parse( "x", { startRule: "c" } ) ).to.equal( "x" );
describe("when optimizing for code size", function() {
describe("when |allowedStartRules| is not set", function() { } );
it("generated parser can start only from the first rule", function() {
let parser = peg.generate(grammar, { optimize: "size" }); } );
expect(parser.parse("x", { startRule: "a" })).to.equal("x"); } );
expect(() => { parser.parse("x", { startRule: "b" }); }).to.throw();
expect(() => { parser.parse("x", { startRule: "c" }); }).to.throw(); describe( "when optimizing for code size", function () {
});
}); describe( "when |allowedStartRules| is not set", function () {
describe("when |allowedStartRules| is set", function() { it( "generated parser can start only from the first rule", function () {
it("generated parser can start only from specified rules", function() {
let parser = peg.generate(grammar, { const parser = peg.generate( grammar, { optimize: "size" } );
expect( parser.parse( "x", { startRule: "a" } ) ).to.equal( "x" );
expect( () => {
parser.parse( "x", { startRule: "b" } );
} ).to.throw();
expect( () => {
parser.parse( "x", { startRule: "c" } );
} ).to.throw();
} );
} );
describe( "when |allowedStartRules| is set", function () {
it( "generated parser can start only from specified rules", function () {
const parser = peg.generate( grammar, {
optimize: "size", optimize: "size",
allowedStartRules: ["b", "c"] allowedStartRules: [ "b", "c" ]
}); } );
expect(() => { parser.parse("x", { startRule: "a" }); }).to.throw(); expect( () => {
expect(parser.parse("x", { startRule: "b" })).to.equal("x");
expect(parser.parse("x", { startRule: "c" })).to.equal("x"); parser.parse( "x", { startRule: "a" } );
});
}); } ).to.throw();
}); expect( parser.parse( "x", { startRule: "b" } ) ).to.equal( "x" );
}); expect( parser.parse( "x", { startRule: "c" } ) ).to.equal( "x" );
describe("intermediate results caching", function() { } );
let grammar = [
"{ var n = 0; }", } );
"start = (a 'b') / (a 'c') { return n; }",
"a = 'a' { n++; }" } );
].join("\n");
} );
describe("when |cache| is not set", function() {
it("generated parser doesn't cache intermediate parse results", function() { describe( "intermediate results caching", function () {
let parser = peg.generate(grammar);
const grammar = `
expect(parser.parse("ac")).to.equal(2);
}); { var n = 0; }
}); start = (a 'b') / (a 'c') { return n; }
a = 'a' { n++; }
describe("when |cache| is set to |false|", function() {
it("generated parser doesn't cache intermediate parse results", function() { `;
let parser = peg.generate(grammar, { cache: false });
describe( "when |cache| is not set", function () {
expect(parser.parse("ac")).to.equal(2);
}); it( "generated parser doesn't cache intermediate parse results", function () {
});
const parser = peg.generate( grammar );
describe("when |cache| is set to |true|", function() { expect( parser.parse( "ac" ) ).to.equal( 2 );
it("generated parser caches intermediate parse results", function() {
let parser = peg.generate(grammar, { cache: true }); } );
expect(parser.parse("ac")).to.equal(1); } );
});
}); describe( "when |cache| is set to |false|", function () {
});
it( "generated parser doesn't cache intermediate parse results", function () {
describe("tracing", function() {
let grammar = "start = 'a'"; const parser = peg.generate( grammar, { cache: false } );
expect( parser.parse( "ac" ) ).to.equal( 2 );
describe("when |trace| is not set", function() {
it("generated parser doesn't trace", function() { } );
let parser = peg.generate(grammar);
let tracer = { trace: sinon.spy() }; } );
parser.parse("a", { tracer: tracer }); describe( "when |cache| is set to |true|", function () {
expect(tracer.trace.called).to.equal(false); it( "generated parser caches intermediate parse results", function () {
});
}); const parser = peg.generate( grammar, { cache: true } );
expect( parser.parse( "ac" ) ).to.equal( 1 );
describe("when |trace| is set to |false|", function() {
it("generated parser doesn't trace", function() { } );
let parser = peg.generate(grammar, { trace: false });
let tracer = { trace: sinon.spy() }; } );
parser.parse("a", { tracer: tracer }); } );
expect(tracer.trace.called).to.equal(false); describe( "tracing", function () {
});
}); const grammar = "start = 'a'";
describe("when |trace| is set to |true|", function() { describe( "when |trace| is not set", function () {
it("generated parser traces", function() {
let parser = peg.generate(grammar, { trace: true }); it( "generated parser doesn't trace", function () {
let tracer = { trace: sinon.spy() };
const parser = peg.generate( grammar );
parser.parse("a", { tracer: tracer }); const tracer = { trace: sinon.spy() };
expect(tracer.trace.called).to.equal(true); parser.parse( "a", { tracer: tracer } );
});
}); expect( tracer.trace.called ).to.equal( false );
});
} );
} );
describe( "when |trace| is set to |false|", function () {
it( "generated parser doesn't trace", function () {
const parser = peg.generate( grammar, { trace: false } );
const tracer = { trace: sinon.spy() };
parser.parse( "a", { tracer: tracer } );
expect( tracer.trace.called ).to.equal( false );
} );
} );
describe( "when |trace| is set to |true|", function () {
it( "generated parser traces", function () {
const parser = peg.generate( grammar, { trace: true } );
const tracer = { trace: sinon.spy() };
parser.parse( "a", { tracer: tracer } );
expect( tracer.trace.called ).to.equal( true );
} );
} );
} );
// The |optimize| option isn't tested because there is no meaningful way to // The |optimize| option isn't tested because there is no meaningful way to
// write the tests without turning this into a performance test. // write the tests without turning this into a performance test.
describe("output", function() { describe( "output", function () {
let grammar = "start = 'a'";
const grammar = "start = 'a'";
describe( "when |output| is not set", function () {
it( "returns generated parser object", function () {
describe("when |output| is not set", function() { const parser = peg.generate( grammar );
it("returns generated parser object", function() {
let parser = peg.generate(grammar);
expect(parser).to.be.an("object"); expect( parser ).to.be.an( "object" );
expect(parser.parse("a")).to.equal("a"); expect( parser.parse( "a" ) ).to.equal( "a" );
});
});
describe("when |output| is set to |\"parser\"|", function() { } );
it("returns generated parser object", function() {
let parser = peg.generate(grammar, { output: "parser" });
expect(parser).to.be.an("object"); } );
expect(parser.parse("a")).to.equal("a");
});
});
describe("when |output| is set to |\"source\"|", function() { describe( "when |output| is set to |\"parser\"|", function () {
it("returns generated parser source code", function() {
let source = peg.generate(grammar, { output: "source" });
expect(source).to.be.a("string"); it( "returns generated parser object", function () {
expect(eval(source).parse("a")).to.equal("a");
}); const parser = peg.generate( grammar, { output: "parser" } );
});
}); expect( parser ).to.be.an( "object" );
expect( parser.parse( "a" ) ).to.equal( "a" );
} );
} );
describe( "when |output| is set to |\"source\"|", function () {
it( "returns generated parser source code", function () {
const source = peg.generate( grammar, { output: "source" } );
expect( source ).to.be.a( "string" );
expect( eval( source ).parse( "a" ) ).to.equal( "a" );
} );
} );
} );
// The |format|, |exportVars|, and |dependencies| options are not tested // The |format|, |exportVars|, and |dependencies| options are not tested
// becasue there is no meaningful way to thest their effects without turning // becasue there is no meaningful way to thest their effects without turning
@ -199,8 +308,12 @@ describe("PEG.js API", function() {
// The |plugins| option is tested in plugin API tests. // The |plugins| option is tested in plugin API tests.
it("accepts custom options", function() { it( "accepts custom options", function () {
peg.generate("start = 'a'", { foo: 42 });
}); peg.generate( "start = 'a'", { foo: 42 } );
});
}); } );
} );
} );

@ -1,128 +1,185 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let peg = require("../../../lib/peg"); const peg = require( "../../../lib/peg" );
let expect = chai.expect; const expect = chai.expect;
describe("plugin API", function() { describe( "plugin API", function () {
describe("use", function() {
let grammar = "start = 'a'";
it("is called for each plugin", function() { describe( "use", function () {
let pluginsUsed = [false, false, false];
let plugins = [ const grammar = "start = 'a'";
{ use() { pluginsUsed[0] = true; } },
{ use() { pluginsUsed[1] = true; } }, it( "is called for each plugin", function () {
{ use() { pluginsUsed[2] = true; } }
const pluginsUsed = [ false, false, false ];
const plugins = [
{ use() {
pluginsUsed[ 0 ] = true;
} },
{ use() {
pluginsUsed[ 1 ] = true;
} },
{ use() {
pluginsUsed[ 2 ] = true;
} }
]; ];
peg.generate(grammar, { plugins: plugins }); peg.generate( grammar, { plugins: plugins } );
expect( pluginsUsed ).to.deep.equal( [ true, true, true ] );
} );
it( "receives configuration", function () {
const plugin = {
use( config ) {
expect( config ).to.be.an( "object" );
expect(pluginsUsed).to.deep.equal([true, true, true]); expect( config.parser ).to.be.an( "object" );
}); expect( config.parser.parse( "start = 'a'" ) ).to.be.an( "object" );
it("receives configuration", function() { expect( config.passes ).to.be.an( "object" );
let plugin = {
use(config) {
expect(config).to.be.an("object");
expect(config.parser).to.be.an("object"); expect( config.passes.check ).to.be.an( "array" );
expect(config.parser.parse("start = 'a'")).to.be.an("object"); config.passes.check.forEach( pass => {
expect(config.passes).to.be.an("object"); expect( pass ).to.be.a( "function" );
expect(config.passes.check).to.be.an("array"); } );
config.passes.check.forEach(pass => {
expect(pass).to.be.a("function");
});
expect(config.passes.transform).to.be.an("array"); expect( config.passes.transform ).to.be.an( "array" );
config.passes.transform.forEach(pass => { config.passes.transform.forEach( pass => {
expect(pass).to.be.a("function");
}); expect( pass ).to.be.a( "function" );
} );
expect( config.passes.generate ).to.be.an( "array" );
config.passes.generate.forEach( pass => {
expect( pass ).to.be.a( "function" );
} );
expect(config.passes.generate).to.be.an("array");
config.passes.generate.forEach(pass => {
expect(pass).to.be.a("function");
});
} }
}; };
peg.generate(grammar, { plugins: [plugin] }); peg.generate( grammar, { plugins: [ plugin ] } );
});
} );
it( "receives options", function () {
const generateOptions = {
plugins: [ {
use( config, options ) {
expect( options ).to.equal( generateOptions );
it("receives options", function() {
let plugin = {
use(config, options) {
expect(options).to.equal(generateOptions);
} }
} ],
foo: 42
}; };
let generateOptions = { plugins: [plugin], foo: 42 };
peg.generate( grammar, generateOptions );
peg.generate(grammar, generateOptions);
}); } );
it("can replace parser", function() { it( "can replace parser", function () {
let plugin = {
use(config) { const plugin = {
let parser = peg.generate([ use( config ) {
"start = .* {",
" return {", config.parser = peg.generate( `
" type: 'grammar',",
" rules: [", start = .* {
" {", return {
" type: 'rule',", type: 'grammar',
" name: 'start',", rules: [{
" expression: { type: 'literal', value: text(), ignoreCase: false }", type: 'rule',
" }", name: 'start',
" ]", expression: {
" };", type: 'literal',
"}" value: text(),
].join("\n")); ignoreCase: false
config.parser = parser;
} }
}]
}; };
let parser = peg.generate("a", { plugins: [plugin] }); }
` );
}
};
const parser = peg.generate( "a", { plugins: [ plugin ] } );
expect( parser.parse( "a" ) ).to.equal( "a" );
expect(parser.parse("a")).to.equal("a"); } );
});
it( "can change compiler passes", function () {
const plugin = {
use( config ) {
function pass( ast ) {
it("can change compiler passes", function() {
let plugin = {
use(config) {
function pass(ast) {
ast.code = "({ parse: function() { return 42; } })"; ast.code = "({ parse: function() { return 42; } })";
} }
config.passes.generate = [pass]; config.passes.generate = [ pass ];
} }
}; };
let parser = peg.generate(grammar, { plugins: [plugin] });
const parser = peg.generate( grammar, { plugins: [ plugin ] } );
expect(parser.parse("a")).to.equal(42); expect( parser.parse( "a" ) ).to.equal( 42 );
});
} );
it("can change options", function() {
let grammar = [ it( "can change options", function () {
"a = 'x'",
"b = 'x'", const grammar = `
"c = 'x'"
].join("\n"); a = 'x'
let plugin = { b = 'x'
use(config, options) { c = 'x'
options.allowedStartRules = ["b", "c"];
`;
const plugin = {
use( config, options ) {
options.allowedStartRules = [ "b", "c" ];
} }
}; };
let parser = peg.generate(grammar, {
allowedStartRules: ["a"], const parser = peg.generate( grammar, {
plugins: [plugin] allowedStartRules: [ "a" ],
}); plugins: [ plugin ]
} );
expect(() => { parser.parse("x", { startRule: "a" }); }).to.throw();
expect(parser.parse("x", { startRule: "b" })).to.equal("x"); expect( () => {
expect(parser.parse("x", { startRule: "c" })).to.equal("x");
}); parser.parse( "x", { startRule: "a" } );
});
}); } ).to.throw();
expect( parser.parse( "x", { startRule: "b" } ) ).to.equal( "x" );
expect( parser.parse( "x", { startRule: "c" } ) ).to.equal( "x" );
} );
} );
} );

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

@ -1,90 +1,112 @@
"use strict"; "use strict";
let parser = require("../../../../../lib/parser"); const parser = require( "../../../../../lib/parser" );
module.exports = function(chai, utils) { module.exports = function ( chai, utils ) {
let Assertion = chai.Assertion;
Assertion.addMethod("changeAST", function(grammar, props, options) { const Assertion = chai.Assertion;
options = options !== undefined ? options : {};
function matchProps(value, props) { Assertion.addMethod( "changeAST", function ( grammar, props, options ) {
function isArray(value) {
return Object.prototype.toString.apply(value) === "[object Array]"; options = typeof options !== "undefined" ? options : {};
}
function matchProps( value, props ) {
function isObject( value ) {
function isObject(value) {
return value !== null && typeof value === "object"; return value !== null && typeof value === "object";
} }
if (isArray(props)) { if ( Array.isArray( props ) ) {
if (!isArray(value)) { return false; }
if ( ! Array.isArray( value ) ) return false;
if ( value.length !== props.length ) return false;
for ( let i = 0; i < props.length; i++ ) {
if ( ! matchProps( value[ i ], props[ i ] ) ) return false;
if (value.length !== props.length) { return false; }
for (let i = 0; i < props.length; i++) {
if (!matchProps(value[i], props[i])) { return false; }
} }
return true; return true;
} else if (isObject(props)) {
if (!isObject(value)) { return false; }
let keys = Object.keys(props); } else if ( isObject( props ) ) {
for (let i = 0; i < keys.length; i++) {
let key = keys[i]; if ( ! isObject( value ) ) return false;
const keys = Object.keys( props );
for ( let i = 0; i < keys.length; i++ ) {
const key = keys[ i ];
if (!(key in value)) { return false; } if ( ! ( key in value ) ) return false;
if ( ! matchProps( value[ key ], props[ key ] ) ) return false;
if (!matchProps(value[key], props[key])) { return false; }
} }
return true; return true;
} else {
return value === props;
} }
return value === props;
} }
let ast = parser.parse(grammar); const ast = parser.parse( grammar );
utils.flag(this, "object")(ast, options); utils.flag( this, "object" )( ast, options );
this.assert( this.assert(
matchProps(ast, props), matchProps( ast, props ),
"expected #{this} to change the AST to match #{exp}", "expected #{this} to change the AST to match #{exp}",
"expected #{this} to not change the AST to match #{exp}", "expected #{this} to not change the AST to match #{exp}",
props, props,
ast ast
); );
});
Assertion.addMethod("reportError", function(grammar, props, options) { } );
options = options !== undefined ? options : {};
Assertion.addMethod( "reportError", function ( grammar, props, options ) {
options = typeof options !== "undefined" ? options : {};
let ast = parser.parse(grammar); const ast = parser.parse( grammar );
let passed, result; let passed, result;
try { try {
utils.flag(this, "object")(ast, options);
utils.flag( this, "object" )( ast, options );
passed = true; passed = true;
} catch (e) {
} catch ( e ) {
result = e; result = e;
passed = false; passed = false;
} }
this.assert( this.assert(
!passed, ! passed,
"expected #{this} to report an error but it didn't", "expected #{this} to report an error but it didn't",
"expected #{this} to not report an error but #{act} was reported", "expected #{this} to not report an error but #{act} was reported",
null, null,
result result
); );
if (!passed && props !== undefined) { if ( ! passed && typeof props !== "undefined" ) {
Object.keys(props).forEach(key => {
new Assertion(result).to.have.property(key) Object.keys( props ).forEach( key => {
.that.is.deep.equal(props[key]);
}); new Assertion( result )
.to.have.property( key )
.that.is.deep.equal( props[ key ] );
} );
} }
});
} );
}; };

@ -1,22 +1,25 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let helpers = require("./helpers"); const helpers = require( "./helpers" );
let pass = require("../../../../../lib/compiler/passes/remove-proxy-rules"); const pass = require( "../../../../../lib/compiler/passes/remove-proxy-rules" );
chai.use(helpers); chai.use( helpers );
let expect = chai.expect; const expect = chai.expect;
describe("compiler pass |removeProxyRules|", function() { describe( "compiler pass |removeProxyRules|", function () {
describe("when a proxy rule isn't listed in |allowedStartRules|", function() {
it("updates references and removes it", function() { describe( "when a proxy rule isn't listed in |allowedStartRules|", function () {
expect(pass).to.changeAST(
it( "updates references and removes it", function () {
expect( pass ).to.changeAST(
[ [
"start = proxy", "start = proxy",
"proxy = proxied", "proxy = proxied",
"proxied = 'a'" "proxied = 'a'"
].join("\n"), ].join( "\n" ),
{ {
rules: [ rules: [
{ {
@ -26,19 +29,23 @@ describe("compiler pass |removeProxyRules|", function() {
{ name: "proxied" } { name: "proxied" }
] ]
}, },
{ allowedStartRules: ["start"] } { allowedStartRules: [ "start" ] }
); );
});
});
describe("when a proxy rule is listed in |allowedStartRules|", function() { } );
it("updates references but doesn't remove it", function() {
expect(pass).to.changeAST( } );
describe( "when a proxy rule is listed in |allowedStartRules|", function () {
it( "updates references but doesn't remove it", function () {
expect( pass ).to.changeAST(
[ [
"start = proxy", "start = proxy",
"proxy = proxied", "proxy = proxied",
"proxied = 'a'" "proxied = 'a'"
].join("\n"), ].join( "\n" ),
{ {
rules: [ rules: [
{ {
@ -52,8 +59,11 @@ describe("compiler pass |removeProxyRules|", function() {
{ name: "proxied" } { name: "proxied" }
] ]
}, },
{ allowedStartRules: ["start", "proxy"] } { allowedStartRules: [ "start", "proxy" ] }
); );
});
}); } );
});
} );
} );

@ -1,63 +1,83 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let helpers = require("./helpers"); const helpers = require( "./helpers" );
let pass = require("../../../../../lib/compiler/passes/report-duplicate-labels"); const pass = require( "../../../../../lib/compiler/passes/report-duplicate-labels" );
chai.use(helpers); chai.use( helpers );
let expect = chai.expect; const expect = chai.expect;
describe("compiler pass |reportDuplicateLabels|", function() { describe( "compiler pass |reportDuplicateLabels|", function () {
describe("in a sequence", function() {
it("reports labels duplicate with labels of preceding elements", function() { describe( "in a sequence", function () {
expect(pass).to.reportError("start = a:'a' a:'a'", {
it( "reports labels duplicate with labels of preceding elements", function () {
expect( pass ).to.reportError( "start = a:'a' a:'a'", {
message: "Label \"a\" is already defined at line 1, column 9.", message: "Label \"a\" is already defined at line 1, column 9.",
location: { location: {
start: { offset: 14, line: 1, column: 15 }, start: { offset: 14, line: 1, column: 15 },
end: { offset: 19, line: 1, column: 20 } end: { offset: 19, line: 1, column: 20 }
} }
}); } );
});
} );
it("doesn't report labels duplicate with labels in subexpressions", function() {
expect(pass).to.not.reportError("start = ('a' / a:'a' / 'a') a:'a'"); it( "doesn't report labels duplicate with labels in subexpressions", function () {
expect(pass).to.not.reportError("start = (a:'a' { }) a:'a'");
expect(pass).to.not.reportError("start = ('a' a:'a' 'a') a:'a'"); expect( pass ).to.not.reportError( "start = ('a' / a:'a' / 'a') a:'a'" );
expect(pass).to.not.reportError("start = b:(a:'a') a:'a'"); expect( pass ).to.not.reportError( "start = (a:'a' { }) a:'a'" );
expect(pass).to.not.reportError("start = $(a:'a') a:'a'"); expect( pass ).to.not.reportError( "start = ('a' a:'a' 'a') a:'a'" );
expect(pass).to.not.reportError("start = &(a:'a') a:'a'"); expect( pass ).to.not.reportError( "start = b:(a:'a') a:'a'" );
expect(pass).to.not.reportError("start = !(a:'a') a:'a'"); expect( pass ).to.not.reportError( "start = $(a:'a') a:'a'" );
expect(pass).to.not.reportError("start = (a:'a')? a:'a'"); expect( pass ).to.not.reportError( "start = &(a:'a') a:'a'" );
expect(pass).to.not.reportError("start = (a:'a')* a:'a'"); expect( pass ).to.not.reportError( "start = !(a:'a') a:'a'" );
expect(pass).to.not.reportError("start = (a:'a')+ a:'a'"); expect( pass ).to.not.reportError( "start = (a:'a')? a:'a'" );
expect(pass).to.not.reportError("start = (a:'a') a:'a'"); expect( pass ).to.not.reportError( "start = (a:'a')* a:'a'" );
}); expect( pass ).to.not.reportError( "start = (a:'a')+ a:'a'" );
}); expect( pass ).to.not.reportError( "start = (a:'a') a:'a'" );
describe("in a choice", function() { } );
it("doesn't report labels duplicate with labels of preceding alternatives", function() {
expect(pass).to.not.reportError("start = a:'a' / a:'a'"); } );
});
}); describe( "in a choice", function () {
describe("in outer sequence", function() { it( "doesn't report labels duplicate with labels of preceding alternatives", function () {
it("reports labels duplicate with labels of preceding elements", function() {
expect(pass).to.reportError("start = a:'a' (a:'a')", { expect( pass ).to.not.reportError( "start = a:'a' / a:'a'" );
} );
} );
describe( "in outer sequence", function () {
it( "reports labels duplicate with labels of preceding elements", function () {
expect( pass ).to.reportError( "start = a:'a' (a:'a')", {
message: "Label \"a\" is already defined at line 1, column 9.", message: "Label \"a\" is already defined at line 1, column 9.",
location: { location: {
start: { offset: 15, line: 1, column: 16 }, start: { offset: 15, line: 1, column: 16 },
end: { offset: 20, line: 1, column: 21 } end: { offset: 20, line: 1, column: 21 }
} }
}); } );
});
} );
it("doesn't report labels duplicate with the label of the current element", function() {
expect(pass).to.not.reportError("start = a:(a:'a')"); it( "doesn't report labels duplicate with the label of the current element", function () {
});
expect( pass ).to.not.reportError( "start = a:(a:'a')" );
it("doesn't report labels duplicate with labels of following elements", function() {
expect(pass).to.not.reportError("start = (a:'a') a:'a'"); } );
});
}); it( "doesn't report labels duplicate with labels of following elements", function () {
});
expect( pass ).to.not.reportError( "start = (a:'a') a:'a'" );
} );
} );
} );

@ -1,24 +1,28 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let helpers = require("./helpers"); const helpers = require( "./helpers" );
let pass = require("../../../../../lib/compiler/passes/report-duplicate-rules"); const pass = require( "../../../../../lib/compiler/passes/report-duplicate-rules" );
chai.use(helpers); chai.use( helpers );
let expect = chai.expect; const expect = chai.expect;
describe("compiler pass |reportDuplicateRules|", function() { describe( "compiler pass |reportDuplicateRules|", function () {
it("reports duplicate rules", function() {
expect(pass).to.reportError([ it( "reports duplicate rules", function () {
expect( pass ).to.reportError( [
"start = 'a'", "start = 'a'",
"start = 'b'" "start = 'b'"
].join("\n"), { ].join( "\n" ), {
message: "Rule \"start\" is already defined at line 1, column 1.", message: "Rule \"start\" is already defined at line 1, column 1.",
location: { location: {
start: { offset: 12, line: 2, column: 1 }, start: { offset: 12, line: 2, column: 1 },
end: { offset: 23, line: 2, column: 12 } end: { offset: 23, line: 2, column: 12 }
} }
}); } );
});
}); } );
} );

@ -1,119 +1,135 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let helpers = require("./helpers"); const helpers = require( "./helpers" );
let pass = require("../../../../../lib/compiler/passes/report-infinite-recursion"); const pass = require( "../../../../../lib/compiler/passes/report-infinite-recursion" );
chai.use(helpers); chai.use( helpers );
let expect = chai.expect; const expect = chai.expect;
describe("compiler pass |reportInfiniteRecursion|", function() { describe( "compiler pass |reportInfiniteRecursion|", function () {
it("reports direct left recursion", function() {
expect(pass).to.reportError("start = start", { it( "reports direct left recursion", function () {
expect( pass ).to.reportError( "start = start", {
message: "Possible infinite loop when parsing (left recursion: start -> start).", message: "Possible infinite loop when parsing (left recursion: start -> start).",
location: { location: {
start: { offset: 8, line: 1, column: 9 }, start: { offset: 8, line: 1, column: 9 },
end: { offset: 13, line: 1, column: 14 } end: { offset: 13, line: 1, column: 14 }
} }
}); } );
});
} );
it( "reports indirect left recursion", function () {
it("reports indirect left recursion", function() { expect( pass ).to.reportError( [
expect(pass).to.reportError([
"start = stop", "start = stop",
"stop = start" "stop = start"
].join("\n"), { ].join( "\n" ), {
message: "Possible infinite loop when parsing (left recursion: start -> stop -> start).", message: "Possible infinite loop when parsing (left recursion: start -> stop -> start).",
location: { location: {
start: { offset: 20, line: 2, column: 8 }, start: { offset: 20, line: 2, column: 8 },
end: { offset: 25, line: 2, column: 13 } end: { offset: 25, line: 2, column: 13 }
} }
}); } );
});
} );
describe( "in sequences", function () {
it( "reports left recursion if all preceding elements match empty string", function () {
expect( pass ).to.reportError( "start = '' '' '' start" );
describe("in sequences", function() { } );
it("reports left recursion if all preceding elements match empty string", function() {
expect(pass).to.reportError("start = '' '' '' start");
});
it("doesn't report left recursion if some preceding element doesn't match empty string", function() { it( "doesn't report left recursion if some preceding element doesn't match empty string", function () {
expect(pass).to.not.reportError("start = 'a' '' '' start");
expect(pass).to.not.reportError("start = '' 'a' '' start"); expect( pass ).to.not.reportError( "start = 'a' '' '' start" );
expect(pass).to.not.reportError("start = '' '' 'a' start"); expect( pass ).to.not.reportError( "start = '' 'a' '' start" );
}); expect( pass ).to.not.reportError( "start = '' '' 'a' start" );
} );
// Regression test for #359. // Regression test for #359.
it("reports left recursion when rule reference is wrapped in an expression", function() { it( "reports left recursion when rule reference is wrapped in an expression", function () {
expect(pass).to.reportError("start = '' start?");
}); expect( pass ).to.reportError( "start = '' start?" );
} );
it("computes expressions that always consume input on success correctly", function() { it( "computes expressions that always consume input on success correctly", function () {
expect(pass).to.reportError([
expect( pass ).to.reportError( [
"start = a start", "start = a start",
"a 'a' = ''" "a 'a' = ''"
].join("\n")); ].join( "\n" ) );
expect(pass).to.not.reportError([ expect( pass ).to.not.reportError( [
"start = a start", "start = a start",
"a 'a' = 'a'" "a 'a' = 'a'"
].join("\n")); ].join( "\n" ) );
expect(pass).to.reportError("start = ('' / 'a' / 'b') start"); expect( pass ).to.reportError( "start = ('' / 'a' / 'b') start" );
expect(pass).to.reportError("start = ('a' / '' / 'b') start"); expect( pass ).to.reportError( "start = ('a' / '' / 'b') start" );
expect(pass).to.reportError("start = ('a' / 'b' / '') start"); expect( pass ).to.reportError( "start = ('a' / 'b' / '') start" );
expect(pass).to.not.reportError("start = ('a' / 'b' / 'c') start"); expect( pass ).to.not.reportError( "start = ('a' / 'b' / 'c') start" );
expect(pass).to.reportError("start = ('' { }) start"); expect( pass ).to.reportError( "start = ('' { }) start" );
expect(pass).to.not.reportError("start = ('a' { }) start"); expect( pass ).to.not.reportError( "start = ('a' { }) start" );
expect(pass).to.reportError("start = ('' '' '') start"); expect( pass ).to.reportError( "start = ('' '' '') start" );
expect(pass).to.not.reportError("start = ('a' '' '') start"); expect( pass ).to.not.reportError( "start = ('a' '' '') start" );
expect(pass).to.not.reportError("start = ('' 'a' '') start"); expect( pass ).to.not.reportError( "start = ('' 'a' '') start" );
expect(pass).to.not.reportError("start = ('' '' 'a') start"); expect( pass ).to.not.reportError( "start = ('' '' 'a') start" );
expect(pass).to.reportError("start = a:'' start"); expect( pass ).to.reportError( "start = a:'' start" );
expect(pass).to.not.reportError("start = a:'a' start"); expect( pass ).to.not.reportError( "start = a:'a' start" );
expect(pass).to.reportError("start = $'' start"); expect( pass ).to.reportError( "start = $'' start" );
expect(pass).to.not.reportError("start = $'a' start"); expect( pass ).to.not.reportError( "start = $'a' start" );
expect(pass).to.reportError("start = &'' start"); expect( pass ).to.reportError( "start = &'' start" );
expect(pass).to.reportError("start = &'a' start"); expect( pass ).to.reportError( "start = &'a' start" );
expect(pass).to.reportError("start = !'' start"); expect( pass ).to.reportError( "start = !'' start" );
expect(pass).to.reportError("start = !'a' start"); expect( pass ).to.reportError( "start = !'a' start" );
expect(pass).to.reportError("start = ''? start"); expect( pass ).to.reportError( "start = ''? start" );
expect(pass).to.reportError("start = 'a'? start"); expect( pass ).to.reportError( "start = 'a'? start" );
expect(pass).to.reportError("start = ''* start"); expect( pass ).to.reportError( "start = ''* start" );
expect(pass).to.reportError("start = 'a'* start"); expect( pass ).to.reportError( "start = 'a'* start" );
expect(pass).to.reportError("start = ''+ start"); expect( pass ).to.reportError( "start = ''+ start" );
expect(pass).to.not.reportError("start = 'a'+ start"); expect( pass ).to.not.reportError( "start = 'a'+ start" );
expect(pass).to.reportError("start = ('') start"); expect( pass ).to.reportError( "start = ('') start" );
expect(pass).to.not.reportError("start = ('a') start"); expect( pass ).to.not.reportError( "start = ('a') start" );
expect(pass).to.reportError("start = &{ } start"); expect( pass ).to.reportError( "start = &{ } start" );
expect(pass).to.reportError("start = !{ } start"); expect( pass ).to.reportError( "start = !{ } start" );
expect(pass).to.reportError([ expect( pass ).to.reportError( [
"start = a start", "start = a start",
"a = ''" "a = ''"
].join("\n")); ].join( "\n" ) );
expect(pass).to.not.reportError([ expect( pass ).to.not.reportError( [
"start = a start", "start = a start",
"a = 'a'" "a = 'a'"
].join("\n")); ].join( "\n" ) );
expect( pass ).to.reportError( "start = '' start" );
expect( pass ).to.not.reportError( "start = 'a' start" );
expect( pass ).to.not.reportError( "start = [a-d] start" );
expect( pass ).to.not.reportError( "start = . start" );
expect(pass).to.reportError("start = '' start"); } );
expect(pass).to.not.reportError("start = 'a' start");
expect(pass).to.not.reportError("start = [a-d] start"); } );
expect(pass).to.not.reportError("start = . start"); } );
});
});
});

@ -1,99 +1,107 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let helpers = require("./helpers"); const helpers = require( "./helpers" );
let pass = require("../../../../../lib/compiler/passes/report-infinite-repetition"); const pass = require( "../../../../../lib/compiler/passes/report-infinite-repetition" );
chai.use(helpers); chai.use( helpers );
let expect = chai.expect; const expect = chai.expect;
describe("compiler pass |reportInfiniteRepetition|", function() { describe( "compiler pass |reportInfiniteRepetition|", function () {
it("reports infinite loops for zero_or_more", function() {
expect(pass).to.reportError("start = ('')*", { it( "reports infinite loops for zero_or_more", function () {
expect( pass ).to.reportError( "start = ('')*", {
message: "Possible infinite loop when parsing (repetition used with an expression that may not consume any input).", message: "Possible infinite loop when parsing (repetition used with an expression that may not consume any input).",
location: { location: {
start: { offset: 8, line: 1, column: 9 }, start: { offset: 8, line: 1, column: 9 },
end: { offset: 13, line: 1, column: 14 } end: { offset: 13, line: 1, column: 14 }
} }
}); } );
});
} );
it( "reports infinite loops for one_or_more", function () {
it("reports infinite loops for one_or_more", function() { expect( pass ).to.reportError( "start = ('')+", {
expect(pass).to.reportError("start = ('')+", {
message: "Possible infinite loop when parsing (repetition used with an expression that may not consume any input).", message: "Possible infinite loop when parsing (repetition used with an expression that may not consume any input).",
location: { location: {
start: { offset: 8, line: 1, column: 9 }, start: { offset: 8, line: 1, column: 9 },
end: { offset: 13, line: 1, column: 14 } end: { offset: 13, line: 1, column: 14 }
} }
}); } );
});
it("computes expressions that always consume input on success correctly", function() { } );
expect(pass).to.reportError([
it( "computes expressions that always consume input on success correctly", function () {
expect( pass ).to.reportError( [
"start = a*", "start = a*",
"a 'a' = ''" "a 'a' = ''"
].join("\n")); ].join( "\n" ) );
expect(pass).to.not.reportError([ expect( pass ).to.not.reportError( [
"start = a*", "start = a*",
"a 'a' = 'a'" "a 'a' = 'a'"
].join("\n")); ].join( "\n" ) );
expect(pass).to.reportError("start = ('' / 'a' / 'b')*"); expect( pass ).to.reportError( "start = ('' / 'a' / 'b')*" );
expect(pass).to.reportError("start = ('a' / '' / 'b')*"); expect( pass ).to.reportError( "start = ('a' / '' / 'b')*" );
expect(pass).to.reportError("start = ('a' / 'b' / '')*"); expect( pass ).to.reportError( "start = ('a' / 'b' / '')*" );
expect(pass).to.not.reportError("start = ('a' / 'b' / 'c')*"); expect( pass ).to.not.reportError( "start = ('a' / 'b' / 'c')*" );
expect(pass).to.reportError("start = ('' { })*"); expect( pass ).to.reportError( "start = ('' { })*" );
expect(pass).to.not.reportError("start = ('a' { })*"); expect( pass ).to.not.reportError( "start = ('a' { })*" );
expect(pass).to.reportError("start = ('' '' '')*"); expect( pass ).to.reportError( "start = ('' '' '')*" );
expect(pass).to.not.reportError("start = ('a' '' '')*"); expect( pass ).to.not.reportError( "start = ('a' '' '')*" );
expect(pass).to.not.reportError("start = ('' 'a' '')*"); expect( pass ).to.not.reportError( "start = ('' 'a' '')*" );
expect(pass).to.not.reportError("start = ('' '' 'a')*"); expect( pass ).to.not.reportError( "start = ('' '' 'a')*" );
expect(pass).to.reportError("start = (a:'')*"); expect( pass ).to.reportError( "start = (a:'')*" );
expect(pass).to.not.reportError("start = (a:'a')*"); expect( pass ).to.not.reportError( "start = (a:'a')*" );
expect(pass).to.reportError("start = ($'')*"); expect( pass ).to.reportError( "start = ($'')*" );
expect(pass).to.not.reportError("start = ($'a')*"); expect( pass ).to.not.reportError( "start = ($'a')*" );
expect(pass).to.reportError("start = (&'')*"); expect( pass ).to.reportError( "start = (&'')*" );
expect(pass).to.reportError("start = (&'a')*"); expect( pass ).to.reportError( "start = (&'a')*" );
expect(pass).to.reportError("start = (!'')*"); expect( pass ).to.reportError( "start = (!'')*" );
expect(pass).to.reportError("start = (!'a')*"); expect( pass ).to.reportError( "start = (!'a')*" );
expect(pass).to.reportError("start = (''?)*"); expect( pass ).to.reportError( "start = (''?)*" );
expect(pass).to.reportError("start = ('a'?)*"); expect( pass ).to.reportError( "start = ('a'?)*" );
expect(pass).to.reportError("start = (''*)*"); expect( pass ).to.reportError( "start = (''*)*" );
expect(pass).to.reportError("start = ('a'*)*"); expect( pass ).to.reportError( "start = ('a'*)*" );
expect(pass).to.reportError("start = (''+)*"); expect( pass ).to.reportError( "start = (''+)*" );
expect(pass).to.not.reportError("start = ('a'+)*"); expect( pass ).to.not.reportError( "start = ('a'+)*" );
expect(pass).to.reportError("start = ('')*"); expect( pass ).to.reportError( "start = ('')*" );
expect(pass).to.not.reportError("start = ('a')*"); expect( pass ).to.not.reportError( "start = ('a')*" );
expect(pass).to.reportError("start = (&{ })*"); expect( pass ).to.reportError( "start = (&{ })*" );
expect(pass).to.reportError("start = (!{ })*"); expect( pass ).to.reportError( "start = (!{ })*" );
expect(pass).to.reportError([ expect( pass ).to.reportError( [
"start = a*", "start = a*",
"a = ''" "a = ''"
].join("\n")); ].join( "\n" ) );
expect(pass).to.not.reportError([ expect( pass ).to.not.reportError( [
"start = a*", "start = a*",
"a = 'a'" "a = 'a'"
].join("\n")); ].join( "\n" ) );
expect( pass ).to.reportError( "start = ''*" );
expect( pass ).to.not.reportError( "start = 'a'*" );
expect( pass ).to.not.reportError( "start = [a-d]*" );
expect(pass).to.reportError("start = ''*"); expect( pass ).to.not.reportError( "start = .*" );
expect(pass).to.not.reportError("start = 'a'*");
expect(pass).to.not.reportError("start = [a-d]*"); } );
expect(pass).to.not.reportError("start = .*"); } );
});
});

@ -1,29 +1,35 @@
"use strict"; "use strict";
let chai = require("chai"); const chai = require( "chai" );
let helpers = require("./helpers"); const helpers = require( "./helpers" );
let pass = require("../../../../../lib/compiler/passes/report-undefined-rules"); const pass = require( "../../../../../lib/compiler/passes/report-undefined-rules" );
chai.use(helpers); chai.use( helpers );
let expect = chai.expect; const expect = chai.expect;
describe("compiler pass |reportUndefinedRules|", function() { describe( "compiler pass |reportUndefinedRules|", function () {
it("reports undefined rules", function() {
expect(pass).to.reportError("start = undefined", { it( "reports undefined rules", function () {
expect( pass ).to.reportError( "start = undefined", {
message: "Rule \"undefined\" is not defined.", message: "Rule \"undefined\" is not defined.",
location: { location: {
start: { offset: 8, line: 1, column: 9 }, start: { offset: 8, line: 1, column: 9 },
end: { offset: 17, line: 1, column: 18 } end: { offset: 17, line: 1, column: 18 }
} }
}); } );
});
} );
it("checks allowedStartRules", function() { it( "checks allowedStartRules", function () {
expect(pass).to.reportError("start = 'a'", {
expect( pass ).to.reportError( "start = 'a'", {
message: "Start rule \"missing\" is not defined." message: "Start rule \"missing\" is not defined."
}, { }, {
allowedStartRules: ["missing"] allowedStartRules: [ "missing" ]
}); } );
});
}); } );
} );

File diff suppressed because it is too large Load Diff
Loading…
Cancel
Save