summaryrefslogtreecommitdiffstats
path: root/js/src/builtin/intl/PluralRules.js
blob: a90fc32d0bbcd6844c5f6dcc22e222eca4979435 (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
/* 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/. */

/**
 * PluralRules internal properties.
 *
 * Spec: ECMAScript 402 API, PluralRules, 13.3.3.
 */
var pluralRulesInternalProperties = {
  localeData: pluralRulesLocaleData,
  relevantExtensionKeys: [],
};

function pluralRulesLocaleData() {
  // PluralRules don't support any extension keys.
  return {};
}

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

  var internalProps = std_Object_create(null);

  var PluralRules = pluralRulesInternalProperties;

  // Compute effective locale.

  // Step 10.
  var localeData = PluralRules.localeData;

  // Step 11.
  const r = ResolveLocale(
    "PluralRules",
    lazyPluralRulesData.requestedLocales,
    lazyPluralRulesData.opt,
    PluralRules.relevantExtensionKeys,
    localeData
  );

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

  // Step 8.
  internalProps.type = lazyPluralRulesData.type;

  // Step 9.
  internalProps.minimumIntegerDigits = lazyPluralRulesData.minimumIntegerDigits;

  if ("minimumFractionDigits" in lazyPluralRulesData) {
    assert(
      "maximumFractionDigits" in lazyPluralRulesData,
      "min/max frac digits mismatch"
    );
    internalProps.minimumFractionDigits =
      lazyPluralRulesData.minimumFractionDigits;
    internalProps.maximumFractionDigits =
      lazyPluralRulesData.maximumFractionDigits;
  }

  if ("minimumSignificantDigits" in lazyPluralRulesData) {
    assert(
      "maximumSignificantDigits" in lazyPluralRulesData,
      "min/max sig digits mismatch"
    );
    internalProps.minimumSignificantDigits =
      lazyPluralRulesData.minimumSignificantDigits;
    internalProps.maximumSignificantDigits =
      lazyPluralRulesData.maximumSignificantDigits;
  }

  // Intl.NumberFormat v3 Proposal
  internalProps.roundingPriority = lazyPluralRulesData.roundingPriority;

  // Step 13 (lazily computed on first access).
  internalProps.pluralCategories = null;

  return internalProps;
}

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

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

  var internalProps = maybeInternalProperties(internals);
  if (internalProps) {
    return internalProps;
  }

  internalProps = resolvePluralRulesInternals(internals.lazyData);
  setInternalProperties(internals, internalProps);
  return internalProps;
}

/**
 * Initializes an object as a PluralRules.
 *
 * 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 PluralRules.
 * This later work occurs in |resolvePluralRulesInternals|; steps not noted
 * here occur there.
 *
 * Spec: ECMAScript 402 API, PluralRules, 13.1.1.
 */
function InitializePluralRules(pluralRules, locales, options) {
  assert(IsObject(pluralRules), "InitializePluralRules called with non-object");
  assert(
    intl_GuardToPluralRules(pluralRules) !== null,
    "InitializePluralRules called with non-PluralRules"
  );

  // Lazy PluralRules data has the following structure:
  //
  //   {
  //     requestedLocales: List of locales,
  //     type: "cardinal" / "ordinal",
  //
  //     opt: // opt object computer in InitializePluralRules
  //       {
  //         localeMatcher: "lookup" / "best fit",
  //       }
  //
  //     minimumIntegerDigits: integer ∈ [1, 21],
  //
  //     // optional, mutually exclusive with the significant-digits option
  //     minimumFractionDigits: integer ∈ [0, 20],
  //     maximumFractionDigits: integer ∈ [0, 20],
  //
  //     // optional, mutually exclusive with the fraction-digits option
  //     minimumSignificantDigits: integer ∈ [1, 21],
  //     maximumSignificantDigits: integer ∈ [1, 21],
  //
  //     roundingPriority: "auto" / "lessPrecision" / "morePrecision",
  //   }
  //
  // Note that lazy data is only installed as a final step of initialization,
  // so every PluralRules lazy data object has *all* these properties, never a
  // subset of them.
  const lazyPluralRulesData = std_Object_create(null);

  // Step 1.
  let requestedLocales = CanonicalizeLocaleList(locales);
  lazyPluralRulesData.requestedLocales = requestedLocales;

  // Steps 2-3.
  if (options === undefined) {
    options = std_Object_create(null);
  } else {
    options = ToObject(options);
  }

  // Step 4.
  let opt = new_Record();
  lazyPluralRulesData.opt = opt;

  // Steps 5-6.
  let matcher = GetOption(
    options,
    "localeMatcher",
    "string",
    ["lookup", "best fit"],
    "best fit"
  );
  opt.localeMatcher = matcher;

  // Step 7.
  const type = GetOption(
    options,
    "type",
    "string",
    ["cardinal", "ordinal"],
    "cardinal"
  );
  lazyPluralRulesData.type = type;

  // Step 9.
  SetNumberFormatDigitOptions(lazyPluralRulesData, options, 0, 3, "standard");

  // Step 15.
  //
  // We've done everything that must be done now: mark the lazy data as fully
  // computed and install it.
  initializeIntlObject(pluralRules, "PluralRules", lazyPluralRulesData);
}

