7 #ifndef __LOCALEMATCHER_H__
8 #define __LOCALEMATCHER_H__
12 #if U_SHOW_CPLUSPLUS_API
136 class LocaleDistance;
137 class LocaleLsrIterator;
139 class XLikelySubtags;
276 int32_t desIndex, int32_t suppIndex,
UBool owned) :
277 desiredLocale(desired), supportedLocale(supported),
278 desiredIndex(desIndex), supportedIndex(suppIndex),
279 desiredIsOwned(owned) {}
284 const Locale *desiredLocale;
285 const Locale *supportedLocale;
286 int32_t desiredIndex;
287 int32_t supportedIndex;
288 UBool desiredIsOwned;
371 template<
typename Iter>
373 if (
U_FAILURE(errorCode_)) {
return *
this; }
374 clearSupportedLocales();
375 while (begin != end) {
376 addSupportedLocale(*begin++);
396 template<
typename Iter,
typename Conv>
398 if (
U_FAILURE(errorCode_)) {
return *
this; }
399 clearSupportedLocales();
400 while (begin != end) {
401 addSupportedLocale(converter(*begin++));
416 #ifndef U_HIDE_DRAFT_API
472 direction_ = direction;
477 #ifndef U_HIDE_DRAFT_API
532 void clearSupportedLocales();
533 bool ensureSupportedLocaleVector();
536 UVector *supportedLocales_ =
nullptr;
537 int32_t thresholdDistance_ = -1;
539 Locale *defaultLocale_ =
nullptr;
540 bool withDefault_ =
true;
543 Locale *maxDistanceDesired_ =
nullptr;
544 Locale *maxDistanceSupported_ =
nullptr;
641 #ifndef U_HIDE_DRAFT_API
658 #ifndef U_HIDE_INTERNAL_API
685 int32_t putIfAbsent(
const LSR &lsr, int32_t i, int32_t suppLength,
UErrorCode &errorCode);
687 int32_t getBestSuppIndex(LSR desiredLSR, LocaleLsrIterator *remainingIter,
UErrorCode &errorCode)
const;
689 const XLikelySubtags &likelySubtags;
690 const LocaleDistance &localeDistance;
691 int32_t thresholdDistance;
692 int32_t demotionPerDesiredLocale;
697 const Locale ** supportedLocales;
699 int32_t supportedLocalesLength;
704 const LSR **supportedLSRs;
705 int32_t *supportedIndexes;
706 int32_t supportedLSRsLength;
707 Locale *ownedDefaultLocale;
708 const Locale *defaultLocale;
Builder & setDirection(ULocMatchDirection direction)
Option for whether to include or ignore one-way (fallback) match data.
Builder & setFavorSubtag(ULocMatchFavorSubtag subtag)
If ULOCMATCH_FAVOR_SCRIPT, then the language differences are smaller than script differences.
Builder & addSupportedLocale(const Locale &locale)
Adds another supported locale.
Builder & setSupportedLocales(Locale::Iterator &locales)
Copies the supported locales, preserving iteration order.
Builder & setSupportedLocales(Iter begin, Iter end)
Copies the supported locales from the begin/end range, preserving iteration order.
Builder & setSupportedLocalesViaConverter(Iter begin, Iter end, Conv converter)
Copies the supported locales from the begin/end range, preserving iteration order.
LocaleMatcher build(UErrorCode &errorCode) const
Builds and returns a new locale matcher.
Builder & operator=(Builder &&src) U_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....
Builder & setMaxDistance(const Locale &desired, const Locale &supported)
Sets the maximum distance for an acceptable match.
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 ...
Builder(Builder &&src) U_NOEXCEPT
Move constructor; might modify the source.
Builder & setDemotionPerDesiredLocale(ULocMatchDemotion demotion)
Option for whether all desired locales are treated equally or earlier ones are preferred (this is the...
UBool copyErrorTo(UErrorCode &outErrorCode) const
Sets the UErrorCode if an error occurred while setting parameters.
Builder()
Constructs a builder used in chaining parameters for building a LocaleMatcher.
Data for the best-matching pair of a desired and a supported locale.
int32_t getSupportedIndex() const
Returns the index of the best-matching supported locale in the constructor’s or builder’s input order...
Result & operator=(Result &&src) U_NOEXCEPT
Move assignment; might modify the source.
const Locale * getSupportedLocale() const
Returns the best-matching supported locale.
int32_t getDesiredIndex() const
Returns the index of the best-matching desired locale in the input Iterable order.
Locale makeResolvedLocale(UErrorCode &errorCode) const
Takes the best-matching supported locale and adds relevant fields of the best-matching desired locale...
const Locale * getDesiredLocale() const
Returns the best-matching desired locale.
Result(Result &&src) U_NOEXCEPT
Move constructor; might modify the source.
Immutable class that picks the best match between a user's desired locales and an application's suppo...
LocaleMatcher(LocaleMatcher &&src) U_NOEXCEPT
Move copy constructor; might modify the source.
const Locale * getBestMatch(const Locale &desiredLocale, UErrorCode &errorCode) const
Returns the supported locale which best matches the desired locale.
UBool isMatch(const Locale &desired, const Locale &supported, UErrorCode &errorCode) const
Returns true if the pair of locales matches acceptably.
Result getBestMatchResult(const Locale &desiredLocale, UErrorCode &errorCode) const
Returns the best match between the desired locale and the supported locales.
Result getBestMatchResult(Locale::Iterator &desiredLocales, UErrorCode &errorCode) const
Returns the best match between the desired and supported locales.
LocaleMatcher & operator=(LocaleMatcher &&src) U_NOEXCEPT
Move assignment operator; might modify the source.
double internalMatch(const Locale &desired, const Locale &supported, UErrorCode &errorCode) const
Returns a fraction between 0 and 1, where 1 means that the languages are a perfect match,...
const Locale * getBestMatchForListString(StringPiece desiredLocaleList, UErrorCode &errorCode) const
Parses an Accept-Language string (RFC 2616 Section 14.4), such as "af, en, fr;q=0....
~LocaleMatcher()
Destructor.
const Locale * getBestMatch(Locale::Iterator &desiredLocales, UErrorCode &errorCode) const
Returns the supported locale which best matches one of the desired locales.
A Locale iterator interface similar to a Java Iterator<Locale>.
A Locale object represents a specific geographical, political, or cultural region.
A string-like object that points to a sized piece of memory.
UMemory is the common ICU base class.
ULocMatchDemotion
Builder option for whether all desired locales are treated equally or earlier ones are preferred.
@ ULOCMATCH_DEMOTION_REGION
Earlier desired locales are preferred.
@ ULOCMATCH_DEMOTION_NONE
All desired locales are treated equally.
ULocMatchDirection
Builder option for whether to include or ignore one-way (fallback) match data.
@ ULOCMATCH_DIRECTION_ONLY_TWO_WAY
Locale matching limited to two-way matches including e.g.
@ ULOCMATCH_DIRECTION_WITH_ONE_WAY
Locale matching includes one-way matches such as Breton→French.
ULocMatchFavorSubtag
Builder option for whether the language subtag or the script subtag is most important.
@ ULOCMATCH_FAVOR_SCRIPT
Makes script differences matter relatively more than language differences.
@ ULOCMATCH_FAVOR_LANGUAGE
Language differences are most important, then script differences, then region differences.
C++ API: Locale ID object.
struct UHashtable UHashtable
C++ API: StringPiece: Read-only byte string wrapper class.
int8_t UBool
The ICU boolean type, a signed-byte integer.
C++ API: Common ICU base class UObject.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
@ U_ZERO_ERROR
No error, no warning.
#define U_FAILURE(x)
Does the error code indicate a failure?
#define U_SUCCESS(x)
Does the error code indicate success?
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.