summaryrefslogtreecommitdiffstats
path: root/js/src/builtin/intl/Collator.js
blob: 4780781e95ce0cee2a09270ad69cc1d9998b27c0 (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
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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/* Portions Copyright Norbert Lindenberg 2011-2012. */

/**
 * Compute an internal properties object from |lazyCollatorData|.
 */
function resolveCollatorInternals(lazyCollatorData) {
  assert(IsObject(lazyCollatorData), "lazy data not an object?");

  var internalProps = std_Object_create(null);

  var Collator = collatorInternalProperties;

  // Step 5.
  internalProps.usage = lazyCollatorData.usage;

  // Steps 6-7.
  var collatorIsSorting = lazyCollatorData.usage === "sort";
  var localeData = collatorIsSorting
    ? Collator.sortLocaleData
    : Collator.searchLocaleData;

  // Compute effective locale.
  // Step 16.
  var relevantExtensionKeys = Collator.relevantExtensionKeys;

  // Step 17.
  var r = ResolveLocale(
    "Collator",
    lazyCollatorData.requestedLocales,
    lazyCollatorData.opt,
    relevantExtensionKeys,
    localeData
  );

  // Step 18.
  internalProps.locale = r.locale;

  // Step 19.
  var collation = r.co;

  // Step 20.
  if (collation === null) {
    collation = "default";
  }

  // Step 21.
  internalProps.collation = collation;

  // Step 22.
  internalProps.numeric = r.kn === "true";

  // Step 23.
  internalProps.caseFirst = r.kf;

  // Compute remaining collation options.
  // Step 25.
  var s = lazyCollatorData.rawSensitivity;
  if (s === undefined) {
    // In theory the default sensitivity for the "search" collator is
    // locale dependent; in reality the CLDR/ICU default strength is
    // always tertiary. Therefore use "variant" as the default value for
    // both collation modes.
    s = "variant";
  }

  // Step 26.
  internalProps.sensitivity = s;

  // Step 28.
  var ignorePunctuation = lazyCollatorData.ignorePunctuation;
  if (ignorePunctuation === undefined) {
    var actualLocale = collatorActualLocale(r.dataLocale);
    ignorePunctuation = intl_isIgnorePunctuation(actualLocale);
  }
  internalProps.ignorePunctuation = ignorePunctuation;

  // The caller is responsible for associating |internalProps| with the right
  // object using |setInternalProperties|.
  return internalProps;
}

/**
 * Returns an object containing the Collator internal properties of |obj|.
 */
function getCollatorInternals(obj) {
  assert(IsObject(obj), "getCollatorInternals called with non-object");
  assert(
    intl_GuardToCollator(obj) !== null,
    "getCollatorInternals called with non-Collator"
  );

  var internals = getIntlObjectInternals(obj);
  assert(
    internals.type === "Collator",
    "bad type escaped getIntlObjectInternals"
  );

  // If internal properties have already been computed, use them.
  var internalProps = maybeInternalProperties(internals);
  if (internalProps) {
    return internalProps;
  }

  // Otherwise it's time to fully create them.
  internalProps = resolveCollatorInternals(internals.lazyData);
  setInternalProperties(internals, internalProps);
  return internalProps;
}

/**
 * Initializes an object as a Collator.
 *
 * This method is complicated a moderate bit by its implementing initialization
 * as a *lazy* concept.  Everything that must happen now, does -- but we defer
 * all the work we can until the object is actually used as a Collator.  This
 * later work occurs in |resolveCollatorInternals|; steps not noted here occur
 * there.
 *
 * Spec: ECMAScript Internationalization API Specification, 10.1.1.
 */
function InitializeCollator(collator, locales, options) {
  assert(IsObject(collator), "InitializeCollator called with non-object");
  assert(
    intl_GuardToCollator(collator) !== null,
    "InitializeCollator called with non-Collator"
  );

  // Lazy Collator data has the following structure:
  //
  //   {
  //     requestedLocales: List of locales,
  //     usage: "sort" / "search",
  //     opt: // opt object computed in InitializeCollator
  //       {
  //         localeMatcher: "lookup" / "best fit",
  //         co: string matching a Unicode extension type / undefined
  //         kn: true / false / undefined,
  //         kf: "upper" / "lower" / "false" / undefined
  //       }
  //     rawSensitivity: "base" / "accent" / "case" / "variant" / undefined,
  //     ignorePunctuation: true / false / undefined
  //   }
  //
  // Note that lazy data is only installed as a final step of initialization,
  // so every Collator lazy data object has *all* these properties, never a
  // subset of them.
  var lazyCollatorData = std_Object_create(null);

  // Step 1.
  var requestedLocales = CanonicalizeLocaleList(locales);
  lazyCollatorData.requestedLocales = requestedLocales;

  // Steps 2-3.
  //
  // If we ever need more speed here at startup, we should try to detect the
  // case where |options === undefined| and then directly use the default
  // value for each option.  For now, just keep it simple.
  if (options === undefined) {
    options = std_Object_create(null);
  } else {
    options = ToObject(options);
  }

  // Compute options that impact interpretation of locale.
  // Step 4.
  var u = GetOption(options, "usage", "string", ["sort", "search"], "sort");
  lazyCollatorData.usage = u;

  // Step 8.
  var opt = new_Record();
  lazyCollatorData.opt = opt;

  // Steps 9-10.
  var matcher = GetOption(
    options,
    "localeMatcher",
    "string",
    ["lookup", "best fit"],
    "best fit"
  );
  opt.localeMatcher = matcher;

  // https://github.com/tc39/ecma402/pull/459
  var collation = GetOption(
    options,
    "collation",
    "string",
    undefined,
    undefined
  );
  if (collation !== undefined) {
    collation = intl_ValidateAndCanonicalizeUnicodeExtensionType(
      collation,
      "collation",
      "co"
    );
  }
  opt.co = collation;

  // Steps 11-13.
  var numericValue = GetOption(
    options,
    "numeric",
    "boolean",
    undefined,
    undefined
  );
  if (numericValue !== undefined) {
    numericValue = numericValue ? "true" : "false";
  }
  opt.kn = numericValue;

  // Steps 14-15.
  var caseFirstValue = GetOption(
    options,
    "caseFirst",
    "string",
    ["upper", "lower", "false"],
    undefined
  );
  opt.kf = caseFirstValue;

  // Compute remaining collation options.
  // Step 24.
  var s = GetOption(
    options,
    "sensitivity",
    "string",
    ["base", "accent", "case", "variant"],
    undefined
  );
  lazyCollatorData.rawSensitivity = s;

  // Step 27.
  var ip = GetOption(options, "ignorePunctuation", "boolean", undefined, undefined);
  lazyCollatorData.ignorePunctuation = ip;

  // Step 29.
  //
  // We've done everything that must be done now: mark the lazy data as fully
  // computed and install it.
  initializeIntlObject(collator, "Collator", lazyCollatorData);
}

/**
 * Returns the subset of the given locale list for which this locale list has a
 * matching (possibly fallback) locale. Locales appear in the same order in the
 * returned list as in the input list.
 *
 * Spec: ECMAScript Internationalization API Specification, 10.2.2.
 */
function Intl_Collator_supportedLocalesOf(locales /*, options*/) {
  var options = ArgumentsLength() > 1 ? GetArgument(1) : undefined;

  // Step 1.
  var availableLocales = "Collator";

  // Step 2.
  var requestedLocales = CanonicalizeLocaleList(locales);

  // Step 3.
  return SupportedLocales(availableLocales, requestedLocales, options);
}

/**
 * Collator internal properties.
 *
 * Spec: ECMAScript Internationalization API Specification, 9.1 and 10.2.3.
 */
var collatorInternalProperties = {
  sortLocaleData: collatorSortLocaleData,
  searchLocaleData: collatorSearchLocaleData,
  relevantExtensionKeys: ["co", "kf", "kn"],
};

/**
 * Returns the actual locale used when a collator for |locale| is constructed.
 */
function collatorActualLocale(locale) {
  assert(typeof locale === "string", "locale should be string");

  // If |locale| is the default locale (e.g. da-DK), but only supported
  // through a fallback (da), we need to get the actual locale before we
  // can call intl_isUpperCaseFirst. Also see intl_BestAvailableLocale.
  return BestAvailableLocaleIgnoringDefault("Collator", locale);
}

/**
 * Returns the default caseFirst values for the given locale. The first
 * element in the returned array denotes the default value per ES2017 Intl,
 * 9.1 Internal slots of Service Constructors.
 */
function collatorSortCaseFirst(locale) {
  var actualLocale = collatorActualLocale(locale);
  if (intl_isUpperCaseFirst(actualLocale)) {
    return ["upper", "false", "lower"];
  }

  // Default caseFirst values for all other languages.
  return ["false", "lower", "upper"];
}

/**
 * Returns the default caseFirst value for the given locale.
 */
function collatorSortCaseFirstDefault(locale) {
  var actualLocale = collatorActualLocale(locale);
  if (intl_isUpperCaseFirst(actualLocale)) {
    return "upper";
  }

  // Default caseFirst value for all other languages.
  return "false";
}

function collatorSortLocaleData() {
  /* eslint-disable object-shorthand */
  return {
    co: intl_availableCollations,
    kn: function() {
      return ["false", "true"];
    },
    kf: collatorSortCaseFirst,
    default: {
      co: function() {
        // The first element of the collations array must be |null|
        // per ES2017 Intl, 10.2.3 Internal Slots.
        return null;
      },
      kn: function() {
        return "false";
      },
      kf: collatorSortCaseFirstDefault,
    },
  };
  /* eslint-enable object-shorthand */
}

function collatorSearchLocaleData() {
  /* eslint-disable object-shorthand */
  return {
    co: function() {
      return [null];
    },
    kn: function() {
      return ["false", "true"];
    },
    kf: function() {
      return ["false", "lower", "upper"];
    },
    default: {
      co: function() {
        return null;
      },
      kn: function() {
        return "false";
      },
      kf: function() {
        return "false";
      },
    },
  };
  /* eslint-enable object-shorthand */
}

/**
 * Create function to be cached and returned by Intl.Collator.prototype.compare.
 *
 * Spec: ECMAScript Internationalization API Specification, 10.3.3.1.
 */
function createCollatorCompare(collator) {
  // This function is not inlined in $Intl_Collator_compare_get to avoid
  // creating a call-object on each call to $Intl_Collator_compare_get.
  return function(x, y) {
    // Step 1 (implicit).

    // Step 2.
    assert(IsObject(collator), "collatorCompareToBind called with non-object");
    assert(
      intl_GuardToCollator(collator) !== null,
      "collatorCompareToBind called with non-Collator"
    );

    // Steps 3-6
    var X = ToString(x);
    var Y = ToString(y);

    // Step 7.
    return intl_CompareStrings(collator, X, Y);
  };
}

/**
 * Returns a function bound to this Collator that compares x (converted to a
 * String value) and y (converted to a String value),
 * and returns a number less than 0 if x < y, 0 if x = y, or a number greater
 * than 0 if x > y according to the sort order for the locale and collation
 * options of this Collator object.
 *
 * Spec: ECMAScript Internationalization API Specification, 10.3.3.
 */
// Uncloned functions with `$` prefix are allocated as extended function
// to store the original name in `SetCanonicalName`.
function $Intl_Collator_compare_get() {
  // Step 1.
  var collator = this;

  // Steps 2-3.
  if (
    !IsObject(collator) ||
    (collator = intl_GuardToCollator(collator)) === null
  ) {
    return callFunction(
      intl_CallCollatorMethodIfWrapped,
      this,
      "$Intl_Collator_compare_get"
    );
  }

  var internals = getCollatorInternals(collator);

  // Step 4.
  if (internals.boundCompare === undefined) {
    // Steps 4.a-c.
    internals.boundCompare = createCollatorCompare(collator);
  }

  // Step 5.
  return internals.boundCompare;
}
SetCanonicalName($Intl_Collator_compare_get, "get compare");

/**
 * Returns the resolved options for a Collator object.
 *
 * Spec: ECMAScript Internationalization API Specification, 10.3.4.
 */
function Intl_Collator_resolvedOptions() {
  // Step 1.
  var collator = this;

  // Steps 2-3.
  if (
    !IsObject(collator) ||
    (collator = intl_GuardToCollator(collator)) === null
  ) {
    return callFunction(
      intl_CallCollatorMethodIfWrapped,
      this,
      "Intl_Collator_resolvedOptions"
    );
  }

  var internals = getCollatorInternals(collator);

  // Steps 4-5.
  var result = {
    locale: internals.locale,
    usage: internals.usage,
    sensitivity: internals.sensitivity,
    ignorePunctuation: internals.ignorePunctuation,
    collation: internals.collation,
    numeric: internals.numeric,
    caseFirst: internals.caseFirst,
  };

  // Step 6.
  return result;
}