ICU 57.1  57.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-2016, 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 {
340  ULOC_ACTUAL_LOCALE = 0,
344  ULOC_VALID_LOCALE = 1,
345 
346 #ifndef U_HIDE_DEPRECATED_API
347 
350  ULOC_REQUESTED_LOCALE = 2,
351 #endif /* U_HIDE_DEPRECATED_API */
352 
353  ULOC_DATA_LOCALE_TYPE_LIMIT = 3
354 } ULocDataLocaleType ;
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 
607 U_STABLE int32_t U_EXPORT2
608 uloc_getDisplayCountry(const char* locale,
609  const char* displayLocale,
610  UChar* country,
611  int32_t countryCapacity,
612  UErrorCode* status);
613 
614 
631 U_STABLE int32_t U_EXPORT2
632 uloc_getDisplayVariant(const char* locale,
633  const char* displayLocale,
634  UChar* variant,
635  int32_t variantCapacity,
636  UErrorCode* status);
637 
678 U_STABLE int32_t U_EXPORT2
679 uloc_getDisplayKeyword(const char* keyword,
680  const char* displayLocale,
681  UChar* dest,
682  int32_t destCapacity,
683  UErrorCode* status);
704 U_STABLE int32_t U_EXPORT2
705 uloc_getDisplayKeywordValue( const char* locale,
706  const char* keyword,
707  const char* displayLocale,
708  UChar* dest,
709  int32_t destCapacity,
710  UErrorCode* status);
727 U_STABLE int32_t U_EXPORT2
728 uloc_getDisplayName(const char* localeID,
729  const char* inLocaleID,
730  UChar* result,
731  int32_t maxResultSize,
732  UErrorCode* err);
733 
734 
745 U_STABLE const char* U_EXPORT2
746 uloc_getAvailable(int32_t n);
747 
754 U_STABLE int32_t U_EXPORT2 uloc_countAvailable(void);
755 
767 U_STABLE const char* const* U_EXPORT2
768 uloc_getISOLanguages(void);
769 
779 U_STABLE const char* const* U_EXPORT2
780 uloc_getISOCountries(void);
781 
795 U_STABLE int32_t U_EXPORT2
796 uloc_getParent(const char* localeID,
797  char* parent,
798  int32_t parentCapacity,
799  UErrorCode* err);
800 
801 
802 
803 
826 U_STABLE int32_t U_EXPORT2
827 uloc_getBaseName(const char* localeID,
828  char* name,
829  int32_t nameCapacity,
830  UErrorCode* err);
831 
841 U_STABLE UEnumeration* U_EXPORT2
842 uloc_openKeywords(const char* localeID,
843  UErrorCode* status);
844 
856 U_STABLE int32_t U_EXPORT2
857 uloc_getKeywordValue(const char* localeID,
858  const char* keywordName,
859  char* buffer, int32_t bufferCapacity,
860  UErrorCode* status);
861 
862 
885 U_STABLE int32_t U_EXPORT2
886 uloc_setKeywordValue(const char* keywordName,
887  const char* keywordValue,
888  char* buffer, int32_t bufferCapacity,
889  UErrorCode* status);
890 
905 U_STABLE UBool U_EXPORT2
906 uloc_isRightToLeft(const char *locale);
907 
913 typedef enum {
914  ULOC_LAYOUT_LTR = 0, /* left-to-right. */
915  ULOC_LAYOUT_RTL = 1, /* right-to-left. */
916  ULOC_LAYOUT_TTB = 2, /* top-to-bottom. */
917  ULOC_LAYOUT_BTT = 3, /* bottom-to-top. */
918  ULOC_LAYOUT_UNKNOWN
919 } ULayoutType;
920 
929 U_STABLE ULayoutType U_EXPORT2
930 uloc_getCharacterOrientation(const char* localeId,
931  UErrorCode *status);
932 
941 U_STABLE ULayoutType U_EXPORT2
942 uloc_getLineOrientation(const char* localeId,
943  UErrorCode *status);
944 
951 typedef enum {
952  ULOC_ACCEPT_FAILED = 0, /* No exact match was found. */
953  ULOC_ACCEPT_VALID = 1, /* An exact match was found. */
954  ULOC_ACCEPT_FALLBACK = 2 /* A fallback was found, for example,
955  Accept list contained 'ja_JP'
956  which matched available locale 'ja'. */
957 } UAcceptResult;
958 
959 
972 U_STABLE int32_t U_EXPORT2
973 uloc_acceptLanguageFromHTTP(char *result, int32_t resultAvailable,
974  UAcceptResult *outResult,
975  const char *httpAcceptLanguage,
976  UEnumeration* availableLocales,
977  UErrorCode *status);
978 
992 U_STABLE int32_t U_EXPORT2
993 uloc_acceptLanguage(char *result, int32_t resultAvailable,
994  UAcceptResult *outResult, const char **acceptList,
995  int32_t acceptListCount,
996  UEnumeration* availableLocales,
997  UErrorCode *status);
998 
999 
1012 U_STABLE int32_t U_EXPORT2
1013 uloc_getLocaleForLCID(uint32_t hostID, char *locale, int32_t localeCapacity,
1014  UErrorCode *status);
1015 
1016 
1050 U_STABLE int32_t U_EXPORT2
1051 uloc_addLikelySubtags(const char* localeID,
1052  char* maximizedLocaleID,
1053  int32_t maximizedLocaleIDCapacity,
1054  UErrorCode* err);
1055 
1056 
1090 U_STABLE int32_t U_EXPORT2
1091 uloc_minimizeSubtags(const char* localeID,
1092  char* minimizedLocaleID,
1093  int32_t minimizedLocaleIDCapacity,
1094  UErrorCode* err);
1095 
1119 U_STABLE int32_t U_EXPORT2
1120 uloc_forLanguageTag(const char* langtag,
1121  char* localeID,
1122  int32_t localeIDCapacity,
1123  int32_t* parsedLength,
1124  UErrorCode* err);
1125 
1147 U_STABLE int32_t U_EXPORT2
1148 uloc_toLanguageTag(const char* localeID,
1149  char* langtag,
1150  int32_t langtagCapacity,
1151  UBool strict,
1152  UErrorCode* err);
1153 
1175 U_STABLE const char* U_EXPORT2
1176 uloc_toUnicodeLocaleKey(const char* keyword);
1177 
1206 U_STABLE const char* U_EXPORT2
1207 uloc_toUnicodeLocaleType(const char* keyword, const char* value);
1208 
1221 U_STABLE const char* U_EXPORT2
1222 uloc_toLegacyKey(const char* keyword);
1223 
1250 U_STABLE const char* U_EXPORT2
1251 uloc_toLegacyType(const char* keyword, const char* value);
1252 
1253 #endif /*_ULOC*/
Generated on Wed Mar 16 2016 23:45:45 for ICU 57.1 by   doxygen 1.8.1.2