C API: Builder API for Locale. More...
Go to the source code of this file.
U_CAPI ULocaleBuilder * ulocbld_open (void)ULocaleBuilder
is used to build valid locale
id string or IETF BCP 47 language tag from values configured by the setters. More...
ULocaleBuilder
to match the provided locale
. More...
ULocaleBuilder
to match the provided ULocale
. More...
C API: Builder API for Locale.
Definition in file ulocbuilder.h.
◆ ULocaleBuilder ◆ ulocbld_addUnicodeLocaleAttribute() U_CAPI void ulocbld_addUnicodeLocaleAttribute ( ULocaleBuilder * builder, const char * attribute, int32_t length )Adds a unicode locale attribute, if not already present, otherwise has no effect.
The attribute must not be empty string and must be well-formed or U_ILLEGAL_ARGUMENT_ERROR will be set to status during the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() calls.
Resets the ULocaleBuilder
to match the provided ULocale
.
Existing state is discarded.
The locale must be not bogus.
This method clears the internal UErrorCode.
Build the IETF BCP 47 language tag string from the fields set on this builder.
If any set methods or during the ulocbld_buildLanguageTag() call require memory allocation but fail U_MEMORY_ALLOCATION_ERROR will be set to status. If any of the fields set by the setters are not well-formed, the status will be set to U_ILLEGAL_ARGUMENT_ERROR. The state of the builder will not change after the ulocbld_buildLanguageTag() call and the caller is free to keep using the same builder to build more locales.
Build the LocaleID string from the fields set on this builder.
If any set methods or during the ulocbld_buildLocaleID() call require memory allocation but fail U_MEMORY_ALLOCATION_ERROR will be set to status. If any of the fields set by the setters are not well-formed, the status will be set to U_ILLEGAL_ARGUMENT_ERROR. The state of the builder will not change after the ulocbld_buildLocaleID() call and the caller is free to keep using the same builder to build more locales.
Build the ULocale object from the fields set on this builder.
If any set methods or during the ulocbld_buildULocale() call require memory allocation but fail U_MEMORY_ALLOCATION_ERROR will be set to status. If any of the fields set by the setters are not well-formed, the status will be set to U_ILLEGAL_ARGUMENT_ERROR. The state of the builder will not change after the ulocbld_buildULocale() call and the caller is free to keep using the same builder to build more locales.
Resets the builder to its initial, empty state.
This method clears the internal UErrorCode.
Resets the extensions to their initial, empty state.
Language, script, region and variant are unchanged.
Close the builder and destroy it's internal states.
Sets the UErrorCode if an error occurred while recording sets.
Preserves older error codes in the outErrorCode.
ULocaleBuilder
is used to build valid locale
id string or IETF BCP 47 language tag from values configured by the setters.
The ULocaleBuilder
checks if a value configured by a setter satisfies the syntax requirements defined by the Locale
class. A string of Locale created by a ULocaleBuilder
is well-formed and can be transformed to a well-formed IETF BCP 47 language tag without losing information.
The following example shows how to create a locale
string with the ULocaleBuilder
.
UErrorCode err = U_ZERO_ERROR; char buffer[ULOC_FULLNAME_CAPACITY]; ULocaleBuilder* builder = ulocbld_open(); ulocbld_setLanguage(builder, "sr", -1); ulocbld_setScript(builder, "Latn", -1); ulocbld_setRegion(builder, "RS", -1); int32_t length = ulocbld_buildLocaleID( builder, buffer, ULOC_FULLNAME_CAPACITY, &error); ulocbld_close(builder);
ULocaleBuilders can be reused; ulocbld_clear()
resets all fields to their default values.
ULocaleBuilder tracks errors in an internal UErrorCode. For all setters, except ulocbld_setLanguageTag and ulocbld_setLocale, ULocaleBuilder will return immediately if the internal UErrorCode is in error state. To reset internal state and error code, call clear method. The ulocbld_setLanguageTag and setLocale method will first clear the internal UErrorCode, then track the error of the validation of the input parameter into the internal UErrorCode.
Constructs an empty ULocaleBuilder. The default value of all fields, extensions, and private use information is the empty string. The created builder should be destroyed by calling ulocbld_close();
Removes a unicode locale attribute, if present, otherwise has no effect.
The attribute must not be empty string and must be well-formed or U_ILLEGAL_ARGUMENT_ERROR will be set to status during the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() calls.
Attribute comparison for removal is case-insensitive.
Sets the extension for the given key.
If the value is the empty string, the extension is removed. Otherwise, the key
and value
must be well-formed, or else the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() methods will later report an U_ILLEGAL_ARGUMENT_ERROR.
Note: The key ('u') is used for the Unicode locale extension. Setting a value for this key replaces any existing Unicode locale key/type pairs with those defined in the extension.
Note: The key ('x') is used for the private use code. To be well-formed, the value for this key needs only to have subtags of one to eight alphanumeric characters, not two to eight as in the general case.
Sets the language.
If language
is the empty string, the language in this ULocaleBuilder
is removed. Otherwise, the language
must be well-formed, or else the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() methods will later report an U_ILLEGAL_ARGUMENT_ERROR.
The syntax of language value is defined as unicode_language_subtag.
Resets the ULocaleBuilder to match the provided IETF BCP 47 language tag.
Discards the existing state. The empty string causes the builder to be reset, like ulocbld_clear. Legacy language tags (marked as “Type: grandfathered” in BCP 47) are converted to their canonical form before being processed. Otherwise, the language tag
must be well-formed, or else the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() methods will later report an U_ILLEGAL_ARGUMENT_ERROR.
This method clears the internal UErrorCode.
Resets the ULocaleBuilder
to match the provided locale
.
Existing state is discarded.
All fields of the locale must be well-formed.
This method clears the internal UErrorCode.
Sets the region.
If region is the empty string, the region in this ULocaleBuilder
is removed. Otherwise, the region
must be well-formed, or else the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() methods will later report an U_ILLEGAL_ARGUMENT_ERROR.
The region value is defined by unicode_region_subtag as a two-letter ISO 3166 code or a three-digit UN M.49 area code.
The region value in the Locale
created by the ULocaleBuilder
is always normalized to upper case.
Sets the script.
If script
is the empty string, the script in this ULocaleBuilder
is removed. Otherwise, the script
must be well-formed, or else the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() methods will later report an U_ILLEGAL_ARGUMENT_ERROR.
The script value is a four-letter script code as unicode_script_subtag defined by ISO 15924
Sets the Unicode locale keyword type for the given key.
If the type StringPiece is constructed with a nullptr, the keyword is removed. If the type is the empty string, the keyword is set without type subtags. Otherwise, the key and type must be well-formed, or else the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() methods will later report an U_ILLEGAL_ARGUMENT_ERROR.
Keys and types are converted to lower case.
Note:Setting the 'u' extension via ulocbld_setExtension replaces all Unicode locale keywords with those defined in the extension.
Sets the variant.
If variant is the empty string, the variant in this ULocaleBuilder
is removed. Otherwise, the variant
must be well-formed, or else the ulocbld_buildLocaleID() and ulocbld_buildLanguageTag() methods will later report an U_ILLEGAL_ARGUMENT_ERROR.
Note: This method checks if variant
satisfies the unicode_variant_subtag syntax requirements, and normalizes the value to lowercase letters. However, the Locale
class does not impose any syntactic restriction on variant. To set an ill-formed variant, use a Locale constructor. If there are multiple unicode_variant_subtag, the caller must concatenate them with '-' as separator (ex: "foobar-fibar").
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4