Bug 379312

Comment 1 Grant Gayed 2012-07-17 13:55:04 EDT

This is logged at mozilla: https://bugzilla.mozilla.org/show_bug.cgi?id=685526 .

Comment 2 Grant Gayed 2013-04-05 15:56:51 EDT

Fixed > 20130405, commit: http://git.eclipse.org/c/orion/org.eclipse.orion.client.git/commit/?id=64245e59b0e3447ffe90e9a37e3fe17df85fb371 .

Comment 3 Grant Gayed 2013-04-12 10:38:30 EDT

Example usage:

/* first, here's a custom type */

/*
 * The current need to provide one of these status values in the result
 * object may go away since the Shell page should be able to compute the
 * status based on the presence/absence of a value in the result, and by
 * comparing the typed string with the prediction strings.  But for now
 * one of these status values must be provided in the result.
 */
var CompletionStatus = {
    /**
     * @name orion.shell.CompletionStatus.MATCH
     * the current text matches a valid argument value
     */
    MATCH: 0,
    /**
     * @name orion.shell.CompletionStatus.PARTIAL
     * the current text matches a subset of the initial characters of a valid
     * argument value (ie.- a value in the midst of being typed)
     */
    PARTIAL: 1,
    /**
     * @name orion.shell.CompletionStatus.ERROR
     * the current text does not match a subset of the initial characters of any valid values
     */
    ERROR: 2
};
var labTypeProperties = { 
    name: "lab"
};
var labTypeImpl = {
    parse: function(arg, typeSpec, context) {
        /*
         * Compute all potential prediction objects here, can be done asynchronously
         * if needed (eg.- if need to wait on an XHR).
         */
        var ottawaValue = {name: 'Ottawa', address: 'Kanata, actually'};
        var rtpValue = {name: 'RTP', address: 'Raleigh'};
        if (typeSpec.showClimateToo) {
            ottawaValue.climate = "colder";
            rtpValue.climate = "warmer";
        }
        var potentialPredictions = [
            {
                name: 'Ottawa', /* the string to be typed */
                value: ottawaValue /* the corresponding model object */
            },
            {
                name: 'RTP', /* the string to be typed */
                value: rtpValue /* the corresponding model object */
            }
        ];

        var value; /* undefined until a valid value is fully typed */
        var status; /* one of the CompletionStatus values above */
        var predictions = []; /* an [] of {name: typedString, value: object} */

        for (var i = 0; i < potentialPredictions.length; i++) {
            if (potentialPredictions[i].name.indexOf(arg.text) === 0) {
                predictions.push(potentialPredictions[i]);
                if (potentialPredictions[i].name === arg.text) {
                    value = potentialPredictions[i].value;
                }
            }
        }

        status = CompletionStatus.ERROR;
        if (predictions.length > 0) {
            status = value ? CompletionStatus.MATCH : CompletionStatus.PARTIAL;
        }
        var result = {
            value: value,
            message: (status === CompletionStatus.ERROR ? ("'" + arg.text + "' is not valid") : undefined),
            status: status,
            predictions: predictions
        };

        /*
         * If all of the above can be computed synchronously then just return result directly.
         * If the above cannot be done synchronously (eg.- waiting on an XHR) then
         * return a promise as demonstrated below and resolve it when the result becomes ready.
         */
        var promise = new orion.Deferred();
        setTimeout(
            function() {
                promise.resolve(result); /* result has become ready some time later */
            }
        );	
        return promise;
    }
};

/* here's a command that uses the custom type */

var printLabProperties = { 
    name: "printLab",
    description: "Print a lab location",
    parameters: [{
        name: "lab",
        type: {name: "lab", showClimateToo: true},
        description: "The name of the lab to print info for"
    }],
    returnType: "string"
};
var printLabImpl = {
    callback: function(args) {
        var result = "Lab name: " + args.lab.name + "\nLocation: " + args.lab.address;
        if (args.lab.climate) {
            result += "\nClimate: " + args.lab.climate;
        }
        return result;
    }
};

var provider = new orion.PluginProvider();
provider.registerServiceProvider("orion.shell.type", labTypeImpl, labTypeProperties);
provider.registerServiceProvider("orion.shell.command", printLabImpl, printLabProperties);
provider.connect();