/**
 * 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 402 API, PluralRules, 13.3.2.
 */
function Intl_PluralRules_supportedLocalesOf(locales /*, options*/) {
  var options = ArgumentsLength() > 1 ? GetArgument(1) : undefined;

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

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

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

/**
 * Returns a String value representing the plural category matching
 * the number passed as value according to the
 * effective locale and the formatting options of this PluralRules.
 *
 * Spec: ECMAScript 402 API, PluralRules, 13.4.3.
 */
function Intl_PluralRules_select(value) {
  // Step 1.
  let pluralRules = this;

  // Steps 2-3.
  if (
    !IsObject(pluralRules) ||
    (pluralRules = intl_GuardToPluralRules(pluralRules)) === null
  ) {
    return callFunction(
      intl_CallPluralRulesMethodIfWrapped,
      this,
      value,
      "Intl_PluralRules_select"
    );
  }

  // Step 4.
  let n = ToNumber(value);

  // Ensure the PluralRules internals are resolved.
  getPluralRulesInternals(pluralRules);

  // Step 5.
  return intl_SelectPluralRule(pluralRules, n);
}

/**
 * Returns a String value representing the plural category matching the input
 * number range according to the effective locale and the formatting options
 * of this PluralRules.
 */
function Intl_PluralRules_selectRange(start, end) {
  // Step 1.
  var pluralRules = this;

  // Step 2.
  if (
    !IsObject(pluralRules) ||
    (pluralRules = intl_GuardToPluralRules(pluralRules)) === null
  ) {
    return callFunction(
      intl_CallPluralRulesMethodIfWrapped,
      this,
      start,
      end,
      "Intl_PluralRules_selectRange"
    );
  }

  // Step 3.
  if (start === undefined || end === undefined) {
    ThrowTypeError(
      JSMSG_UNDEFINED_NUMBER,
      start === undefined ? "start" : "end",
      "PluralRules",
      "selectRange"
    );
  }

  // Step 4.
  var x = ToNumber(start);

  // Step 5.
  var y = ToNumber(end);

  // Step 6.
  return intl_SelectPluralRuleRange(pluralRules, x, y);
}

/**
 * Returns the resolved options for a PluralRules object.
 *
 * Spec: ECMAScript 402 API, PluralRules, 13.4.4.
 */
function Intl_PluralRules_resolvedOptions() {
  // Step 1.
  var pluralRules = this;

  // Steps 2-3.
  if (
    !IsObject(pluralRules) ||
    (pluralRules = intl_GuardToPluralRules(pluralRules)) === null
  ) {
    return callFunction(
      intl_CallPluralRulesMethodIfWrapped,
      this,
      "Intl_PluralRules_resolvedOptions"
    );
  }

  var internals = getPluralRulesInternals(pluralRules);

  // Steps 4-5.
  var result = {
    locale: internals.locale,
    type: internals.type,
    minimumIntegerDigits: internals.minimumIntegerDigits,
  };

  // Min/Max fraction digits are either both present or not present at all.
  assert(
    hasOwn("minimumFractionDigits", internals) ===
      hasOwn("maximumFractionDigits", internals),
    "minimumFractionDigits is present iff maximumFractionDigits is present"
  );

  if (hasOwn("minimumFractionDigits", internals)) {
    DefineDataProperty(
      result,
      "minimumFractionDigits",
      internals.minimumFractionDigits
    );
    DefineDataProperty(
      result,
      "maximumFractionDigits",
      internals.maximumFractionDigits
    );
  }

  // Min/Max significant digits are either both present or not present at all.
  assert(
    hasOwn("minimumSignificantDigits", internals) ===
      hasOwn("maximumSignificantDigits", internals),
    "minimumSignificantDigits is present iff maximumSignificantDigits is present"
  );

  if (hasOwn("minimumSignificantDigits", internals)) {
    DefineDataProperty(
      result,
      "minimumSignificantDigits",
      internals.minimumSignificantDigits
    );
    DefineDataProperty(
      result,
      "maximumSignificantDigits",
      internals.maximumSignificantDigits
    );
  }

  // Step 6.
  var internalsPluralCategories = internals.pluralCategories;
  if (internalsPluralCategories === null) {
    internalsPluralCategories = intl_GetPluralCategories(pluralRules);
    internals.pluralCategories = internalsPluralCategories;
  }

  var pluralCategories = [];
  for (var i = 0; i < internalsPluralCategories.length; i++) {
    DefineDataProperty(pluralCategories, i, internalsPluralCategories[i]);
  }

  // Step 7.
  DefineDataProperty(result, "pluralCategories", pluralCategories);

#ifdef NIGHTLY_BUILD
  DefineDataProperty(result, "roundingPriority", internals.roundingPriority);
#endif

  // Step 8.
  return result;
}