golden hour
/opt/alt/libicu/usr/include/unicode
⬆️ Go Up
Upload
File/Folder
Size
Actions
alphaindex.h
26.42 KB
Del
OK
appendable.h
8.43 KB
Del
OK
basictz.h
8.84 KB
Del
OK
brkiter.h
27.53 KB
Del
OK
bytestream.h
9.54 KB
Del
OK
bytestrie.h
19.26 KB
Del
OK
bytestriebuilder.h
7.02 KB
Del
OK
calendar.h
105.06 KB
Del
OK
caniter.h
7.37 KB
Del
OK
casemap.h
25.26 KB
Del
OK
char16ptr.h
7.16 KB
Del
OK
chariter.h
24 KB
Del
OK
choicfmt.h
23.85 KB
Del
OK
coleitr.h
13.7 KB
Del
OK
coll.h
55.59 KB
Del
OK
compactdecimalformat.h
6.81 KB
Del
OK
curramt.h
3.69 KB
Del
OK
currpinf.h
7.24 KB
Del
OK
currunit.h
3.52 KB
Del
OK
datefmt.h
40.37 KB
Del
OK
dbbi.h
1.11 KB
Del
OK
dcfmtsym.h
20.1 KB
Del
OK
decimfmt.h
86.4 KB
Del
OK
docmain.h
6.72 KB
Del
OK
dtfmtsym.h
37.64 KB
Del
OK
dtintrv.h
3.76 KB
Del
OK
dtitvfmt.h
42.87 KB
Del
OK
dtitvinf.h
18.46 KB
Del
OK
dtptngen.h
25.03 KB
Del
OK
dtrule.h
8.62 KB
Del
OK
edits.h
20.67 KB
Del
OK
enumset.h
2.08 KB
Del
OK
errorcode.h
4.78 KB
Del
OK
fieldpos.h
8.63 KB
Del
OK
filteredbrk.h
5.24 KB
Del
OK
fmtable.h
24.36 KB
Del
OK
format.h
12.44 KB
Del
OK
fpositer.h
2.98 KB
Del
OK
gender.h
3.27 KB
Del
OK
gregocal.h
31.57 KB
Del
OK
icudataver.h
1.03 KB
Del
OK
icuplug.h
11.88 KB
Del
OK
idna.h
12.63 KB
Del
OK
listformatter.h
6.18 KB
Del
OK
localpointer.h
16.88 KB
Del
OK
locdspnm.h
7.05 KB
Del
OK
locid.h
44.92 KB
Del
OK
measfmt.h
12.01 KB
Del
OK
measunit.h
38.5 KB
Del
OK
measure.h
4.26 KB
Del
OK
messagepattern.h
33.65 KB
Del
OK
msgfmt.h
43.36 KB
Del
OK
normalizer2.h
33.97 KB
Del
OK
normlzr.h
30.74 KB
Del
OK
nounit.h
2.63 KB
Del
OK
numberformatter.h
87.07 KB
Del
OK
numberrangeformatter.h
28.74 KB
Del
OK
numfmt.h
49.14 KB
Del
OK
numsys.h
6.73 KB
Del
OK
parseerr.h
3.08 KB
Del
OK
parsepos.h
5.45 KB
Del
OK
platform.h
27.1 KB
Del
OK
plurfmt.h
25.18 KB
Del
OK
plurrule.h
17.42 KB
Del
OK
ptypes.h
3.49 KB
Del
OK
putil.h
6.33 KB
Del
OK
rbbi.h
26.41 KB
Del
OK
rbnf.h
49.79 KB
Del
OK
rbtz.h
15.47 KB
Del
OK
regex.h
84.91 KB
Del
OK
region.h
9.12 KB
Del
OK
reldatefmt.h
14.46 KB
Del
OK
rep.h
9.5 KB
Del
OK
resbund.h
18.01 KB
Del
OK
schriter.h
6.26 KB
Del
OK
scientificnumberformatter.h
6.32 KB
Del
OK
search.h
22.21 KB
Del
OK
selfmt.h
14.24 KB
Del
OK
simpleformatter.h
11.43 KB
Del
OK
simpletz.h
45.3 KB
Del
OK
smpdtfmt.h
70.74 KB
Del
OK
sortkey.h
11.12 KB
Del
OK
std_string.h
1015 B
Del
OK
strenum.h
10.04 KB
Del
OK
stringoptions.h
5.79 KB
Del
OK
stringpiece.h
6.46 KB
Del
OK
stringtriebuilder.h
15.27 KB
Del
OK
stsearch.h
21.29 KB
Del
OK
symtable.h
4.21 KB
Del
OK
tblcoll.h
36.4 KB
Del
OK
timezone.h
40.88 KB
Del
OK
tmunit.h
3.29 KB
Del
OK
tmutamt.h
4.8 KB
Del
OK
tmutfmt.h
7.79 KB
Del
OK
translit.h
65.76 KB
Del
OK
tzfmt.h
42.82 KB
Del
OK
tznames.h
16.79 KB
Del
OK
tzrule.h
35.32 KB
Del
OK
tztrans.h
6.07 KB
Del
OK
ubidi.h
89.56 KB
Del
OK
ubiditransform.h
12.65 KB
Del
OK
ubrk.h
23.97 KB
Del
OK
ucal.h
55.2 KB
Del
OK
ucasemap.h
15.18 KB
Del
OK
ucat.h
5.36 KB
Del
OK
uchar.h
139.96 KB
Del
OK
ucharstrie.h
21.06 KB
Del
OK
ucharstriebuilder.h
7.14 KB
Del
OK
uchriter.h
13.14 KB
Del
OK
uclean.h
11.21 KB
Del
OK
ucnv.h
83.09 KB
Del
OK
ucnv_cb.h
6.59 KB
Del
OK
ucnv_err.h
20.99 KB
Del
OK
ucnvsel.h
6.14 KB
Del
OK
ucol.h
61.39 KB
Del
OK
ucoleitr.h
9.46 KB
Del
OK
uconfig.h
11.67 KB
Del
OK
ucpmap.h
5.58 KB
Del
OK
ucptrie.h
22.29 KB
Del
OK
ucsdet.h
14.67 KB
Del
OK
ucurr.h
15.57 KB
Del
OK
udat.h
60.13 KB
Del
OK
udata.h
15.53 KB
Del
OK
udateintervalformat.h
6.79 KB
Del
OK
udatpg.h
26.04 KB
Del
OK
udisplaycontext.h
5.89 KB
Del
OK
uenum.h
7.78 KB
Del
OK
ufieldpositer.h
4.36 KB
Del
OK
uformattable.h
10.94 KB
Del
OK
ugender.h
2 KB
Del
OK
uidna.h
33.37 KB
Del
OK
uiter.h
22.77 KB
Del
OK
uldnames.h
10.45 KB
Del
OK
ulistformatter.h
5.03 KB
Del
OK
uloc.h
50.75 KB
Del
OK
ulocdata.h
11.26 KB
Del
OK
umachine.h
13.19 KB
Del
OK
umisc.h
1.33 KB
Del
OK
umsg.h
24.23 KB
Del
OK
umutablecptrie.h
8.28 KB
Del
OK
unifilt.h
3.63 KB
Del
OK
unifunct.h
3.98 KB
Del
OK
unimatch.h
6.04 KB
Del
OK
unirepl.h
3.32 KB
Del
OK
uniset.h
64.25 KB
Del
OK
unistr.h
174.4 KB
Del
OK
unorm.h
20.45 KB
Del
OK
unorm2.h
24.66 KB
Del
OK
unum.h
53.38 KB
Del
OK
unumberformatter.h
23.76 KB
Del
OK
unumsys.h
7.14 KB
Del
OK
uobject.h
10.7 KB
Del
OK
upluralrules.h
6.72 KB
Del
OK
uregex.h
72.05 KB
Del
OK
uregion.h
9.84 KB
Del
OK
ureldatefmt.h
12.22 KB
Del
OK
urename.h
127.73 KB
Del
OK
urep.h
5.38 KB
Del
OK
ures.h
36.53 KB
Del
OK
uscript.h
26.52 KB
Del
OK
usearch.h
38.12 KB
Del
OK
uset.h
40 KB
Del
OK
usetiter.h
9.49 KB
Del
OK
ushape.h
18 KB
Del
OK
uspoof.h
66.03 KB
Del
OK
usprep.h
8.14 KB
Del
OK
ustdio.h
38.54 KB
Del
OK
ustream.h
1.8 KB
Del
OK
ustring.h
72.47 KB
Del
OK
ustringtrie.h
3.15 KB
Del
OK
utext.h
58.11 KB
Del
OK
utf.h
7.86 KB
Del
OK
utf16.h
22.33 KB
Del
OK
utf32.h
763 B
Del
OK
utf8.h
30.01 KB
Del
OK
utf_old.h
43.78 KB
Del
OK
utmscale.h
13.78 KB
Del
OK
utrace.h
13.89 KB
Del
OK
utrans.h
25.54 KB
Del
OK
utypes.h
30.48 KB
Del
OK
uvernum.h
6.06 KB
Del
OK
uversion.h
6.7 KB
Del
OK
vtzone.h
20.17 KB
Del
OK
Edit: numberrangeformatter.h
// © 2018 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html #if !UCONFIG_NO_FORMATTING #ifndef __NUMBERRANGEFORMATTER_H__ #define __NUMBERRANGEFORMATTER_H__ #include <atomic> #include "unicode/appendable.h" #include "unicode/fieldpos.h" #include "unicode/fpositer.h" #include "unicode/numberformatter.h" #ifndef U_HIDE_DRAFT_API /** * \file * \brief C++ API: Library for localized formatting of number, currency, and unit ranges. * * The main entrypoint to the formatting of ranges of numbers, including currencies and other units of measurement. * <p> * Usage example: * <p> * <pre> * NumberRangeFormatter::with() * .identityFallback(UNUM_IDENTITY_FALLBACK_APPROXIMATELY_OR_SINGLE_VALUE) * .numberFormatterFirst(NumberFormatter::with().adoptUnit(MeasureUnit::createMeter())) * .numberFormatterSecond(NumberFormatter::with().adoptUnit(MeasureUnit::createKilometer())) * .locale("en-GB") * .formatRange(750, 1.2, status) * .toString(status); * // => "750 m - 1.2 km" * </pre> * <p> * Like NumberFormatter, NumberRangeFormatter instances are immutable and thread-safe. This API is based on the * <em>fluent</em> design pattern popularized by libraries such as Google's Guava. * * @author Shane Carr */ /** * Defines how to merge fields that are identical across the range sign. * * @draft ICU 63 */ typedef enum UNumberRangeCollapse { /** * Use locale data and heuristics to determine how much of the string to collapse. Could end up collapsing none, * some, or all repeated pieces in a locale-sensitive way. * * The heuristics used for this option are subject to change over time. * * @draft ICU 63 */ UNUM_RANGE_COLLAPSE_AUTO, /** * Do not collapse any part of the number. Example: "3.2 thousand kilograms – 5.3 thousand kilograms" * * @draft ICU 63 */ UNUM_RANGE_COLLAPSE_NONE, /** * Collapse the unit part of the number, but not the notation, if present. Example: "3.2 thousand – 5.3 thousand * kilograms" * * @draft ICU 63 */ UNUM_RANGE_COLLAPSE_UNIT, /** * Collapse any field that is equal across the range sign. May introduce ambiguity on the magnitude of the * number. Example: "3.2 – 5.3 thousand kilograms" * * @draft ICU 63 */ UNUM_RANGE_COLLAPSE_ALL } UNumberRangeCollapse; /** * Defines the behavior when the two numbers in the range are identical after rounding. To programmatically detect * when the identity fallback is used, compare the lower and upper BigDecimals via FormattedNumber. * * @draft ICU 63 * @see NumberRangeFormatter */ typedef enum UNumberRangeIdentityFallback { /** * Show the number as a single value rather than a range. Example: "$5" * * @draft ICU 63 */ UNUM_IDENTITY_FALLBACK_SINGLE_VALUE, /** * Show the number using a locale-sensitive approximation pattern. If the numbers were the same before rounding, * show the single value. Example: "~$5" or "$5" * * @draft ICU 63 */ UNUM_IDENTITY_FALLBACK_APPROXIMATELY_OR_SINGLE_VALUE, /** * Show the number using a locale-sensitive approximation pattern. Use the range pattern always, even if the * inputs are the same. Example: "~$5" * * @draft ICU 63 */ UNUM_IDENTITY_FALLBACK_APPROXIMATELY, /** * Show the number as the range of two equal values. Use the range pattern always, even if the inputs are the * same. Example (with RangeCollapse.NONE): "$5 – $5" * * @draft ICU 63 */ UNUM_IDENTITY_FALLBACK_RANGE } UNumberRangeIdentityFallback; /** * Used in the result class FormattedNumberRange to indicate to the user whether the numbers formatted in the range * were equal or not, and whether or not the identity fallback was applied. * * @draft ICU 63 * @see NumberRangeFormatter */ typedef enum UNumberRangeIdentityResult { /** * Used to indicate that the two numbers in the range were equal, even before any rounding rules were applied. * * @draft ICU 63 * @see NumberRangeFormatter */ UNUM_IDENTITY_RESULT_EQUAL_BEFORE_ROUNDING, /** * Used to indicate that the two numbers in the range were equal, but only after rounding rules were applied. * * @draft ICU 63 * @see NumberRangeFormatter */ UNUM_IDENTITY_RESULT_EQUAL_AFTER_ROUNDING, /** * Used to indicate that the two numbers in the range were not equal, even after rounding rules were applied. * * @draft ICU 63 * @see NumberRangeFormatter */ UNUM_IDENTITY_RESULT_NOT_EQUAL, #ifndef U_HIDE_INTERNAL_API /** * The number of entries in this enum. * @internal */ UNUM_IDENTITY_RESULT_COUNT #endif } UNumberRangeIdentityResult; U_NAMESPACE_BEGIN namespace number { // icu::number // Forward declarations: class UnlocalizedNumberRangeFormatter; class LocalizedNumberRangeFormatter; class FormattedNumberRange; namespace impl { // Forward declarations: struct RangeMacroProps; class DecimalQuantity; struct UFormattedNumberRangeData; class NumberRangeFormatterImpl; } // namespace impl /** * \cond * Export an explicit template instantiation. See datefmt.h * (When building DLLs for Windows this is required.) */ #if U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN && !defined(U_IN_DOXYGEN) template struct U_I18N_API std::atomic<impl::NumberRangeFormatterImpl*>; #endif /** \endcond */ // Other helper classes would go here, but there are none. namespace impl { // icu::number::impl // Do not enclose entire MacroProps with #ifndef U_HIDE_INTERNAL_API, needed for a protected field /** @internal */ struct U_I18N_API RangeMacroProps : public UMemory { /** @internal */ UnlocalizedNumberFormatter formatter1; // = NumberFormatter::with(); /** @internal */ UnlocalizedNumberFormatter formatter2; // = NumberFormatter::with(); /** @internal */ bool singleFormatter = true; /** @internal */ UNumberRangeCollapse collapse = UNUM_RANGE_COLLAPSE_AUTO; /** @internal */ UNumberRangeIdentityFallback identityFallback = UNUM_IDENTITY_FALLBACK_APPROXIMATELY; /** @internal */ Locale locale; // NOTE: Uses default copy and move constructors. /** * Check all members for errors. * @internal */ bool copyErrorTo(UErrorCode &status) const { return formatter1.copyErrorTo(status) || formatter2.copyErrorTo(status); } }; } // namespace impl /** * An abstract base class for specifying settings related to number formatting. This class is implemented by * {@link UnlocalizedNumberRangeFormatter} and {@link LocalizedNumberRangeFormatter}. This class is not intended for * public subclassing. */ template<typename Derived> class U_I18N_API NumberRangeFormatterSettings { public: /** * Sets the NumberFormatter instance to use for the numbers in the range. The same formatter is applied to both * sides of the range. * <p> * The NumberFormatter instances must not have a locale applied yet; the locale specified on the * NumberRangeFormatter will be used. * * @param formatter * The formatter to use for both numbers in the range. * @return The fluent chain. * @draft ICU 63 */ Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) const &; /** * Overload of numberFormatterBoth() for use on an rvalue reference. * * @param formatter * The formatter to use for both numbers in the range. * @return The fluent chain. * @see #numberFormatterBoth * @draft ICU 63 */ Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) &&; /** * Overload of numberFormatterBoth() for use on an rvalue reference. * * @param formatter * The formatter to use for both numbers in the range. * @return The fluent chain. * @see #numberFormatterBoth * @draft ICU 63 */ Derived numberFormatterBoth(UnlocalizedNumberFormatter &&formatter) const &; /** * Overload of numberFormatterBoth() for use on an rvalue reference. * * @param formatter * The formatter to use for both numbers in the range. * @return The fluent chain. * @see #numberFormatterBoth * @draft ICU 63 */ Derived numberFormatterBoth(UnlocalizedNumberFormatter &&formatter) &&; /** * Sets the NumberFormatter instance to use for the first number in the range. * <p> * The NumberFormatter instances must not have a locale applied yet; the locale specified on the * NumberRangeFormatter will be used. * * @param formatterFirst * The formatter to use for the first number in the range. * @return The fluent chain. * @draft ICU 63 */ Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) const &; /** * Overload of numberFormatterFirst() for use on an rvalue reference. * * @param formatterFirst * The formatter to use for the first number in the range. * @return The fluent chain. * @see #numberFormatterFirst * @draft ICU 63 */ Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) &&; /** * Overload of numberFormatterFirst() for use on an rvalue reference. * * @param formatterFirst * The formatter to use for the first number in the range. * @return The fluent chain. * @see #numberFormatterFirst * @draft ICU 63 */ Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) const &; /** * Overload of numberFormatterFirst() for use on an rvalue reference. * * @param formatterFirst * The formatter to use for the first number in the range. * @return The fluent chain. * @see #numberFormatterFirst * @draft ICU 63 */ Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) &&; /** * Sets the NumberFormatter instance to use for the second number in the range. * <p> * The NumberFormatter instances must not have a locale applied yet; the locale specified on the * NumberRangeFormatter will be used. * * @param formatterSecond * The formatter to use for the second number in the range. * @return The fluent chain. * @draft ICU 63 */ Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) const &; /** * Overload of numberFormatterSecond() for use on an rvalue reference. * * @param formatterSecond * The formatter to use for the second number in the range. * @return The fluent chain. * @see #numberFormatterSecond * @draft ICU 63 */ Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) &&; /** * Overload of numberFormatterSecond() for use on an rvalue reference. * * @param formatterSecond * The formatter to use for the second number in the range. * @return The fluent chain. * @see #numberFormatterSecond * @draft ICU 63 */ Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) const &; /** * Overload of numberFormatterSecond() for use on an rvalue reference. * * @param formatterSecond * The formatter to use for the second number in the range. * @return The fluent chain. * @see #numberFormatterSecond * @draft ICU 63 */ Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) &&; /** * Sets the aggressiveness of "collapsing" fields across the range separator. Possible values: * <p> * <ul> * <li>ALL: "3-5K miles"</li> * <li>UNIT: "3K - 5K miles"</li> * <li>NONE: "3K miles - 5K miles"</li> * <li>AUTO: usually UNIT or NONE, depending on the locale and formatter settings</li> * </ul> * <p> * The default value is AUTO. * * @param collapse * The collapsing strategy to use for this range. * @return The fluent chain. * @draft ICU 63 */ Derived collapse(UNumberRangeCollapse collapse) const &; /** * Overload of collapse() for use on an rvalue reference. * * @param collapse * The collapsing strategy to use for this range. * @return The fluent chain. * @see #collapse * @draft ICU 63 */ Derived collapse(UNumberRangeCollapse collapse) &&; /** * Sets the behavior when the two sides of the range are the same. This could happen if the same two numbers are * passed to the formatRange function, or if different numbers are passed to the function but they become the same * after rounding rules are applied. Possible values: * <p> * <ul> * <li>SINGLE_VALUE: "5 miles"</li> * <li>APPROXIMATELY_OR_SINGLE_VALUE: "~5 miles" or "5 miles", depending on whether the number was the same before * rounding was applied</li> * <li>APPROXIMATELY: "~5 miles"</li> * <li>RANGE: "5-5 miles" (with collapse=UNIT)</li> * </ul> * <p> * The default value is APPROXIMATELY. * * @param identityFallback * The strategy to use when formatting two numbers that end up being the same. * @return The fluent chain. * @draft ICU 63 */ Derived identityFallback(UNumberRangeIdentityFallback identityFallback) const &; /** * Overload of identityFallback() for use on an rvalue reference. * * @param identityFallback * The strategy to use when formatting two numbers that end up being the same. * @return The fluent chain. * @see #identityFallback * @draft ICU 63 */ Derived identityFallback(UNumberRangeIdentityFallback identityFallback) &&; /** * Sets the UErrorCode if an error occurred in the fluent chain. * Preserves older error codes in the outErrorCode. * @return TRUE if U_FAILURE(outErrorCode) * @draft ICU 63 */ UBool copyErrorTo(UErrorCode &outErrorCode) const { if (U_FAILURE(outErrorCode)) { // Do not overwrite the older error code return TRUE; } fMacros.copyErrorTo(outErrorCode); return U_FAILURE(outErrorCode); }; // NOTE: Uses default copy and move constructors. private: impl::RangeMacroProps fMacros; // Don't construct me directly! Use (Un)LocalizedNumberFormatter. NumberRangeFormatterSettings() = default; friend class LocalizedNumberRangeFormatter; friend class UnlocalizedNumberRangeFormatter; }; /** * A NumberRangeFormatter that does not yet have a locale. In order to format, a locale must be specified. * * @see NumberRangeFormatter * @draft ICU 63 */ class U_I18N_API UnlocalizedNumberRangeFormatter : public NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>, public UMemory { public: /** * Associate the given locale with the number range formatter. The locale is used for picking the * appropriate symbols, formats, and other data for number display. * * @param locale * The locale to use when loading data for number formatting. * @return The fluent chain. * @draft ICU 63 */ LocalizedNumberRangeFormatter locale(const icu::Locale &locale) const &; /** * Overload of locale() for use on an rvalue reference. * * @param locale * The locale to use when loading data for number formatting. * @return The fluent chain. * @see #locale * @draft ICU 63 */ LocalizedNumberRangeFormatter locale(const icu::Locale &locale) &&; /** * Default constructor: puts the formatter into a valid but undefined state. * * @draft ICU 63 */ UnlocalizedNumberRangeFormatter() = default; /** * Returns a copy of this UnlocalizedNumberRangeFormatter. * @draft ICU 63 */ UnlocalizedNumberRangeFormatter(const UnlocalizedNumberRangeFormatter &other); /** * Move constructor: * The source UnlocalizedNumberRangeFormatter will be left in a valid but undefined state. * @draft ICU 63 */ UnlocalizedNumberRangeFormatter(UnlocalizedNumberRangeFormatter&& src) U_NOEXCEPT; /** * Copy assignment operator. * @draft ICU 63 */ UnlocalizedNumberRangeFormatter& operator=(const UnlocalizedNumberRangeFormatter& other); /** * Move assignment operator: * The source UnlocalizedNumberRangeFormatter will be left in a valid but undefined state. * @draft ICU 63 */ UnlocalizedNumberRangeFormatter& operator=(UnlocalizedNumberRangeFormatter&& src) U_NOEXCEPT; private: explicit UnlocalizedNumberRangeFormatter( const NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>& other); explicit UnlocalizedNumberRangeFormatter( NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>&& src) U_NOEXCEPT; // To give the fluent setters access to this class's constructor: friend class NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>; // To give NumberRangeFormatter::with() access to this class's constructor: friend class NumberRangeFormatter; }; /** * A NumberRangeFormatter that has a locale associated with it; this means .formatRange() methods are available. * * @see NumberFormatter * @draft ICU 63 */ class U_I18N_API LocalizedNumberRangeFormatter : public NumberRangeFormatterSettings<LocalizedNumberRangeFormatter>, public UMemory { public: /** * Format the given Formattables to a string using the settings specified in the NumberRangeFormatter fluent setting * chain. * * @param first * The first number in the range, usually to the left in LTR locales. * @param second * The second number in the range, usually to the right in LTR locales. * @param status * Set if an error occurs while formatting. * @return A FormattedNumberRange object; call .toString() to get the string. * @draft ICU 63 */ FormattedNumberRange formatFormattableRange( const Formattable& first, const Formattable& second, UErrorCode& status) const; /** * Default constructor: puts the formatter into a valid but undefined state. * * @draft ICU 63 */ LocalizedNumberRangeFormatter() = default; /** * Returns a copy of this LocalizedNumberRangeFormatter. * @draft ICU 63 */ LocalizedNumberRangeFormatter(const LocalizedNumberRangeFormatter &other); /** * Move constructor: * The source LocalizedNumberRangeFormatter will be left in a valid but undefined state. * @draft ICU 63 */ LocalizedNumberRangeFormatter(LocalizedNumberRangeFormatter&& src) U_NOEXCEPT; /** * Copy assignment operator. * @draft ICU 63 */ LocalizedNumberRangeFormatter& operator=(const LocalizedNumberRangeFormatter& other); /** * Move assignment operator: * The source LocalizedNumberRangeFormatter will be left in a valid but undefined state. * @draft ICU 63 */ LocalizedNumberRangeFormatter& operator=(LocalizedNumberRangeFormatter&& src) U_NOEXCEPT; #ifndef U_HIDE_INTERNAL_API /** * @param results * The results object. This method will mutate it to save the results. * @param equalBeforeRounding * Whether the number was equal before copying it into a DecimalQuantity. * Used for determining the identity fallback behavior. * @param status * Set if an error occurs while formatting. * @internal */ void formatImpl(impl::UFormattedNumberRangeData& results, bool equalBeforeRounding, UErrorCode& status) const; #endif /** * Destruct this LocalizedNumberRangeFormatter, cleaning up any memory it might own. * @draft ICU 63 */ ~LocalizedNumberRangeFormatter(); private: std::atomic<impl::NumberRangeFormatterImpl*> fAtomicFormatter = {}; const impl::NumberRangeFormatterImpl* getFormatter(UErrorCode& stauts) const; explicit LocalizedNumberRangeFormatter( const NumberRangeFormatterSettings<LocalizedNumberRangeFormatter>& other); explicit LocalizedNumberRangeFormatter( NumberRangeFormatterSettings<LocalizedNumberRangeFormatter>&& src) U_NOEXCEPT; LocalizedNumberRangeFormatter(const impl::RangeMacroProps ¯os, const Locale &locale); LocalizedNumberRangeFormatter(impl::RangeMacroProps &¯os, const Locale &locale); void clear(); // To give the fluent setters access to this class's constructor: friend class NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>; friend class NumberRangeFormatterSettings<LocalizedNumberRangeFormatter>; // To give UnlocalizedNumberRangeFormatter::locale() access to this class's constructor: friend class UnlocalizedNumberRangeFormatter; }; /** * The result of a number range formatting operation. This class allows the result to be exported in several data types, * including a UnicodeString and a FieldPositionIterator. * * @draft ICU 63 */ class U_I18N_API FormattedNumberRange : public UMemory { public: /** * Returns a UnicodeString representation of the formatted number range. * * @param status * Set if an error occurs while formatting the number to the UnicodeString. * @return a UnicodeString containing the localized number range. * @draft ICU 63 */ UnicodeString toString(UErrorCode& status) const; /** * Appends the formatted number range to an Appendable. * * @param appendable * The Appendable to which to append the formatted number range string. * @param status * Set if an error occurs while formatting the number range to the Appendable. * @return The same Appendable, for chaining. * @draft ICU 63 * @see Appendable */ Appendable &appendTo(Appendable &appendable, UErrorCode& status) const; /** * Determines the start (inclusive) and end (exclusive) indices of the next occurrence of the given * <em>field</em> in the output string. This allows you to determine the locations of, for example, * the integer part, fraction part, or symbols. * * If both sides of the range have the same field, the field will occur twice, once before the * range separator and once after the range separator, if applicable. * * If a field occurs just once, calling this method will find that occurrence and return it. If a * field occurs multiple times, this method may be called repeatedly with the following pattern: * * <pre> * FieldPosition fpos(UNUM_INTEGER_FIELD); * while (formattedNumberRange.nextFieldPosition(fpos, status)) { * // do something with fpos. * } * </pre> * * This method is useful if you know which field to query. If you want all available field position * information, use #getAllFieldPositions(). * * @param fieldPosition * Input+output variable. See {@link FormattedNumber#nextFieldPosition}. * @param status * Set if an error occurs while populating the FieldPosition. * @return TRUE if a new occurrence of the field was found; FALSE otherwise. * @draft ICU 63 * @see UNumberFormatFields */ UBool nextFieldPosition(FieldPosition& fieldPosition, UErrorCode& status) const; /** * Export the formatted number range to a FieldPositionIterator. This allows you to determine which characters in * the output string correspond to which <em>fields</em>, such as the integer part, fraction part, and sign. * * If information on only one field is needed, use #nextFieldPosition() instead. * * @param iterator * The FieldPositionIterator to populate with all of the fields present in the formatted number. * @param status * Set if an error occurs while populating the FieldPositionIterator. * @draft ICU 63 * @see UNumberFormatFields */ void getAllFieldPositions(FieldPositionIterator &iterator, UErrorCode &status) const; /** * Export the first formatted number as a decimal number. This endpoint * is useful for obtaining the exact number being printed after scaling * and rounding have been applied by the number range formatting pipeline. * * The syntax of the unformatted number is a "numeric string" * as defined in the Decimal Arithmetic Specification, available at * http://speleotrove.com/decimal * * @return A decimal representation of the first formatted number. * @draft ICU 63 * @see NumberRangeFormatter * @see #getSecondDecimal */ UnicodeString getFirstDecimal(UErrorCode& status) const; /** * Export the second formatted number as a decimal number. This endpoint * is useful for obtaining the exact number being printed after scaling * and rounding have been applied by the number range formatting pipeline. * * The syntax of the unformatted number is a "numeric string" * as defined in the Decimal Arithmetic Specification, available at * http://speleotrove.com/decimal * * @return A decimal representation of the second formatted number. * @draft ICU 63 * @see NumberRangeFormatter * @see #getFirstDecimal */ UnicodeString getSecondDecimal(UErrorCode& status) const; /** * Returns whether the pair of numbers was successfully formatted as a range or whether an identity fallback was * used. For example, if the first and second number were the same either before or after rounding occurred, an * identity fallback was used. * * @return An indication the resulting identity situation in the formatted number range. * @draft ICU 63 * @see UNumberRangeIdentityFallback */ UNumberRangeIdentityResult getIdentityResult(UErrorCode& status) const; /** * Copying not supported; use move constructor instead. */ FormattedNumberRange(const FormattedNumberRange&) = delete; /** * Copying not supported; use move assignment instead. */ FormattedNumberRange& operator=(const FormattedNumberRange&) = delete; /** * Move constructor: * Leaves the source FormattedNumberRange in an undefined state. * @draft ICU 63 */ FormattedNumberRange(FormattedNumberRange&& src) U_NOEXCEPT; /** * Move assignment: * Leaves the source FormattedNumberRange in an undefined state. * @draft ICU 63 */ FormattedNumberRange& operator=(FormattedNumberRange&& src) U_NOEXCEPT; /** * Destruct an instance of FormattedNumberRange, cleaning up any memory it might own. * @draft ICU 63 */ ~FormattedNumberRange(); private: // Can't use LocalPointer because UFormattedNumberRangeData is forward-declared const impl::UFormattedNumberRangeData *fResults; // Error code for the terminal methods UErrorCode fErrorCode; /** * Internal constructor from data type. Adopts the data pointer. * @internal */ explicit FormattedNumberRange(impl::UFormattedNumberRangeData *results) : fResults(results), fErrorCode(U_ZERO_ERROR) {}; explicit FormattedNumberRange(UErrorCode errorCode) : fResults(nullptr), fErrorCode(errorCode) {}; void getAllFieldPositionsImpl(FieldPositionIteratorHandler& fpih, UErrorCode& status) const; // To give LocalizedNumberRangeFormatter format methods access to this class's constructor: friend class LocalizedNumberRangeFormatter; }; /** * See the main description in numberrangeformatter.h for documentation and examples. * * @draft ICU 63 */ class U_I18N_API NumberRangeFormatter final { public: /** * Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is not currently * known at the call site. * * @return An {@link UnlocalizedNumberRangeFormatter}, to be used for chaining. * @draft ICU 63 */ static UnlocalizedNumberRangeFormatter with(); /** * Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is known at the call * site. * * @param locale * The locale from which to load formats and symbols for number range formatting. * @return A {@link LocalizedNumberRangeFormatter}, to be used for chaining. * @draft ICU 63 */ static LocalizedNumberRangeFormatter withLocale(const Locale &locale); /** * Use factory methods instead of the constructor to create a NumberFormatter. */ NumberRangeFormatter() = delete; }; } // namespace number U_NAMESPACE_END #endif // U_HIDE_DRAFT_API #endif // __NUMBERRANGEFORMATTER_H__ #endif /* #if !UCONFIG_NO_FORMATTING */
Save