https://www.mediawiki.org/wiki/Special:Code/MediaWiki/108233
Revision: 108233
Author: gwicke
Date: 2012-01-06 14:30:55 +0000 (Fri, 06 Jan 2012)
Log Message:
-----------
Add template expansion handler skeleton, not yet functional. Also note
improvements needed in the tokenizer template handling.
Modified Paths:
--------------
trunk/extensions/VisualEditor/modules/parser/pegTokenizer.pegjs.txt
Added Paths:
-----------
trunk/extensions/VisualEditor/modules/parser/ext.core.TemplateHandler.js
Added: trunk/extensions/VisualEditor/modules/parser/ext.core.TemplateHandler.js
===================================================================
--- trunk/extensions/VisualEditor/modules/parser/ext.core.TemplateHandler.js
(rev 0)
+++ trunk/extensions/VisualEditor/modules/parser/ext.core.TemplateHandler.js
2012-01-06 14:30:55 UTC (rev 108233)
@@ -0,0 +1,146 @@
+/**
+ * Template and template argument handling.
+ *
+ * @author Gabriel Wicke <[email protected]>
+ */
+
+function TemplateHandler () {
+ this.reset();
+}
+
+TemplateHandler.prototype.reset = function () {
+ this.outstanding = 0;
+};
+
+// constants
+TemplateHandler.prototype.rank = 1.1;
+
+TemplateHandler.prototype.register = function ( dispatcher ) {
+ this.dispatcher = dispatcher;
+ // Register for template and templatearg tag tokens
+ dispatcher.addTransform( this.onTemplate.bind(this),
+ this.rank, 'tag', 'template' );
+ dispatcher.addTransform( this.onTemplateArg.bind(this),
+ this.rank, 'tag', 'templatearg' );
+
+ // Reset internal state when the parser pipeline is done
+ dispatcher.addTransform( this.reset.bind(this),
+ this.rank, 'end' );
+};
+
+
+/**
+ * Main template token handler
+ *
+ * Expands target and arguments (both keys and values) and either directly
+ * calls or sets up the callback to _expandTemplate, which then fetches and
+ * processes the template.
+ */
+TemplateHandler.prototype.onTemplate = function ( token, cb, frame ) {
+ // check for 'subst:'
+ // check for variable magic names
+ // check for msg, msgnw, raw magics
+ // check for parser functions
+
+ // create a new frame
+ var newFrame = {
+ args: {},
+ env: frame.env,
+ target: token.attribs[0][1], // XXX: use data-target
key instead!
+
// Also handle templates and args in
+
// target!
+ outstanding: 0,
+ cb: cb
+ },
+ argcb,
+ i = 0,
+ kvs = [],
+ res,
+ kv;
+ // XXX: transform the target
+
+
+ // transform each argument (key and value), and handle asynchronous
returns
+ for ( var key in token.args ) {
+ if ( token.hasOwnProperty( key ) ) {
+ kv = { key: [], value: [] };
+ // transform the value
+ argCB = this._returnArgValue.bind( this, { index: i,
frame: newFrame } );
+ res = frame.transformPhase( frame, args[key], argCB );
+ if ( res.async ) {
+ newFrame.outstanding++;
+ }
+ kv.value = res.tokens;
+
+ // XXX: transform key too, and store it in the token's
value for
+ // the original key
+ // For now, we assume the key to be a string.
+ kv.key = key;
+
+ // finally, append to kvs
+ kvs.push( kv );
+ i++;
+ }
+ }
+
+ if ( newFrame.outstanding === 0 ) {
+ return this._expandTemplate ( newFrame );
+ } else {
+ return { async: true };
+ }
+};
+
+/**
+ * Callback for async argument value expansions
+ */
+TemplateHandler.prototype._returnArgValue = function ( ref, tokens, notYetDone
) {
+ var frame = ref.frame,
+ res;
+ frame.args[ref.index].push( tokens );
+ if ( ! notYetDone ) {
+ frame.outstanding--;
+ if ( frame.outstanding === 0 ) {
+ // this calls back to frame.cb, so no return here.
+ this._expandTemplate( frame );
+ }
+ }
+};
+
+/**
+ * Fetch, tokenize and token-transform a template after all arguments and the
+ * target were expanded in frame.
+ */
+TemplateHandler.prototype._expandTemplate = function ( frame ) {
+ // Set up a pipeline:
+ // fetch template source -> tokenizer
+ // -> TokenTransformDispatcher (phase 1/2 only, with frame passed in)
+ // -> frame.cb( tokens )
+
+
+ // XXX: notes from brion's mediawiki.parser.environment
+ // resolve template name
+ // load template w/ canonical name
+ // load template w/ variant names
+ // recursion depth check
+ // fetch from DB or interwiki
+ // infinte loop check
+ //
+ // TODO: template fetching is already implemented there, copy this over!
+};
+
+
+TemplateHandler.prototype.onTemplateArg = function ( token, cb, frame ) {
+ var argName = token.attribs[0][1]; // XXX: do this properly!
+ if ( argName in frame.args ) {
+ // return tokens for argument
+ return { tokens: frame.args[argName] };
+ } else {
+ // FIXME: support default value!
+ return { token: { type: 'TEXT', value: '' } };
+ }
+};
+
+
+if (typeof module == "object") {
+ module.exports.TemplateHandler = TemplateHandler;
+}
Property changes on:
trunk/extensions/VisualEditor/modules/parser/ext.core.TemplateHandler.js
___________________________________________________________________
Added: svn:eol-style
+ native
Modified: trunk/extensions/VisualEditor/modules/parser/pegTokenizer.pegjs.txt
===================================================================
--- trunk/extensions/VisualEditor/modules/parser/pegTokenizer.pegjs.txt
2012-01-06 14:21:16 UTC (rev 108232)
+++ trunk/extensions/VisualEditor/modules/parser/pegTokenizer.pegjs.txt
2012-01-06 14:30:55 UTC (rev 108233)
@@ -405,7 +405,7 @@
//b.push({type: 'NEWLINE'});
// Move this to a token stream transform!
//console.log('about to emit' + pp(self));
- //self._tokenizer.emit('chunk', b);
+ console.log( pp( result._tokenizer ));
//console.log('emitted chunk' + pp(b));
//return [];
return b;
@@ -718,6 +718,7 @@
return obj;
}
+// XXX: support template and args in target!
template_target
= h:( !"}}" x:([^|\n]) { return x } )* { return h.join(''); }
@@ -742,6 +743,7 @@
return obj;
}
+// FIXME: handle template args and templates in key! (or even parser
functions?)
template_param_name
= h:( !"}}" x:([^=|\n]) { return x } )* { return h.join(''); }
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
