Rename i18n to intl

pkg/i18n/intl.dart

-// Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
-// for details. All rights reserved. Use of this source code is governed by a
-// BSD-style license that can be found in the LICENSE file.
-
-#library('intl');
-
-#import('dart:web');
-
-#import('date_format.dart');
-#source('intl_message.dart');
-#source('bidi_formatter.dart');
-#source('bidi_utils.dart');
-
-/**
- * Internationalization object providing access to message formatting objects,
- * date formatting, parsing, bidirectional text relative to a specific locale.
- */
-
-class Intl {
-  /**
-   * String indicating the locale code with which the message is to be
-   * formatted (such as en-CA).
-   */
-  static String _locale;
-
-  IntlMessage intlMsg;
-
-  /**
-   * Return a new date format using the specified [pattern].
-   * If [desiredLocale] is not specified, then we default to [locale].
-   */
-  DateFormat date(String pattern, [String desiredLocale]) {
-    var actualLocale = (desiredLocale == null) ? _locale : desiredLocale;
-    return new DateFormat(pattern, actualLocale);
-  }
-
-  /**
-   * Constructor optionally [_locale] for specifics of the language
-   * locale to be used, otherwise, we will attempt to infer it (acceptable if
-   * Dart is running on the client, we can infer from the browser/client
-   * preferences).
-   */
-  Intl([a_locale]) {
-    if (a_locale == null) {
-      _locale = _getDefaultLocale();
-    } else {
-      _locale = verifiedLocale(a_locale);
-    }
-    intlMsg = new IntlMessage(_locale);
-  }
-
-  /**
-   * Create a message that can be internationalized. It takes a
-   * [message_str] that will be translated, which may be interpolated
-   * based on one or more variables, a [desc] providing a description of usage
-   * for the [message_str], and a map of [examples] for each data element to be
-   * substituted into the message. For example, if message="Hello, $name", then
-   * examples = {'name': 'Sparky'}. If not using the user's default locale, or
-   * if the locale is not easily detectable, explicitly pass [locale].
-   * The values of [desc] and [examples] are not used at run-time but are only
-   * made available to the translators, so they MUST be simple Strings available
-   * at compile time: no String interpolation or concatenation.
-   * The expected usage of this is inside a function that takes as parameters
-   * the variables used in the interpolated string, and additionally also a
-   * locale (optional).
-   */
-  static String message(String message_str, [final String desc='',
-                        final Map examples=const {}, String locale='']) {
-    return message_str;
-  }
-
-  /**
-   * Return the locale for this instance. If none was set, the locale will
-   * be the default.
-   */
-  String get locale() => _locale;
-
-  /**
-   * Return true if the locale exists, or if it is null. The null case
-   * is interpreted to mean that we use the default locale.
-   */
-  static bool _localeExists(localeName) {
-    return DateFormat.localeExists(localeName);
-  }
-
-  /**
-   * Given [newLocale] return a locale that we have data for that is similar
-   * to it, if possible.
-   * If [newLocale] is found directly, return it. If it can't be found, look up
-   * based on just the language (e.g. 'en_CA' -> 'en'). Also accepts '-'
-   * as a separator and changes it into '_' for lookup, and changes the
-   * country to uppercase.
-   * Note that null is interpreted as meaning the default locale, so if
-   * [newLocale] is null it will be returned.
-   */
-  static String verifiedLocale(String newLocale) {
-    if (newLocale == null) return _getDefaultLocale();
-    if (_localeExists(newLocale)) {
-      return newLocale;
-    }
-    for (var each in [_canonicalized(newLocale), _shortLocale(newLocale)]) {
-      if (_localeExists(each)) {
-        return each;
-      }
-    }
-    throw new IllegalArgumentException("Invalid locale '$newLocale'");
-  }
-
-  /** Return the short version of a locale name, e.g. 'en_US' => 'en' */
-  static String _shortLocale(String aLocale) {
-    if (aLocale.length < 2) return aLocale;
-    return aLocale.substring(0, 2).toLowerCase();
-  }
-
-  /**
-   * Return a locale name turned into xx_YY where it might possibly be
-   * in the wrong case or with a hyphen instead of an underscore.
-   */
-  static String _canonicalized(String aLocale) {
-    // Locales of length < 5 are presumably two-letter forms, or else malformed.
-    // Locales of length > 6 are likely to be malformed. In either case we
-    // return them unmodified and if correct they will be found.
-    if ((aLocale.length < 5) || (aLocale.length > 6)) return aLocale;
-    if (aLocale[2] != '-' && (aLocale[2] != '_')) return aLocale;
-    return '${aLocale[0]}${aLocale[1]}_${aLocale[3].toUpperCase()}'
-           '${aLocale[4].toUpperCase()}';
-  }
-
-  /**
-   * Support method for message formatting. Select the correct plural form from
-   * [cases] given [howMany].
-   */
-  static String plural(var howMany, Map cases, [num offset=0]) {
-    // TODO(efortuna): Deal with "few" and "many" cases, offset, and others!
-    return select(howMany.toString(), cases);
-  }
-
-  /**
-   * Format the given function with a specific [locale], given a
-   * [msg_function] that takes no parameters and returns a String. We
-   * basically delay calling the message function proper until after the proper
-   * locale has been set.
-   */
-  static String withLocale(String locale, Function msg_function) {
-    // We have to do this silliness because Locale is not known at compile time,
-    // but must be a static variable.
-    if (_locale == null) _locale = _getDefaultLocale();
-    var oldLocale = _locale;
-    _locale = locale;
-    var result = msg_function();
-    _locale = oldLocale;
-    return result;
-  }
-
-  /**
-   * Support method for message formatting. Select the correct exact (gender,
-   * usually) form from [cases] given the user [choice].
-   */
-  static String select(String choice, Map cases) {
-    if (cases.containsKey(choice)) {
-      return cases[choice];
-    } else if (cases.containsKey('other')){
-      return cases['other'];
-    } else {
-      return '';
-    }
-  }
-
-  /**
-   * Helper to detect the locale as defined at runtime.
-   */
-  static String _getDefaultLocale() {
-    // TODO(efortuna): Detect the default locale given the user preferences.
-    // That would mean using window.navigator.language in a browser or
-    // an environment variable or other OS mechanism for the standalone VM.
-    // Yay, hard-coding for now!
-    return 'en_US';
-  }
-
-  /**
-   * Accessor for the current locale. This should always == the default locale,
-   * unless for some reason this gets called inside a message that resets the
-   * locale.
-   */
-  static String getCurrentLocale() {
-    return _locale;
-  }
-}