ICU 76.1 76.1
|
LocaleMatcher builder. More...
#include <localematcher.h>
Public Member Functions | |
Builder () | |
Constructs a builder used in chaining parameters for building a LocaleMatcher. | |
Builder (Builder &&src) noexcept | |
Move constructor; might modify the source. | |
~Builder () | |
Destructor. | |
Builder & | operator= (Builder &&src) noexcept |
Move assignment; might modify the source. | |
Builder & | setSupportedLocalesFromListString (StringPiece locales) |
Parses an Accept-Language string (RFC 2616 Section 14.4), such as "af, en, fr;q=0.9", and sets the supported locales accordingly. | |
Builder & | setSupportedLocales (Locale::Iterator &locales) |
Copies the supported locales, preserving iteration order. | |
template<typename Iter> | |
Builder & | setSupportedLocales (Iter begin, Iter end) |
Copies the supported locales from the begin/end range, preserving iteration order. | |
template<typename Iter, typename Conv> | |
Builder & | setSupportedLocalesViaConverter (Iter begin, Iter end, Conv converter) |
Copies the supported locales from the begin/end range, preserving iteration order. | |
Builder & | addSupportedLocale (const Locale &locale) |
Adds another supported locale. | |
Builder & | setNoDefaultLocale () |
Sets no default locale. | |
Builder & | setDefaultLocale (const Locale *defaultLocale) |
Sets the default locale; if nullptr, or if it is not set explicitly, then the first supported locale is used as the default locale. | |
Builder & | setFavorSubtag (ULocMatchFavorSubtag subtag) |
If ULOCMATCH_FAVOR_SCRIPT, then the language differences are smaller than script differences. | |
Builder & | setDemotionPerDesiredLocale (ULocMatchDemotion demotion) |
Option for whether all desired locales are treated equally or earlier ones are preferred (this is the default). | |
Builder & | setDirection (ULocMatchDirection matchDirection) |
Option for whether to include or ignore one-way (fallback) match data. | |
Builder & | setMaxDistance (const Locale &desired, const Locale &supported) |
Sets the maximum distance for an acceptable match. | |
UBool | copyErrorTo (UErrorCode &outErrorCode) const |
Sets the UErrorCode if an error occurred while setting parameters. | |
LocaleMatcher | build (UErrorCode &errorCode) const |
Builds and returns a new locale matcher. |
Friends | |
class | LocaleMatcher |
LocaleMatcher builder.
Movable but not copyable.
Definition at line 301 of file localematcher.h.
|
inline |
Constructs a builder used in chaining parameters for building a LocaleMatcher.
Definition at line 309 of file localematcher.h.
Referenced by addSupportedLocale(), build(), Builder(), operator=(), setDefaultLocale(), setDemotionPerDesiredLocale(), setDirection(), setFavorSubtag(), setMaxDistance(), setNoDefaultLocale(), setSupportedLocales(), setSupportedLocales(), setSupportedLocalesFromListString(), and setSupportedLocalesViaConverter().
|
noexcept |
icu::LocaleMatcher::Builder::~Builder | ( | ) |
Destructor.
Adds another supported locale.
Duplicates are allowed, and are not removed.
locale | another locale |
References Builder().
Referenced by setSupportedLocales(), and setSupportedLocalesViaConverter().
LocaleMatcher icu::LocaleMatcher::Builder::build | ( | UErrorCode & | errorCode | ) | const |
Builds and returns a new locale matcher.
This builder can continue to be used.
errorCode | 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.) |
References Builder(), operator=(), U_ZERO_ERROR, ULOCMATCH_DEMOTION_REGION, ULOCMATCH_DIRECTION_WITH_ONE_WAY, and ULOCMATCH_FAVOR_LANGUAGE.
UBool icu::LocaleMatcher::Builder::copyErrorTo | ( | UErrorCode & | outErrorCode | ) | const |
Sets the UErrorCode if an error occurred while setting parameters.
Preserves older error codes in the outErrorCode.
outErrorCode | Set to an error code if it does not contain one already and an error occurred while setting parameters. Otherwise unchanged. |
Sets the default locale; if nullptr, or if it is not set explicitly, then the first supported locale is used as the default locale.
There is no default locale at all (nullptr will be returned instead) if setNoDefaultLocale() is called.
defaultLocale | the default locale (will be copied) |
References Builder().
Builder & icu::LocaleMatcher::Builder::setDemotionPerDesiredLocale | ( | ULocMatchDemotion | demotion | ) |
|
inline |
Builder & icu::LocaleMatcher::Builder::setFavorSubtag | ( | ULocMatchFavorSubtag | subtag | ) |
If ULOCMATCH_FAVOR_SCRIPT, then the language differences are smaller than script differences.
This is used in situations (such as maps) where it is better to fall back to the same script than a similar language.
subtag | the subtag to favor |
References Builder().
Builder & icu::LocaleMatcher::Builder::setMaxDistance | ( | const Locale & | desired, |
const Locale & | supported ) |
Sets the maximum distance for an acceptable match.
The matcher will return a match for a pair of locales only if they match at least as well as the pair given here.
For example, setMaxDistance(en-US, en-GB) limits matches to ones where the (desired, support) locales have a distance no greater than a region subtag difference. This is much stricter than the CLDR default.
The details of locale matching are subject to changes in CLDR data and in the algorithm. Specifying a maximum distance in relative terms via a sample pair of locales insulates from changes that affect all distance metrics similarly, but some changes will necessarily affect relative distances between different pairs of locales.
desired | the desired locale for distance comparison. |
supported | the supported locale for distance comparison. |
References Builder().
Builder & icu::LocaleMatcher::Builder::setNoDefaultLocale | ( | ) |
|
inline |
Copies the supported locales from the begin/end range, preserving iteration order.
Clears any previously set/added supported locales first. Duplicates are allowed, and are not removed.
Each of the iterator parameter values must be an input iterator whose value is convertible to const Locale &.
begin | Start of range. |
end | Exclusive end of range. |
Definition at line 374 of file localematcher.h.
References addSupportedLocale(), Builder(), and U_FAILURE.
Builder & icu::LocaleMatcher::Builder::setSupportedLocales | ( | Locale::Iterator & | locales | ) |
Builder & icu::LocaleMatcher::Builder::setSupportedLocalesFromListString | ( | StringPiece | locales | ) |
Parses an Accept-Language string (RFC 2616 Section 14.4), such as "af, en, fr;q=0.9", and sets the supported locales accordingly.
Allows whitespace in more places but does not allow "*". Clears any previously set/added supported locales first.
locales | the Accept-Language string of locales to set |
References Builder().
|
inline |
Copies the supported locales from the begin/end range, preserving iteration order.
Calls the converter to convert each *begin to a Locale or const Locale &. Clears any previously set/added supported locales first. Duplicates are allowed, and are not removed.
Each of the iterator parameter values must be an input iterator whose value is convertible to const Locale &.
begin | Start of range. |
end | Exclusive end of range. |
converter | Converter from *begin to const Locale & or compatible. |
Definition at line 399 of file localematcher.h.
References addSupportedLocale(), Builder(), and U_FAILURE.
|
friend |
Definition at line 525 of file localematcher.h.