aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/icu/include/unicode/uloc.h
diff options
context:
space:
mode:
authormcheshkov <mcheshkov@yandex-team.ru>2022-02-10 16:46:16 +0300
committerDaniil Cherednik <dcherednik@yandex-team.ru>2022-02-10 16:46:16 +0300
commit1312621288956f199a5bd5342b0133d4395fa725 (patch)
tree1a2c5ffcf89eb53ecd79dbc9bc0a195c27404d0c /contrib/libs/icu/include/unicode/uloc.h
parente9d19cec64684c9c1e6b0c98297e5b895cf904fe (diff)
downloadydb-1312621288956f199a5bd5342b0133d4395fa725.tar.gz
Restoring authorship annotation for <mcheshkov@yandex-team.ru>. Commit 2 of 2.
Diffstat (limited to 'contrib/libs/icu/include/unicode/uloc.h')
-rw-r--r--contrib/libs/icu/include/unicode/uloc.h278
1 files changed, 139 insertions, 139 deletions
diff --git a/contrib/libs/icu/include/unicode/uloc.h b/contrib/libs/icu/include/unicode/uloc.h
index ae6e2e38ca..d877ce49af 100644
--- a/contrib/libs/icu/include/unicode/uloc.h
+++ b/contrib/libs/icu/include/unicode/uloc.h
@@ -1,4 +1,4 @@
-// © 2016 and later: Unicode, Inc. and others.
+// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
**********************************************************************
@@ -61,7 +61,7 @@
* http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</a>
*
* <P>
- * The second option includes an additional <STRONG>ISO Country
+ * The second option includes an additional <STRONG>ISO Country
* Code.</STRONG> These codes are the upper-case two-letter codes
* as defined by ISO-3166.
* You can find a full list of these codes at a number of sites, such as:
@@ -69,7 +69,7 @@
* http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</a>
*
* <P>
- * The third option requires another additional information--the
+ * The third option requires another additional information--the
* <STRONG>Variant.</STRONG>
* The Variant codes are vendor and browser-specific.
* For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX.
@@ -157,7 +157,7 @@
* <STRONG>just</STRONG> a mechanism for identifying these services.
*
* <P>
- * Each international service that performs locale-sensitive operations
+ * Each international service that performs locale-sensitive operations
* allows you
* to get all the available objects of that type. You can sift
* through these objects by language, country, or variant,
@@ -539,9 +539,9 @@ uloc_getISO3Country(const char* localeID);
* Gets the Win32 LCID value for the specified locale.
* If the ICU locale is not recognized by Windows, 0 will be returned.
*
- * LCIDs were deprecated with Windows Vista and Microsoft recommends
- * that developers use BCP47 style tags instead (uloc_toLanguageTag).
- *
+ * LCIDs were deprecated with Windows Vista and Microsoft recommends
+ * that developers use BCP47 style tags instead (uloc_toLanguageTag).
+ *
* @param localeID the locale to get the Win32 LCID value with
* @return country the Win32 LCID for localeID
* @stable ICU 2.0
@@ -580,7 +580,7 @@ uloc_getDisplayLanguage(const char* locale,
* if the locale's language code is "en", passing Locale::getFrench() for
* inLocale would result in "", while passing Locale::getGerman()
* for inLocale would result in "". NULL may be used to specify the default.
- * @param script the displayable script for the localeID
+ * @param script the displayable script for the localeID
* @param scriptCapacity the size of the script buffer to store the
* displayable script code with
* @param status error information if retrieving the displayable script code failed
@@ -742,18 +742,18 @@ uloc_getDisplayName(const char* localeID,
/**
- * Gets the specified locale from a list of available locales.
- *
- * This method corresponds to uloc_openAvailableByType called with the
- * ULOC_AVAILABLE_DEFAULT type argument.
- *
- * The return value is a pointer to an item of a locale name array. Both this
- * array and the pointers it contains are owned by ICU and should not be
- * deleted or written through by the caller. The locale name is terminated by
- * a null pointer.
- *
- * @param n the specific locale name index of the available locale list;
- * should not exceed the number returned by uloc_countAvailable.
+ * Gets the specified locale from a list of available locales.
+ *
+ * This method corresponds to uloc_openAvailableByType called with the
+ * ULOC_AVAILABLE_DEFAULT type argument.
+ *
+ * The return value is a pointer to an item of a locale name array. Both this
+ * array and the pointers it contains are owned by ICU and should not be
+ * deleted or written through by the caller. The locale name is terminated by
+ * a null pointer.
+ *
+ * @param n the specific locale name index of the available locale list;
+ * should not exceed the number returned by uloc_countAvailable.
* @return a specified locale name of all available locales
* @stable ICU 2.0
*/
@@ -768,74 +768,74 @@ uloc_getAvailable(int32_t n);
*/
U_STABLE int32_t U_EXPORT2 uloc_countAvailable(void);
-#ifndef U_HIDE_DRAFT_API
-
+#ifndef U_HIDE_DRAFT_API
+
/**
- * Types for uloc_getAvailableByType and uloc_countAvailableByType.
- *
- * @draft ICU 65
- */
-typedef enum ULocAvailableType {
- /**
- * Locales that return data when passed to ICU APIs,
- * but not including legacy or alias locales.
- *
- * @draft ICU 65
- */
- ULOC_AVAILABLE_DEFAULT,
-
- /**
- * Legacy or alias locales that return data when passed to ICU APIs.
- * Examples of supported legacy or alias locales:
- *
- * - iw (alias to he)
- * - mo (alias to ro)
- * - zh_CN (alias to zh_Hans_CN)
- * - sr_BA (alias to sr_Cyrl_BA)
- * - ars (alias to ar_SA)
- *
- * The locales in this set are disjoint from the ones in
- * ULOC_AVAILABLE_DEFAULT. To get both sets at the same time, use
- * ULOC_AVAILABLE_WITH_LEGACY_ALIASES.
- *
- * @draft ICU 65
- */
- ULOC_AVAILABLE_ONLY_LEGACY_ALIASES,
-
- /**
- * The union of the locales in ULOC_AVAILABLE_DEFAULT and
- * ULOC_AVAILABLE_ONLY_LEGACY_ALIAS.
- *
- * @draft ICU 65
- */
- ULOC_AVAILABLE_WITH_LEGACY_ALIASES,
-
-#ifndef U_HIDE_INTERNAL_API
- /**
- * @internal
- */
- ULOC_AVAILABLE_COUNT
-#endif
-} ULocAvailableType;
-
-/**
- * Gets a list of available locales according to the type argument, allowing
- * the user to access different sets of supported locales in ICU.
- *
- * The returned UEnumeration must be closed by the caller.
- *
- * @param type Type choice from ULocAvailableType.
- * @param status Set if an error occurred.
- * @return a UEnumeration owned by the caller, or nullptr on failure.
- * @draft ICU 65
- */
-U_DRAFT UEnumeration* U_EXPORT2
-uloc_openAvailableByType(ULocAvailableType type, UErrorCode* status);
-
-#endif // U_HIDE_DRAFT_API
-
-/**
- *
+ * Types for uloc_getAvailableByType and uloc_countAvailableByType.
+ *
+ * @draft ICU 65
+ */
+typedef enum ULocAvailableType {
+ /**
+ * Locales that return data when passed to ICU APIs,
+ * but not including legacy or alias locales.
+ *
+ * @draft ICU 65
+ */
+ ULOC_AVAILABLE_DEFAULT,
+
+ /**
+ * Legacy or alias locales that return data when passed to ICU APIs.
+ * Examples of supported legacy or alias locales:
+ *
+ * - iw (alias to he)
+ * - mo (alias to ro)
+ * - zh_CN (alias to zh_Hans_CN)
+ * - sr_BA (alias to sr_Cyrl_BA)
+ * - ars (alias to ar_SA)
+ *
+ * The locales in this set are disjoint from the ones in
+ * ULOC_AVAILABLE_DEFAULT. To get both sets at the same time, use
+ * ULOC_AVAILABLE_WITH_LEGACY_ALIASES.
+ *
+ * @draft ICU 65
+ */
+ ULOC_AVAILABLE_ONLY_LEGACY_ALIASES,
+
+ /**
+ * The union of the locales in ULOC_AVAILABLE_DEFAULT and
+ * ULOC_AVAILABLE_ONLY_LEGACY_ALIAS.
+ *
+ * @draft ICU 65
+ */
+ ULOC_AVAILABLE_WITH_LEGACY_ALIASES,
+
+#ifndef U_HIDE_INTERNAL_API
+ /**
+ * @internal
+ */
+ ULOC_AVAILABLE_COUNT
+#endif
+} ULocAvailableType;
+
+/**
+ * Gets a list of available locales according to the type argument, allowing
+ * the user to access different sets of supported locales in ICU.
+ *
+ * The returned UEnumeration must be closed by the caller.
+ *
+ * @param type Type choice from ULocAvailableType.
+ * @param status Set if an error occurred.
+ * @return a UEnumeration owned by the caller, or nullptr on failure.
+ * @draft ICU 65
+ */
+U_DRAFT UEnumeration* U_EXPORT2
+uloc_openAvailableByType(ULocAvailableType type, UErrorCode* status);
+
+#endif // U_HIDE_DRAFT_API
+
+/**
+ *
* Gets a list of all available 2-letter language codes defined in ISO 639,
* plus additional 3-letter codes determined to be useful for locale generation as
* defined by Unicode CLDR. This is a pointer
@@ -927,12 +927,12 @@ uloc_openKeywords(const char* localeID,
* Get the value for a keyword. Locale name does not need to be normalized.
*
* @param localeID locale name containing the keyword ("de_DE@currency=EURO;collation=PHONEBOOK")
- * @param keywordName name of the keyword for which we want the value; must not be
- * NULL or empty, and must consist only of [A-Za-z0-9]. Case insensitive.
+ * @param keywordName name of the keyword for which we want the value; must not be
+ * NULL or empty, and must consist only of [A-Za-z0-9]. Case insensitive.
* @param buffer receiving buffer
* @param bufferCapacity capacity of receiving buffer
- * @param status containing error code: e.g. buffer not big enough or ill-formed localeID
- * or keywordName parameters.
+ * @param status containing error code: e.g. buffer not big enough or ill-formed localeID
+ * or keywordName parameters.
* @return the length of keyword value
* @stable ICU 2.8
*/
@@ -949,26 +949,26 @@ uloc_getKeywordValue(const char* localeID,
* For removing all keywords, use uloc_getBaseName().
*
* NOTE: Unlike almost every other ICU function which takes a
- * buffer, this function will NOT truncate the output text, and will
- * not update the buffer with unterminated text setting a status of
- * U_STRING_NOT_TERMINATED_WARNING. If a BUFFER_OVERFLOW_ERROR is received,
- * it means a terminated version of the updated locale ID would not fit
- * in the buffer, and the original buffer is untouched. This is done to
- * prevent incorrect or possibly even malformed locales from being generated
- * and used.
- *
- * @param keywordName name of the keyword to be set; must not be
- * NULL or empty, and must consist only of [A-Za-z0-9]. Case insensitive.
+ * buffer, this function will NOT truncate the output text, and will
+ * not update the buffer with unterminated text setting a status of
+ * U_STRING_NOT_TERMINATED_WARNING. If a BUFFER_OVERFLOW_ERROR is received,
+ * it means a terminated version of the updated locale ID would not fit
+ * in the buffer, and the original buffer is untouched. This is done to
+ * prevent incorrect or possibly even malformed locales from being generated
+ * and used.
+ *
+ * @param keywordName name of the keyword to be set; must not be
+ * NULL or empty, and must consist only of [A-Za-z0-9]. Case insensitive.
* @param keywordValue value of the keyword to be set. If 0-length or
- * NULL, will result in the keyword being removed; no error is given if
- * that keyword does not exist. Otherwise, must consist only of
- * [A-Za-z0-9] and [/_+-].
- * @param buffer input buffer containing well-formed locale ID to be
- * modified.
+ * NULL, will result in the keyword being removed; no error is given if
+ * that keyword does not exist. Otherwise, must consist only of
+ * [A-Za-z0-9] and [/_+-].
+ * @param buffer input buffer containing well-formed locale ID to be
+ * modified.
* @param bufferCapacity capacity of receiving buffer
- * @param status containing error code: e.g. buffer not big enough
- * or ill-formed keywordName or keywordValue parameters, or ill-formed
- * locale ID in buffer on input.
+ * @param status containing error code: e.g. buffer not big enough
+ * or ill-formed keywordName or keywordValue parameters, or ill-formed
+ * locale ID in buffer on input.
* @return the length needed for the buffer
* @see uloc_getKeywordValue
* @stable ICU 3.2
@@ -1034,45 +1034,45 @@ uloc_getLineOrientation(const char* localeId,
UErrorCode *status);
/**
- * Output values which uloc_acceptLanguage() writes to the 'outResult' parameter.
- *
+ * Output values which uloc_acceptLanguage() writes to the 'outResult' parameter.
+ *
* @see uloc_acceptLanguageFromHTTP
* @see uloc_acceptLanguage
* @stable ICU 3.2
*/
typedef enum {
- /**
- * No exact match was found.
- * @stable ICU 3.2
- */
- ULOC_ACCEPT_FAILED = 0,
- /**
- * An exact match was found.
- * @stable ICU 3.2
- */
- ULOC_ACCEPT_VALID = 1,
- /**
- * A fallback was found. For example, the Accept-Language list includes 'ja_JP'
- * and is matched with available locale 'ja'.
- * @stable ICU 3.2
- */
- ULOC_ACCEPT_FALLBACK = 2 /* */
+ /**
+ * No exact match was found.
+ * @stable ICU 3.2
+ */
+ ULOC_ACCEPT_FAILED = 0,
+ /**
+ * An exact match was found.
+ * @stable ICU 3.2
+ */
+ ULOC_ACCEPT_VALID = 1,
+ /**
+ * A fallback was found. For example, the Accept-Language list includes 'ja_JP'
+ * and is matched with available locale 'ja'.
+ * @stable ICU 3.2
+ */
+ ULOC_ACCEPT_FALLBACK = 2 /* */
} UAcceptResult;
/**
* Based on a HTTP header from a web browser and a list of available locales,
* determine an acceptable locale for the user.
- *
- * This is a thin wrapper over C++ class LocaleMatcher.
- *
+ *
+ * This is a thin wrapper over C++ class LocaleMatcher.
+ *
* @param result - buffer to accept the result locale
* @param resultAvailable the size of the result buffer.
* @param outResult - An out parameter that contains the fallback status
* @param httpAcceptLanguage - "Accept-Language:" header as per HTTP.
* @param availableLocales - list of available locales to match
- * @param status ICU error code. Its input value must pass the U_SUCCESS() test,
- * or else the function returns immediately. Check for U_FAILURE()
- * on output or use with function chaining. (See User Guide for details.)
+ * @param status ICU error code. Its input value must pass the U_SUCCESS() test,
+ * or else the function returns immediately. Check for U_FAILURE()
+ * on output or use with function chaining. (See User Guide for details.)
* @return length needed for the locale.
* @stable ICU 3.2
*/
@@ -1086,18 +1086,18 @@ uloc_acceptLanguageFromHTTP(char *result, int32_t resultAvailable,
/**
* Based on a list of available locales,
* determine an acceptable locale for the user.
- *
- * This is a thin wrapper over C++ class LocaleMatcher.
- *
+ *
+ * This is a thin wrapper over C++ class LocaleMatcher.
+ *
* @param result - buffer to accept the result locale
* @param resultAvailable the size of the result buffer.
* @param outResult - An out parameter that contains the fallback status
* @param acceptList - list of acceptable languages
* @param acceptListCount - count of acceptList items
* @param availableLocales - list of available locales to match
- * @param status ICU error code. Its input value must pass the U_SUCCESS() test,
- * or else the function returns immediately. Check for U_FAILURE()
- * on output or use with function chaining. (See User Guide for details.)
+ * @param status ICU error code. Its input value must pass the U_SUCCESS() test,
+ * or else the function returns immediately. Check for U_FAILURE()
+ * on output or use with function chaining. (See User Guide for details.)
* @return length needed for the locale.
* @stable ICU 3.2
*/