summaryrefslogtreecommitdiff
path: root/common/modules/messages.jsm
blob: 1cbf3be3e225f7a302571427da74dbcd32164758 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
// Copyright (c) 2011-2014 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";

defineModule("messages", {
    exports: ["Messages", "messages", "_"],
    require: ["services", "util"]
});

var Messages = Module("messages", {

    init: function init(name="messages") {
        let self = this;
        this.name = name;

        this._ = Class("_", String, {
            init: function _(message) {
                this.args = arguments;
            },
            instance: {},
            message: Class.Memoize(function () {
                let message = this.args[0];

                if (this.args.length > 1) {
                    let args = Array.slice(this.args, 1);
                    return self.format(message + "-" + args.length, args, null) || self.format(message, args);
                }
                return self.get(message);
            }),
            valueOf: function valueOf() this.message,
            toString: function toString() this.message
        });
    },

    cleanup: function cleanup() {
        services.stringBundle.flushBundles();
    },

    bundles: Class.Memoize(function ()
        array.uniq([JSMLoader.getTarget("dactyl://locale/" + this.name + ".properties"),
                    JSMLoader.getTarget("dactyl://locale-local/" + this.name + ".properties"),
                    "resource://dactyl-locale/en-US/" + this.name + ".properties",
                    "resource://dactyl-locale-local/en-US/" + this.name + ".properties"],
                   true)
             .map(services.stringBundle.createBundle)
             .filter(function (bundle) {
                 try {
                     bundle.getSimpleEnumeration();
                     return true;
                 }
                 catch (e) {
                     return false;
                 }
             })),

    iterate: function* () {
        let seen = new RealSet;
        for (let bundle of this.bundles)
            for (let { key, value } of iter(bundle.getSimpleEnumeration(), Ci.nsIPropertyElement))
                if (!seen.add(key))
                    yield [key, value];
    },

    get: function get(value, default_) {
        for (let bundle of this.bundles)
            try {
                let res = bundle.GetStringFromName(value);
                if (res.slice(0, 2) == "+ ")
                    return res.slice(2).replace(/\s+/g, " ");
                return res;
            }
            catch (e) {}

        // Report error so tests fail, but don't throw
        if (arguments.length < 2) // Do *not* localize these strings
            util.reportError(Error("Invalid locale string: " + value));
        return arguments.length > 1 ? default_ : value;
    },

    format: function format(value, args, default_) {
        for (let bundle of this.bundles)
            try {
                let res = bundle.formatStringFromName(value, args, args.length);
                if (res.slice(0, 2) == "+ ")
                    return res.slice(2).replace(/\s+/g, " ");
                return res;
            }
            catch (e) {}

        // Report error so tests fail, but don't throw
        if (arguments.length < 3) // Do *not* localize these strings
            util.reportError(Error("Invalid locale string: " + value));
        return arguments.length > 2 ? default_ : value;
    },

    /**
     * Exports known localizable strings to a properties file.
     *
     * @param {string|nsIFile} {file} The file to which to export
     *      the strings.
     */
    export: function export_(file) {
        let { Buffer, commands, hints, io, mappings, modes, options, sanitizer } = overlay.activeModules;
        file = io.File(file);

        function properties(base, iter_, prop="description") iter(function* _properties() {
            function key(...args) [base, obj.identifier || obj.name].concat(args).join(".").replace(/[\\:=]/g, "\\$&");

            for (var obj of iter_) {
                if (!obj.hive || obj.hive.name !== "user") {
                    yield key(prop) + " = " + obj[prop];

                    if (iter_.values) {
                        let iter_ = isArray(obj.values) ? array.iterValues(obj.values)
                                                        : iter(obj.values);

                        for (let [k, v] of iter_)
                            yield key("values", k) + " = " + v;
                    }

                    for (let opt of values(obj.options))
                        yield key("options", opt.names[0]) + " = " + opt.description;

                    if (obj.deprecated)
                        yield key("deprecated") + " = " + obj.deprecated;
                }
            }
        }()).toArray();

        file.write(
            array(commands.allHives.map(h => properties("command", h)))
                          .concat(modes.all.map(m =>
                              properties("map", values(mappings.builtin.getStack(m)
                                                               .filter(map => map.modes[0] == m)))))
                          .concat(properties("mode", values(modes.all.filter(m => !m.hidden))))
                          .concat(properties("option", options))
                          .concat(properties("hintmode", values(hints.modes), "prompt"))
                          .concat(properties("pageinfo", values(Buffer.pageInfo), "title"))
                          .concat(properties("sanitizeitem", values(sanitizer.itemMap)))
                .flatten().uniq().join("\n"));
    }
}, {
    Localized: Class("Localized", Class.Property, {
        init: function init(prop, obj) {
            let _prop = "unlocalized_" + prop;
            if (this.initialized) {
                /*
                if (config.locale === "en-US")
                    return { configurable: true, enumerable: true, value: this.default, writable: true };
                */

                if (!hasOwnProperty(obj, "localizedProperties"))
                    obj.localizedProperties = new RealSet(obj.localizedProperties);
                obj.localizedProperties.add(prop);

                obj[_prop] = this.default;
                return {
                    get: function get() {
                        let value = this[_prop];

                        function getter(key, default_) function getter() messages.get([name, key].join("."), default_);

                        if (value != null) {
                            var name = [this.constructor.className.toLowerCase(),
                                        this.identifier || this.name,
                                        prop].join(".");

                            if (!isObject(value))
                                value = messages.get(name, value);
                            else if (isArray(value))
                                // Deprecated
                                iter(value).forEach(function ([k, v]) {
                                    if (isArray(v))
                                        memoize(v, 1, getter(v[0], v[1]));
                                    else
                                        memoize(value, k, getter(k, v));
                                });
                            else
                                iter(value).forEach(function ([k, v]) {
                                    memoize(value, k, () => messages.get([name, k].join("."), v));
                                });
                        }

                        return Class.replaceProperty(this, prop, value);
                    },

                    set: function set(val) this[_prop] = val
                };
            }
            this.default = prop;
            this.initialized = true;
        }
    })
}, {
    javascript: function initJavascript(dactyl, modules, window) {
        let { JavaScript } = modules;

        JavaScript.setCompleter([this._, this.get, this.format], [
            context => messages.iterate()
        ]);

        JavaScript.setCompleter([this.export],
            [function (context, obj, args) {
                context.quote[2] = "";
                modules.completion.file(context, true);
            }]);
    }
});

var { _ } = messages;

endModule();

// catch(e){ if (!e.stack) e = Error(e); dump(e.fileName+":"+e.lineNumber+": "+e+"\n" + e.stack); }

// vim: set fdm=marker sw=4 sts=4 ts=8 et ft=javascript: