1 // © 2016 and later: Unicode, Inc. and others. 2 // License & terms of use: http://www.unicode.org/copyright.html 4 ********************************************************************** 5 * Copyright (C) 1997-2016, International Business Machines 6 * Corporation and others. All Rights Reserved. 7 ********************************************************************** 11 * Modification History: 13 * Date Name Description 14 * 04/01/97 aliu Creation. 15 * 08/22/98 stephen JDK 1.2 sync. 16 * 12/08/98 rtg New C API for Locale 17 * 03/30/99 damiba overhaul 18 * 03/31/99 helena Javadoc for uloc functions. 19 * 04/15/99 Madhu Updated Javadoc 20 ******************************************************************************** 203 #define ULOC_CHINESE "zh" 205 #define ULOC_ENGLISH "en" 207 #define ULOC_FRENCH "fr" 209 #define ULOC_GERMAN "de" 211 #define ULOC_ITALIAN "it" 213 #define ULOC_JAPANESE "ja" 215 #define ULOC_KOREAN "ko" 217 #define ULOC_SIMPLIFIED_CHINESE "zh_CN" 219 #define ULOC_TRADITIONAL_CHINESE "zh_TW" 222 #define ULOC_CANADA "en_CA" 224 #define ULOC_CANADA_FRENCH "fr_CA" 226 #define ULOC_CHINA "zh_CN" 228 #define ULOC_PRC "zh_CN" 230 #define ULOC_FRANCE "fr_FR" 232 #define ULOC_GERMANY "de_DE" 234 #define ULOC_ITALY "it_IT" 236 #define ULOC_JAPAN "ja_JP" 238 #define ULOC_KOREA "ko_KR" 240 #define ULOC_TAIWAN "zh_TW" 242 #define ULOC_UK "en_GB" 244 #define ULOC_US "en_US" 251 #define ULOC_LANG_CAPACITY 12 258 #define ULOC_COUNTRY_CAPACITY 4 264 #define ULOC_FULLNAME_CAPACITY 157 271 #define ULOC_SCRIPT_CAPACITY 6 277 #define ULOC_KEYWORDS_CAPACITY 96 283 #define ULOC_KEYWORD_AND_VALUES_CAPACITY 100 289 #define ULOC_KEYWORD_SEPARATOR '@' 296 #define ULOC_KEYWORD_SEPARATOR_UNICODE 0x40 302 #define ULOC_KEYWORD_ASSIGN '=' 309 #define ULOC_KEYWORD_ASSIGN_UNICODE 0x3D 315 #define ULOC_KEYWORD_ITEM_SEPARATOR ';' 322 #define ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE 0x3B 348 #ifndef U_HIDE_DEPRECATED_API 359 #endif// U_HIDE_DEPRECATED_API 362 #ifndef U_HIDE_SYSTEM_API 374 U_CAPIconstchar* U_EXPORT2
397 #endif/* U_HIDE_SYSTEM_API */ 417 int32_t languageCapacity,
438 int32_t scriptCapacity,
459 int32_t countryCapacity,
480 int32_t variantCapacity,
507 int32_t nameCapacity,
530 int32_t nameCapacity,
540 U_CAPIconstchar* U_EXPORT2
551 U_CAPIconstchar* U_EXPORT2
591 constchar* displayLocale,
593 int32_t languageCapacity,
620 constchar* displayLocale,
622 int32_t scriptCapacity,
652 constchar* displayLocale,
654 int32_t countryCapacity,
682 constchar* displayLocale,
684 int32_t variantCapacity,
731 constchar* displayLocale,
733 int32_t destCapacity,
760 constchar* displayLocale,
762 int32_t destCapacity,
782 constchar* inLocaleID,
784 int32_t maxResultSize,
804 U_CAPIconstchar* U_EXPORT2
855 #ifndef U_HIDE_INTERNAL_API 860 #endif/* U_HIDE_INTERNAL_API */ 888 U_CAPIconstchar*
const* U_EXPORT2
900 U_CAPIconstchar*
const* U_EXPORT2
919 int32_t parentCapacity,
950 int32_t nameCapacity,
981 constchar* keywordName,
982 char* buffer, int32_t bufferCapacity,
1018 constchar* keywordValue,
1019 char* buffer, int32_t bufferCapacity,
1045 ULOC_LAYOUT_LTR = 0,
/* left-to-right. */ 1046 ULOC_LAYOUT_RTL = 1,
/* right-to-left. */ 1047 ULOC_LAYOUT_TTB = 2,
/* top-to-bottom. */ 1048 ULOC_LAYOUT_BTT = 3,
/* bottom-to-top. */ 1122 constchar *httpAcceptLanguage,
1147 int32_t acceptListCount,
1205 char* maximizedLocaleID,
1206 int32_t maximizedLocaleIDCapacity,
1245 char* minimizedLocaleID,
1246 int32_t minimizedLocaleIDCapacity,
1279 int32_t localeIDCapacity,
1280 int32_t* parsedLength,
1307 int32_t langtagCapacity,
1332 U_CAPIconstchar* U_EXPORT2
1363 U_CAPIconstchar* U_EXPORT2
1378 U_CAPIconstchar* U_EXPORT2
1407 U_CAPIconstchar* U_EXPORT2
C API: String Enumeration.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
U_CAPI int32_t uloc_acceptLanguage(char *result, int32_t resultAvailable, UAcceptResult *outResult, const char **acceptList, int32_t acceptListCount, UEnumeration *availableLocales, UErrorCode *status)
Based on a list of available locales, determine an acceptable locale for the user.
U_CAPI const char * uloc_getAvailable(int32_t n)
Gets the specified locale from a list of available locales.
U_CAPI const char * uloc_getDefault(void)
Gets ICU's default locale.
U_CAPI const char * uloc_getISO3Language(const char *localeID)
Gets the ISO language code for the specified locale.
U_CAPI ULayoutType uloc_getLineOrientation(const char *localeId, UErrorCode *status)
Get the layout line orientation for the specified locale.
U_CAPI int32_t uloc_toLanguageTag(const char *localeID, char *langtag, int32_t langtagCapacity, UBool strict, UErrorCode *err)
Returns a well-formed language tag for this locale ID.
U_CAPI const char * uloc_toUnicodeLocaleType(const char *keyword, const char *value)
Converts the specified keyword value (legacy type, or BCP 47 Unicode locale extension type) to the we...
U_CAPI int32_t 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.
UAcceptResult
Output values which uloc_acceptLanguage() writes to the 'outResult' parameter.
@ ULOC_ACCEPT_VALID
An exact match was found.
@ ULOC_ACCEPT_FALLBACK
A fallback was found.
@ ULOC_ACCEPT_FAILED
No exact match was found.
U_CAPI int32_t uloc_getDisplayVariant(const char *locale, const char *displayLocale, UChar *variant, int32_t variantCapacity, UErrorCode *status)
Gets the variant name suitable for display for the specified locale.
U_CAPI int32_t uloc_getDisplayScript(const char *locale, const char *displayLocale, UChar *script, int32_t scriptCapacity, UErrorCode *status)
Gets the script name suitable for display for the specified locale.
U_CAPI int32_t uloc_getVariant(const char *localeID, char *variant, int32_t variantCapacity, UErrorCode *err)
Gets the variant code for the specified locale.
U_CAPI const char * uloc_getISO3Country(const char *localeID)
Gets the ISO country code for the specified locale.
U_CAPI int32_t uloc_getKeywordValue(const char *localeID, const char *keywordName, char *buffer, int32_t bufferCapacity, UErrorCode *status)
Get the value for a keyword.
U_CAPI const char * uloc_toLegacyType(const char *keyword, const char *value)
Converts the specified keyword value (BCP 47 Unicode locale extension type, or legacy type or type al...
ULayoutType
enums for the return value for the character and line orientation functions.
U_CAPI int32_t uloc_getLanguage(const char *localeID, char *language, int32_t languageCapacity, UErrorCode *err)
Gets the language code for the specified locale.
U_CAPI uint32_t uloc_getLCID(const char *localeID)
Gets the Win32 LCID value for the specified locale.
U_CAPI int32_t uloc_canonicalize(const char *localeID, char *name, int32_t nameCapacity, UErrorCode *err)
Gets the full name for the specified locale.
U_CAPI int32_t uloc_minimizeSubtags(const char *localeID, char *minimizedLocaleID, int32_t minimizedLocaleIDCapacity, UErrorCode *err)
Minimize the subtags for a provided locale ID, per the algorithm described in the following CLDR tech...
U_CAPI int32_t uloc_addLikelySubtags(const char *localeID, char *maximizedLocaleID, int32_t maximizedLocaleIDCapacity, UErrorCode *err)
Add the likely subtags for a provided locale ID, per the algorithm described in the following CLDR te...
U_CAPI UEnumeration * uloc_openKeywords(const char *localeID, UErrorCode *status)
Gets an enumeration of keywords for the specified locale.
U_CAPI const char *const * uloc_getISOCountries(void)
Gets a list of all available 2-letter country codes defined in ISO 639.
U_CAPI int32_t uloc_acceptLanguageFromHTTP(char *result, int32_t resultAvailable, UAcceptResult *outResult, const char *httpAcceptLanguage, UEnumeration *availableLocales, UErrorCode *status)
Based on a HTTP header from a web browser and a list of available locales, determine an acceptable lo...
U_CAPI UEnumeration * uloc_openAvailableByType(ULocAvailableType type, UErrorCode *status)
Gets a list of available locales according to the type argument, allowing the user to access differen...
U_CAPI int32_t uloc_getScript(const char *localeID, char *script, int32_t scriptCapacity, UErrorCode *err)
Gets the script code for the specified locale.
U_CAPI ULayoutType uloc_getCharacterOrientation(const char *localeId, UErrorCode *status)
Get the layout character orientation for the specified locale.
U_CAPI void uloc_setDefault(const char *localeID, UErrorCode *status)
Sets ICU's default locale.
U_CAPI int32_t uloc_getCountry(const char *localeID, char *country, int32_t countryCapacity, UErrorCode *err)
Gets the country code for the specified locale.
U_CAPI UBool uloc_isRightToLeft(const char *locale)
Returns whether the locale's script is written right-to-left.
U_CAPI const char * uloc_toUnicodeLocaleKey(const char *keyword)
Converts the specified keyword (legacy key, or BCP 47 Unicode locale extension key) to the equivalent...
U_CAPI int32_t uloc_getParent(const char *localeID, char *parent, int32_t parentCapacity, UErrorCode *err)
Truncate the locale ID string to get the parent locale ID.
U_CAPI int32_t uloc_getBaseName(const char *localeID, char *name, int32_t nameCapacity, UErrorCode *err)
Gets the full name for the specified locale, like uloc_getName(), but without keywords.
U_CAPI int32_t uloc_getName(const char *localeID, char *name, int32_t nameCapacity, UErrorCode *err)
Gets the full name for the specified locale.
U_CAPI int32_t uloc_countAvailable(void)
Gets the size of the all available locale list.
U_CAPI int32_t uloc_forLanguageTag(const char *langtag, char *localeID, int32_t localeIDCapacity, int32_t *parsedLength, UErrorCode *err)
Returns a locale ID for the specified BCP47 language tag string.
U_CAPI int32_t uloc_getDisplayKeyword(const char *keyword, const char *displayLocale, UChar *dest, int32_t destCapacity, UErrorCode *status)
Gets the keyword name suitable for display for the specified locale.
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
@ ULOC_DATA_LOCALE_TYPE_LIMIT
One more than the highest normal ULocDataLocaleType value.
@ ULOC_ACTUAL_LOCALE
This is locale the data actually comes from.
@ ULOC_VALID_LOCALE
This is the most specific locale supported by ICU.
@ ULOC_REQUESTED_LOCALE
This is the requested locale.
U_CAPI int32_t uloc_getDisplayCountry(const char *locale, const char *displayLocale, UChar *country, int32_t countryCapacity, UErrorCode *status)
Gets the country name suitable for display for the specified locale.
U_CAPI int32_t uloc_setKeywordValue(const char *keywordName, const char *keywordValue, char *buffer, int32_t bufferCapacity, UErrorCode *status)
Sets or removes the value of the specified keyword.
U_CAPI const char * uloc_toLegacyKey(const char *keyword)
Converts the specified keyword (BCP 47 Unicode locale extension key, or legacy key) to the legacy key...
U_CAPI int32_t uloc_getDisplayLanguage(const char *locale, const char *displayLocale, UChar *language, int32_t languageCapacity, UErrorCode *status)
Gets the language name suitable for display for the specified locale.
U_CAPI int32_t uloc_getLocaleForLCID(uint32_t hostID, char *locale, int32_t localeCapacity, UErrorCode *status)
Gets the ICU locale ID for the specified Win32 LCID value.
U_CAPI const char *const * uloc_getISOLanguages(void)
Gets a list of all available 2-letter language codes defined in ISO 639, plus additional 3-letter cod...
ULocAvailableType
Types for uloc_getAvailableByType and uloc_countAvailableByType.
@ ULOC_AVAILABLE_ONLY_LEGACY_ALIASES
Legacy or alias locales that return data when passed to ICU APIs.
@ ULOC_AVAILABLE_WITH_LEGACY_ALIASES
The union of the locales in ULOC_AVAILABLE_DEFAULT and ULOC_AVAILABLE_ONLY_LEGACY_ALIAS.
@ ULOC_AVAILABLE_DEFAULT
Locales that return data when passed to ICU APIs, but not including legacy or alias locales.
U_CAPI int32_t uloc_getDisplayKeywordValue(const char *locale, const char *keyword, const char *displayLocale, UChar *dest, int32_t destCapacity, UErrorCode *status)
Gets the value of the keyword suitable for display for the specified locale.
int8_t UBool
The ICU boolean type, a signed-byte integer.
#define U_CAPI
This is used to declare a function as a public ICU C API.
char16_t UChar
The base type for UTF-16 code units and pointers.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.