#include "unicode/utypes.h"
Go to the source code of this file.
Defines | |
#define | ULOC_CHINESE "zh" |
#define | ULOC_ENGLISH "en" |
#define | ULOC_FRENCH "fr" |
#define | ULOC_GERMAN "de" |
#define | ULOC_ITALIAN "it" |
#define | ULOC_JAPANESE "ja" |
#define | ULOC_KOREAN "ko" |
#define | ULOC_SIMPLIFIED_CHINESE "zh_CN" |
#define | ULOC_TRADITIONAL_CHINESE "zh_TW" |
#define | ULOC_CANADA "en_CA" |
#define | ULOC_CANADA_FRENCH "fr_CA" |
#define | ULOC_CHINA "zh_CN" |
#define | ULOC_PRC "zh_CN" |
#define | ULOC_FRANCE "fr_FR" |
#define | ULOC_GERMANY "de_DE" |
#define | ULOC_ITALY "it_IT" |
#define | ULOC_JAPAN "ja_JP" |
#define | ULOC_KOREA "ko_KR" |
#define | ULOC_TAIWAN "zh_TW" |
#define | ULOC_UK "en_GB" |
#define | ULOC_US "en_US" |
#define | ULOC_LANG_CAPACITY 12 |
Useful constants for the size of locale IDs. | |
#define | ULOC_COUNTRY_CAPACITY 4 |
#define | ULOC_FULLNAME_CAPACITY 50 |
Enumerations | |
enum | ULocDataLocaleType { ULOC_ACTUAL_LOCALE = 0, ULOC_VALID_LOCALE = 1, ULOC_REQUESTED_LOCALE = 2, ULOC_DATA_LOCALE_TYPE_LIMIT } |
Constants for *_getLocale() Allow user to select whether she wants information on requested, valid or actual locale. More... | |
Functions | |
U_CAPI const char *U_EXPORT2 | uloc_getDefault (void) |
Gets ICU's default locale. | |
U_CAPI void U_EXPORT2 | uloc_setDefault (const char *localeID, UErrorCode *status) |
Sets ICU's default locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getLanguage (const char *localeID, char *language, int32_t languageCapacity, UErrorCode *err) |
Gets the language code for the specified locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getCountry (const char *localeID, char *country, int32_t countryCapacity, UErrorCode *err) |
Gets the country code for the specified locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getVariant (const char *localeID, char *variant, int32_t variantCapacity, UErrorCode *err) |
Gets the variant code for the specified locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getName (const char *localeID, char *name, int32_t nameCapacity, UErrorCode *err) |
Gets the full name for the specified locale. | |
U_CAPI const char *U_EXPORT2 | uloc_getISO3Language (const char *localeID) |
Gets the ISO language code for the specified locale. | |
U_CAPI const char *U_EXPORT2 | uloc_getISO3Country (const char *localeID) |
Gets the ISO country code for the specified locale. | |
U_CAPI uint32_t U_EXPORT2 | uloc_getLCID (const char *localeID) |
Gets the Win32 LCID value for the specified locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getDisplayLanguage (const char *locale, const char *inLocale, UChar *language, int32_t languageCapacity, UErrorCode *status) |
Gets the language name suitable for display for the specified locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getDisplayCountry (const char *locale, const char *inLocale, UChar *country, int32_t countryCapacity, UErrorCode *status) |
Gets the country name suitable for display for the specified locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getDisplayVariant (const char *locale, const char *inLocale, UChar *variant, int32_t variantCapacity, UErrorCode *status) |
Gets the variant code suitable for display for the specified locale. | |
U_CAPI int32_t U_EXPORT2 | uloc_getDisplayName (const char *localeID, const char *inLocaleID, UChar *result, int32_t maxResultSize, UErrorCode *err) |
Gets the full name suitable for display for the specified locale. | |
U_CAPI const char *U_EXPORT2 | uloc_getAvailable (int32_t n) |
Gets the specified locale from a list of all available locales. | |
U_CAPI int32_t U_EXPORT2 | uloc_countAvailable (void) |
Gets the size of the all available locale list. | |
U_CAPI const char *const *U_EXPORT2 | uloc_getISOLanguages (void) |
Gets a list of all available language codes defined in ISO 639. | |
U_CAPI const char *const *U_EXPORT2 | uloc_getISOCountries (void) |
Gets a list of all available 2-letter country codes defined in ISO 639. | |
U_CAPI int32_t U_EXPORT2 | uloc_getParent (const char *localeID, char *parent, int32_t parentCapacity, UErrorCode *err) |
Truncate the locale ID string to get the parent locale ID. |
A Locale
represents a specific geographical, political, or cultural region. An operation that requires a Locale
to perform its task is called locale-sensitive and uses the Locale
to tailor information for the user. For example, displaying a number is a locale-sensitive operation--the number should be formatted according to the customs/conventions of the user's native country, region, or culture. In the C APIs, a locales is simply a const char string.
You create a Locale
with one of the three options listed below. Each of the component is separated by '_' in the locale string.
The first option is a valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. You can find a full list of these codes at a number of sites, such as:newLanguage newLanguage + newCountry newLanguage + newCountry + newVariant
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
The second option includes an additonal ISO Country Code. These codes are the upper-case two-letter codes as defined by ISO-3166. You can find a full list of these codes at a number of sites, such as:
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html
The third option requires another additonal information--the Variant. The Variant codes are vendor and browser-specific. For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX. Where there are two variants, separate them with an underscore, and put the most important one first. For example, a Traditional Spanish collation might be referenced, with "ES", "ES", "Traditional_WIN".
Because a
Locale
is just an identifier for a region, no validity check is performed when you specify aLocale
. If you want to see whether particular resources are available for theLocale
you asked for, you must query those resources. For example, ask theUNumberFormat
for the locales it supports using itsgetAvailable
method.
Note: When you ask for a resource for a particular locale, you get back the best available match, not necessarily precisely what you asked for. For more information, look atUResourceBundle
.The
Locale
provides a number of convenient constants that you can use to specify the commonly used locales. For example, the following refers to a locale for the United States:ULOC_USOnce you've specified a locale you can query it for information about itself. Use
uloc_getCountry
to get the ISO Country Code anduloc_getLanguage
to get the ISO Language Code. You can useuloc_getDisplayCountry
to get the name of the country suitable for displaying to the user. Similarly, you can useuloc_getDisplayLanguage
to get the name of the language suitable for displaying to the user. Interestingly, theuloc_getDisplayXXX
methods are themselves locale-sensitive and have two versions: one that uses the default locale and one that takes a locale as an argument and displays the name or country in a language appropriate to that locale.The ICU provides a number of services that perform locale-sensitive operations. For example, the
unum_xxx
functions format numbers, currency, or percentages in a locale-sensitive manner.Each of these methods has two variants; one with an explicit locale and one without; the latter using the default locale.UErrorCode success = U_ZERO_ERROR; UNumberFormat *nf; const char* myLocale = "fr_FR"; nf = unum_open( UNUM_DEFAULT, NULL, success ); unum_close(nf); nf = unum_open( UNUM_CURRENCY, NULL, success ); unum_close(nf); nf = unum_open( UNUM_PERCENT, NULL, success ); unum_close(nf);Anf = unum_open( UNUM_DEFAULT, myLocale, success ); unum_close(nf); nf = unum_open( UNUM_CURRENCY, myLocale, success ); unum_close(nf); nf = unum_open( UNUM_PERCENT, myLocale, success ); unum_close(nf);Locale
is the mechanism for identifying the kind of services (UNumberFormat
) that you would like to get. The locale is just a mechanism for identifying these services.Each international serivce that performs locale-sensitive operations allows you to get all the available objects of that type. You can sift through these objects by language, country, or variant, and use the display names to present a menu to the user. For example, you can create a menu of all the collation objects suitable for a given language. Such classes implement these three class methods:
const char* uloc_getAvailable(int32_t index); int32_t uloc_countAvailable(); int32_t uloc_getDisplayName(const char* localeID, const char* inLocaleID, UChar* result, int32_t maxResultSize, UErrorCode* err);Concerning POSIX/RFC1766 Locale IDs, the getLanguage/getCountry/getVariant/getName functions do understand the POSIX type form of language_COUNTRY.ENCODING and if there is not an ICU-stype variant, uloc_getVariant() for example will return the one listed after the sign. As well, the hyphen "-" is recognized as a country/variant separator similarly to RFC1766. So for example, "en-us" will be interpreted as en_US. As a result, uloc_getName() is far from a no-op, and will have the effect of converting POSIX/RFC1766 IDs into ICU form, although it does NOT map any of the actual codes (i.e. russian->ru) in any way. Applications should call uloc_getName() at the point where a locale ID is coming from an external source (user entry, OS, web browser) and pass the resulting string to other ICU functions. For example, don't use de-de as an argument to resourcebundle.
Define Documentation
|
Useful constants for the size of locale IDs.
|
|
Constants for *_getLocale() Allow user to select whether she wants information on requested, valid or actual locale. For example, a collator for "en_US_CALIFORNIA" was requested. In the current state of ICU (2.0), the requested locale is "en_US_CALIFORNIA", the valid locale is "en_US" (most specific locale supported by ICU) and the actual locale is "root" (the collation data comes unmodified from the UCA) The locale is considered supported by ICU if there is a core ICU bundle for that locale (although it may be empty). ICU 2.1 |
|
Gets the size of the all available locale list.
|
|
Gets the specified locale from a list of all available locales. The return value is a pointer to an item of a locale name array. Both this array and the pointers it contains are owned by ICU and should not be deleted or written through by the caller. The locale name is terminated by a null pointer.
|
|
Gets the country code for the specified locale.
|
|
Gets ICU's default locale. This pointer and/or the contents of the pointer may become invalid if the uloc_setDefault() is called, so copy the contents of the pointer before calling uloc_setDefault().
|
|
Gets the country name suitable for display for the specified locale.
|
|
Gets the language name suitable for display for the specified locale.
|
|
Gets the full name suitable for display for the specified locale.
|
|
Gets the variant code suitable for display for the specified locale.
|
|
Gets the ISO country code for the specified locale.
|
|
Gets the ISO language code for the specified locale.
|
|
Gets a list of all available 2-letter country codes defined in ISO 639. This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by ICU-- do not delete them, and do not write through them. The array is terminated with a null pointer.
|
|
Gets a list of all available language codes defined in ISO 639. This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by ICU-- do not delete them, and do not write through them. The array is terminated with a null pointer.
|
|
Gets the language code for the specified locale.
|
|
Gets the Win32 LCID value for the specified locale.
|
|
Gets the full name for the specified locale. Note: This has the effect of 'canonicalizing' the string to a certain extent. Upper and lower case are set as needed, and if the components were in 'POSIX' format they are changed to ICU format. It does NOT map aliased names in any way. See the top of this header file.
|
|
Truncate the locale ID string to get the parent locale ID. Copies the part of the string before the last underscore. The parent locale ID will be an empty string if there is no underscore, or if there is only one underscore at localeID[0].
|
|
Gets the variant code for the specified locale.
|
|
Sets ICU's default locale. Call this once during setup or program initialization.
|