1// © 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
29/**
30 * \file
31 * \brief C API: Locale ID functionality similar to C++ class Locale
32 *
33 * <h2> ULoc C API for Locale </h2>
34 * A <code>Locale</code> represents a specific geographical, political,
35 * or cultural region. An operation that requires a <code>Locale</code> to perform
36 * its task is called <em>locale-sensitive</em> and uses the <code>Locale</code>
37 * to tailor information for the user. For example, displaying a number
38 * is a locale-sensitive operation--the number should be formatted
39 * according to the customs/conventions of the user's native country,
40 * region, or culture. In the C APIs, a locales is simply a const char string.
41 *
42 * <P>
43 * You create a <code>Locale</code> with one of the three options listed below.
44 * Each of the component is separated by '_' in the locale string.
45 * \htmlonly<blockquote>\endhtmlonly
46 * <pre>
47 * \code
48 * newLanguage
49 *
50 * newLanguage + newCountry
51 *
52 * newLanguage + newCountry + newVariant
53 * \endcode
54 * </pre>
55 * \htmlonly</blockquote>\endhtmlonly
56 * The first option is a valid <STRONG>ISO
57 * Language Code.</STRONG> These codes are the lower-case two-letter
58 * codes as defined by ISO-639.
59 * You can find a full list of these codes at a number of sites, such as:
60 * <BR><a href ="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">
61 * http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</a>
62 *
63 * <P>
64 * The second option includes an additional <STRONG>ISO Country
65 * Code.</STRONG> These codes are the upper-case two-letter codes
66 * as defined by ISO-3166.
67 * You can find a full list of these codes at a number of sites, such as:
68 * <BR><a href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html">
69 * http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</a>
70 *
71 * <P>
72 * The third option requires another additional information--the
73 * <STRONG>Variant.</STRONG>
74 * The Variant codes are vendor and browser-specific.
75 * For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX.
76 * Where there are two variants, separate them with an underscore, and
77 * put the most important one first. For
78 * example, a Traditional Spanish collation might be referenced, with
79 * "ES", "ES", "Traditional_WIN".
80 *
81 * <P>
82 * Because a <code>Locale</code> is just an identifier for a region,
83 * no validity check is performed when you specify a <code>Locale</code>.
84 * If you want to see whether particular resources are available for the
85 * <code>Locale</code> you asked for, you must query those resources. For
86 * example, ask the <code>UNumberFormat</code> for the locales it supports
87 * using its <code>getAvailable</code> method.
88 * <BR><STRONG>Note:</STRONG> When you ask for a resource for a particular
89 * locale, you get back the best available match, not necessarily
90 * precisely what you asked for. For more information, look at
91 * <code>UResourceBundle</code>.
92 *
93 * <P>
94 * The <code>Locale</code> provides a number of convenient constants
95 * that you can use to specify the commonly used
96 * locales. For example, the following refers to a locale
97 * for the United States:
98 * \htmlonly<blockquote>\endhtmlonly
99 * <pre>
100 * \code
101 * ULOC_US
102 * \endcode
103 * </pre>
104 * \htmlonly</blockquote>\endhtmlonly
105 *
106 * <P>
107 * Once you've specified a locale you can query it for information about
108 * itself. Use <code>uloc_getCountry</code> to get the ISO Country Code and
109 * <code>uloc_getLanguage</code> to get the ISO Language Code. You can
110 * use <code>uloc_getDisplayCountry</code> to get the
111 * name of the country suitable for displaying to the user. Similarly,
112 * you can use <code>uloc_getDisplayLanguage</code> to get the name of
113 * the language suitable for displaying to the user. Interestingly,
114 * the <code>uloc_getDisplayXXX</code> methods are themselves locale-sensitive
115 * and have two versions: one that uses the default locale and one
116 * that takes a locale as an argument and displays the name or country in
117 * a language appropriate to that locale.
118 *
119 * <P>
120 * The ICU provides a number of services that perform locale-sensitive
121 * operations. For example, the <code>unum_xxx</code> functions format
122 * numbers, currency, or percentages in a locale-sensitive manner.
123 * </P>
124 * \htmlonly<blockquote>\endhtmlonly
125 * <pre>
126 * \code
127 * UErrorCode success = U_ZERO_ERROR;
128 * UNumberFormat *nf;
129 * const char* myLocale = "fr_FR";
130 *
131 * nf = unum_open( UNUM_DEFAULT, NULL, success );
132 * unum_close(nf);
133 * nf = unum_open( UNUM_CURRENCY, NULL, success );
134 * unum_close(nf);
135 * nf = unum_open( UNUM_PERCENT, NULL, success );
136 * unum_close(nf);
137 * \endcode
138 * </pre>
139 * \htmlonly</blockquote>\endhtmlonly
140 * Each of these methods has two variants; one with an explicit locale
141 * and one without; the latter using the default locale.
142 * \htmlonly<blockquote>\endhtmlonly
143 * <pre>
144 * \code
145 *
146 * nf = unum_open( UNUM_DEFAULT, myLocale, success );
147 * unum_close(nf);
148 * nf = unum_open( UNUM_CURRENCY, myLocale, success );
149 * unum_close(nf);
150 * nf = unum_open( UNUM_PERCENT, myLocale, success );
151 * unum_close(nf);
152 * \endcode
153 * </pre>
154 * \htmlonly</blockquote>\endhtmlonly
155 * A <code>Locale</code> is the mechanism for identifying the kind of services
156 * (<code>UNumberFormat</code>) that you would like to get. The locale is
157 * <STRONG>just</STRONG> a mechanism for identifying these services.
158 *
159 * <P>
160 * Each international service that performs locale-sensitive operations
161 * allows you
162 * to get all the available objects of that type. You can sift
163 * through these objects by language, country, or variant,
164 * and use the display names to present a menu to the user.
165 * For example, you can create a menu of all the collation objects
166 * suitable for a given language. Such classes implement these
167 * three class methods:
168 * \htmlonly<blockquote>\endhtmlonly
169 * <pre>
170 * \code
171 * const char* uloc_getAvailable(int32_t index);
172 * int32_t uloc_countAvailable();
173 * int32_t
174 * uloc_getDisplayName(const char* localeID,
175 * const char* inLocaleID,
176 * UChar* result,
177 * int32_t maxResultSize,
178 * UErrorCode* err);
179 *
180 * \endcode
181 * </pre>
182 * \htmlonly</blockquote>\endhtmlonly
183 * <P>
184 * Concerning POSIX/RFC1766 Locale IDs,
185 * the getLanguage/getCountry/getVariant/getName functions do understand
186 * the POSIX type form of language_COUNTRY.ENCODING\@VARIANT
187 * and if there is not an ICU-stype variant, uloc_getVariant() for example
188 * will return the one listed after the \@at sign. As well, the hyphen
189 * "-" is recognized as a country/variant separator similarly to RFC1766.
190 * So for example, "en-us" will be interpreted as en_US.
191 * As a result, uloc_getName() is far from a no-op, and will have the
192 * effect of converting POSIX/RFC1766 IDs into ICU form, although it does
193 * NOT map any of the actual codes (i.e. russian->ru) in any way.
194 * Applications should call uloc_getName() at the point where a locale ID
195 * is coming from an external source (user entry, OS, web browser)
196 * and pass the resulting string to other ICU functions. For example,
197 * don't use de-de\@EURO as an argument to resourcebundle.
198 *
199 * @see UResourceBundle
200 */
201
202/** Useful constant for this language. @stable ICU 2.0 */
203#define ULOC_CHINESE "zh"
204/** Useful constant for this language. @stable ICU 2.0 */
205#define ULOC_ENGLISH "en"
206/** Useful constant for this language. @stable ICU 2.0 */
207#define ULOC_FRENCH "fr"
208/** Useful constant for this language. @stable ICU 2.0 */
209#define ULOC_GERMAN "de"
210/** Useful constant for this language. @stable ICU 2.0 */
211#define ULOC_ITALIAN "it"
212/** Useful constant for this language. @stable ICU 2.0 */
213#define ULOC_JAPANESE "ja"
214/** Useful constant for this language. @stable ICU 2.0 */
215#define ULOC_KOREAN "ko"
216/** Useful constant for this language. @stable ICU 2.0 */
217#define ULOC_SIMPLIFIED_CHINESE "zh_CN"
218/** Useful constant for this language. @stable ICU 2.0 */
219#define ULOC_TRADITIONAL_CHINESE "zh_TW"
220
221/** Useful constant for this country/region. @stable ICU 2.0 */
222#define ULOC_CANADA "en_CA"
223/** Useful constant for this country/region. @stable ICU 2.0 */
224#define ULOC_CANADA_FRENCH "fr_CA"
225/** Useful constant for this country/region. @stable ICU 2.0 */
226#define ULOC_CHINA "zh_CN"
227/** Useful constant for this country/region. @stable ICU 2.0 */
228#define ULOC_PRC "zh_CN"
229/** Useful constant for this country/region. @stable ICU 2.0 */
230#define ULOC_FRANCE "fr_FR"
231/** Useful constant for this country/region. @stable ICU 2.0 */
232#define ULOC_GERMANY "de_DE"
233/** Useful constant for this country/region. @stable ICU 2.0 */
234#define ULOC_ITALY "it_IT"
235/** Useful constant for this country/region. @stable ICU 2.0 */
236#define ULOC_JAPAN "ja_JP"
237/** Useful constant for this country/region. @stable ICU 2.0 */
238#define ULOC_KOREA "ko_KR"
239/** Useful constant for this country/region. @stable ICU 2.0 */
240#define ULOC_TAIWAN "zh_TW"
241/** Useful constant for this country/region. @stable ICU 2.0 */
242#define ULOC_UK "en_GB"
243/** Useful constant for this country/region. @stable ICU 2.0 */
244#define ULOC_US "en_US"
245
246/**
247 * Useful constant for the maximum size of the language part of a locale ID.
248 * (including the terminating NULL).
249 * @stable ICU 2.0
250 */
251#define ULOC_LANG_CAPACITY 12
252
253/**
254 * Useful constant for the maximum size of the country part of a locale ID
255 * (including the terminating NULL).
256 * @stable ICU 2.0
257 */
258#define ULOC_COUNTRY_CAPACITY 4
259/**
260 * Useful constant for the maximum size of the whole locale ID
261 * (including the terminating NULL and all keywords).
262 * @stable ICU 2.0
263 */
264#define ULOC_FULLNAME_CAPACITY 157
265
266/**
267 * Useful constant for the maximum size of the script part of a locale ID
268 * (including the terminating NULL).
269 * @stable ICU 2.8
270 */
271#define ULOC_SCRIPT_CAPACITY 6
272
273/**
274 * Useful constant for the maximum size of keywords in a locale
275 * @stable ICU 2.8
276 */
277#define ULOC_KEYWORDS_CAPACITY 96
278
279/**
280 * Useful constant for the maximum total size of keywords and their values in a locale
281 * @stable ICU 2.8
282 */
283#define ULOC_KEYWORD_AND_VALUES_CAPACITY 100
284
285/**
286 * Invariant character separating keywords from the locale string
287 * @stable ICU 2.8
288 */
289#define ULOC_KEYWORD_SEPARATOR '@'
290
291/**
292 * Unicode code point for '@' separating keywords from the locale string.
293 * @see ULOC_KEYWORD_SEPARATOR
294 * @stable ICU 4.6
295 */
296#define ULOC_KEYWORD_SEPARATOR_UNICODE 0x40
297
298/**
299 * Invariant character for assigning value to a keyword
300 * @stable ICU 2.8
301 */
302#define ULOC_KEYWORD_ASSIGN '='
303
304/**
305 * Unicode code point for '=' for assigning value to a keyword.
306 * @see ULOC_KEYWORD_ASSIGN
307 * @stable ICU 4.6
308 */
309#define ULOC_KEYWORD_ASSIGN_UNICODE 0x3D
310
311/**
312 * Invariant character separating keywords
313 * @stable ICU 2.8
314 */
315#define ULOC_KEYWORD_ITEM_SEPARATOR ';'
316
317/**
318 * Unicode code point for ';' separating keywords
319 * @see ULOC_KEYWORD_ITEM_SEPARATOR
320 * @stable ICU 4.6
321 */
322#define ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE 0x3B
323
324/**
325 * Constants for *_getLocale()
326 * Allow user to select whether she wants information on
327 * requested, valid or actual locale.
328 * For example, a collator for "en_US_CALIFORNIA" was
329 * requested. In the current state of ICU (2.0),
330 * the requested locale is "en_US_CALIFORNIA",
331 * the valid locale is "en_US" (most specific locale supported by ICU)
332 * and the actual locale is "root" (the collation data comes unmodified
333 * from the UCA)
334 * The locale is considered supported by ICU if there is a core ICU bundle
335 * for that locale (although it may be empty).
336 * @stable ICU 2.1
337 */
338typedef enum {
339 /** This is locale the data actually comes from
340 * @stable ICU 2.1
341 */
342 ULOC_ACTUAL_LOCALE = 0,
343 /** This is the most specific locale supported by ICU
344 * @stable ICU 2.1
345 */
346 ULOC_VALID_LOCALE = 1,
347
348#ifndef U_HIDE_DEPRECATED_API
349 /** This is the requested locale
350 * @deprecated ICU 2.8
351 */
352 ULOC_REQUESTED_LOCALE = 2,
353
354 /**
355 * One more than the highest normal ULocDataLocaleType value.
356 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
357 */
358 ULOC_DATA_LOCALE_TYPE_LIMIT = 3
359#endif // U_HIDE_DEPRECATED_API
360} ULocDataLocaleType;
361
362#ifndef U_HIDE_SYSTEM_API
363/**
364 * Gets ICU's default locale.
365 * The returned string is a snapshot in time, and will remain valid
366 * and unchanged even when uloc_setDefault() is called.
367 * The returned storage is owned by ICU, and must not be altered or deleted
368 * by the caller.
369 *
370 * @return the ICU default locale
371 * @system
372 * @stable ICU 2.0
373 */
374U_CAPI const char* U_EXPORT2
375uloc_getDefault(void);
376
377/**
378 * Sets ICU's default locale.
379 * By default (without calling this function), ICU's default locale will be based
380 * on information obtained from the underlying system environment.
381 * <p>
382 * Changes to ICU's default locale do not propagate back to the
383 * system environment.
384 * <p>
385 * Changes to ICU's default locale to not affect any ICU services that
386 * may already be open based on the previous default locale value.
387 *
388 * @param localeID the new ICU default locale. A value of NULL will try to get
389 * the system's default locale.
390 * @param status the error information if the setting of default locale fails
391 * @system
392 * @stable ICU 2.0
393 */
394U_CAPI void U_EXPORT2
395uloc_setDefault(const char* localeID,
396 UErrorCode* status);
397#endif /* U_HIDE_SYSTEM_API */
398
399/**
400 * Gets the language code for the specified locale.
401 *
402 * @param localeID the locale to get the ISO language code with
403 * @param language the language code for localeID
404 * @param languageCapacity the size of the language buffer to store the
405 * language code with
406 * @param err error information if retrieving the language code failed
407 * @return the actual buffer size needed for the language code. If it's greater
408 * than languageCapacity, the returned language code will be truncated.
409 * @stable ICU 2.0
410 */
411U_CAPI int32_t U_EXPORT2
412uloc_getLanguage(const char* localeID,
413 char* language,
414 int32_t languageCapacity,
415 UErrorCode* err);
416
417/**
418 * Gets the script code for the specified locale.
419 *
420 * @param localeID the locale to get the ISO language code with
421 * @param script the language code for localeID
422 * @param scriptCapacity the size of the language buffer to store the
423 * language code with
424 * @param err error information if retrieving the language code failed
425 * @return the actual buffer size needed for the language code. If it's greater
426 * than scriptCapacity, the returned language code will be truncated.
427 * @stable ICU 2.8
428 */
429U_CAPI int32_t U_EXPORT2
430uloc_getScript(const char* localeID,
431 char* script,
432 int32_t scriptCapacity,
433 UErrorCode* err);
434
435/**
436 * Gets the country code for the specified locale.
437 *
438 * @param localeID the locale to get the country code with
439 * @param country the country code for localeID
440 * @param countryCapacity the size of the country buffer to store the
441 * country code with
442 * @param err error information if retrieving the country code failed
443 * @return the actual buffer size needed for the country code. If it's greater
444 * than countryCapacity, the returned country code will be truncated.
445 * @stable ICU 2.0
446 */
447U_CAPI int32_t U_EXPORT2
448uloc_getCountry(const char* localeID,
449 char* country,
450 int32_t countryCapacity,
451 UErrorCode* err);
452
453/**
454 * Gets the variant code for the specified locale.
455 *
456 * @param localeID the locale to get the variant code with
457 * @param variant the variant code for localeID
458 * @param variantCapacity the size of the variant buffer to store the
459 * variant code with
460 * @param err error information if retrieving the variant code failed
461 * @return the actual buffer size needed for the variant code. If it's greater
462 * than variantCapacity, the returned variant code will be truncated.
463 * @stable ICU 2.0
464 */
465U_CAPI int32_t U_EXPORT2
466uloc_getVariant(const char* localeID,
467 char* variant,
468 int32_t variantCapacity,
469 UErrorCode* err);
470
471
472/**
473 * Gets the full name for the specified locale.
474 * Note: This has the effect of 'canonicalizing' the ICU locale ID to
475 * a certain extent. Upper and lower case are set as needed.
476 * It does NOT map aliased names in any way.
477 * See the top of this header file.
478 * This API supports preflighting.
479 *
480 * @param localeID the locale to get the full name with
481 * @param name fill in buffer for the name without keywords.
482 * @param nameCapacity capacity of the fill in buffer.
483 * @param err error information if retrieving the full name failed
484 * @return the actual buffer size needed for the full name. If it's greater
485 * than nameCapacity, the returned full name will be truncated.
486 * @stable ICU 2.0
487 */
488U_CAPI int32_t U_EXPORT2
489uloc_getName(const char* localeID,
490 char* name,
491 int32_t nameCapacity,
492 UErrorCode* err);
493
494/**
495 * Gets the full name for the specified locale.
496 * Note: This has the effect of 'canonicalizing' the string to
497 * a certain extent. Upper and lower case are set as needed,
498 * and if the components were in 'POSIX' format they are changed to
499 * ICU format. It does NOT map aliased names in any way.
500 * See the top of this header file.
501 *
502 * @param localeID the locale to get the full name with
503 * @param name the full name for localeID
504 * @param nameCapacity the size of the name buffer to store the
505 * full name with
506 * @param err error information if retrieving the full name failed
507 * @return the actual buffer size needed for the full name. If it's greater
508 * than nameCapacity, the returned full name will be truncated.
509 * @stable ICU 2.8
510 */
511U_CAPI int32_t U_EXPORT2
512uloc_canonicalize(const char* localeID,
513 char* name,
514 int32_t nameCapacity,
515 UErrorCode* err);
516
517/**
518 * Gets the ISO language code for the specified locale.
519 *
520 * @param localeID the locale to get the ISO language code with
521 * @return language the ISO language code for localeID
522 * @stable ICU 2.0
523 */
524U_CAPI const char* U_EXPORT2
525uloc_getISO3Language(const char* localeID);
526
527
528/**
529 * Gets the ISO country code for the specified locale.
530 *
531 * @param localeID the locale to get the ISO country code with
532 * @return country the ISO country code for localeID
533 * @stable ICU 2.0
534 */
535U_CAPI const char* U_EXPORT2
536uloc_getISO3Country(const char* localeID);
537
538/**
539 * Gets the Win32 LCID value for the specified locale.
540 * If the ICU locale is not recognized by Windows, 0 will be returned.
541 *
542 * LCIDs were deprecated with Windows Vista and Microsoft recommends
543 * that developers use BCP47 style tags instead (uloc_toLanguageTag).
544 *
545 * @param localeID the locale to get the Win32 LCID value with
546 * @return country the Win32 LCID for localeID
547 * @stable ICU 2.0
548 */
549U_CAPI uint32_t U_EXPORT2
550uloc_getLCID(const char* localeID);
551
552/**
553 * Gets the language name suitable for display for the specified locale.
554 *
555 * @param locale the locale to get the ISO language code with
556 * @param displayLocale Specifies the locale to be used to display the name. In
557 * other words, if the locale's language code is "en", passing
558 * Locale::getFrench() for inLocale would result in "Anglais",
559 * while passing Locale::getGerman() for inLocale would result
560 * in "Englisch".
561 * @param language the displayable language code for localeID
562 * @param languageCapacity the size of the language buffer to store the
563 * displayable language code with.
564 * @param status error information if retrieving the displayable language code
565 * failed. U_USING_DEFAULT_WARNING indicates that no data was
566 * found from the locale resources and a case canonicalized
567 * language code is placed into language as fallback.
568 * @return the actual buffer size needed for the displayable language code. If
569 * it's greater than languageCapacity, the returned language
570 * code will be truncated.
571 * @stable ICU 2.0
572 */
573U_CAPI int32_t U_EXPORT2
574uloc_getDisplayLanguage(const char* locale,
575 const char* displayLocale,
576 UChar* language,
577 int32_t languageCapacity,
578 UErrorCode* status);
579
580/**
581 * Gets the script name suitable for display for the specified locale.
582 *
583 * @param locale the locale to get the displayable script code with. NULL may be
584 * used to specify the default.
585 * @param displayLocale Specifies the locale to be used to display the name. In
586 * other words, if the locale's language code is "en", passing
587 * Locale::getFrench() for inLocale would result in "", while
588 * passing Locale::getGerman() for inLocale would result in "".
589 * NULL may be used to specify the default.
590 * @param script the displayable script for the localeID.
591 * @param scriptCapacity the size of the script buffer to store the displayable
592 * script code with.
593 * @param status error information if retrieving the displayable script code
594 * failed. U_USING_DEFAULT_WARNING indicates that no data was
595 * found from the locale resources and a case canonicalized
596 * script code is placed into script as fallback.
597 * @return the actual buffer size needed for the displayable script code. If
598 * it's greater than scriptCapacity, the returned displayable
599 * script code will be truncated.
600 * @stable ICU 2.8
601 */
602U_CAPI int32_t U_EXPORT2
603uloc_getDisplayScript(const char* locale,
604 const char* displayLocale,
605 UChar* script,
606 int32_t scriptCapacity,
607 UErrorCode* status);
608
609/**
610 * Gets the country name suitable for display for the specified locale.
611 * Warning: this is for the region part of a valid locale ID; it cannot just be
612 * the region code (like "FR"). To get the display name for a region alone, or
613 * for other options, use ULocaleDisplayNames instead.
614 *
615 * @param locale the locale to get the displayable country code with. NULL may
616 * be used to specify the default.
617 * @param displayLocale Specifies the locale to be used to display the name. In
618 * other words, if the locale's language code is "en", passing
619 * Locale::getFrench() for inLocale would result in "Anglais",
620 * while passing Locale::getGerman() for inLocale would result
621 * in "Englisch". NULL may be used to specify the default.
622 * @param country the displayable country code for localeID.
623 * @param countryCapacity the size of the country buffer to store the
624 * displayable country code with.
625 * @param status error information if retrieving the displayable country code
626 * failed. U_USING_DEFAULT_WARNING indicates that no data was
627 * found from the locale resources and a case canonicalized
628 * country code is placed into country as fallback.
629 * @return the actual buffer size needed for the displayable country code. If
630 * it's greater than countryCapacity, the returned displayable
631 * country code will be truncated.
632 * @stable ICU 2.0
633 */
634U_CAPI int32_t U_EXPORT2
635uloc_getDisplayCountry(const char* locale,
636 const char* displayLocale,
637 UChar* country,
638 int32_t countryCapacity,
639 UErrorCode* status);
640
641
642/**
643 * Gets the variant name suitable for display for the specified locale.
644 *
645 * @param locale the locale to get the displayable variant code with. NULL may
646 * be used to specify the default.
647 * @param displayLocale Specifies the locale to be used to display the name. In
648 * other words, if the locale's language code is "en", passing
649 * Locale::getFrench() for inLocale would result in "Anglais",
650 * while passing Locale::getGerman() for inLocale would result
651 * in "Englisch". NULL may be used to specify the default.
652 * @param variant the displayable variant code for localeID.
653 * @param variantCapacity the size of the variant buffer to store the
654 * displayable variant code with.
655 * @param status error information if retrieving the displayable variant code
656 * failed. U_USING_DEFAULT_WARNING indicates that no data was
657 * found from the locale resources and a case canonicalized
658 * variant code is placed into variant as fallback.
659 * @return the actual buffer size needed for the displayable variant code. If
660 * it's greater than variantCapacity, the returned displayable
661 * variant code will be truncated.
662 * @stable ICU 2.0
663 */
664U_CAPI int32_t U_EXPORT2
665uloc_getDisplayVariant(const char* locale,
666 const char* displayLocale,
667 UChar* variant,
668 int32_t variantCapacity,
669 UErrorCode* status);
670
671/**
672 * Gets the keyword name suitable for display for the specified locale. E.g:
673 * for the locale string de_DE\@collation=PHONEBOOK, this API gets the display
674 * string for the keyword collation.
675 * Usage:
676 * <code>
677 * UErrorCode status = U_ZERO_ERROR;
678 * const char* keyword =NULL;
679 * int32_t keywordLen = 0;
680 * int32_t keywordCount = 0;
681 * UChar displayKeyword[256];
682 * int32_t displayKeywordLen = 0;
683 * UEnumeration* keywordEnum = uloc_openKeywords("de_DE@collation=PHONEBOOK;calendar=TRADITIONAL", &status);
684 * for(keywordCount = uenum_count(keywordEnum, &status); keywordCount > 0 ; keywordCount--){
685 * if(U_FAILURE(status)){
686 * ...something went wrong so handle the error...
687 * break;
688 * }
689 * // the uenum_next returns NUL terminated string
690 * keyword = uenum_next(keywordEnum, &keywordLen, &status);
691 * displayKeywordLen = uloc_getDisplayKeyword(keyword, "en_US", displayKeyword, 256);
692 * ... do something interesting .....
693 * }
694 * uenum_close(keywordEnum);
695 * </code>
696 * @param keyword The keyword whose display string needs to be returned.
697 * @param displayLocale Specifies the locale to be used to display the name. In other words,
698 * if the locale's language code is "en", passing Locale::getFrench() for
699 * inLocale would result in "Anglais", while passing Locale::getGerman()
700 * for inLocale would result in "Englisch". NULL may be used to specify the default.
701 * @param dest the buffer to which the displayable keyword should be written.
702 * @param destCapacity The size of the buffer (number of UChars). If it is 0, then
703 * dest may be NULL and the function will only return the length of the
704 * result without writing any of the result string (pre-flighting).
705 * @param status error information if retrieving the displayable string failed.
706 * Should not be NULL and should not indicate failure on entry.
707 * U_USING_DEFAULT_WARNING indicates that no data was found from the locale
708 * resources and the keyword is placed into dest as fallback.
709 * @return the actual buffer size needed for the displayable variant code.
710 * @see #uloc_openKeywords
711 * @stable ICU 2.8
712 */
713U_CAPI int32_t U_EXPORT2
714uloc_getDisplayKeyword(const char* keyword,
715 const char* displayLocale,
716 UChar* dest,
717 int32_t destCapacity,
718 UErrorCode* status);
719/**
720 * Gets the value of the keyword suitable for display for the specified locale.
721 * E.g: for the locale string de_DE\@collation=PHONEBOOK, this API gets the display
722 * string for PHONEBOOK, in the display locale, when "collation" is specified as the keyword.
723 *
724 * @param locale The locale to get the displayable variant code with. NULL may be used to specify the default.
725 * @param keyword The keyword for whose value should be used.
726 * @param displayLocale Specifies the locale to be used to display the name. In other words,
727 * if the locale's language code is "en", passing Locale::getFrench() for
728 * inLocale would result in "Anglais", while passing Locale::getGerman()
729 * for inLocale would result in "Englisch". NULL may be used to specify the default.
730 * @param dest the buffer to which the displayable keyword should be written.
731 * @param destCapacity The size of the buffer (number of UChars). If it is 0, then
732 * dest may be NULL and the function will only return the length of the
733 * result without writing any of the result string (pre-flighting).
734 * @param status error information if retrieving the displayable string failed.
735 * Should not be NULL and must not indicate failure on entry.
736 * U_USING_DEFAULT_WARNING indicates that no data was found from the locale
737 * resources and the value of the keyword is placed into dest as fallback.
738 * @return the actual buffer size needed for the displayable variant code.
739 * @stable ICU 2.8
740 */
741U_CAPI int32_t U_EXPORT2
742uloc_getDisplayKeywordValue( const char* locale,
743 const char* keyword,
744 const char* displayLocale,
745 UChar* dest,
746 int32_t destCapacity,
747 UErrorCode* status);
748/**
749 * Gets the full name suitable for display for the specified locale.
750 *
751 * @param localeID the locale to get the displayable name with. NULL may be used to specify the default.
752 * @param inLocaleID Specifies the locale to be used to display the name. In other words,
753 * if the locale's language code is "en", passing Locale::getFrench() for
754 * inLocale would result in "Anglais", while passing Locale::getGerman()
755 * for inLocale would result in "Englisch". NULL may be used to specify the default.
756 * @param result the displayable name for localeID
757 * @param maxResultSize the size of the name buffer to store the
758 * displayable full name with
759 * @param err error information if retrieving the displayable name failed
760 * @return the actual buffer size needed for the displayable name. If it's greater
761 * than maxResultSize, the returned displayable name will be truncated.
762 * @stable ICU 2.0
763 */
764U_CAPI int32_t U_EXPORT2
765uloc_getDisplayName(const char* localeID,
766 const char* inLocaleID,
767 UChar* result,
768 int32_t maxResultSize,
769 UErrorCode* err);
770
771
772/**
773 * Gets the specified locale from a list of available locales.
774 *
775 * This method corresponds to uloc_openAvailableByType called with the
776 * ULOC_AVAILABLE_DEFAULT type argument.
777 *
778 * The return value is a pointer to an item of a locale name array. Both this
779 * array and the pointers it contains are owned by ICU and should not be
780 * deleted or written through by the caller. The locale name is terminated by
781 * a null pointer.
782 *
783 * @param n the specific locale name index of the available locale list;
784 * should not exceed the number returned by uloc_countAvailable.
785 * @return a specified locale name of all available locales
786 * @stable ICU 2.0
787 */
788U_CAPI const char* U_EXPORT2
789uloc_getAvailable(int32_t n);
790
791/**
792 * Gets the size of the all available locale list.
793 *
794 * @return the size of the locale list
795 * @stable ICU 2.0
796 */
797U_CAPI int32_t U_EXPORT2 uloc_countAvailable(void);
798
799/**
800 * Types for uloc_getAvailableByType and uloc_countAvailableByType.
801 *
802 * @stable ICU 65
803 */
804typedef enum ULocAvailableType {
805 /**
806 * Locales that return data when passed to ICU APIs,
807 * but not including legacy or alias locales.
808 *
809 * @stable ICU 65
810 */
811 ULOC_AVAILABLE_DEFAULT,
812
813 /**
814 * Legacy or alias locales that return data when passed to ICU APIs.
815 * Examples of supported legacy or alias locales:
816 *
817 * - iw (alias to he)
818 * - mo (alias to ro)
819 * - zh_CN (alias to zh_Hans_CN)
820 * - sr_BA (alias to sr_Cyrl_BA)
821 * - ars (alias to ar_SA)
822 *
823 * The locales in this set are disjoint from the ones in
824 * ULOC_AVAILABLE_DEFAULT. To get both sets at the same time, use
825 * ULOC_AVAILABLE_WITH_LEGACY_ALIASES.
826 *
827 * @stable ICU 65
828 */
829 ULOC_AVAILABLE_ONLY_LEGACY_ALIASES,
830
831 /**
832 * The union of the locales in ULOC_AVAILABLE_DEFAULT and
833 * ULOC_AVAILABLE_ONLY_LEGACY_ALIAS.
834 *
835 * @stable ICU 65
836 */
837 ULOC_AVAILABLE_WITH_LEGACY_ALIASES,
838
839#ifndef U_HIDE_INTERNAL_API
840 /**
841 * @internal
842 */
843 ULOC_AVAILABLE_COUNT
844#endif /* U_HIDE_INTERNAL_API */
845} ULocAvailableType;
846
847/**
848 * Gets a list of available locales according to the type argument, allowing
849 * the user to access different sets of supported locales in ICU.
850 *
851 * The returned UEnumeration must be closed by the caller.
852 *
853 * @param type Type choice from ULocAvailableType.
854 * @param status Set if an error occurred.
855 * @return a UEnumeration owned by the caller, or nullptr on failure.
856 * @stable ICU 65
857 */
858U_CAPI UEnumeration* U_EXPORT2
859uloc_openAvailableByType(ULocAvailableType type, UErrorCode* status);
860
861/**
862 *
863 * Gets a list of all available 2-letter language codes defined in ISO 639,
864 * plus additional 3-letter codes determined to be useful for locale generation as
865 * defined by Unicode CLDR. This is a pointer
866 * to an array of pointers to arrays of char. All of these pointers are owned
867 * by ICU-- do not delete them, and do not write through them. The array is
868 * terminated with a null pointer.
869 * @return a list of all available language codes
870 * @stable ICU 2.0
871 */
872U_CAPI const char* const* U_EXPORT2
873uloc_getISOLanguages(void);
874
875/**
876 *
877 * Gets a list of all available 2-letter country codes defined in ISO 639. This is a
878 * pointer to an array of pointers to arrays of char. All of these pointers are
879 * owned by ICU-- do not delete them, and do not write through them. The array is
880 * terminated with a null pointer.
881 * @return a list of all available country codes
882 * @stable ICU 2.0
883 */
884U_CAPI const char* const* U_EXPORT2
885uloc_getISOCountries(void);
886
887/**
888 * Truncate the locale ID string to get the parent locale ID.
889 * Copies the part of the string before the last underscore.
890 * The parent locale ID will be an empty string if there is no
891 * underscore, or if there is only one underscore at localeID[0].
892 *
893 * @param localeID Input locale ID string.
894 * @param parent Output string buffer for the parent locale ID.
895 * @param parentCapacity Size of the output buffer.
896 * @param err A UErrorCode value.
897 * @return The length of the parent locale ID.
898 * @stable ICU 2.0
899 */
900U_CAPI int32_t U_EXPORT2
901uloc_getParent(const char* localeID,
902 char* parent,
903 int32_t parentCapacity,
904 UErrorCode* err);
905
906
907
908
909/**
910 * Gets the full name for the specified locale, like uloc_getName(),
911 * but without keywords.
912 *
913 * Note: This has the effect of 'canonicalizing' the string to
914 * a certain extent. Upper and lower case are set as needed,
915 * and if the components were in 'POSIX' format they are changed to
916 * ICU format. It does NOT map aliased names in any way.
917 * See the top of this header file.
918 *
919 * This API strips off the keyword part, so "de_DE\@collation=phonebook"
920 * will become "de_DE".
921 * This API supports preflighting.
922 *
923 * @param localeID the locale to get the full name with
924 * @param name fill in buffer for the name without keywords.
925 * @param nameCapacity capacity of the fill in buffer.
926 * @param err error information if retrieving the full name failed
927 * @return the actual buffer size needed for the full name. If it's greater
928 * than nameCapacity, the returned full name will be truncated.
929 * @stable ICU 2.8
930 */
931U_CAPI int32_t U_EXPORT2
932uloc_getBaseName(const char* localeID,
933 char* name,
934 int32_t nameCapacity,
935 UErrorCode* err);
936
937/**
938 * Gets an enumeration of keywords for the specified locale. Enumeration
939 * must get disposed of by the client using uenum_close function.
940 *
941 * @param localeID the locale to get the variant code with
942 * @param status error information if retrieving the keywords failed
943 * @return enumeration of keywords or NULL if there are no keywords.
944 * @stable ICU 2.8
945 */
946U_CAPI UEnumeration* U_EXPORT2
947uloc_openKeywords(const char* localeID,
948 UErrorCode* status);
949
950/**
951 * Get the value for a keyword. Locale name does not need to be normalized.
952 *
953 * @param localeID locale name containing the keyword ("de_DE@currency=EURO;collation=PHONEBOOK")
954 * @param keywordName name of the keyword for which we want the value; must not be
955 * NULL or empty, and must consist only of [A-Za-z0-9]. Case insensitive.
956 * @param buffer receiving buffer
957 * @param bufferCapacity capacity of receiving buffer
958 * @param status containing error code: e.g. buffer not big enough or ill-formed localeID
959 * or keywordName parameters.
960 * @return the length of keyword value
961 * @stable ICU 2.8
962 */
963U_CAPI int32_t U_EXPORT2
964uloc_getKeywordValue(const char* localeID,
965 const char* keywordName,
966 char* buffer, int32_t bufferCapacity,
967 UErrorCode* status);
968
969
970/**
971 * Sets or removes the value of the specified keyword.
972 *
973 * For removing all keywords, use uloc_getBaseName().
974 *
975 * NOTE: Unlike almost every other ICU function which takes a
976 * buffer, this function will NOT truncate the output text, and will
977 * not update the buffer with unterminated text setting a status of
978 * U_STRING_NOT_TERMINATED_WARNING. If a BUFFER_OVERFLOW_ERROR is received,
979 * it means a terminated version of the updated locale ID would not fit
980 * in the buffer, and the original buffer is untouched. This is done to
981 * prevent incorrect or possibly even malformed locales from being generated
982 * and used.
983 *
984 * @param keywordName name of the keyword to be set; must not be
985 * NULL or empty, and must consist only of [A-Za-z0-9]. Case insensitive.
986 * @param keywordValue value of the keyword to be set. If 0-length or
987 * NULL, will result in the keyword being removed; no error is given if
988 * that keyword does not exist. Otherwise, must consist only of
989 * [A-Za-z0-9] and [/_+-].
990 * @param buffer input buffer containing well-formed locale ID to be
991 * modified.
992 * @param bufferCapacity capacity of receiving buffer
993 * @param status containing error code: e.g. buffer not big enough
994 * or ill-formed keywordName or keywordValue parameters, or ill-formed
995 * locale ID in buffer on input.
996 * @return the length needed for the buffer
997 * @see uloc_getKeywordValue
998 * @stable ICU 3.2
999 */
1000U_CAPI int32_t U_EXPORT2
1001uloc_setKeywordValue(const char* keywordName,
1002 const char* keywordValue,
1003 char* buffer, int32_t bufferCapacity,
1004 UErrorCode* status);
1005
1006/**
1007 * Returns whether the locale's script is written right-to-left.
1008 * If there is no script subtag, then the likely script is used, see uloc_addLikelySubtags().
1009 * If no likely script is known, then false is returned.
1010 *
1011 * A script is right-to-left according to the CLDR script metadata
1012 * which corresponds to whether the script's letters have Bidi_Class=R or AL.
1013 *
1014 * Returns true for "ar" and "en-Hebr", false for "zh" and "fa-Cyrl".
1015 *
1016 * @param locale input locale ID
1017 * @return true if the locale's script is written right-to-left
1018 * @stable ICU 54
1019 */
1020U_CAPI UBool U_EXPORT2
1021uloc_isRightToLeft(const char *locale);
1022
1023/**
1024 * enums for the return value for the character and line orientation
1025 * functions.
1026 * @stable ICU 4.0
1027 */
1028typedef enum {
1029 ULOC_LAYOUT_LTR = 0, /* left-to-right. */
1030 ULOC_LAYOUT_RTL = 1, /* right-to-left. */
1031 ULOC_LAYOUT_TTB = 2, /* top-to-bottom. */
1032 ULOC_LAYOUT_BTT = 3, /* bottom-to-top. */
1033 ULOC_LAYOUT_UNKNOWN
1034} ULayoutType;
1035
1036/**
1037 * Get the layout character orientation for the specified locale.
1038 *
1039 * @param localeId locale name
1040 * @param status Error status
1041 * @return an enum indicating the layout orientation for characters.
1042 * @stable ICU 4.0
1043 */
1044U_CAPI ULayoutType U_EXPORT2
1045uloc_getCharacterOrientation(const char* localeId,
1046 UErrorCode *status);
1047
1048/**
1049 * Get the layout line orientation for the specified locale.
1050 *
1051 * @param localeId locale name
1052 * @param status Error status
1053 * @return an enum indicating the layout orientation for lines.
1054 * @stable ICU 4.0
1055 */
1056U_CAPI ULayoutType U_EXPORT2
1057uloc_getLineOrientation(const char* localeId,
1058 UErrorCode *status);
1059
1060/**
1061 * Output values which uloc_acceptLanguage() writes to the 'outResult' parameter.
1062 *
1063 * @see uloc_acceptLanguageFromHTTP
1064 * @see uloc_acceptLanguage
1065 * @stable ICU 3.2
1066 */
1067typedef enum {
1068 /**
1069 * No exact match was found.
1070 * @stable ICU 3.2
1071 */
1072 ULOC_ACCEPT_FAILED = 0,
1073 /**
1074 * An exact match was found.
1075 * @stable ICU 3.2
1076 */
1077 ULOC_ACCEPT_VALID = 1,
1078 /**
1079 * A fallback was found. For example, the Accept-Language list includes 'ja_JP'
1080 * and is matched with available locale 'ja'.
1081 * @stable ICU 3.2
1082 */
1083 ULOC_ACCEPT_FALLBACK = 2 /* */
1084} UAcceptResult;
1085
1086/**
1087 * Based on a HTTP header from a web browser and a list of available locales,
1088 * determine an acceptable locale for the user.
1089 *
1090 * This is a thin wrapper over C++ class LocaleMatcher.
1091 *
1092 * @param result - buffer to accept the result locale
1093 * @param resultAvailable the size of the result buffer.
1094 * @param outResult - An out parameter that contains the fallback status
1095 * @param httpAcceptLanguage - "Accept-Language:" header as per HTTP.
1096 * @param availableLocales - list of available locales to match
1097 * @param status ICU error code. Its input value must pass the U_SUCCESS() test,
1098 * or else the function returns immediately. Check for U_FAILURE()
1099 * on output or use with function chaining. (See User Guide for details.)
1100 * @return length needed for the locale.
1101 * @stable ICU 3.2
1102 */
1103U_CAPI int32_t U_EXPORT2
1104uloc_acceptLanguageFromHTTP(char *result, int32_t resultAvailable,
1105 UAcceptResult *outResult,
1106 const char *httpAcceptLanguage,
1107 UEnumeration* availableLocales,
1108 UErrorCode *status);
1109
1110/**
1111 * Based on a list of available locales,
1112 * determine an acceptable locale for the user.
1113 *
1114 * This is a thin wrapper over C++ class LocaleMatcher.
1115 *
1116 * @param result - buffer to accept the result locale
1117 * @param resultAvailable the size of the result buffer.
1118 * @param outResult - An out parameter that contains the fallback status
1119 * @param acceptList - list of acceptable languages
1120 * @param acceptListCount - count of acceptList items
1121 * @param availableLocales - list of available locales to match
1122 * @param status ICU error code. Its input value must pass the U_SUCCESS() test,
1123 * or else the function returns immediately. Check for U_FAILURE()
1124 * on output or use with function chaining. (See User Guide for details.)
1125 * @return length needed for the locale.
1126 * @stable ICU 3.2
1127 */
1128U_CAPI int32_t U_EXPORT2
1129uloc_acceptLanguage(char *result, int32_t resultAvailable,
1130 UAcceptResult *outResult, const char **acceptList,
1131 int32_t acceptListCount,
1132 UEnumeration* availableLocales,
1133 UErrorCode *status);
1134
1135
1136/**
1137 * Gets the ICU locale ID for the specified Win32 LCID value.
1138 *
1139 * @param hostID the Win32 LCID to translate
1140 * @param locale the output buffer for the ICU locale ID, which will be NUL-terminated
1141 * if there is room.
1142 * @param localeCapacity the size of the output buffer
1143 * @param status an error is returned if the LCID is unrecognized or the output buffer
1144 * is too small
1145 * @return actual the actual size of the locale ID, not including NUL-termination
1146 * @stable ICU 3.8
1147 */
1148U_CAPI int32_t U_EXPORT2
1149uloc_getLocaleForLCID(uint32_t hostID, char *locale, int32_t localeCapacity,
1150 UErrorCode *status);
1151
1152
1153/**
1154 * Add the likely subtags for a provided locale ID, per the algorithm described
1155 * in the following CLDR technical report:
1156 *
1157 * http://www.unicode.org/reports/tr35/#Likely_Subtags
1158 *
1159 * If localeID is already in the maximal form, or there is no data available
1160 * for maximization, it will be copied to the output buffer. For example,
1161 * "und-Zzzz" cannot be maximized, since there is no reasonable maximization.
1162 *
1163 * Examples:
1164 *
1165 * "en" maximizes to "en_Latn_US"
1166 *
1167 * "de" maximizes to "de_Latn_US"
1168 *
1169 * "sr" maximizes to "sr_Cyrl_RS"
1170 *
1171 * "sh" maximizes to "sr_Latn_RS" (Note this will not reverse.)
1172 *
1173 * "zh_Hani" maximizes to "zh_Hans_CN" (Note this will not reverse.)
1174 *
1175 * @param localeID The locale to maximize
1176 * @param maximizedLocaleID The maximized locale
1177 * @param maximizedLocaleIDCapacity The capacity of the maximizedLocaleID buffer
1178 * @param err Error information if maximizing the locale failed. If the length
1179 * of the localeID and the null-terminator is greater than the maximum allowed size,
1180 * or the localeId is not well-formed, the error code is U_ILLEGAL_ARGUMENT_ERROR.
1181 * @return The actual buffer size needed for the maximized locale. If it's
1182 * greater than maximizedLocaleIDCapacity, the returned ID will be truncated.
1183 * On error, the return value is -1.
1184 * @stable ICU 4.0
1185 */
1186U_CAPI int32_t U_EXPORT2
1187uloc_addLikelySubtags(const char* localeID,
1188 char* maximizedLocaleID,
1189 int32_t maximizedLocaleIDCapacity,
1190 UErrorCode* err);
1191
1192
1193/**
1194 * Minimize the subtags for a provided locale ID, per the algorithm described
1195 * in the following CLDR technical report:
1196 *
1197 * http://www.unicode.org/reports/tr35/#Likely_Subtags
1198 *
1199 * If localeID is already in the minimal form, or there is no data available
1200 * for minimization, it will be copied to the output buffer. Since the
1201 * minimization algorithm relies on proper maximization, see the comments
1202 * for uloc_addLikelySubtags for reasons why there might not be any data.
1203 *
1204 * Examples:
1205 *
1206 * "en_Latn_US" minimizes to "en"
1207 *
1208 * "de_Latn_US" minimizes to "de"
1209 *
1210 * "sr_Cyrl_RS" minimizes to "sr"
1211 *
1212 * "zh_Hant_TW" minimizes to "zh_TW" (The region is preferred to the
1213 * script, and minimizing to "zh" would imply "zh_Hans_CN".)
1214 *
1215 * @param localeID The locale to minimize
1216 * @param minimizedLocaleID The minimized locale
1217 * @param minimizedLocaleIDCapacity The capacity of the minimizedLocaleID buffer
1218 * @param err Error information if minimizing the locale failed. If the length
1219 * of the localeID and the null-terminator is greater than the maximum allowed size,
1220 * or the localeId is not well-formed, the error code is U_ILLEGAL_ARGUMENT_ERROR.
1221 * @return The actual buffer size needed for the minimized locale. If it's
1222 * greater than minimizedLocaleIDCapacity, the returned ID will be truncated.
1223 * On error, the return value is -1.
1224 * @stable ICU 4.0
1225 */
1226U_CAPI int32_t U_EXPORT2
1227uloc_minimizeSubtags(const char* localeID,
1228 char* minimizedLocaleID,
1229 int32_t minimizedLocaleIDCapacity,
1230 UErrorCode* err);
1231
1232/**
1233 * Returns a locale ID for the specified BCP47 language tag string.
1234 * If the specified language tag contains any ill-formed subtags,
1235 * the first such subtag and all following subtags are ignored.
1236 * <p>
1237 * This implements the 'Language-Tag' production of BCP 47, and so
1238 * supports legacy language tags (marked as “Type: grandfathered” in BCP 47)
1239 * (regular and irregular) as well as private use language tags.
1240 *
1241 * Private use tags are represented as 'x-whatever',
1242 * and legacy tags are converted to their canonical replacements where they exist.
1243 *
1244 * Note that a few legacy tags have no modern replacement;
1245 * these will be converted using the fallback described in
1246 * the first paragraph, so some information might be lost.
1247 *
1248 * @param langtag the input BCP47 language tag.
1249 * @param localeID the output buffer receiving a locale ID for the
1250 * specified BCP47 language tag.
1251 * @param localeIDCapacity the size of the locale ID output buffer.
1252 * @param parsedLength if not NULL, successfully parsed length
1253 * for the input language tag is set.
1254 * @param err error information if receiving the locald ID
1255 * failed.
1256 * @return the length of the locale ID.
1257 * @stable ICU 4.2
1258 */
1259U_CAPI int32_t U_EXPORT2
1260uloc_forLanguageTag(const char* langtag,
1261 char* localeID,
1262 int32_t localeIDCapacity,
1263 int32_t* parsedLength,
1264 UErrorCode* err);
1265
1266/**
1267 * Returns a well-formed language tag for this locale ID.
1268 * <p>
1269 * <b>Note</b>: When <code>strict</code> is false, any locale
1270 * fields which do not satisfy the BCP47 syntax requirement will
1271 * be omitted from the result. When <code>strict</code> is
1272 * true, this function sets U_ILLEGAL_ARGUMENT_ERROR to the
1273 * <code>err</code> if any locale fields do not satisfy the
1274 * BCP47 syntax requirement.
1275 * @param localeID the input locale ID
1276 * @param langtag the output buffer receiving BCP47 language
1277 * tag for the locale ID.
1278 * @param langtagCapacity the size of the BCP47 language tag
1279 * output buffer.
1280 * @param strict boolean value indicating if the function returns
1281 * an error for an ill-formed input locale ID.
1282 * @param err error information if receiving the language
1283 * tag failed.
1284 * @return The length of the BCP47 language tag.
1285 * @stable ICU 4.2
1286 */
1287U_CAPI int32_t U_EXPORT2
1288uloc_toLanguageTag(const char* localeID,
1289 char* langtag,
1290 int32_t langtagCapacity,
1291 UBool strict,
1292 UErrorCode* err);
1293
1294/**
1295 * Converts the specified keyword (legacy key, or BCP 47 Unicode locale
1296 * extension key) to the equivalent BCP 47 Unicode locale extension key.
1297 * For example, BCP 47 Unicode locale extension key "co" is returned for
1298 * the input keyword "collation".
1299 * <p>
1300 * When the specified keyword is unknown, but satisfies the BCP syntax,
1301 * then the pointer to the input keyword itself will be returned.
1302 * For example,
1303 * <code>uloc_toUnicodeLocaleKey("ZZ")</code> returns "ZZ".
1304 *
1305 * @param keyword the input locale keyword (either legacy key
1306 * such as "collation" or BCP 47 Unicode locale extension
1307 * key such as "co").
1308 * @return the well-formed BCP 47 Unicode locale extension key,
1309 * or NULL if the specified locale keyword cannot be
1310 * mapped to a well-formed BCP 47 Unicode locale extension
1311 * key.
1312 * @see uloc_toLegacyKey
1313 * @stable ICU 54
1314 */
1315U_CAPI const char* U_EXPORT2
1316uloc_toUnicodeLocaleKey(const char* keyword);
1317
1318/**
1319 * Converts the specified keyword value (legacy type, or BCP 47
1320 * Unicode locale extension type) to the well-formed BCP 47 Unicode locale
1321 * extension type for the specified keyword (category). For example, BCP 47
1322 * Unicode locale extension type "phonebk" is returned for the input
1323 * keyword value "phonebook", with the keyword "collation" (or "co").
1324 * <p>
1325 * When the specified keyword is not recognized, but the specified value
1326 * satisfies the syntax of the BCP 47 Unicode locale extension type,
1327 * or when the specified keyword allows 'variable' type and the specified
1328 * value satisfies the syntax, then the pointer to the input type value itself
1329 * will be returned.
1330 * For example,
1331 * <code>uloc_toUnicodeLocaleType("Foo", "Bar")</code> returns "Bar",
1332 * <code>uloc_toUnicodeLocaleType("variableTop", "00A4")</code> returns "00A4".
1333 *
1334 * @param keyword the locale keyword (either legacy key such as
1335 * "collation" or BCP 47 Unicode locale extension
1336 * key such as "co").
1337 * @param value the locale keyword value (either legacy type
1338 * such as "phonebook" or BCP 47 Unicode locale extension
1339 * type such as "phonebk").
1340 * @return the well-formed BCP47 Unicode locale extension type,
1341 * or NULL if the locale keyword value cannot be mapped to
1342 * a well-formed BCP 47 Unicode locale extension type.
1343 * @see uloc_toLegacyType
1344 * @stable ICU 54
1345 */
1346U_CAPI const char* U_EXPORT2
1347uloc_toUnicodeLocaleType(const char* keyword, const char* value);
1348
1349/**
1350 * Converts the specified keyword (BCP 47 Unicode locale extension key, or
1351 * legacy key) to the legacy key. For example, legacy key "collation" is
1352 * returned for the input BCP 47 Unicode locale extension key "co".
1353 *
1354 * @param keyword the input locale keyword (either BCP 47 Unicode locale
1355 * extension key or legacy key).
1356 * @return the well-formed legacy key, or NULL if the specified
1357 * keyword cannot be mapped to a well-formed legacy key.
1358 * @see toUnicodeLocaleKey
1359 * @stable ICU 54
1360 */
1361U_CAPI const char* U_EXPORT2
1362uloc_toLegacyKey(const char* keyword);
1363
1364/**
1365 * Converts the specified keyword value (BCP 47 Unicode locale extension type,
1366 * or legacy type or type alias) to the canonical legacy type. For example,
1367 * the legacy type "phonebook" is returned for the input BCP 47 Unicode
1368 * locale extension type "phonebk" with the keyword "collation" (or "co").
1369 * <p>
1370 * When the specified keyword is not recognized, but the specified value
1371 * satisfies the syntax of legacy key, or when the specified keyword
1372 * allows 'variable' type and the specified value satisfies the syntax,
1373 * then the pointer to the input type value itself will be returned.
1374 * For example,
1375 * <code>uloc_toLegacyType("Foo", "Bar")</code> returns "Bar",
1376 * <code>uloc_toLegacyType("vt", "00A4")</code> returns "00A4".
1377 *
1378 * @param keyword the locale keyword (either legacy keyword such as
1379 * "collation" or BCP 47 Unicode locale extension
1380 * key such as "co").
1381 * @param value the locale keyword value (either BCP 47 Unicode locale
1382 * extension type such as "phonebk" or legacy keyword value
1383 * such as "phonebook").
1384 * @return the well-formed legacy type, or NULL if the specified
1385 * keyword value cannot be mapped to a well-formed legacy
1386 * type.
1387 * @see toUnicodeLocaleType
1388 * @stable ICU 54
1389 */
1390U_CAPI const char* U_EXPORT2
1391uloc_toLegacyType(const char* keyword, const char* value);
1392
1393#endif /*_ULOC*/
1394