/* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Skywriter. * * The Initial Developer of the Original Code is * Mozilla. * Portions created by the Initial Developer are Copyright (C) 2009 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Skywriter Team (skywriter@mozilla.com) * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ define(function(require, exports, module) { var checks = require("pilot/typecheck"); var canon = require('pilot/canon'); /** * 'help' command */ var helpCommandSpec = { name: 'help', params: [ { name: 'search', type: 'text', description: 'Search string to narrow the output.', defaultValue: null } ], description: 'Get help on the available commands.', exec: function(env, args, request) { var output = []; var command = canon.getCommand(args.search); if (command && command.exec) { // caught a real command output.push(command.description ? command.description : 'No description for ' + args.search); } else { var showHidden = false; if (command) { // We must be looking at sub-commands output.push('

Sub-Commands of ' + command.name + '

'); output.push('

' + command.description + '

'); } else if (args.search) { if (args.search == 'hidden') { // sneaky, sneaky. args.search = ''; showHidden = true; } output.push('

Commands starting with \'' + args.search + '\':

'); } else { output.push('

Available Commands:

'); } var commandNames = canon.getCommandNames(); commandNames.sort(); output.push(''); for (var i = 0; i < commandNames.length; i++) { command = canon.getCommand(commandNames[i]); if (!showHidden && command.hidden) { continue; } if (command.description === undefined) { // Ignore editor actions continue; } if (args.search && command.name.indexOf(args.search) !== 0) { // Filtered out by the user continue; } if (!args.search && command.name.indexOf(' ') != -1) { // sub command continue; } if (command && command.name == args.search) { // sub command, and we've already given that help continue; } // todo add back a column with parameter information, perhaps? output.push(''); output.push(''); output.push(''); output.push(''); } output.push('
' + command.name + '' + command.description + '
'); } request.done(output.join('')); } }; /** * 'eval' command */ var evalCommandSpec = { name: 'eval', params: [ { name: 'javascript', type: 'text', description: 'The JavaScript to evaluate' } ], description: 'evals given js code and show the result', hidden: true, exec: function(env, args, request) { var result; var javascript = args.javascript; try { result = eval(javascript); } catch (e) { result = 'Error: ' + e.message + ''; } var msg = ''; var type = ''; var x; if (checks.isFunction(result)) { // converts the function to a well formated string msg = (result + '').replace(/\n/g, '
').replace(/ /g, ' '); type = 'function'; } else if (checks.isObject(result)) { if (Array.isArray(result)) { type = 'array'; } else { type = 'object'; } var items = []; var value; for (x in result) { if (result.hasOwnProperty(x)) { if (checks.isFunction(result[x])) { value = '[function]'; } else if (checks.isObject(result[x])) { value = '[object]'; } else { value = result[x]; } items.push({name: x, value: value}); } } items.sort(function(a,b) { return (a.name.toLowerCase() < b.name.toLowerCase()) ? -1 : 1; }); for (x = 0; x < items.length; x++) { msg += '' + items[x].name + ': ' + items[x].value + '
'; } } else { msg = result; type = typeof result; } request.done('Result for eval \'' + javascript + '\'' + ' (type: '+ type+'):

'+ msg); } }; var canon = require('pilot/canon'); exports.startup = function(data, reason) { canon.addCommand(helpCommandSpec); canon.addCommand(evalCommandSpec); }; exports.shutdown = function(data, reason) { canon.removeCommand(helpCommandSpec); canon.removeCommand(evalCommandSpec); }; });