#!/bin/false

// common functions for parsing the JSON comments out of

// the C wrapper files (like common.py)

var fs = require('fs');

var path = require('path');

/// Object representing each builtin

function Builtin(j) {

// remove arrays of description - folw it down with newlines

if ("description" in j)

if (j.description instanceof Array)

j.description = j.description.join("\n\n");

for (var k in j)

this[k] = j[k];

}

Builtin.prototype.getDescription = function() {

var d = "";

if ("description" in this)

d = this.description;

if (d instanceof Array)

d = d.join("\n\n");

return d;

};

Builtin.prototype.getURL = function() {

if (this.type == "class")

anchor = this.class;

else if ("class" in this)

anchor = "l_"+this.class+"_"+this.name;

else

anchor = "l__global_"+this.name;

return "http://www.espruino.com/Reference#"+anchor;

};

/// Tern types - for tern.js json format

function getBasicTernType(t) {

if (["int","float","int32"].indexOf(t)>=0) return "number";

if (t=="pin") return "+Pin";

if (t=="bool") return "bool";

if (t=="JsVarArray") return "?"; // TODO: not right. Should be variable arg count

return "?";

}

/// Get full Tern type - for tern.js json format

Builtin.prototype.getTernType = function() {

if (["class","library"].indexOf(this.type)>=0) {

return "fn()";

} else if (["function","method","staticmethod","constructor"].indexOf(this.type)>=0) {

// it's a function

var args = [];

if ("params" in this)

args = this.params.map(function (p) {

if (p[0]=="pin" && p[1]=="JsVar")

return "pin: +Pin"; // hack because digitalRead/Write can also take arrays/objects (but most use cases are Pins)

return p[0]+": "+getBasicTernType(p[1]);

});

var ret = "";

if ("return_object" in this)

ret = " -> +"+this.return_object

else if ("return" in this)

ret = " -> "+getBasicTernType(this.return[0]);

return "fn("+args.join("\, ")+")"+ret;

} else {

return getBasicTernType(this.return[0]);

}

};

/// Get any files that we think might contain 'JSON' tags

exports.getWrapperFiles = function (callback) {

var BASEDIR = path.resolve(__dirname, "..");

require('child_process').exec("find "+BASEDIR+" -name jswrap*.c", function(error, stdout, stderr) {

callback(stdout.toString().trim().split("\n"));

});

}

/// Extract the /*JSON ... */ comments from a file and parse them

exports.readWrapperFile = function(filename) {

var contents = fs.readFileSync(filename).toString();

var builtins = [];

var comments = contents.match( /\/\*JSON(?:(?!\*\/).|[\n\r])*\*\//g );

if (comments) comments.forEach(function(comment) {

comment = comment.slice(6,-2); // pull off /*JSON ... */ bit

var endOfJson = comment.indexOf("\n}")+2;

var json = comment.substr(0,endOfJson);

var description = comment.substr(endOfJson).trim();

var j = new Builtin(JSON.parse(json));

if (description.length) j.description = description;

j.implementation = filename;

builtins.push(j);

});

return builtins;

}

/// Extract all parsed /*JSON ... */ comments from all files

exports.readAllWrapperFiles = function(callback) {

exports.getWrapperFiles(function(files) {

var builtins = [];

files.forEach(function(filename) {

builtins = builtins.concat(exports.readWrapperFile(filename));

});

callback(builtins);

});

}