Future requirements could include: *
The execute() command doesn't really live here, except as part of that * last future requirement, and because it doesn't really have anywhere else to * live. */ /** * The array of requests that wish to announce their presence */ exports.requests = []; /** * How many requests do we store? */ var maxRequestLength = 100; /** * Called by Request instances when some output (or a cell to async() happens) */ exports.addRequestOutput = function(request) { exports.requests.push(request); // This could probably be optimized with some maths, but 99.99% of the // time we will only be off by one, and I'm feeling lazy. while (exports.requests.length > maxRequestLength) { exports.requests.shiftObject(); } exports._dispatchEvent('addedRequestOutput', { request: request }); }; /** * Execute a new command. * This is basically an error trapping wrapper around request.command(...) */ exports.execute = function(args, request) { // Check the function pointed to in the meta-data exists if (!request.command) { request.doneWithError('Command not found.'); return; } try { request.command(args, request); } catch (ex) { var trace = new Trace(ex, true); console.group('Error executing command \'' + request.typed + '\''); console.log('command=', request.commandExt); console.log('args=', args); console.error(ex); trace.log(3); console.groupEnd(); request.doneWithError(ex); } }; /** * To create an invocation, you need to do something like this (all the ctor * args are optional): *
* var request = new Request({
* command: command,
* commandExt: commandExt,
* args: args,
* typed: typed
* });
*
*/
exports.Request = function(options) {
options = options || {};
// Will be used in the keyboard case and the cli case
this.command = options.command;
this.commandExt = options.commandExt;
// Will be used only in the cli case
this.args = options.args;
this.typed = options.typed;
// Have we been initialized?
this._begunOutput = false;
this.start = new Date();
this.end = null;
this.completed = false;
this.error = false;
};
oop.implement(exports.Request.prototype, EventEmitter);
/**
* Lazy init to register with the history should only be done on output.
* init() is expensive, and won't be used in the majority of cases
*/
exports.Request.prototype._beginOutput = function() {
this._begunOutput = true;
this.outputs = [];
exports.addRequestOutput(this);
};
/**
* Sugar for:
* request.error = true; request.done(output);*/ exports.Request.prototype.doneWithError = function(content) { this.error = true; this.done(content); }; /** * Declares that this function will not be automatically done when * the command exits */ exports.Request.prototype.async = function() { if (!this._begunOutput) { this._beginOutput(); } }; /** * Complete the currently executing command with successful output. * @param output Either DOM node, an SproutCore element or something that * can be used in the content of a DIV to create a DOM node. */ exports.Request.prototype.output = function(content) { if (!this._begunOutput) { this._beginOutput(); } if (typeof content !== 'string' && !(content instanceof Node)) { content = content.toString(); } this.outputs.push(content); this._dispatchEvent('changed', {}); return this; }; /** * All commands that do output must call this to indicate that the command * has finished execution. */ exports.Request.prototype.done = function(content) { this.completed = true; this.end = new Date(); this.duration = this.end.getTime() - this.start.getTime(); if (content) { this.output(content); } this._dispatchEvent('changed', {}); }; });