common/modules/services.jsm

   1 // Copyright (c) 2008-2011 by Kris Maglione <maglione.k at Gmail>
   2 //
   3 // This work is licensed for reuse under an MIT license. Details are
   4 // given in the LICENSE.txt file included with this file.
   5 "use strict";
   6
   7 try {
   8
   9 var global = this;
  10 Components.utils.import("resource://dactyl/bootstrap.jsm");
  11 defineModule("services", {
  12     exports: ["services"],
  13     use: ["util"]
  14 }, this);
  15
  16 /**
  17  * A lazily-instantiated XPCOM class and service cache.
  18  */
  19 var Services = Module("Services", {
  20     init: function () {
  21         this.services = {};
  22
  23         this.add("annotation",          "@mozilla.org/browser/annotation-service;1",        "nsIAnnotationService");
  24         this.add("appShell",            "@mozilla.org/appshell/appShellService;1",          "nsIAppShellService");
  25         this.add("appStartup",          "@mozilla.org/toolkit/app-startup;1",               "nsIAppStartup");
  26         this.add("autoCompleteSearch",  "@mozilla.org/autocomplete/search;1?name=history",  "nsIAutoCompleteSearch");
  27         this.add("bookmarks",           "@mozilla.org/browser/nav-bookmarks-service;1",     "nsINavBookmarksService");
  28         this.add("browserSearch",       "@mozilla.org/browser/search-service;1",            "nsIBrowserSearchService");
  29         this.add("cache",               "@mozilla.org/network/cache-service;1",             "nsICacheService");
  30         this.add("charset",             "@mozilla.org/charset-converter-manager;1",         "nsICharsetConverterManager");
  31         this.add("chromeRegistry",      "@mozilla.org/chrome/chrome-registry;1",            "nsIXULChromeRegistry");
  32         this.add("commandLineHandler",  "@mozilla.org/commandlinehandler/general-startup;1?type=dactyl");
  33         this.add("console",             "@mozilla.org/consoleservice;1",                    "nsIConsoleService");
  34         this.add("dactyl:",             "@mozilla.org/network/protocol;1?name=dactyl");
  35         this.add("debugger",            "@mozilla.org/js/jsd/debugger-service;1",           "jsdIDebuggerService");
  36         this.add("directory",           "@mozilla.org/file/directory_service;1",            "nsIProperties");
  37         this.add("downloadManager",     "@mozilla.org/download-manager;1",                  "nsIDownloadManager");
  38         this.add("environment",         "@mozilla.org/process/environment;1",               "nsIEnvironment");
  39         this.add("extensionManager",    "@mozilla.org/extensions/manager;1",                "nsIExtensionManager");
  40         this.add("externalProtocol",    "@mozilla.org/uriloader/external-protocol-service;1", "nsIExternalProtocolService");
  41         this.add("favicon",             "@mozilla.org/browser/favicon-service;1",           "nsIFaviconService");
  42         this.add("focus",               "@mozilla.org/focus-manager;1",                     "nsIFocusManager");
  43         this.add("history",             "@mozilla.org/browser/global-history;2",
  44                  ["nsIBrowserHistory", "nsIGlobalHistory3", "nsINavHistoryService", "nsPIPlacesDatabase"]);
  45         this.add("io",                  "@mozilla.org/network/io-service;1",                "nsIIOService");
  46         this.add("json",                "@mozilla.org/dom/json;1",                          "nsIJSON", "createInstance");
  47         this.add("livemark",            "@mozilla.org/browser/livemark-service;2",          "nsILivemarkService");
  48         this.add("mime",                "@mozilla.org/mime;1",                              "nsIMIMEService");
  49         this.add("observer",            "@mozilla.org/observer-service;1",                  "nsIObserverService");
  50         this.add("pref",                "@mozilla.org/preferences-service;1",               ["nsIPrefBranch2", "nsIPrefService"]);
  51         this.add("privateBrowsing",     "@mozilla.org/privatebrowsing;1",                   "nsIPrivateBrowsingService");
  52         this.add("profile",             "@mozilla.org/toolkit/profile-service;1",           "nsIToolkitProfileService");
  53         this.add("resource:",           "@mozilla.org/network/protocol;1?name=resource",    ["nsIProtocolHandler", "nsIResProtocolHandler"]);
  54         this.add("runtime",             "@mozilla.org/xre/runtime;1",                       ["nsIXULAppInfo", "nsIXULRuntime"]);
  55         this.add("rdf",                 "@mozilla.org/rdf/rdf-service;1",                   "nsIRDFService");
  56         this.add("sessionStore",        "@mozilla.org/browser/sessionstore;1",              "nsISessionStore");
  57         this.add("stringBundle",        "@mozilla.org/intl/stringbundle;1",                 "nsIStringBundleService");
  58         this.add("stylesheet",          "@mozilla.org/content/style-sheet-service;1",       "nsIStyleSheetService");
  59         this.add("subscriptLoader",     "@mozilla.org/moz/jssubscript-loader;1",            "mozIJSSubScriptLoader");
  60         this.add("tagging",             "@mozilla.org/browser/tagging-service;1",           "nsITaggingService");
  61         this.add("threading",           "@mozilla.org/thread-manager;1",                    "nsIThreadManager");
  62         this.add("urifixup",            "@mozilla.org/docshell/urifixup;1",                 "nsIURIFixup");
  63         this.add("versionCompare",      "@mozilla.org/xpcom/version-comparator;1",          "nsIVersionComparator");
  64         this.add("windowMediator",      "@mozilla.org/appshell/window-mediator;1",          "nsIWindowMediator");
  65         this.add("windowWatcher",       "@mozilla.org/embedcomp/window-watcher;1",          "nsIWindowWatcher");
  66         this.add("zipReader",           "@mozilla.org/libjar/zip-reader-cache;1",           "nsIZipReaderCache");
  67
  68         this.addClass("CharsetConv",  "@mozilla.org/intl/scriptableunicodeconverter", "nsIScriptableUnicodeConverter", "charset");
  69         this.addClass("File",         "@mozilla.org/file/local;1",                 "nsILocalFile");
  70         this.addClass("file:",        "@mozilla.org/network/protocol;1?name=file", "nsIFileProtocolHandler");
  71         this.addClass("Find",         "@mozilla.org/embedcomp/rangefind;1",        "nsIFind");
  72         this.addClass("HtmlConverter","@mozilla.org/widget/htmlformatconverter;1", "nsIFormatConverter");
  73         this.addClass("HtmlEncoder",  "@mozilla.org/layout/htmlCopyEncoder;1",     "nsIDocumentEncoder");
  74         this.addClass("InputStream",  "@mozilla.org/scriptableinputstream;1",      "nsIScriptableInputStream", "init");
  75         this.addClass("Persist",      "@mozilla.org/embedding/browser/nsWebBrowserPersist;1", "nsIWebBrowserPersist");
  76         this.addClass("Pipe",         "@mozilla.org/pipe;1",                       "nsIPipe", "init");
  77         this.addClass("Process",      "@mozilla.org/process/util;1",               "nsIProcess", "init");
  78         this.addClass("StreamChannel","@mozilla.org/network/input-stream-channel;1",
  79                       ["nsIChannel", "nsIInputStreamChannel", "nsIRequest"], "setURI");
  80         this.addClass("StreamCopier", "@mozilla.org/network/async-stream-copier;1","nsIAsyncStreamCopier", "init");
  81         this.addClass("String",       "@mozilla.org/supports-string;1",            "nsISupportsString", "data");
  82         this.addClass("StringStream", "@mozilla.org/io/string-input-stream;1",     "nsIStringInputStream", "data");
  83         this.addClass("Transfer",     "@mozilla.org/transfer;1",                   "nsITransfer", "init");
  84         this.addClass("Timer",        "@mozilla.org/timer;1",                      "nsITimer", "initWithCallback");
  85         this.addClass("Xmlhttp",      "@mozilla.org/xmlextras/xmlhttprequest;1",   "nsIXMLHttpRequest");
  86         this.addClass("XPathEvaluator", "@mozilla.org/dom/xpath-evaluator;1",      "nsIDOMXPathEvaluator");
  87         this.addClass("ZipReader",    "@mozilla.org/libjar/zip-reader;1",          "nsIZipReader", "open");
  88         this.addClass("ZipWriter",    "@mozilla.org/zipwriter;1",                  "nsIZipWriter");
  89     },
  90     reinit: function () {},
  91
  92     _create: function (classes, ifaces, meth, init, args) {
  93         try {
  94             let res = Cc[classes][meth || "getService"]();
  95             if (!ifaces)
  96                 return res["wrapped" + "JSObject"]; // Kill stupid validator warning
  97             Array.concat(ifaces).forEach(function (iface) res.QueryInterface(Ci[iface]));
  98             if (init && args.length) {
  99                 try {
 100                     var isCallable = callable(res[init]);
 101                 }
 102                 catch (e) {} // Ugh.
 103
 104                 if (isCallable)
 105                     res[init].apply(res, args);
 106                 else
 107                     res[init] = args[0];
 108             }
 109             return res;
 110         }
 111         catch (e) {
 112             if (typeof util !== "undefined")
 113                 util.reportError(e);
 114             else
 115                 dump("dactyl: Service creation failed for '" + classes + "': " + e + "\n" + (e.stack || Error(e).stack));
 116             return null;
 117         }
 118     },
 119
 120     /**
 121      * Adds a new XPCOM service to the cache.
 122      *
 123      * @param {string} name The service's cache key.
 124      * @param {string} class The class's contract ID.
 125      * @param {string|string[]} ifaces The interface or array of
 126      *     interfaces implemented by this service.
 127      * @param {string} meth The name of the function used to instantiate
 128      *     the service.
 129      */
 130     add: function (name, class_, ifaces, meth) {
 131         const self = this;
 132         this.services[name] = { class: class_, interfaces: Array.concat(ifaces || []) };
 133         if (name in this && ifaces && !this.__lookupGetter__(name) && !(this[name] instanceof Ci.nsISupports))
 134             throw TypeError();
 135         memoize(this, name, function () self._create(class_, ifaces, meth));
 136     },
 137
 138     /**
 139      * Adds a new XPCOM class to the cache.
 140      *
 141      * @param {string} name The class's cache key.
 142      * @param {string} class_ The class's contract ID.
 143      * @param {nsISupports|nsISupports[]} ifaces The interface or array of
 144      *     interfaces implemented by this class.
 145      * @param {string} init Name of a property or method used to initialise the
 146      *     class. See {@link #_create}.
 147      */
 148     addClass: function (name, class_, ifaces, init) {
 149         const self = this;
 150         this[name] = function () self._create(class_, ifaces, "createInstance", init, arguments);
 151         update.apply(null, [this[name]].concat([Ci[i] for each (i in Array.concat(ifaces))]));
 152         return this[name];
 153     },
 154
 155     /**
 156      * Returns a new instance of the cached class with the specified name.
 157      *
 158      * @param {string} name The class's cache key.
 159      */
 160     create: function (name) this[name[0].toUpperCase() + name.substr(1)],
 161
 162     /**
 163      * Returns the cached service with the specified name.
 164      *
 165      * @param {string} name The service's cache key.
 166      */
 167     get: function (name) this[name],
 168
 169     /**
 170      * Returns true if the given service is available.
 171      *
 172      * @param {string} name The service's cache key.
 173      */
 174     has: function (name) set.has(this.services, name) && this.services[name].class in Cc &&
 175         this.services[name].interfaces.every(function (iface) iface in Ci)
 176 }, {
 177 }, {
 178     javascript: function (dactyl, modules) {
 179         modules.JavaScript.setCompleter(this.get, [function () [[k, v] for ([k, v] in Iterator(services)) if (v instanceof Ci.nsISupports)]]);
 180     }
 181 });
 182
 183 endModule();
 184
 185 } catch(e){dump(e.fileName+":"+e.lineNumber+": "+e+"\n" + e.stack);}
 186
 187 // vim: set fdm=marker sw=4 sts=4 et ft=javascript: