intl/locale/PluralForm.jsm

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 var EXPORTED_SYMBOLS = ["PluralForm"];
   6
   7 const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
   8
   9 /**
  10  * This module provides the PluralForm object which contains a method to figure
  11  * out which plural form of a word to use for a given number based on the
  12  * current localization. There is also a makeGetter method that creates a get
  13  * function for the desired plural rule. This is useful for extensions that
  14  * specify their own plural rule instead of relying on the browser default.
  15  * (I.e., the extension hasn't been localized to the browser's locale.)
  16  *
  17  * See: http://developer.mozilla.org/en/docs/Localization_and_Plurals
  18  *
  19  * NOTE: any change to these plural forms need to be reflected in
  20  * compare-locales:
  21  * https://hg.mozilla.org/l10n/compare-locales/file/default/compare_locales/plurals.py
  22  *
  23  * List of methods:
  24  *
  25  * string pluralForm
  26  * get(int aNum, string aWords)
  27  *
  28  * int numForms
  29  * numForms()
  30  *
  31  * [string pluralForm get(int aNum, string aWords), int numForms numForms()]
  32  * makeGetter(int aRuleNum)
  33  * Note: Basically, makeGetter returns 2 functions that do "get" and "numForm"
  34  */
  35
  36 const kIntlProperties = "chrome://global/locale/intl.properties";
  37
  38 // These are the available plural functions that give the appropriate index
  39 // based on the plural rule number specified. The first element is the number
  40 // of plural forms and the second is the function to figure out the index.
  41 /* eslint-disable no-nested-ternary */
  42 var gFunctions = [
  43   // 0: Chinese
  44   [1, n => 0],
  45   // 1: English
  46   [2, n => (n != 1 ? 1 : 0)],
  47   // 2: French
  48   [2, n => (n > 1 ? 1 : 0)],
  49   // 3: Latvian
  50   [3, n => (n % 10 == 1 && n % 100 != 11 ? 1 : n % 10 == 0 ? 0 : 2)],
  51   // 4: Scottish Gaelic
  52   [
  53     4,
  54     n =>
  55       n == 1 || n == 11 ? 0 : n == 2 || n == 12 ? 1 : n > 0 && n < 20 ? 2 : 3,
  56   ],
  57   // 5: Romanian
  58   [3, n => (n == 1 ? 0 : n == 0 || (n % 100 > 0 && n % 100 < 20) ? 1 : 2)],
  59   // 6: Lithuanian
  60   [
  61     3,
  62     n =>
  63       n % 10 == 1 && n % 100 != 11
  64         ? 0
  65         : n % 10 >= 2 && (n % 100 < 10 || n % 100 >= 20)
  66         ? 2
  67         : 1,
  68   ],
  69   // 7: Russian
  70   [
  71     3,
  72     n =>
  73       n % 10 == 1 && n % 100 != 11
  74         ? 0
  75         : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20)
  76         ? 1
  77         : 2,
  78   ],
  79   // 8: Slovak
  80   [3, n => (n == 1 ? 0 : n >= 2 && n <= 4 ? 1 : 2)],
  81   // 9: Polish
  82   [
  83     3,
  84     n =>
  85       n == 1
  86         ? 0
  87         : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20)
  88         ? 1
  89         : 2,
  90   ],
  91   // 10: Slovenian
  92   [
  93     4,
  94     n =>
  95       n % 100 == 1
  96         ? 0
  97         : n % 100 == 2
  98         ? 1
  99         : n % 100 == 3 || n % 100 == 4
 100         ? 2
 101         : 3,
 102   ],
 103   // 11: Irish Gaeilge
 104   [
 105     5,
 106     n =>
 107       n == 1
 108         ? 0
 109         : n == 2
 110         ? 1
 111         : n >= 3 && n <= 6
 112         ? 2
 113         : n >= 7 && n <= 10
 114         ? 3
 115         : 4,
 116   ],
 117   // 12: Arabic
 118   [
 119     6,
 120     n =>
 121       n == 0
 122         ? 5
 123         : n == 1
 124         ? 0
 125         : n == 2
 126         ? 1
 127         : n % 100 >= 3 && n % 100 <= 10
 128         ? 2
 129         : n % 100 >= 11 && n % 100 <= 99
 130         ? 3
 131         : 4,
 132   ],
 133   // 13: Maltese
 134   [
 135     4,
 136     n =>
 137       n == 1
 138         ? 0
 139         : n == 0 || (n % 100 > 0 && n % 100 <= 10)
 140         ? 1
 141         : n % 100 > 10 && n % 100 < 20
 142         ? 2
 143         : 3,
 144   ],
 145   // 14: Unused
 146   [3, n => (n % 10 == 1 ? 0 : n % 10 == 2 ? 1 : 2)],
 147   // 15: Icelandic, Macedonian
 148   [2, n => (n % 10 == 1 && n % 100 != 11 ? 0 : 1)],
 149   // 16: Breton
 150   [
 151     5,
 152     n =>
 153       n % 10 == 1 && n % 100 != 11 && n % 100 != 71 && n % 100 != 91
 154         ? 0
 155         : n % 10 == 2 && n % 100 != 12 && n % 100 != 72 && n % 100 != 92
 156         ? 1
 157         : (n % 10 == 3 || n % 10 == 4 || n % 10 == 9) &&
 158           n % 100 != 13 &&
 159           n % 100 != 14 &&
 160           n % 100 != 19 &&
 161           n % 100 != 73 &&
 162           n % 100 != 74 &&
 163           n % 100 != 79 &&
 164           n % 100 != 93 &&
 165           n % 100 != 94 &&
 166           n % 100 != 99
 167         ? 2
 168         : n % 1000000 == 0 && n != 0
 169         ? 3
 170         : 4,
 171   ],
 172   // 17: Shuar
 173   [2, n => (n != 0 ? 1 : 0)],
 174   // 18: Welsh
 175   [
 176     6,
 177     n => (n == 0 ? 0 : n == 1 ? 1 : n == 2 ? 2 : n == 3 ? 3 : n == 6 ? 4 : 5),
 178   ],
 179   // 19: Slavic languages (bs, hr, sr). Same as rule 7, but resulting in different CLDR categories
 180   [
 181     3,
 182     n =>
 183       n % 10 == 1 && n % 100 != 11
 184         ? 0
 185         : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20)
 186         ? 1
 187         : 2,
 188   ],
 189 ];
 190 /* eslint-enable no-nested-ternary */
 191
 192 var PluralForm = {
 193   /**
 194    * Get the correct plural form of a word based on the number
 195    *
 196    * @param aNum
 197    *        The number to decide which plural form to use
 198    * @param aWords
 199    *        A semi-colon (;) separated string of words to pick the plural form
 200    * @return The appropriate plural form of the word
 201    */
 202   get get() {
 203     // This method will lazily load to avoid perf when it is first needed and
 204     // creates getPluralForm function. The function it creates is based on the
 205     // value of pluralRule specified in the intl stringbundle.
 206     // See: http://developer.mozilla.org/en/docs/Localization_and_Plurals
 207
 208     // Delete the getters to be overwritten
 209     delete PluralForm.numForms;
 210     delete PluralForm.get;
 211
 212     // Make the plural form get function and set it as the default get
 213     [PluralForm.get, PluralForm.numForms] = PluralForm.makeGetter(
 214       PluralForm.ruleNum
 215     );
 216     return PluralForm.get;
 217   },
 218
 219   /**
 220    * Create a pair of plural form functions for the given plural rule number.
 221    *
 222    * @param aRuleNum
 223    *        The plural rule number to create functions
 224    * @return A pair: [function that gets the right plural form,
 225    *                  function that returns the number of plural forms]
 226    */
 227   makeGetter(aRuleNum) {
 228     // Default to "all plural" if the value is out of bounds or invalid
 229     if (aRuleNum < 0 || aRuleNum >= gFunctions.length || isNaN(aRuleNum)) {
 230       log(["Invalid rule number: ", aRuleNum, " -- defaulting to 0"]);
 231       aRuleNum = 0;
 232     }
 233
 234     // Get the desired pluralRule function
 235     let [numForms, pluralFunc] = gFunctions[aRuleNum];
 236
 237     // Return functions that give 1) the number of forms and 2) gets the right
 238     // plural form
 239     return [
 240       function(aNum, aWords) {
 241         // Figure out which index to use for the semi-colon separated words
 242         let index = pluralFunc(aNum ? Number(aNum) : 0);
 243         let words = aWords ? aWords.split(/;/) : [""];
 244
 245         // Explicitly check bounds to avoid strict warnings
 246         let ret = index < words.length ? words[index] : undefined;
 247
 248         // Check for array out of bounds or empty strings
 249         if (ret == undefined || ret == "") {
 250           // Report the caller to help figure out who is causing badness
 251           let caller = Components.stack.caller
 252             ? Components.stack.caller.name
 253             : "top";
 254
 255           // Display a message in the error console
 256           log([
 257             "Index #",
 258             index,
 259             " of '",
 260             aWords,
 261             "' for value ",
 262             aNum,
 263             " is invalid -- plural rule #",
 264             aRuleNum,
 265             "; called by ",
 266             caller,
 267           ]);
 268
 269           // Default to the first entry (which might be empty, but not undefined)
 270           ret = words[0];
 271         }
 272
 273         return ret;
 274       },
 275       () => numForms,
 276     ];
 277   },
 278
 279   /**
 280    * Get the number of forms for the current plural rule
 281    *
 282    * @return The number of forms
 283    */
 284   get numForms() {
 285     // We lazily load numForms, so trigger the init logic with get()
 286     PluralForm.get();
 287     return PluralForm.numForms;
 288   },
 289
 290   /**
 291    * Get the plural rule number from the intl stringbundle
 292    *
 293    * @return The plural rule number
 294    */
 295   get ruleNum() {
 296     return Number(
 297       Services.strings
 298         .createBundle(kIntlProperties)
 299         .GetStringFromName("pluralRule")
 300     );
 301   },
 302 };
 303
 304 /**
 305  * Private helper function to log errors to the error console and command line
 306  *
 307  * @param aMsg
 308  *        Error message to log or an array of strings to concat
 309  */
 310 function log(aMsg) {
 311   let msg = "PluralForm.jsm: " + (aMsg.join ? aMsg.join("") : aMsg);
 312   Services.console.logStringMessage(msg);
 313   dump(msg + "\n");
 314 }