forked from dojo/dojo-oldmirror
-
Notifications
You must be signed in to change notification settings - Fork 0
/
i18n.js
608 lines (555 loc) · 24 KB
/
i18n.js
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
define(["./_base/kernel", "require", "./has", "./_base/array", "./_base/config", "./_base/lang", "./has!host-browser?./_base/xhr", "./json", "module"],
function(dojo, require, has, array, config, lang, xhr, json, module){
// module:
// dojo/i18n
has.add("dojo-preload-i18n-Api",
// if true, define the preload localizations machinery
1
);
has.add("dojo-v1x-i18n-Api",
// if true, define the v1.x i18n functions
1
);
var
thisModule = dojo.i18n =
{
// summary:
// This module implements the dojo/i18n! plugin and the v1.6- i18n API
// description:
// We choose to include our own plugin to leverage functionality already contained in dojo
// and thereby reduce the size of the plugin compared to various loader implementations. Also, this
// allows foreign AMD loaders to be used without their plugins.
},
nlsRe =
// regexp for reconstructing the master bundle name from parts of the regexp match
// nlsRe.exec("foo/bar/baz/nls/en-ca/foo") gives:
// ["foo/bar/baz/nls/en-ca/foo", "foo/bar/baz/nls/", "/", "/", "en-ca", "foo"]
// nlsRe.exec("foo/bar/baz/nls/foo") gives:
// ["foo/bar/baz/nls/foo", "foo/bar/baz/nls/", "/", "/", "foo", ""]
// so, if match[5] is blank, it means this is the top bundle definition.
// courtesy of http://requirejs.org
/(^.*(^|\/)nls)(\/|$)([^\/]*)\/?([^\/]*)/,
getAvailableLocales = function(
root,
locale,
bundlePath,
bundleName
){
// summary:
// return a vector of module ids containing all available locales with respect to the target locale
// For example, assuming:
//
// - the root bundle indicates specific bundles for "fr" and "fr-ca",
// - bundlePath is "myPackage/nls"
// - bundleName is "myBundle"
//
// Then a locale argument of "fr-ca" would return
//
// ["myPackage/nls/myBundle", "myPackage/nls/fr/myBundle", "myPackage/nls/fr-ca/myBundle"]
//
// Notice that bundles are returned least-specific to most-specific, starting with the root.
//
// If root===false indicates we're working with a pre-AMD i18n bundle that doesn't tell about the available locales;
// therefore, assume everything is available and get 404 errors that indicate a particular localization is not available
for(var result = [bundlePath + bundleName], localeParts = locale.split("-"), current = "", i = 0; i<localeParts.length; i++){
current += (current ? "-" : "") + localeParts[i];
if(!root || root[current]){
result.push(bundlePath + current + "/" + bundleName);
result.specificity = current;
}
}
return result;
},
cache = {},
getBundleName = function(moduleName, bundleName, locale){
locale = locale ? locale.toLowerCase() : dojo.locale;
moduleName = moduleName.replace(/\./g, "/");
bundleName = bundleName.replace(/\./g, "/");
return (/root/i.test(locale)) ?
(moduleName + "/nls/" + bundleName) :
(moduleName + "/nls/" + locale + "/" + bundleName);
},
getL10nName = dojo.getL10nName = function(moduleName, bundleName, locale){
return moduleName = module.id + "!" + getBundleName(moduleName, bundleName, locale);
},
doLoad = function(require, bundlePathAndName, bundlePath, bundleName, locale, load){
// summary:
// get the root bundle which instructs which other bundles are required to construct the localized bundle
require([bundlePathAndName], function(root){
var current = lang.clone(root.root || root.ROOT),// 1.6 built bundle defined ROOT
availableLocales = getAvailableLocales(!root._v1x && root, locale, bundlePath, bundleName);
require(availableLocales, function(){
for (var i = 1; i<availableLocales.length; i++){
current = lang.mixin(lang.clone(current), arguments[i]);
}
// target may not have been resolve (e.g., maybe only "fr" exists when "fr-ca" was requested)
var target = bundlePathAndName + "/" + locale;
cache[target] = current;
current.$locale = availableLocales.specificity;
load();
});
});
},
normalize = function(id, toAbsMid){
// summary:
// id may be relative.
// preload has form `*preload*<path>/nls/<module>*<flattened locales>` and
// therefore never looks like a relative
return /^\./.test(id) ? toAbsMid(id) : id;
},
getLocalesToLoad = function(targetLocale){
var list = config.extraLocale || [];
list = lang.isArray(list) ? list : [list];
list.push(targetLocale);
return list;
},
load = function(id, require, load){
// summary:
// id is in one of the following formats
//
// 1. <path>/nls/<bundle>
// => load the bundle, localized to config.locale; load all bundles localized to
// config.extraLocale (if any); return the loaded bundle localized to config.locale.
//
// 2. <path>/nls/<locale>/<bundle>
// => load then return the bundle localized to <locale>
//
// 3. *preload*<path>/nls/<module>*<JSON array of available locales>
// => for config.locale and all config.extraLocale, load all bundles found
// in the best-matching bundle rollup. A value of 1 is returned, which
// is meaningless other than to say the plugin is executing the requested
// preloads
//
// In cases 1 and 2, <path> is always normalized to an absolute module id upon entry; see
// normalize. In case 3, it <path> is assumed to be absolute; this is arranged by the builder.
//
// To load a bundle means to insert the bundle into the plugin's cache and publish the bundle
// value to the loader. Given <path>, <bundle>, and a particular <locale>, the cache key
//
// <path>/nls/<bundle>/<locale>
//
// will hold the value. Similarly, then plugin will publish this value to the loader by
//
// define("<path>/nls/<bundle>/<locale>", <bundle-value>);
//
// Given this algorithm, other machinery can provide fast load paths be preplacing
// values in the plugin's cache, which is public. When a load is demanded the
// cache is inspected before starting any loading. Explicitly placing values in the plugin
// cache is an advanced/experimental feature that should not be needed; use at your own risk.
//
// For the normal AMD algorithm, the root bundle is loaded first, which instructs the
// plugin what additional localized bundles are required for a particular locale. These
// additional locales are loaded and a mix of the root and each progressively-specific
// locale is returned. For example:
//
// 1. The client demands "dojo/i18n!some/path/nls/someBundle
//
// 2. The loader demands load(some/path/nls/someBundle)
//
// 3. This plugin require's "some/path/nls/someBundle", which is the root bundle.
//
// 4. Assuming config.locale is "ab-cd-ef" and the root bundle indicates that localizations
// are available for "ab" and "ab-cd-ef" (note the missing "ab-cd", then the plugin
// requires "some/path/nls/ab/someBundle" and "some/path/nls/ab-cd-ef/someBundle"
//
// 5. Upon receiving all required bundles, the plugin constructs the value of the bundle
// ab-cd-ef as...
//
// mixin(mixin(mixin({}, require("some/path/nls/someBundle"),
// require("some/path/nls/ab/someBundle")),
// require("some/path/nls/ab-cd-ef/someBundle"));
//
// This value is inserted into the cache and published to the loader at the
// key/module-id some/path/nls/someBundle/ab-cd-ef.
//
// The special preload signature (case 3) instructs the plugin to stop servicing all normal requests
// (further preload requests will be serviced) until all ongoing preloading has completed.
//
// The preload signature instructs the plugin that a special rollup module is available that contains
// one or more flattened, localized bundles. The JSON array of available locales indicates which locales
// are available. Here is an example:
//
// *preload*some/path/nls/someModule*["root", "ab", "ab-cd-ef"]
//
// This indicates the following rollup modules are available:
//
// some/path/nls/someModule_ROOT
// some/path/nls/someModule_ab
// some/path/nls/someModule_ab-cd-ef
//
// Each of these modules is a normal AMD module that contains one or more flattened bundles in a hash.
// For example, assume someModule contained the bundles some/bundle/path/someBundle and
// some/bundle/path/someOtherBundle, then some/path/nls/someModule_ab would be expressed as follows:
//
// define({
// some/bundle/path/someBundle:<value of someBundle, flattened with respect to locale ab>,
// some/bundle/path/someOtherBundle:<value of someOtherBundle, flattened with respect to locale ab>,
// });
//
// E.g., given this design, preloading for locale=="ab" can execute the following algorithm:
//
// require(["some/path/nls/someModule_ab"], function(rollup){
// for(var p in rollup){
// var id = p + "/ab",
// cache[id] = rollup[p];
// define(id, rollup[p]);
// }
// });
//
// Similarly, if "ab-cd" is requested, the algorithm can determine that "ab" is the best available and
// load accordingly.
//
// The builder will write such rollups for every layer if a non-empty localeList profile property is
// provided. Further, the builder will include the following cache entry in the cache associated with
// any layer.
//
// "*now":function(r){r(['dojo/i18n!*preload*<path>/nls/<module>*<JSON array of available locales>']);}
//
// The *now special cache module instructs the loader to apply the provided function to context-require
// with respect to the particular layer being defined. This causes the plugin to hold all normal service
// requests until all preloading is complete.
//
// Notice that this algorithm is rarely better than the standard AMD load algorithm. Consider the normal case
// where the target locale has a single segment and a layer depends on a single bundle:
//
// Without Preloads:
//
// 1. Layer loads root bundle.
// 2. bundle is demanded; plugin loads single localized bundle.
//
// With Preloads:
//
// 1. Layer causes preloading of target bundle.
// 2. bundle is demanded; service is delayed until preloading complete; bundle is returned.
//
// In each case a single transaction is required to load the target bundle. In cases where multiple bundles
// are required and/or the locale has multiple segments, preloads still requires a single transaction whereas
// the normal path requires an additional transaction for each additional bundle/locale-segment. However all
// of these additional transactions can be done concurrently. Owing to this analysis, the entire preloading
// algorithm can be discard during a build by setting the has feature dojo-preload-i18n-Api to false.
if(has("dojo-preload-i18n-Api")){
var split = id.split("*"),
preloadDemand = split[1] == "preload";
if(preloadDemand){
if(!cache[id]){
// use cache[id] to prevent multiple preloads of the same preload; this shouldn't happen, but
// who knows what over-aggressive human optimizers may attempt
cache[id] = 1;
preloadL10n(split[2], json.parse(split[3]), 1, require);
}
// don't stall the loader!
load(1);
}
if(preloadDemand || waitForPreloads(id, require, load)){
return;
}
}
var match = nlsRe.exec(id),
bundlePath = match[1] + "/",
bundleName = match[5] || match[4],
bundlePathAndName = bundlePath + bundleName,
localeSpecified = (match[5] && match[4]),
targetLocale = localeSpecified || dojo.locale || "",
loadTarget = bundlePathAndName + "/" + targetLocale,
loadList = localeSpecified ? [targetLocale] : getLocalesToLoad(targetLocale),
remaining = loadList.length,
finish = function(){
if(!--remaining){
load(lang.delegate(cache[loadTarget]));
}
};
array.forEach(loadList, function(locale){
var target = bundlePathAndName + "/" + locale;
if(has("dojo-preload-i18n-Api")){
checkForLegacyModules(target);
}
if(!cache[target]){
doLoad(require, bundlePathAndName, bundlePath, bundleName, locale, finish);
}else{
finish();
}
});
};
if(has("dojo-preload-i18n-Api") || has("dojo-v1x-i18n-Api")){
var normalizeLocale = thisModule.normalizeLocale = function(locale){
var result = locale ? locale.toLowerCase() : dojo.locale;
return result == "root" ? "ROOT" : result;
},
isXd = function(mid, contextRequire){
return (has("dojo-sync-loader") && has("dojo-v1x-i18n-Api")) ?
contextRequire.isXdUrl(require.toUrl(mid + ".js")) :
true;
},
preloading = 0,
preloadWaitQueue = [],
preloadL10n = thisModule._preloadLocalizations = function(/*String*/bundlePrefix, /*Array*/localesGenerated, /*boolean?*/ guaranteedAmdFormat, /*function?*/ contextRequire){
// summary:
// Load available flattened resource bundles associated with a particular module for dojo/locale and all dojo/config.extraLocale (if any)
// description:
// Only called by built layer files. The entire locale hierarchy is loaded. For example,
// if locale=="ab-cd", then ROOT, "ab", and "ab-cd" are loaded. This is different than v1.6-
// in that the v1.6- would only load ab-cd...which was *always* flattened.
//
// If guaranteedAmdFormat is true, then the module can be loaded with require thereby circumventing the detection algorithm
// and the extra possible extra transaction.
// If this function is called from legacy code, then guaranteedAmdFormat and contextRequire will be undefined. Since the function
// needs a require in order to resolve module ids, fall back to the context-require associated with this dojo/i18n module, which
// itself may have been mapped.
contextRequire = contextRequire || require;
function doRequire(mid, callback){
if(isXd(mid, contextRequire) || guaranteedAmdFormat){
contextRequire([mid], callback);
}else{
syncRequire([mid], callback, contextRequire);
}
}
function forEachLocale(locale, func){
// given locale= "ab-cd-ef", calls func on "ab-cd-ef", "ab-cd", "ab", "ROOT"; stops calling the first time func returns truthy
var parts = locale.split("-");
while(parts.length){
if(func(parts.join("-"))){
return;
}
parts.pop();
}
func("ROOT");
}
function preloadingAddLock(){
preloading++;
}
function preloadingRelLock(){
--preloading;
while(!preloading && preloadWaitQueue.length){
load.apply(null, preloadWaitQueue.shift());
}
}
function cacheId(path, name, loc, require){
// path is assumed to have a trailing "/"
return require.toAbsMid(path + name + "/" + loc)
}
function preload(locale){
locale = normalizeLocale(locale);
forEachLocale(locale, function(loc){
if(array.indexOf(localesGenerated, loc) >= 0){
var mid = bundlePrefix.replace(/\./g, "/") + "_" + loc;
preloadingAddLock();
doRequire(mid, function(rollup){
for(var p in rollup){
var bundle = rollup[p],
match = p.match(/(.+)\/([^\/]+)$/),
bundleName, bundlePath;
// If there is no match, the bundle is not a regular bundle from an AMD layer.
if (!match){continue;}
bundleName = match[2];
bundlePath = match[1] + "/";
// backcompat
if(!bundle._localized){continue;}
var localized;
if(loc === "ROOT"){
var root = localized = bundle._localized;
delete bundle._localized;
root.root = bundle;
cache[require.toAbsMid(p)] = root;
}else{
localized = bundle._localized;
cache[cacheId(bundlePath, bundleName, loc, require)] = bundle;
}
if(loc !== locale){
// capture some locale variables
function improveBundle(bundlePath, bundleName, bundle, localized){
// locale was not flattened and we've fallen back to a less-specific locale that was flattened
// for example, we had a flattened 'fr', a 'fr-ca' is available for at least this bundle, and
// locale==='fr-ca'; therefore, we must improve the bundle as retrieved from the rollup by
// manually loading the fr-ca version of the bundle and mixing this into the already-retrieved 'fr'
// version of the bundle.
//
// Remember, different bundles may have different sets of locales available.
//
// we are really falling back on the regular algorithm here, but--hopefully--starting with most
// of the required bundles already on board as given by the rollup and we need to "manually" load
// only one locale from a few bundles...or even better...we won't find anything better to load.
// This algorithm ensures there is nothing better to load even when we can only load a less-specific rollup.
//
// note: this feature is only available in async mode
// inspect the loaded bundle that came from the rollup to see if something better is available
// for any bundle in a rollup, more-specific available locales are given at localized.
var requiredBundles = [],
cacheIds = [];
forEachLocale(locale, function(loc){
if(localized[loc]){
requiredBundles.push(require.toAbsMid(bundlePath + loc + "/" + bundleName));
cacheIds.push(cacheId(bundlePath, bundleName, loc, require));
}
});
if(requiredBundles.length){
preloadingAddLock();
contextRequire(requiredBundles, function(){
// requiredBundles was constructed by forEachLocale so it contains locales from
// less specific to most specific.
// the loop starts with the most specific locale, the last one.
for(var i = requiredBundles.length - 1; i >= 0 ; i--){
bundle = lang.mixin(lang.clone(bundle), arguments[i]);
cache[cacheIds[i]] = bundle;
}
// this is the best possible (maybe a perfect match, maybe not), accept it
cache[cacheId(bundlePath, bundleName, locale, require)] = lang.clone(bundle);
preloadingRelLock();
});
}else{
// this is the best possible (definitely not a perfect match), accept it
cache[cacheId(bundlePath, bundleName, locale, require)] = bundle;
}
}
improveBundle(bundlePath, bundleName, bundle, localized);
}
}
preloadingRelLock();
});
return true;
}
return false;
});
}
preload();
array.forEach(dojo.config.extraLocale, preload);
},
waitForPreloads = function(id, require, load){
if(preloading){
preloadWaitQueue.push([id, require, load]);
}
return preloading;
},
checkForLegacyModules = function()
{};
}
if(has("dojo-v1x-i18n-Api")){
// this code path assumes the dojo loader and won't work with a standard AMD loader
var amdValue = {},
evalBundle =
// use the function ctor to keep the minifiers away (also come close to global scope, but this is secondary)
new Function(
"__bundle", // the bundle to evalutate
"__checkForLegacyModules", // a function that checks if __bundle defined __mid in the global space
"__mid", // the mid that __bundle is intended to define
"__amdValue",
// returns one of:
// 1 => the bundle was an AMD bundle
// a legacy bundle object that is the value of __mid
// instance of Error => could not figure out how to evaluate bundle
// used to detect when __bundle calls define
"var define = function(mid, factory){define.called = 1; __amdValue.result = factory || mid;},"
+ " require = function(){define.called = 1;};"
+ "try{"
+ "define.called = 0;"
+ "eval(__bundle);"
+ "if(define.called==1)"
// bundle called define; therefore signal it's an AMD bundle
+ "return __amdValue;"
+ "if((__checkForLegacyModules = __checkForLegacyModules(__mid)))"
// bundle was probably a v1.6- built NLS flattened NLS bundle that defined __mid in the global space
+ "return __checkForLegacyModules;"
+ "}catch(e){}"
// evaulating the bundle was *neither* an AMD *nor* a legacy flattened bundle
// either way, re-eval *after* surrounding with parentheses
+ "try{"
+ "return eval('('+__bundle+')');"
+ "}catch(e){"
+ "return e;"
+ "}"
),
syncRequire = function(deps, callback, require){
var results = [];
array.forEach(deps, function(mid){
var url = require.toUrl(mid + ".js");
function load(text){
var result = evalBundle(text, checkForLegacyModules, mid, amdValue);
if(result===amdValue){
// the bundle was an AMD module; re-inject it through the normal AMD path
// we gotta do this since it could be an anonymous module and simply evaluating
// the text here won't provide the loader with the context to know what
// module is being defined()'d. With browser caching, this should be free; further
// this entire code path can be circumvented by using the AMD format to begin with
results.push(cache[url] = amdValue.result);
}else{
if(result instanceof Error){
console.error("failed to evaluate i18n bundle; url=" + url, result);
result = {};
}
// nls/<locale>/<bundle-name> indicates not the root.
results.push(cache[url] = (/nls\/[^\/]+\/[^\/]+$/.test(url) ? result : {root:result, _v1x:1}));
}
}
if(cache[url]){
results.push(cache[url]);
}else{
var bundle = require.syncLoadNls(mid);
// need to check for legacy module here because there might be a legacy module for a
// less specific locale (which was not looked up during the first checkForLegacyModules
// call in load()).
// Also need to reverse the locale and the module name in the mid because syncRequire
// deps parameters uses the AMD style package/nls/locale/module while legacy code uses
// package/nls/module/locale.
if(!bundle){
bundle = checkForLegacyModules(mid.replace(/nls\/([^\/]*)\/([^\/]*)$/, "nls/$2/$1"));
}
if(bundle){
results.push(bundle);
}else{
if(!xhr){
try{
require.getText(url, true, load);
}catch(e){
results.push(cache[url] = {});
}
}else{
xhr.get({
url:url,
sync:true,
load:load,
error:function(){
results.push(cache[url] = {});
}
});
}
}
}
});
callback && callback.apply(null, results);
};
checkForLegacyModules = function(target){
// legacy code may have already loaded [e.g] the raw bundle x/y/z at x.y.z; when true, push into the cache
for(var result, names = target.split("/"), object = dojo.global[names[0]], i = 1; object && i<names.length-1; object = object[names[i++]]){}
if(object){
result = object[names[i]];
if(!result){
// fallback for incorrect bundle build of 1.6
result = object[names[i].replace(/-/g,"_")];
}
if(result){
cache[target] = result;
}
}
return result;
};
thisModule.getLocalization = function(moduleName, bundleName, locale){
var result,
l10nName = getBundleName(moduleName, bundleName, locale);
load(
l10nName,
// isXd() and syncRequire() need a context-require in order to resolve the mid with respect to a reference module.
// Since this legacy function does not have the concept of a reference module, resolve with respect to this
// dojo/i18n module, which, itself may have been mapped.
(!isXd(l10nName, require) ? function(deps, callback){ syncRequire(deps, callback, require); } : require),
function(result_){ result = result_; }
);
return result;
};
}
return lang.mixin(thisModule, {
dynamic:true,
normalize:normalize,
load:load,
cache:cache,
getL10nName: getL10nName
});
});