brackets/lib/domains/BaseDomain.js

/*
 * Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

(function () {
    "use strict";

    var //Launcher = require("./Launcher"),
        Logger   = require("./Logger");

    /**
     * @private
     * @type {DomainManager}
     * DomainManager provided at initialization time
     */
    var _domainManager = null;

    /**
     * @private
     * Implementation of base.enableDebugger commnad.
     * In the future, process._debugProcess may go away. In that case
     * we will probably have to implement re-launching of the Node process
     * with the --debug command line switch.
     */
    function cmdEnableDebugger() {
        // Unfortunately, there's no indication of whether this succeeded
        // This is the case for _all_ of the methods for enabling the debugger.
        process._debugProcess(process.pid);
    }

    /**
     * @private
     * Implementation of base.restartNode command.
     */
    function cmdRestartNode() {
//        Launcher.exit();
    }

    /**
     * @private
     * Implementation of base.loadDomainModulesFromPaths
     * @param {Array.<string>} paths Paths to load
     * @return {boolean} Whether the load succeeded
     */
    function cmdLoadDomainModulesFromPaths(paths) {
        if (_domainManager) {
            var success = _domainManager.loadDomainModulesFromPaths(paths);
            if (success) {
                _domainManager.emitEvent("base", "newDomains");
            }
            return success;
        } else {
            return false;
        }
    }

    /**
     *
     * Registers commands with the DomainManager
     * @param {DomainManager} domainManager The DomainManager to use
     */
    function init(domainManager) {
        _domainManager = domainManager;

        _domainManager.registerDomain("base", {major: 0, minor: 1});
        _domainManager.registerCommand(
            "base",
            "enableDebugger",
            cmdEnableDebugger,
            false,
            "Attempt to enable the debugger",
            [], // no parameters
            []  // no return type
        );
        _domainManager.registerCommand(
            "base",
            "restartNode",
            cmdRestartNode,
            false,
            "Attempt to restart the Node server",
            [], // no parameters
            []  // no return type
        );
        _domainManager.registerCommand(
            "base",
            "loadDomainModulesFromPaths",
            cmdLoadDomainModulesFromPaths,
            false,
            "Attempt to load command modules from the given paths. " +
            "The paths should be absolute.",
            [{name: "paths", type: "array<string>"}],
            [{name: "success", type: "boolean"}]
        );

        _domainManager.registerEvent(
            "base",
            "log",
            [{name: "level", type: "string"},
             {name: "timestamp", type: "Date"},
             {name: "message", type: "string"}]
        );
        Logger.on(
            "log",
            function (level, timestamp, message) {
                _domainManager.emitEvent(
                    "base",
                    "log",
                    [level, timestamp, message]
                );
            }
        );

        _domainManager.registerEvent("base", "newDomains", []);
    }

    exports.init = init;

}());