Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parse more information from the RNG grammar. #913

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Parse more information from the RNG grammar. #913

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59e44f6
Parse more information from the RNG grammar.
vandenoever Aug 14, 2015
b1128b6
Support Relax NG <mixed/> element.
vandenoever Aug 14, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
271 changes: 216 additions & 55 deletions webodf/tools/odfRng2Config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,73 @@
* @source: https://github.com/kogmbh/WebODF/
*/

function aggregate(callback) {
return function (collection, individual) {
return collection.concat(callback(individual));
};
}
"use strict";

function toArray(nodeList) {
"use strict";
return Array.prototype.slice.call(nodeList);
var rngns = "http://relaxng.org/ns/structure/1.0";

/**
* Check if a node is an element in the rng namespace and the given localName.
* @param {!string} localName
* @param {!Node} node
* @return {!boolean}
*/
function isRng(localName, node) {
if (node.nodeType !== 1) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Magic number should probably have a variable name (or, you could use the defined value on the Node tree, e.g., Node.ELEMENT_NODE)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not available in the DOM implementation that WebODF uses on Node.js.

return false;
}
if (node.namespaceURI !== rngns) {
return false;
}
if (node.localName !== localName) {
return false;
}
return true;
}

function getName(node) {
return node && node.getAttribute("name");
/**
* @param {!Node} node
* @return {?Element}
*/
function getFirstElementNode(node) {
node = node.firstChild;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a firstElementChild and nextElementSibling properties you might be able to use here instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not available in the DOM implementation that WebODF uses on Node.js.

while (node && node.nodeType !== 1) {
node = node.nextSibling;
}
return node;
}

/**
* Return all explicit names for an <element/> or <attribute/> element.
* <anyName/> and <nsName/> return nothing.
*
* @param {!Node} node
* @return {!Array.<!string>}
*/
function getNames(node) {
var name = getName(node);
return name ? [name] : toArray(node.getElementsByTagName("name")).map(function (node) {
return node.textContent;
});
var names = [];
if (node.hasAttribute("name")) {
names.push(node.getAttribute("name"));
} else {
node = getFirstElementNode(node);
if (isRng("choice", node)) {
node = getFirstElementNode(node);
}
while (node) {
if (isRng("name", node)) {
names.push(node.textContent);
}
node = node.nextSibling;
}
}
return names;
}

/**
* Increase length of string by adding spaces.
* @param {!string} str
* @param {!number} length
* @return {!string}
*/
function pad(str, length) {
while (str.length < length) {
str += " ";
Expand All @@ -52,58 +97,174 @@ function pad(str, length) {
}

/**
* Extract container node information out of the supplied RNG schema document.
* This only does extremely simplistic parsing.
*
* @constructor
* @param {!Document} document
* Get all the <define/> elements from an RNG grammar.
* @param {!Element} grammar
* @return {!Object.<!string,!Element>}
*/
function ExtractContainerInfo(document) {
/**
* @param {!Node} node
* @return {!Array.<!Node>}
*/
function findParentElements(node) {
var refs;

while (node && /(define|element)/.test(node.localName) === false) {
node = node.parentNode;
function getDefines(grammar) {
var defines = {},
c = grammar.firstChild;
while (c) {
if (c.nodeType === 1 && isRng("define", c)) {
defines[c.getAttribute("name")] = c;
}
c = c.nextSibling;
}
return defines;
}

if (node) {
if (node.localName === "element") {
return [node];
/**
* Information about an attribute or element.
* @constructor
*/
function Info() {
/**@type {!Object.<!string,!string>}*/
this.refs = {};
/**@type {!boolean}*/
this.text = false;
/**@type {!boolean}*/
this.data = false;
/**@type {!boolean}*/
this.value = false;
/**@type {!Array.<!Info}*/
this.childElements = [];
/**@type {!Array.<!Info}*/
this.attributes = [];
}

/**
* Add information from a <define/> to that of <element/> or <attribute/>.
* @param {!Info} info
* @param {!string} ref
* @param {!Object.<!string,!Info>} defines
* @return {undefined}
*/
function addDefine(info, ref, defines) {
var define = defines[ref],
c;
if (define) {
info.text = info.text || define.text;
info.data = info.data || define.data;
info.value = info.value || define.value;
define.childElements.forEach(function (ce) {
if (info.childElements.indexOf(ce) === -1) {
info.childElements.push(ce);
}
refs = toArray(document.querySelectorAll("ref[name='" + getName(node) + "']"));
return refs.reduce(aggregate(findParentElements), []);
}
return [];
});
define.attributes.forEach(function (a) {
if (info.attributes.indexOf(a) === -1) {
info.attributes.push(a);
}
});
}
}

this.getTextElements = function() {
return toArray(document.getElementsByTagName("text")).reduce(aggregate(findParentElements), []);
};
/**
* Add information from <define/> elements to the set of <element/> or
* <attribute/> elements.
* @param {!Object.<!string,!Info>} infos
* @param {!Object.<!string,!Info>} defines
* @return {undefined}
*/
function resolveDefines(infos, defines) {
Object.keys(infos).forEach(function (name) {
var info = infos[name];
Object.keys(info.refs).forEach(function (ref) {
addDefine(info, ref, defines);
});
});
}

/**
* Recursively collect information from all elements in an RNG grammar.
* If a <ref/> is encountered, the corresponding <define/> is traversed.
* This is done only once for each <define/>.
*
* @param {!Element} e
* @param {!Object.<!string,!Element} defs
* @param {?Info} current
* @param {!Object.<!string,!Info} elements
* @param {!Object.<!string,!Info} attributes
* @param {!Object.<!string,!Info} defines
* @return {undefined}
*/
function handleChildElements(e, defs, current, elements, attributes, defines) {
var c = e.firstChild,
def,
info,
name;
while (c) {
if (isRng("ref", c)) {
name = c.getAttribute("name");
if (current) {
current.refs[name] = name;
}
def = defs[name];
if (def) {
delete defs[name];
info = new Info();
defines[name] = info;
handleChildElements(def, defs, info, elements, attributes, defines);
}
} else if (isRng("element", c)) {
info = new Info();
getNames(c).forEach(function (name) {
elements[name] = info;
});
if (current) {
current.childElements.push(info);
}
handleChildElements(c, defs, info, elements, attributes, defines);
} else if (isRng("attribute", c)) {
info = new Info();
getNames(c).forEach(function (name) {
attributes[name] = info;
});
if (current) {
current.attributes.push(info);
}
handleChildElements(c, defs, info, elements, attributes, defines);
} else if (isRng("text", c)) {
current.text = true;
} else if (isRng("mixed", c)) {
current.text = true;
handleChildElements(c, defs, current, elements, attributes, defines);
} else if (isRng("data", c)) {
current.data = true;
} else if (isRng("value", c)) {
current.value = true;
} else {
handleChildElements(c, defs, current, elements, attributes, defines);
}
c = c.nextSibling;
}
}

function onLoadRng(err, document) {
if (err) {
console.log("\nError: " + err + "\n");
runtime.exit(1);
} else {
var containerFinder = new ExtractContainerInfo(document),
textElements,
elementNames,
doc;

textElements = containerFinder.getTextElements();
elementNames = textElements.reduce(aggregate(getNames), []).sort();
doc = elementNames.map(function (elementName) {
return "[" + pad('"' + elementName + '"', 40) + ", TODO]";
}).join(",\n");

console.log(doc + "\n");
runtime.exit(0);
return runtime.exit(1);
}
var grammar = document.documentElement,
start = document.getElementsByTagNameNS(rngns, "start").item(0),
defs = getDefines(grammar),
elements = {},
attributes = {},
defines = {},
elementNames,
doc;

handleChildElements(start, defs, null, elements, attributes, defines);
resolveDefines(elements, defines);
resolveDefines(attributes, defines);

elementNames = Object.keys(elements).sort();
doc = elementNames.map(function (elementName) {
return "[" + pad('"' + elementName + '"', 40) + ", TODO]";
}).join(",\n");

console.log(doc + "\n");
runtime.exit(0);
}

function main(args) {
Expand All @@ -117,4 +278,4 @@ function main(args) {
runtime.loadXML(rngPath, onLoadRng);
}
}
main(String(typeof arguments) !== "undefined" && Array.prototype.slice.call(arguments));
main(String(typeof arguments) !== "undefined" && Array.prototype.slice.call(arguments));