/**
* @license
* Copyright The Closure Library Authors.
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Functions for dealing with Date formatting & Parsing,
* County and language name, TimeZone list.
* @suppress {deprecated} Use goog.i18n instead.
*/
/**
* Namespace for locale related functions.
*/
goog.provide('goog.locale');
goog.require('goog.locale.nativeNameConstants');
/**
* Set current locale to the specified one.
* @param {string} localeName Locale name string. We are following the usage
* in CLDR, but can make a few compromise for existing name compatibility.
*/
goog.locale.setLocale = function(localeName) {
'use strict';
// it is common to see people use '-' as locale part separator, normalize it.
localeName = localeName.replace(/-/g, '_');
goog.locale.activeLocale_ = localeName;
};
/**
* Retrieve the current locale
* @return {string} Current locale name string.
* @deprecated Use goog.LOCALE and goog.i18n instead.
*/
goog.locale.getLocale = function() {
'use strict';
if (!goog.locale.activeLocale_) {
goog.locale.activeLocale_ = 'en';
}
return goog.locale.activeLocale_;
};
// Couple of constants to represent predefined Date/Time format type.
/**
* Enum of resources that can be registered.
* @enum {string}
*/
goog.locale.Resource = {
DATE_TIME_CONSTANTS: 'DateTimeConstants',
NUMBER_FORMAT_CONSTANTS: 'NumberFormatConstants',
TIME_ZONE_CONSTANTS: 'TimeZoneConstants',
LOCAL_NAME_CONSTANTS: 'LocaleNameConstants',
TIME_ZONE_SELECTED_IDS: 'TimeZoneSelectedIds',
TIME_ZONE_SELECTED_SHORT_NAMES: 'TimeZoneSelectedShortNames',
TIME_ZONE_SELECTED_LONG_NAMES: 'TimeZoneSelectedLongNames',
TIME_ZONE_ALL_LONG_NAMES: 'TimeZoneAllLongNames'
};
// BCP 47 language code:
//
// LanguageCode := LanguageSubtag
// ("-" ScriptSubtag)?
// ("-" RegionSubtag)?
// ("-" VariantSubtag)?
// ("@" Keyword "=" Value ("," Keyword "=" Value)* )?
//
// e.g. en-Latn-GB
//
// NOTICE:
// No special format checking is performed. If you pass an invalid
// language code as a parameter to the following functions,
// you might get an unexpected result.
/**
* Returns the language-subtag of the given language code.
*
* @param {string} languageCode Language code to extract language subtag from.
* @return {string} Language subtag (in lowercase).
*/
goog.locale.getLanguageSubTag = function(languageCode) {
'use strict';
var result = languageCode.match(/^\w{2,3}([-_]|$)/);
return result ? result[0].replace(/[_-]/g, '') : '';
};
/**
* Returns the region-sub-tag of the given language code.
*
* @param {string} languageCode Language code to extract region subtag from.
* @return {string} Region sub-tag (in uppercase).
*/
goog.locale.getRegionSubTag = function(languageCode) {
'use strict';
var result = languageCode.match(/[-_]([a-zA-Z]{2}|\d{3})([-_]|$)/);
return result ? result[0].replace(/[_-]/g, '') : '';
};
/**
* Returns the script subtag of the locale with the first alphabet in uppercase
* and the rest 3 characters in lower case.
*
* @param {string} languageCode Language Code to extract script subtag from.
* @return {string} Script subtag.
*/
goog.locale.getScriptSubTag = function(languageCode) {
'use strict';
var result = languageCode.split(/[-_]/g);
return result.length > 1 && result[1].match(/^[a-zA-Z]{4}$/) ? result[1] : '';
};
/**
* Returns the variant-sub-tag of the given language code.
*
* @param {string} languageCode Language code to extract variant subtag from.
* @return {string} Variant sub-tag.
*/
goog.locale.getVariantSubTag = function(languageCode) {
'use strict';
var result = languageCode.match(/[-_]([a-z]{2,})/);
return result ? result[1] : '';
};
/**
* Returns the country name of the provided language code in its native
* language.
*
* This method depends on goog.locale.nativeNameConstants available from
* nativenameconstants.js. User of this method has to add dependency to this.
*
* @param {string} countryCode Code to lookup the country name for.
*
* @return {string} Country name for the provided language code.
*/
goog.locale.getNativeCountryName = function(countryCode) {
'use strict';
var key = goog.locale.getLanguageSubTag(countryCode) + '_' +
goog.locale.getRegionSubTag(countryCode);
return key in goog.locale.nativeNameConstants['COUNTRY'] ?
goog.locale.nativeNameConstants['COUNTRY'][key] :
countryCode;
};
/**
* Returns the localized country name for the provided language code in the
* current or provided locale symbols set.
*
* This method depends on `goog.locale.LocaleNameConstants__<locale>` available
* from http://go/js_locale_data. User of this method has to add dependency to
* this.
*
* @param {string} languageCode Language code to lookup the country name for.
* @param {Object=} opt_localeSymbols If omitted the current locale symbol
* set is used.
*
* @return {string} Localized country name.
*/
goog.locale.getLocalizedCountryName = function(
languageCode, opt_localeSymbols) {
'use strict';
var code = goog.locale.getRegionSubTag(languageCode);
var name =
goog.locale.getLocalizedRegionNameFromRegionCode(code, opt_localeSymbols);
return name == code ? languageCode : name;
};
/**
* Returns the localized country name for the provided language code in the
* current or provided locale symbols set.
*
* This method depends on `goog.locale.LocaleNameConstants__<locale>` available
* from http://go/js_locale_data. User of this method has to add dependency to
* this.
*
* @param {string} regionCode Two character country code or three digit region
* code to look up the country name for.
* @param {?Object=} opt_localeSymbols If omitted the current locale symbol
* set is used.
*
* @return {string} Localized region name.
*/
goog.locale.getLocalizedRegionNameFromRegionCode = function(
regionCode, opt_localeSymbols) {
'use strict';
if (!opt_localeSymbols) {
opt_localeSymbols =
goog.locale.getResource('LocaleNameConstants', goog.locale.getLocale());
}
return regionCode in opt_localeSymbols['COUNTRY'] ?
opt_localeSymbols['COUNTRY'][regionCode] :
regionCode;
};
/**
* Returns the language name of the provided language code in its native
* language.
*
* This method depends on goog.locale.nativeNameConstants available from
* nativenameconstants.js. User of this method has to add dependency to this.
*
* @param {string} languageCode Language code to lookup the language name for.
*
* @return {string} Language name for the provided language code.
*/
goog.locale.getNativeLanguageName = function(languageCode) {
'use strict';
if (languageCode in goog.locale.nativeNameConstants['LANGUAGE'])
return goog.locale.nativeNameConstants['LANGUAGE'][languageCode];
var code = goog.locale.getLanguageSubTag(languageCode);
return code in goog.locale.nativeNameConstants['LANGUAGE'] ?
goog.locale.nativeNameConstants['LANGUAGE'][code] :
languageCode;
};
/**
* Returns the localized language name for the provided language code in
* the current or provided locale symbols set.
*
* This method depends on `goog.locale.LocaleNameConstants__<locale>` available
* from http://go/js_locale_data. User of this method has to add dependency to
* this.
*
* @param {string} languageCode Language code to lookup the language name for.
* @param {Object=} opt_localeSymbols locale symbol set if given.
*
* @return {string} Localized language name of the provided language code.
*/
goog.locale.getLocalizedLanguageName = function(
languageCode, opt_localeSymbols) {
'use strict';
if (!opt_localeSymbols) {
opt_localeSymbols =
goog.locale.getResource('LocaleNameConstants', goog.locale.getLocale());
}
if (languageCode in opt_localeSymbols['LANGUAGE'])
return opt_localeSymbols['LANGUAGE'][languageCode];
var code = goog.locale.getLanguageSubTag(languageCode);
return code in opt_localeSymbols['LANGUAGE'] ?
opt_localeSymbols['LANGUAGE'][code] :
languageCode;
};
/**
* Register a resource object for certain locale.
* @param {Object} dataObj The resource object being registered.
* @param {goog.locale.Resource|string} resourceName String that represents
* the type of resource.
* @param {string} localeName Locale ID.
*/
goog.locale.registerResource = function(dataObj, resourceName, localeName) {
'use strict';
if (!goog.locale.resourceRegistry_[resourceName]) {
goog.locale.resourceRegistry_[resourceName] = {};
}
goog.locale.resourceRegistry_[resourceName][localeName] = dataObj;
// the first registered locale becomes active one. Usually there will be
// only one locale per js binary bundle.
if (!goog.locale.activeLocale_) {
goog.locale.activeLocale_ = localeName;
}
};
/**
* Returns true if the required resource has already been registered.
* @param {goog.locale.Resource|string} resourceName String that represents
* the type of resource.
* @param {string} localeName Locale ID.
* @return {boolean} Whether the required resource has already been registered.
*/
goog.locale.isResourceRegistered = function(resourceName, localeName) {
'use strict';
return resourceName in goog.locale.resourceRegistry_ &&
localeName in goog.locale.resourceRegistry_[resourceName];
};
/**
* This object maps (resourceName, localeName) to a resourceObj.
* @type {Object}
* @private
*/
goog.locale.resourceRegistry_ = {};
/**
* Registers the timezone constants object for a given locale name.
* @param {Object} dataObj The resource object.
* @param {string} localeName Locale ID.
* @deprecated Use goog.i18n.TimeZone, no longer need this.
*/
goog.locale.registerTimeZoneConstants = function(dataObj, localeName) {
'use strict';
goog.locale.registerResource(
dataObj, goog.locale.Resource.TIME_ZONE_CONSTANTS, localeName);
};
/**
* Registers the LocaleNameConstants constants object for a given locale name.
* @param {Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
goog.locale.registerLocaleNameConstants = function(dataObj, localeName) {
'use strict';
goog.locale.registerResource(
dataObj, goog.locale.Resource.LOCAL_NAME_CONSTANTS, localeName);
};
/**
* Registers the TimeZoneSelectedIds constants object for a given locale name.
* @param {Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
goog.locale.registerTimeZoneSelectedIds = function(dataObj, localeName) {
'use strict';
goog.locale.registerResource(
dataObj, goog.locale.Resource.TIME_ZONE_SELECTED_IDS, localeName);
};
/**
* Registers the TimeZoneSelectedShortNames constants object for a given
* locale name.
* @param {Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
goog.locale.registerTimeZoneSelectedShortNames = function(dataObj, localeName) {
'use strict';
goog.locale.registerResource(
dataObj, goog.locale.Resource.TIME_ZONE_SELECTED_SHORT_NAMES, localeName);
};
/**
* Registers the TimeZoneSelectedLongNames constants object for a given locale
* name.
* @param {Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
goog.locale.registerTimeZoneSelectedLongNames = function(dataObj, localeName) {
'use strict';
goog.locale.registerResource(
dataObj, goog.locale.Resource.TIME_ZONE_SELECTED_LONG_NAMES, localeName);
};
/**
* Registers the TimeZoneAllLongNames constants object for a given locale name.
* @param {Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
goog.locale.registerTimeZoneAllLongNames = function(dataObj, localeName) {
'use strict';
goog.locale.registerResource(
dataObj, goog.locale.Resource.TIME_ZONE_ALL_LONG_NAMES, localeName);
};
/**
* Retrieve specified resource for certain locale.
* @param {string} resourceName String that represents the type of resource.
* @param {string=} opt_locale Locale ID, if not given, current locale
* will be assumed.
* @return {Object|undefined} The resource object that hold all the resource
* data, or undefined if not available.
*/
goog.locale.getResource = function(resourceName, opt_locale) {
'use strict';
var locale = opt_locale ? opt_locale : goog.locale.getLocale();
if (!(resourceName in goog.locale.resourceRegistry_)) {
return undefined;
}
return goog.locale.resourceRegistry_[resourceName][locale];
};
/**
* Retrieve specified resource for certain locale with fallback. For example,
* request of 'zh_CN' will be resolved in following order: zh_CN, zh, en.
* If none of the above succeeds, of if the resource as indicated by
* resourceName does not exist at all, undefined will be returned.
*
* @param {string} resourceName String that represents the type of resource.
* @param {string=} opt_locale locale ID, if not given, current locale
* will be assumed.
* @return {Object|undefined} The resource object for desired locale.
*/
goog.locale.getResourceWithFallback = function(resourceName, opt_locale) {
'use strict';
var locale = opt_locale ? opt_locale : goog.locale.getLocale();
if (!(resourceName in goog.locale.resourceRegistry_)) {
return undefined;
}
if (locale in goog.locale.resourceRegistry_[resourceName]) {
return goog.locale.resourceRegistry_[resourceName][locale];
}
// if locale has multiple parts (2 atmost in reality), fallback to base part.
var locale_parts = locale.split('_');
if (locale_parts.length > 1 &&
locale_parts[0] in goog.locale.resourceRegistry_[resourceName]) {
return goog.locale.resourceRegistry_[resourceName][locale_parts[0]];
}
// otherwise, fallback to 'en'
return goog.locale.resourceRegistry_[resourceName]['en'];
};
// Export global functions that are used by the date time constants files.
// See http://go/js_locale_data
/**
* Registers the LocaleNameConstants constants object for a given locale name.
* @param {!Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
var registerLocalNameConstants = goog.locale.registerLocaleNameConstants;
/**
* Registers the TimeZoneSelectedIds constants object for a given locale name.
* @param {?Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
var registerTimeZoneSelectedIds = goog.locale.registerTimeZoneSelectedIds;
/**
* Registers the TimeZoneSelectedShortNames constants object for a given
* locale name.
* @param {!Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
var registerTimeZoneSelectedShortNames =
goog.locale.registerTimeZoneSelectedShortNames;
/**
* Registers the TimeZoneSelectedLongNames constants object for a given locale
* name.
* @param {!Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
var registerTimeZoneSelectedLongNames =
goog.locale.registerTimeZoneSelectedLongNames;
/**
* Registers the TimeZoneAllLongNames constants object for a given locale name.
* @param {!Object} dataObj The resource object.
* @param {string} localeName Locale ID.
*/
var registerTimeZoneAllLongNames = goog.locale.registerTimeZoneAllLongNames;
Codebase Browser
chromium