1 // Copyright (c) 2011-2012 Kris Maglione <maglione.k@gmail.com>
3 // This work is licensed for reuse under an MIT license. Details are
4 // given in the LICENSE.txt file included with this file.
7 defineModule("messages", {
8 exports: ["Messages", "messages", "_"],
9 require: ["services", "util"]
12 var Messages = Module("messages", {
14 init: function init(name) {
16 this.name = name || "messages";
18 this._ = Class("_", String, {
19 init: function _(message) {
20 this.args = arguments;
23 message: Class.Memoize(function () {
24 let message = this.args[0];
26 if (this.args.length > 1) {
27 let args = Array.slice(this.args, 1);
28 return self.format(message + "-" + args.length, args, null) || self.format(message, args);
30 return self.get(message);
32 valueOf: function valueOf() this.message,
33 toString: function toString() this.message
37 cleanup: function cleanup() {
38 services.stringBundle.flushBundles();
41 bundles: Class.Memoize(function ()
42 array.uniq([JSMLoader.getTarget("dactyl://locale/" + this.name + ".properties"),
43 JSMLoader.getTarget("dactyl://locale-local/" + this.name + ".properties"),
44 "resource://dactyl-locale/en-US/" + this.name + ".properties",
45 "resource://dactyl-locale-local/en-US/" + this.name + ".properties"],
47 .map(services.stringBundle.createBundle)
48 .filter(function (bundle) { try { bundle.getSimpleEnumeration(); return true; } catch (e) { return false; } })),
50 iterate: function () {
52 for (let bundle in values(this.bundles))
53 for (let { key, value } in iter(bundle.getSimpleEnumeration(), Ci.nsIPropertyElement))
54 if (!Set.add(seen, key))
58 get: function get(value, default_) {
59 for (let bundle in values(this.bundles))
61 let res = bundle.GetStringFromName(value);
62 if (res.slice(0, 2) == "+ ")
63 return res.slice(2).replace(/\s+/g, " ");
68 // Report error so tests fail, but don't throw
69 if (arguments.length < 2) // Do *not* localize these strings
70 util.reportError(Error("Invalid locale string: " + value));
71 return arguments.length > 1 ? default_ : value;
74 format: function format(value, args, default_) {
75 for (let bundle in values(this.bundles))
77 let res = bundle.formatStringFromName(value, args, args.length);
78 if (res.slice(0, 2) == "+ ")
79 return res.slice(2).replace(/\s+/g, " ");
84 // Report error so tests fail, but don't throw
85 if (arguments.length < 3) // Do *not* localize these strings
86 util.reportError(Error("Invalid locale string: " + value));
87 return arguments.length > 2 ? default_ : value;
91 * Exports known localizable strings to a properties file.
93 * @param {string|nsIFile} {file} The file to which to export
96 export: function export_(file) {
97 let { Buffer, commands, hints, io, mappings, modes, options, sanitizer } = overlay.activeModules;
100 function properties(base, iter_, prop) iter(function _properties() {
101 function key() [base, obj.identifier || obj.name].concat(Array.slice(arguments)).join(".").replace(/[\\:=]/g, "\\$&");
103 prop = prop || "description";
104 for (var obj in iter_) {
105 if (!obj.hive || obj.hive.name !== "user") {
106 yield key(prop) + " = " + obj[prop];
109 for (let [k, v] in isArray(obj.values) ? array.iterValues(obj.values) : iter(obj.values))
110 yield key("values", k) + " = " + v;
112 for (let opt in values(obj.options))
113 yield key("options", opt.names[0]) + " = " + opt.description;
116 yield key("deprecated") + " = " + obj.deprecated;
122 array(commands.allHives.map(function (h) properties("command", h)))
123 .concat(modes.all.map(function (m)
124 properties("map", values(mappings.builtin.getStack(m)
125 .filter(function (map) map.modes[0] == m)))))
126 .concat(properties("mode", values(modes.all.filter(function (m) !m.hidden))))
127 .concat(properties("option", options))
128 .concat(properties("hintmode", values(hints.modes), "prompt"))
129 .concat(properties("pageinfo", values(Buffer.pageInfo), "title"))
130 .concat(properties("sanitizeitem", values(sanitizer.itemMap)))
131 .flatten().uniq().join("\n"));
134 Localized: Class("Localized", Class.Property, {
135 init: function init(prop, obj) {
136 let _prop = "unlocalized_" + prop;
137 if (this.initialized) {
139 if (config.locale === "en-US")
140 return { configurable: true, enumerable: true, value: this.default, writable: true };
143 if (!Set.has(obj, "localizedProperties"))
144 obj.localizedProperties = { __proto__: obj.localizedProperties };
145 obj.localizedProperties[prop] = true;
147 obj[_prop] = this.default;
149 get: function get() {
151 let value = this[_prop];
153 function getter(key, default_) function getter() messages.get([name, key].join("."), default_);
156 var name = [this.constructor.className.toLowerCase(),
157 this.identifier || this.name,
160 if (!isObject(value))
161 value = messages.get(name, value);
162 else if (isArray(value))
164 iter(value).forEach(function ([k, v]) {
166 memoize(v, 1, getter(v[0], v[1]));
168 memoize(value, k, getter(k, v));
171 iter(value).forEach(function ([k, v]) {
172 memoize(value, k, function () messages.get([name, k].join("."), v));
176 return Class.replaceProperty(this, prop, value);
179 set: function set(val) this[_prop] = val
183 this.initialized = true;
187 javascript: function initJavascript(dactyl, modules, window) {
188 let { JavaScript } = modules;
190 JavaScript.setCompleter([this._, this.get, this.format], [
191 function (context) messages.iterate()
194 JavaScript.setCompleter([this.export],
195 [function (context, obj, args) {
196 context.quote[2] = "";
197 modules.completion.file(context, true);
202 var { _ } = messages;
206 // catch(e){ if (!e.stack) e = Error(e); dump(e.fileName+":"+e.lineNumber+": "+e+"\n" + e.stack); }
208 // vim: set fdm=marker sw=4 ts=4 et ft=javascript: