ICU 58.2  58.2
uloc.h
Go to the documentation of this file.
1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 **********************************************************************
5 * Copyright (C) 1997-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 **********************************************************************
8 *
9 * File ULOC.H
10 *
11 * Modification History:
12 *
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 ********************************************************************************
21 */
22 
23 #ifndef ULOC_H
24 #define ULOC_H
25 
26 #include "unicode/utypes.h"
27 #include "unicode/uenum.h"
28 
203 #define ULOC_CHINESE "zh"
204 
205 #define ULOC_ENGLISH "en"
206 
207 #define ULOC_FRENCH "fr"
208 
209 #define ULOC_GERMAN "de"
210 
211 #define ULOC_ITALIAN "it"
212 
213 #define ULOC_JAPANESE "ja"
214 
215 #define ULOC_KOREAN "ko"
216 
217 #define ULOC_SIMPLIFIED_CHINESE "zh_CN"
218 
219 #define ULOC_TRADITIONAL_CHINESE "zh_TW"
220 
222 #define ULOC_CANADA "en_CA"
223 
224 #define ULOC_CANADA_FRENCH "fr_CA"
225 
226 #define ULOC_CHINA "zh_CN"
227 
228 #define ULOC_PRC "zh_CN"
229 
230 #define ULOC_FRANCE "fr_FR"
231 
232 #define ULOC_GERMANY "de_DE"
233 
234 #define ULOC_ITALY "it_IT"
235 
236 #define ULOC_JAPAN "ja_JP"
237 
238 #define ULOC_KOREA "ko_KR"
239 
240 #define ULOC_TAIWAN "zh_TW"
241 
242 #define ULOC_UK "en_GB"
243 
244 #define ULOC_US "en_US"
245 
251 #define ULOC_LANG_CAPACITY 12
252 
258 #define ULOC_COUNTRY_CAPACITY 4
259 
264 #define ULOC_FULLNAME_CAPACITY 157
265 
271 #define ULOC_SCRIPT_CAPACITY 6
272 
277 #define ULOC_KEYWORDS_CAPACITY 96
278 
283 #define ULOC_KEYWORD_AND_VALUES_CAPACITY 100
284 
289 #define ULOC_KEYWORD_SEPARATOR '@'
290 
296 #define ULOC_KEYWORD_SEPARATOR_UNICODE 0x40
297 
302 #define ULOC_KEYWORD_ASSIGN '='
303 
309 #define ULOC_KEYWORD_ASSIGN_UNICODE 0x3D
310 
315 #define ULOC_KEYWORD_ITEM_SEPARATOR ';'
316 
322 #define ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE 0x3B
323 
338 typedef enum {
347 
348 #ifndef U_HIDE_DEPRECATED_API
349 
353 
359 #endif // U_HIDE_DEPRECATED_API
361 
362 #ifndef U_HIDE_SYSTEM_API
363 
374 U_STABLE const char* U_EXPORT2
375 uloc_getDefault(void);
376 
394 U_STABLE void U_EXPORT2
395 uloc_setDefault(const char* localeID,
396  UErrorCode* status);
397 #endif /* U_HIDE_SYSTEM_API */
398 
411 U_STABLE int32_t U_EXPORT2
412 uloc_getLanguage(const char* localeID,
413  char* language,
414  int32_t languageCapacity,
415  UErrorCode* err);
416 
429 U_STABLE int32_t U_EXPORT2
430 uloc_getScript(const char* localeID,
431  char* script,
432  int32_t scriptCapacity,
433  UErrorCode* err);
434 
447 U_STABLE int32_t U_EXPORT2
448 uloc_getCountry(const char* localeID,
449  char* country,
450  int32_t countryCapacity,
451  UErrorCode* err);
452 
465 U_STABLE int32_t U_EXPORT2
466 uloc_getVariant(const char* localeID,
467  char* variant,
468  int32_t variantCapacity,
469  UErrorCode* err);
470 
471 
488 U_STABLE int32_t U_EXPORT2
489 uloc_getName(const char* localeID,
490  char* name,
491  int32_t nameCapacity,
492  UErrorCode* err);
493 
511 U_STABLE int32_t U_EXPORT2
512 uloc_canonicalize(const char* localeID,
513  char* name,
514  int32_t nameCapacity,
515  UErrorCode* err);
516 
524 U_STABLE const char* U_EXPORT2
525 uloc_getISO3Language(const char* localeID);
526 
527 
535 U_STABLE const char* U_EXPORT2
536 uloc_getISO3Country(const char* localeID);
537 
546 U_STABLE uint32_t U_EXPORT2
547 uloc_getLCID(const char* localeID);
548 
565 U_STABLE int32_t U_EXPORT2
566 uloc_getDisplayLanguage(const char* locale,
567  const char* displayLocale,
568  UChar* language,
569  int32_t languageCapacity,
570  UErrorCode* status);
571 
588 U_STABLE int32_t U_EXPORT2
589 uloc_getDisplayScript(const char* locale,
590  const char* displayLocale,
591  UChar* script,
592  int32_t scriptCapacity,
593  UErrorCode* status);
594 
613 U_STABLE int32_t U_EXPORT2
614 uloc_getDisplayCountry(const char* locale,
615  const char* displayLocale,
616  UChar* country,
617  int32_t countryCapacity,
618  UErrorCode* status);
619 
620 
637 U_STABLE int32_t U_EXPORT2
638 uloc_getDisplayVariant(const char* locale,
639  const char* displayLocale,
640  UChar* variant,
641  int32_t variantCapacity,
642  UErrorCode* status);
643 
684 U_STABLE int32_t U_EXPORT2
685 uloc_getDisplayKeyword(const char* keyword,
686  const char* displayLocale,
687  UChar* dest,
688  int32_t destCapacity,
689  UErrorCode* status);
710 U_STABLE int32_t U_EXPORT2
711 uloc_getDisplayKeywordValue( const char* locale,
712  const char* keyword,
713  const char* displayLocale,
714  UChar* dest,
715  int32_t destCapacity,
716  UErrorCode* status);
733 U_STABLE int32_t U_EXPORT2
734 uloc_getDisplayName(const char* localeID,
735  const char* inLocaleID,
736  UChar* result,
737  int32_t maxResultSize,
738  UErrorCode* err);
739 
740 
751 U_STABLE const char* U_EXPORT2
752 uloc_getAvailable(int32_t n);
753 
760 U_STABLE int32_t U_EXPORT2 uloc_countAvailable(void);
761 
773 U_STABLE const char* const* U_EXPORT2
775 
785 U_STABLE const char* const* U_EXPORT2
787 
801 U_STABLE int32_t U_EXPORT2
802 uloc_getParent(const char* localeID,
803  char* parent,
804  int32_t parentCapacity,
805  UErrorCode* err);
806 
807 
808 
809 
832 U_STABLE int32_t U_EXPORT2
833 uloc_getBaseName(const char* localeID,
834  char* name,
835  int32_t nameCapacity,
836  UErrorCode* err);
837 
847 U_STABLE UEnumeration* U_EXPORT2
848 uloc_openKeywords(const char* localeID,
849  UErrorCode* status);
850 
862 U_STABLE int32_t U_EXPORT2
863 uloc_getKeywordValue(const char* localeID,
864  const char* keywordName,
865  char* buffer, int32_t bufferCapacity,
866  UErrorCode* status);
867 
868 
891 U_STABLE int32_t U_EXPORT2
892 uloc_setKeywordValue(const char* keywordName,
893  const char* keywordValue,
894  char* buffer, int32_t bufferCapacity,
895  UErrorCode* status);
896 
911 U_STABLE UBool U_EXPORT2
912 uloc_isRightToLeft(const char *locale);
913 
919 typedef enum {
920  ULOC_LAYOUT_LTR = 0, /* left-to-right. */
921  ULOC_LAYOUT_RTL = 1, /* right-to-left. */
922  ULOC_LAYOUT_TTB = 2, /* top-to-bottom. */
923  ULOC_LAYOUT_BTT = 3, /* bottom-to-top. */
924  ULOC_LAYOUT_UNKNOWN
925 } ULayoutType;
926 
935 U_STABLE ULayoutType U_EXPORT2
936 uloc_getCharacterOrientation(const char* localeId,
937  UErrorCode *status);
938 
947 U_STABLE ULayoutType U_EXPORT2
948 uloc_getLineOrientation(const char* localeId,
949  UErrorCode *status);
950 
957 typedef enum {
958  ULOC_ACCEPT_FAILED = 0, /* No exact match was found. */
959  ULOC_ACCEPT_VALID = 1, /* An exact match was found. */
960  ULOC_ACCEPT_FALLBACK = 2 /* A fallback was found, for example,
961  Accept list contained 'ja_JP'
962  which matched available locale 'ja'. */
963 } UAcceptResult;
964 
965 
978 U_STABLE int32_t U_EXPORT2
979 uloc_acceptLanguageFromHTTP(char *result, int32_t resultAvailable,
980  UAcceptResult *outResult,
981  const char *httpAcceptLanguage,
982  UEnumeration* availableLocales,
983  UErrorCode *status);
984 
998 U_STABLE int32_t U_EXPORT2
999 uloc_acceptLanguage(char *result, int32_t resultAvailable,
1000  UAcceptResult *outResult, const char **acceptList,
1001  int32_t acceptListCount,
1002  UEnumeration* availableLocales,
1003  UErrorCode *status);
1004 
1005 
1018 U_STABLE int32_t U_EXPORT2
1019 uloc_getLocaleForLCID(uint32_t hostID, char *locale, int32_t localeCapacity,
1020  UErrorCode *status);
1021 
1022 
1056 U_STABLE int32_t U_EXPORT2
1057 uloc_addLikelySubtags(const char* localeID,
1058  char* maximizedLocaleID,
1059  int32_t maximizedLocaleIDCapacity,
1060  UErrorCode* err);
1061 
1062 
1096 U_STABLE int32_t U_EXPORT2
1097 uloc_minimizeSubtags(const char* localeID,
1098  char* minimizedLocaleID,
1099  int32_t minimizedLocaleIDCapacity,
1100  UErrorCode* err);
1101 
1125 U_STABLE int32_t U_EXPORT2
1126 uloc_forLanguageTag(const char* langtag,
1127  char* localeID,
1128  int32_t localeIDCapacity,
1129  int32_t* parsedLength,
1130  UErrorCode* err);
1131 
1153 U_STABLE int32_t U_EXPORT2
1154 uloc_toLanguageTag(const char* localeID,
1155  char* langtag,
1156  int32_t langtagCapacity,
1157  UBool strict,
1158  UErrorCode* err);
1159 
1181 U_STABLE const char* U_EXPORT2
1182 uloc_toUnicodeLocaleKey(const char* keyword);
1183 
1212 U_STABLE const char* U_EXPORT2
1213 uloc_toUnicodeLocaleType(const char* keyword, const char* value);
1214 
1227 U_STABLE const char* U_EXPORT2
1228 uloc_toLegacyKey(const char* keyword);
1229 
1256 U_STABLE const char* U_EXPORT2
1257 uloc_toLegacyType(const char* keyword, const char* value);
1258 
1259 #endif /*_ULOC*/
int32_t uloc_getScript(const char *localeID, char *script, int32_t scriptCapacity, UErrorCode *err)
Gets the script code for the specified locale.
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.
uint32_t uloc_getLCID(const char *localeID)
Gets the Win32 LCID value for the specified locale.
int32_t uloc_getName(const char *localeID, char *name, int32_t nameCapacity, UErrorCode *err)
Gets the full name for the specified locale.
const char *const * uloc_getISOCountries(void)
Gets a list of all available 2-letter country codes defined in ISO 639.
This is the requested locale.
Definition: uloc.h:352
const char * uloc_toLegacyKey(const char *keyword)
Converts the specified keyword (BCP 47 Unicode locale extension key, or legacy key) to the legacy key...
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.
const char * uloc_getISO3Country(const char *localeID)
Gets the ISO country code for the specified locale.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:41
const char * uloc_getISO3Language(const char *localeID)
Gets the ISO language code for the specified locale.
const char * uloc_getAvailable(int32_t n)
Gets the specified locale from a list of all available locales.
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.
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.
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.
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.
This is locale the data actually comes from.
Definition: uloc.h:342
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.
int32_t uloc_getLanguage(const char *localeID, char *language, int32_t languageCapacity, UErrorCode *err)
Gets the language code for the specified locale.
ULayoutType uloc_getCharacterOrientation(const char *localeId, UErrorCode *status)
Get the layout character orientation for the specified locale.
This is the most specific locale supported by ICU.
Definition: uloc.h:346
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.
int32_t uloc_getVariant(const char *localeID, char *variant, int32_t variantCapacity, UErrorCode *err)
Gets the variant code for the specified locale.
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...
One more than the highest normal ULocDataLocaleType value.
Definition: uloc.h:358
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...
ULayoutType uloc_getLineOrientation(const char *localeId, UErrorCode *status)
Get the layout line orientation for the specified locale.
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.
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.
int32_t uloc_canonicalize(const char *localeID, char *name, int32_t nameCapacity, UErrorCode *err)
Gets the full name for the specified locale.
const char * uloc_getDefault(void)
Gets ICU's default locale.
UAcceptResult
enums for the 'outResult' parameter return value
Definition: uloc.h:957
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:337
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...
int32_t uloc_getKeywordValue(const char *localeID, const char *keywordName, char *buffer, int32_t bufferCapacity, UErrorCode *status)
Get the value for a keyword.
int32_t uloc_getCountry(const char *localeID, char *country, int32_t countryCapacity, UErrorCode *err)
Gets the country code for the specified locale.
UBool uloc_isRightToLeft(const char *locale)
Returns whether the locale's script is written right-to-left.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested...
Definition: uloc.h:338
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...
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.
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.
C API: String Enumeration.
Basic definitions for ICU, for both C and C++ APIs.
void uloc_setDefault(const char *localeID, UErrorCode *status)
Sets ICU's default locale.
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.
UEnumeration * uloc_openKeywords(const char *localeID, UErrorCode *status)
Gets an enumeration of keywords for the specified locale.
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...
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...
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.
ULayoutType
enums for the return value for the character and line orientation functions.
Definition: uloc.h:919
const char * uloc_toUnicodeLocaleKey(const char *keyword)
Converts the specified keyword (legacy key, or BCP 47 Unicode locale extension key) to the equivalent...
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:134
int32_t uloc_countAvailable(void)
Gets the size of the all available locale list.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:259