1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-20 15:37:59 +01:00
Files
pentadactyl-pm/common/modules/overlay.jsm
Kris Maglione 7a0c7dacbe Move config module to config.jsm.
--HG--
rename : common/content/configbase.js => common/modules/config.jsm
2010-12-29 14:49:20 -05:00

267 lines
11 KiB
JavaScript

// Copyright (c) 2009-2010 by Kris Maglione <maglione.k@gmail.com>
//
// This work is licensed for reuse under an MIT license. Details are
// given in the LICENSE.txt file included with this file.
"use strict";
Components.utils.import("resource://dactyl/base.jsm");
defineModule("overlay", {
exports: ["ModuleBase"],
require: ["config", "sanitizer", "services", "util"]
});
/**
* @class ModuleBase
* The base class for all modules.
*/
var ModuleBase = Class("ModuleBase", {
/**
* @property {[string]} A list of module prerequisites which
* must be initialized before this module is loaded.
*/
requires: [],
toString: function () "[module " + this.constructor.className + "]"
});
var Overlay = Module("Overlay", {
init: function () {
util.overlayWindow(config.overlayChrome, function (window) ({
init: function (document) {
/**
* @constructor Module
*
* Constructs a new ModuleBase class and makes arrangements for its
* initialization. Arguments marked as optional must be either
* entirely elided, or they must have the exact type specified.
* Loading semantics are as follows:
*
* - A module is guaranteed not to be initialized before any of its
* prerequisites as listed in its {@see ModuleBase#requires} member.
* - A module is considered initialized once it's been instantiated,
* its {@see Class#init} method has been called, and its
* instance has been installed into the top-level {@see modules}
* object.
* - Once the module has been initialized, its module-dependent
* initialization functions will be called as described hereafter.
* @param {string} name The module's name as it will appear in the
* top-level {@see modules} object.
* @param {ModuleBase} base The base class for this module.
* @optional
* @param {Object} prototype The prototype for instances of this
* object. The object itself is copied and not used as a prototype
* directly.
* @param {Object} classProperties The class properties for the new
* module constructor.
* @optional
* @param {Object} moduleInit The module initialization functions
* for the new module. Each function is called as soon as the named module
* has been initialized, but after the module itself. The constructors are
* guaranteed to be called in the same order that the dependent modules
* were initialized.
* @optional
*
* @returns {function} The constructor for the resulting module.
*/
function Module(name) {
let args = Array.slice(arguments);
var base = ModuleBase;
if (callable(args[1]))
base = args.splice(1, 1)[0];
let [, prototype, classProperties, moduleInit] = args;
const module = Class(name, base, prototype, classProperties);
module.INIT = moduleInit || {};
module.prototype.INIT = module.INIT;
module.requires = prototype.requires || [];
Module.list.push(module);
Module.constructors[name] = module;
return module;
}
Module.list = [];
Module.constructors = {};
const BASE = "chrome://dactyl/content/";
const create = window.Object.create || (function () {
window.__dactyl_eval_string = "(function (proto) ({ __proto__: proto }))";
services.subscriptLoader.loadSubScript(BASE + "eval.js", window);
let res = window.__dactyl_eval_result;
delete window.__dactyl_eval_string;
delete window.__dactyl_eval_result;
return res;
})();
const jsmodules = { NAME: "jsmodules" };
const modules = update(create(jsmodules), {
jsmodules: jsmodules,
get content() this.config.browser.contentWindow || window.content,
window: window,
Module: Module,
load: function load(script) {
for (let [i, base] in Iterator(prefix)) {
try {
services.subscriptLoader.loadSubScript(base + script + ".js", modules, "UTF-8");
return;
}
catch (e) {
if (typeof e !== "string") {
util.dump("Trying: " + (base + script + ".js") + ":");
util.reportError(e);
}
}
}
try {
require(jsmodules, script);
}
catch (e) {
util.dump("Loading script " + script + ":");
util.reportError(e);
}
},
newContext: function newContext(proto) {
let sandbox = Components.utils.Sandbox(window, { sandboxPrototype: proto || modules, wantXrays: false });
// Hack:
sandbox.Object = jsmodules.Object;
sandbox.Math = jsmodules.Math;
sandbox.__proto__ = proto || modules;
return sandbox;
}
});
modules.modules = modules;
window.dactyl = { modules: modules };
let prefix = [BASE];
["base",
"config",
"util",
"services",
"overlay",
"prefs",
"storage"
].forEach(function (name) require(jsmodules, name));
prefix.unshift("chrome://" + config.name + "/content/");
["javascript",
"dactyl",
"modes",
"abbreviations",
"autocommands",
"buffer",
"commandline",
"commands",
"completion",
"editor",
"events",
"finder",
"highlight",
"hints",
"io",
"mappings",
"marks",
"options",
"statusline",
"styles",
"template"
].forEach(modules.load);
config.scripts.forEach(modules.load);
},
load: function (document) {
var { modules, Module } = window.dactyl.modules;
delete window.dactyl;
Module.list.forEach(function (module) {
modules.__defineGetter__(module.className, function () {
delete modules[module.className];
return load(module.className, null, Components.stack.caller);
});
});
const start = Date.now();
const deferredInit = { load: [] };
const seen = set();
const loaded = set(["init"]);
modules.loaded = loaded;
function init(module) {
function init(func, mod)
function () defineModule.time(module.className || module.constructor.className, mod,
func, module,
modules.dactyl, modules, window);
set.add(loaded, module.constructor.className);
for (let [mod, func] in Iterator(module.INIT)) {
if (mod in loaded)
init(func, mod)();
else {
deferredInit[mod] = deferredInit[mod] || [];
deferredInit[mod].push(init(func, mod));
}
}
}
defineModule.modules.map(init);
function load(module, prereq, frame) {
if (isString(module)) {
if (!Module.constructors.hasOwnProperty(module))
modules.load(module);
module = Module.constructors[module];
}
try {
if (module.className in loaded)
return;
if (module.className in seen)
throw Error("Module dependency loop.");
set.add(seen, module.className);
for (let dep in values(module.requires))
load(Module.constructors[dep], module.className);
defineModule.loadLog.push("Load" + (isString(prereq) ? " " + prereq + " dependency: " : ": ") + module.className);
if (frame && frame.filename)
defineModule.loadLog.push(" from: " + frame.filename + ":" + frame.lineNumber);
delete modules[module.className];
modules[module.className] = defineModule.time(module.className, "init", module);
init(modules[module.className]);
for (let [, fn] in iter(deferredInit[module.className] || []))
fn();
}
catch (e) {
util.dump("Loading " + (module && module.className) + ":");
util.reportError(e);
}
return modules[module.className];
}
Module.list.forEach(load);
deferredInit["load"].forEach(call);
modules.times = update({}, defineModule.times);
util.dump("Loaded in " + (Date.now() - start) + "ms");
modules.events.addSessionListener(window, "unload", function onUnload() {
window.removeEventListener("unload", onUnload.wrapped, false);
for (let [, mod] in iter(modules))
if (mod instanceof ModuleBase && "destroy" in mod)
util.trapErrors(mod.destroy, mod);
}, false);
}
}));
}
});
// vim: set fdm=marker sw=4 ts=4 et: