ICU 56.1  56.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
uloc.h
Go to the documentation of this file.
1 /*
2 **********************************************************************
3 * Copyright (C) 1997-2015, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 **********************************************************************
6 *
7 * File ULOC.H
8 *
9 * Modification History:
10 *
11 * Date Name Description
12 * 04/01/97 aliu Creation.
13 * 08/22/98 stephen JDK 1.2 sync.
14 * 12/08/98 rtg New C API for Locale
15 * 03/30/99 damiba overhaul
16 * 03/31/99 helena Javadoc for uloc functions.
17 * 04/15/99 Madhu Updated Javadoc
18 ********************************************************************************
19 */
20 
21 #ifndef ULOC_H
22 #define ULOC_H
23 
24 #include "unicode/utypes.h"
25 #include "unicode/uenum.h"
26 
201 #define ULOC_CHINESE "zh"
202 
203 #define ULOC_ENGLISH "en"
204 
205 #define ULOC_FRENCH "fr"
206 
207 #define ULOC_GERMAN "de"
208 
209 #define ULOC_ITALIAN "it"
210 
211 #define ULOC_JAPANESE "ja"
212 
213 #define ULOC_KOREAN "ko"
214 
215 #define ULOC_SIMPLIFIED_CHINESE "zh_CN"
216 
217 #define ULOC_TRADITIONAL_CHINESE "zh_TW"
218 
220 #define ULOC_CANADA "en_CA"
221 
222 #define ULOC_CANADA_FRENCH "fr_CA"
223 
224 #define ULOC_CHINA "zh_CN"
225 
226 #define ULOC_PRC "zh_CN"
227 
228 #define ULOC_FRANCE "fr_FR"
229 
230 #define ULOC_GERMANY "de_DE"
231 
232 #define ULOC_ITALY "it_IT"
233 
234 #define ULOC_JAPAN "ja_JP"
235 
236 #define ULOC_KOREA "ko_KR"
237 
238 #define ULOC_TAIWAN "zh_TW"
239 
240 #define ULOC_UK "en_GB"
241 
242 #define ULOC_US "en_US"
243 
249 #define ULOC_LANG_CAPACITY 12
250 
256 #define ULOC_COUNTRY_CAPACITY 4
257 
262 #define ULOC_FULLNAME_CAPACITY 157
263 
269 #define ULOC_SCRIPT_CAPACITY 6
270 
275 #define ULOC_KEYWORDS_CAPACITY 96
276 
281 #define ULOC_KEYWORD_AND_VALUES_CAPACITY 100
282 
287 #define ULOC_KEYWORD_SEPARATOR '@'
288 
294 #define ULOC_KEYWORD_SEPARATOR_UNICODE 0x40
295 
300 #define ULOC_KEYWORD_ASSIGN '='
301 
307 #define ULOC_KEYWORD_ASSIGN_UNICODE 0x3D
308 
313 #define ULOC_KEYWORD_ITEM_SEPARATOR ';'
314 
320 #define ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE 0x3B
321 
336 typedef enum {
345 
346 #ifndef U_HIDE_DEPRECATED_API
347 
351 #endif /* U_HIDE_DEPRECATED_API */
352 
353  ULOC_DATA_LOCALE_TYPE_LIMIT = 3
355 
356 #ifndef U_HIDE_SYSTEM_API
357 
368 U_STABLE const char* U_EXPORT2
369 uloc_getDefault(void);
370 
388 U_STABLE void U_EXPORT2
389 uloc_setDefault(const char* localeID,
390  UErrorCode* status);
391 #endif /* U_HIDE_SYSTEM_API */
392 
405 U_STABLE int32_t U_EXPORT2
406 uloc_getLanguage(const char* localeID,
407  char* language,
408  int32_t languageCapacity,
409  UErrorCode* err);
410 
423 U_STABLE int32_t U_EXPORT2
424 uloc_getScript(const char* localeID,
425  char* script,
426  int32_t scriptCapacity,
427  UErrorCode* err);
428 
441 U_STABLE int32_t U_EXPORT2
442 uloc_getCountry(const char* localeID,
443  char* country,
444  int32_t countryCapacity,
445  UErrorCode* err);
446 
459 U_STABLE int32_t U_EXPORT2
460 uloc_getVariant(const char* localeID,
461  char* variant,
462  int32_t variantCapacity,
463  UErrorCode* err);
464 
465 
482 U_STABLE int32_t U_EXPORT2
483 uloc_getName(const char* localeID,
484  char* name,
485  int32_t nameCapacity,
486  UErrorCode* err);
487 
505 U_STABLE int32_t U_EXPORT2
506 uloc_canonicalize(const char* localeID,
507  char* name,
508  int32_t nameCapacity,
509  UErrorCode* err);
510 
518 U_STABLE const char* U_EXPORT2
519 uloc_getISO3Language(const char* localeID);
520 
521 
529 U_STABLE const char* U_EXPORT2
530 uloc_getISO3Country(const char* localeID);
531 
540 U_STABLE uint32_t U_EXPORT2
541 uloc_getLCID(const char* localeID);
542 
559 U_STABLE int32_t U_EXPORT2
560 uloc_getDisplayLanguage(const char* locale,
561  const char* displayLocale,
562  UChar* language,
563  int32_t languageCapacity,
564  UErrorCode* status);
565 
582 U_STABLE int32_t U_EXPORT2
583 uloc_getDisplayScript(const char* locale,
584  const char* displayLocale,
585  UChar* script,
586  int32_t scriptCapacity,
587  UErrorCode* status);
588 
605 U_STABLE int32_t U_EXPORT2
606 uloc_getDisplayCountry(const char* locale,
607  const char* displayLocale,
608  UChar* country,
609  int32_t countryCapacity,
610  UErrorCode* status);
611 
612 
629 U_STABLE int32_t U_EXPORT2
630 uloc_getDisplayVariant(const char* locale,
631  const char* displayLocale,
632  UChar* variant,
633  int32_t variantCapacity,
634  UErrorCode* status);
635 
676 U_STABLE int32_t U_EXPORT2
677 uloc_getDisplayKeyword(const char* keyword,
678  const char* displayLocale,
679  UChar* dest,
680  int32_t destCapacity,
681  UErrorCode* status);
702 U_STABLE int32_t U_EXPORT2
703 uloc_getDisplayKeywordValue( const char* locale,
704  const char* keyword,
705  const char* displayLocale,
706  UChar* dest,
707  int32_t destCapacity,
708  UErrorCode* status);
725 U_STABLE int32_t U_EXPORT2
726 uloc_getDisplayName(const char* localeID,
727  const char* inLocaleID,
728  UChar* result,
729  int32_t maxResultSize,
730  UErrorCode* err);
731 
732 
743 U_STABLE const char* U_EXPORT2
744 uloc_getAvailable(int32_t n);
745 
752 U_STABLE int32_t U_EXPORT2 uloc_countAvailable(void);
753 
765 U_STABLE const char* const* U_EXPORT2
767 
777 U_STABLE const char* const* U_EXPORT2
779 
793 U_STABLE int32_t U_EXPORT2
794 uloc_getParent(const char* localeID,
795  char* parent,
796  int32_t parentCapacity,
797  UErrorCode* err);
798 
799 
800 
801 
824 U_STABLE int32_t U_EXPORT2
825 uloc_getBaseName(const char* localeID,
826  char* name,
827  int32_t nameCapacity,
828  UErrorCode* err);
829 
839 U_STABLE UEnumeration* U_EXPORT2
840 uloc_openKeywords(const char* localeID,
841  UErrorCode* status);
842 
854 U_STABLE int32_t U_EXPORT2
855 uloc_getKeywordValue(const char* localeID,
856  const char* keywordName,
857  char* buffer, int32_t bufferCapacity,
858  UErrorCode* status);
859 
860 
883 U_STABLE int32_t U_EXPORT2
884 uloc_setKeywordValue(const char* keywordName,
885  const char* keywordValue,
886  char* buffer, int32_t bufferCapacity,
887  UErrorCode* status);
888 
903 U_STABLE UBool U_EXPORT2
904 uloc_isRightToLeft(const char *locale);
905 
911 typedef enum {
912  ULOC_LAYOUT_LTR = 0, /* left-to-right. */
913  ULOC_LAYOUT_RTL = 1, /* right-to-left. */
914  ULOC_LAYOUT_TTB = 2, /* top-to-bottom. */
915  ULOC_LAYOUT_BTT = 3, /* bottom-to-top. */
916  ULOC_LAYOUT_UNKNOWN
917 } ULayoutType;
918 
927 U_STABLE ULayoutType U_EXPORT2
928 uloc_getCharacterOrientation(const char* localeId,
929  UErrorCode *status);
930 
939 U_STABLE ULayoutType U_EXPORT2
940 uloc_getLineOrientation(const char* localeId,
941  UErrorCode *status);
942 
949 typedef enum {
950  ULOC_ACCEPT_FAILED = 0, /* No exact match was found. */
951  ULOC_ACCEPT_VALID = 1, /* An exact match was found. */
952  ULOC_ACCEPT_FALLBACK = 2 /* A fallback was found, for example,
953  Accept list contained 'ja_JP'
954  which matched available locale 'ja'. */
955 } UAcceptResult;
956 
957 
970 U_STABLE int32_t U_EXPORT2
971 uloc_acceptLanguageFromHTTP(char *result, int32_t resultAvailable,
972  UAcceptResult *outResult,
973  const char *httpAcceptLanguage,
974  UEnumeration* availableLocales,
975  UErrorCode *status);
976 
990 U_STABLE int32_t U_EXPORT2
991 uloc_acceptLanguage(char *result, int32_t resultAvailable,
992  UAcceptResult *outResult, const char **acceptList,
993  int32_t acceptListCount,
994  UEnumeration* availableLocales,
995  UErrorCode *status);
996 
997 
1010 U_STABLE int32_t U_EXPORT2
1011 uloc_getLocaleForLCID(uint32_t hostID, char *locale, int32_t localeCapacity,
1012  UErrorCode *status);
1013 
1014 
1048 U_STABLE int32_t U_EXPORT2
1049 uloc_addLikelySubtags(const char* localeID,
1050  char* maximizedLocaleID,
1051  int32_t maximizedLocaleIDCapacity,
1052  UErrorCode* err);
1053 
1054 
1088 U_STABLE int32_t U_EXPORT2
1089 uloc_minimizeSubtags(const char* localeID,
1090  char* minimizedLocaleID,
1091  int32_t minimizedLocaleIDCapacity,
1092  UErrorCode* err);
1093 
1117 U_STABLE int32_t U_EXPORT2
1118 uloc_forLanguageTag(const char* langtag,
1119  char* localeID,
1120  int32_t localeIDCapacity,
1121  int32_t* parsedLength,
1122  UErrorCode* err);
1123 
1145 U_STABLE int32_t U_EXPORT2
1146 uloc_toLanguageTag(const char* localeID,
1147  char* langtag,
1148  int32_t langtagCapacity,
1149  UBool strict,
1150  UErrorCode* err);
1151 
1173 U_STABLE const char* U_EXPORT2
1174 uloc_toUnicodeLocaleKey(const char* keyword);
1175 
1204 U_STABLE const char* U_EXPORT2
1205 uloc_toUnicodeLocaleType(const char* keyword, const char* value);
1206 
1219 U_STABLE const char* U_EXPORT2
1220 uloc_toLegacyKey(const char* keyword);
1221 
1248 U_STABLE const char* U_EXPORT2
1249 uloc_toLegacyType(const char* keyword, const char* value);
1250 
1251 #endif /*_ULOC*/