MediaWiki:Gadget-ParserPlayground.js

/** * MediaWiki:Gadget-ParserPopups.js * Brion Vibber  * 2011-05-02 * * Initial steps on some experiments to flip between various parsing methods to * compare source, parse trees, and outcomes. * * Adds a fold-out section in the editor (using enhanced toolbar) to swap view of: * - Source (your regular editable text) * - MediaWiki parser (parsed page as full HTML) * - Preprocessor tree (tree view of XML preprocessor tree; shows limited pre-parsing breakdown) * - FakeParser (a very primitive parser class in this gadget) * - FakeParser's parse tree * - FakeParser's output and parse tree side-by-side. * * The parsed views update to match the current editor state when you bump over to them. * In side-by-side view, matching items are highlighted on the two sides, and clicking * will scroll the related side into view if needed. */ (function(mw, $) {

function htmlEscape(str) { return str.replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;').replace('"', '&quot;'); }

/** * Render an XML tree into this thingy. * @param {DOMNode} node * @param {jQuery} dest a list object! * @param {HashMap} inspectorMap */ function renderXmlTree(node, dest, inspectorMap) { if (node.nodeType == Node.ELEMENT_NODE) { var base = ' ' + htmlEscape(node.nodeName) + ' ', str = '&lt;' + base, closer; $.each(node.attributes, function(i, attr) {           str += ' ' + htmlEscape(attr.nodeName) + '= "' + htmlEscape(htmlEscape(attr.nodeValue)) + '" ';        }); if (node.childNodes.length == 0) { str += ' /&gt;'; dest.append('' + str + ''); } else { str += '&gt;'; closer = '&lt;/' + base + '&gt;'; var chunk = $('' +                         ' ' + str + ' ' +                          '' +                          ' ' + closer + ' ' +                          ''); var sublist = chunk.find('ul'); dest.append(chunk); $.each(node.childNodes, function(i, child) {               renderXmlTree(child, sublist);            }); }   } else if (node.nodeType == Node.TEXT_NODE) { dest.append($('').text(node.textContent)); } }

/** * Render a JSON tree into this thingy. * @param {mixed} node * @param {jQuery} dest a list object! * @param {HashMap} inspectorMap */ function renderJsonTree(node, dest, inspectorMap) { var type = (typeof node); var chunk, item, sublist; if (type == 'object' && node === null) { dest.append('null'); } else if (type == 'object' && node instanceof Array) { chunk = $(' ' +                 ' [ ' +                  '' +                  ' ] ' +                  ' '); sublist = chunk.find('ul'); $.each(node, function(i, val) {           item = $('');            renderJsonTree(val, item, inspectorMap);            sublist.append(item);        }); dest.append(chunk); } else if (type == 'object') { chunk = $(' ' +                 ' { ' +                  '' +                  ' } ' +                  ' '); chunk.data('parseNode', node); // assign the node for the tree inspector if (inspectorMap) { // save reverse lookup for the inspector inspectorMap.put(node, chunk[0]); }       sublist = chunk.find('ul'); // hack $.each(node, function(key, val) {           var item = $(' ' + htmlEscape('' + key) + ' : </li>');            renderJsonTree(val, item, inspectorMap);            sublist.append(item);        }); dest.append(chunk); } else if (type == 'string') { dest.append(htmlEscape(JSON.stringify(node))); // easy way to escape :)   } else {        dest.append(htmlEscape('' + node));    } }

/** * Render a JSON or XML tree into this thingy. * @param {mixed} node * @param {jQuery} dest a list object! * @param {HashMap} inspectorMap */ function renderTree(node, dest, inspectorMap) { var render; if (node instanceof Node) { render = renderXmlTree; } else { render = renderJsonTree; }   render(node, dest, inspectorMap); }

var onResize = null; $(window).resize(function {   if (onResize) {        onResize;    } }); $('.mw-pp-node').live('click', function {   var ul = $(this.parentNode).find('ul:first');    if (ul.is(":hidden")) {        ul.slideDown;    } else {        ul.slideUp;    } });

var makeMagicBox = function(inside) { $('#mw-parser-popup').remove; // line-height is needed to compensate for oddity in WikiEditor extension, which zeroes the line-height on a parent container var box = $('#wpTextbox1'); var target = $(' <div class="editor" style="line-height: 1.5em; top: 0px; left: 0px; right: 0px; bottom: 0px; border: 1px solid gray">' + inside + ' ').insertAfter(box); $('#wpTextbox1').css('display', 'none');

onResize = function { target.width(box.width) .height(box.height); };   onResize; return target; };

/** * Create two scrollable columns for an 'inspector' display. * @param {jQuery} dest -- jquery obj to receive the target * @return {jQuery} */ var makeInspectorColumns = function(dest) { var h = $('#wpTextbox1').height; // hack var target = $(       ' ').appendTo(dest); return target; };

/** * Set up 'inspector' events to highlight elements with matching parseNode data properties * between the given two sections. * * @param {jQuery} left * @param {jQUery} right */ var setupInspector = function(left, right, leftMap, rightMap) { var makeMagic = function(a, b, inspectorMap) { var match = function(aNode, callback) { var treeNode = $(aNode).data('parseNode'); var bNode = treeNode && inspectorMap.get(treeNode); callback(aNode, bNode); };       a.delegate('.parseNode', 'mouseenter', function(event) {            match(this, function(node, other) { $(node).addClass('parseNodeHighlight'); $(other).addClass('parseNodeHighlight'); });       }).delegate('.parseNode', 'mouseleave', function(event) {            match(this, function(node, other) { $(node).removeClass('parseNodeHighlight'); $(other).removeClass('parseNodeHighlight'); });       }).delegate('.parseNode', 'click', function(event) {            match(this, function(node, other) { if (other) { // try to scroll the other into view. how... feasible is this? :DD var visibleStart = b.scrollTop; var visibleEnd = visibleStart + b.height; var otherStart = visibleStart + $(other).position.top; var otherEnd = otherStart + $(other).height; if (otherStart > visibleEnd) { b.scrollTop(otherStart); } else if (otherEnd < visibleStart) { b.scrollTop(otherStart); }                   event.preventDefault; return false; }           });        });    };    makeMagic(left, right, rightMap); makeMagic(right, left, leftMap); };

var addParserModes = function(modes, parserClass, className, detail) { detail = detail || ''; modes[className] = { label: className, desc: ' Showing the page rendered with ' + className + '. ' + detail, render: function(src, dest) { var parser = new parserClass; parser.parseToTree(src, function(tree, err) {               parser.treeToHtml(tree, function(node, err) { dest.append(node); });           });        }	};	modes[className + '-tree'] = { label: className + ' tree', desc: ' Showing the page broken down to parse tree with ' + className + '. ' + detail, render: function(src, dest) { var parser = new parserClass; parser.parseToTree(src, function(tree, err) {               var target = $('</li></ul>').appendTo(dest);                renderTree(tree, target.find('li'));            }); }	};	modes[className + '-roundtrip'] = { label: className + ' round-trip', desc: ' Showing the page as parsed, then returned to source via ' + className + '. ' + detail, render: function(src, dest) { var parser = new parserClass; parser.parseToTree(src, function(tree, err) {               parser.treeToSource(tree, function(src2, err) { var target = $(' ').appendTo(dest); target.html(diffString(src, src2)); });           });        }	};	modes[className + '-inspect'] = { label: className + ' inspect', desc: ' Shows ' + className + '\'s HTML output and parse tree side-by-side. ' + detail, render: function(src, dest) { var parser = new parserClass; var treeMap = new HashMap, renderMap = new HashMap; parser.parseToTree(src, function(tree, err) {               var target = makeInspectorColumns(dest);                var left = target.find('.left'), right = target.find('.right');                renderTree(tree, left, treeMap);                parser.treeToHtml(tree, function(node, err) { right.append(node); setupInspector(left, right, treeMap, renderMap); }, renderMap);           }); }	}; };

$(function {   /* Start trying to add items... */    var editor = $('#wpTextbox1');    if (editor.length > 0 && typeof $.fn.wikiEditor === 'function') {        //$('#wpTextbox1').bind('wikiEditor-toolbar-buildSection-main', function { var modes = { 'source': { label: 'Source', desc: 'Showing the page\'s original wikitext source code, as you are used to editing it.', render: false }       };        addParserModes(modes, MediaWikiParser, 'MediaWikiParser'); addParserModes(modes, FakeParser, 'FakeParser'); addParserModes(modes, PegParser, 'PegParser', ' Peg-based parser plus FakeParser\'s output. <a href="http://pegjs.majda.cz/documentation">pegjs documentation</a>; edit and reselect to reparse with updated parser '); window.setTimeout(function {           // Great, now let's hook the booklet buttons... (explicit callbacks would be better)            var hook = function(key, callback) {                // using live since they haven't been created yet...                // 'mouseup' as a hack since the upstream click handler cancels other event handlers                $('#wikiEditor-ui-toolbar .sections .section-parser .index div[rel=' + key + ']').live('mouseup', callback);            };            var pages = {};            $.each(modes, function(name, mode) { pages[name] = { 'layout': 'table', 'label': mode.label, 'rows': [ {							'desc': { 'html': mode.desc } }					]				};               var render = mode.render; hook(name, function {                   $('#pegparser-source').hide; // it'll reshow; others won't need it                    if (mode.render) {                        var target = makeMagicBox('');                        var src = $('#wpTextbox1').val;                        var dest = target.find('div');                        render(src, dest);                    } else {                        $('#mw-parser-popup').remove;                        onResize = null;                        $('#wpTextbox1').css('display', 'block');                    }                }); });           editor.wikiEditor( 'addToToolbar', { 'sections': { 'parser': { 'label': 'Parser', 'type': 'booklet', 'pages': pages }				}           } );

}, 500 );   } else {        mw.log('No wiki editor');    } });

})(mediaWiki, jQuery);