1971 lines
64 KiB
C++
1971 lines
64 KiB
C++
// © 2017 and later: Unicode, Inc. and others.
|
||
// License & terms of use: http://www.unicode.org/copyright.html
|
||
|
||
#if !UCONFIG_NO_FORMATTING
|
||
#ifndef __NUMBERFORMATTER_H__
|
||
#define __NUMBERFORMATTER_H__
|
||
|
||
#include <atomic>
|
||
|
||
#include "unicode/appendable.h"
|
||
#include "unicode/dcfmtsym.h"
|
||
#include "unicode/currunit.h"
|
||
#include "unicode/fieldpos.h"
|
||
#include "unicode/fpositer.h"
|
||
#include "unicode/measunit.h"
|
||
#include "unicode/nounit.h"
|
||
#include "unicode/plurrule.h"
|
||
#include "unicode/ucurr.h"
|
||
#include "unicode/unum.h"
|
||
|
||
#ifndef U_HIDE_DRAFT_API
|
||
|
||
/**
|
||
* \file
|
||
* \brief C++ API: Library for localized number formatting introduced in ICU 60.
|
||
*
|
||
* This library was introduced in ICU 60 to simplify the process of formatting localized number strings.
|
||
* Basic usage examples:
|
||
*
|
||
* <pre>
|
||
* // Most basic usage:
|
||
* NumberFormatter::withLocale(...).format(123).toString(); // 1,234 in en-US
|
||
*
|
||
* // Custom notation, unit, and rounding strategy:
|
||
* NumberFormatter::with()
|
||
* .notation(Notation::compactShort())
|
||
* .unit(CurrencyUnit("EUR", status))
|
||
* .rounding(Rounder::maxDigits(2))
|
||
* .locale(...)
|
||
* .format(1234)
|
||
* .toString(); // €1.2K in en-US
|
||
*
|
||
* // Create a formatter in a singleton for use later:
|
||
* static const LocalizedNumberFormatter formatter = NumberFormatter::withLocale(...)
|
||
* .unit(NoUnit::percent())
|
||
* .rounding(Rounder::fixedFraction(3));
|
||
* formatter.format(5.9831).toString(); // 5.983% in en-US
|
||
*
|
||
* // Create a "template" in a singleton but without setting a locale until the call site:
|
||
* static const UnlocalizedNumberFormatter template = NumberFormatter::with()
|
||
* .sign(UNumberSignDisplay::UNUM_SIGN_ALWAYS)
|
||
* .adoptUnit(MeasureUnit::createMeter(status))
|
||
* .unitWidth(UNumberUnitWidth::UNUM_UNIT_WIDTH_FULL_NAME);
|
||
* template.locale(...).format(1234).toString(); // +1,234 meters in en-US
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* This API offers more features than DecimalFormat and is geared toward new users of ICU.
|
||
*
|
||
* <p>
|
||
* NumberFormatter instances are immutable and thread safe. This means that invoking a configuration method has no
|
||
* effect on the receiving instance; you must store and use the new number formatter instance it returns instead.
|
||
*
|
||
* <pre>
|
||
* UnlocalizedNumberFormatter formatter = UnlocalizedNumberFormatter::with().notation(Notation::scientific());
|
||
* formatter.rounding(Rounder.maxFraction(2)); // does nothing!
|
||
* formatter.locale(Locale.getEnglish()).format(9.8765).toString(); // prints "9.8765E0", not "9.88E0"
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* This API is based on the <em>fluent</em> design pattern popularized by libraries such as Google's Guava. For
|
||
* extensive details on the design of this API, read <a href="https://goo.gl/szi5VB">the design doc</a>.
|
||
*
|
||
* @author Shane Carr
|
||
*/
|
||
|
||
/**
|
||
* An enum declaring how to render units, including currencies. Example outputs when formatting 123 USD and 123
|
||
* meters in <em>en-CA</em>:
|
||
*
|
||
* <p>
|
||
* <ul>
|
||
* <li>NARROW*: "$123.00" and "123 m"
|
||
* <li>SHORT: "US$ 123.00" and "123 m"
|
||
* <li>FULL_NAME: "123.00 US dollars" and "123 meters"
|
||
* <li>ISO_CODE: "USD 123.00" and undefined behavior
|
||
* <li>HIDDEN: "123.00" and "123"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* * The narrow format for currencies is not currently supported; this is a known issue that will be fixed in a
|
||
* future version. See #11666 for more information.
|
||
*
|
||
* <p>
|
||
* This enum is similar to {@link com.ibm.icu.text.MeasureFormat.FormatWidth}.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
typedef enum UNumberUnitWidth {
|
||
/**
|
||
* Print an abbreviated version of the unit name. Similar to SHORT, but always use the shortest available
|
||
* abbreviation or symbol. This option can be used when the context hints at the identity of the unit. For more
|
||
* information on the difference between NARROW and SHORT, see SHORT.
|
||
*
|
||
* <p>
|
||
* In CLDR, this option corresponds to the "Narrow" format for measure units and the "¤¤¤¤¤" placeholder for
|
||
* currencies.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_UNIT_WIDTH_NARROW,
|
||
|
||
/**
|
||
* Print an abbreviated version of the unit name. Similar to NARROW, but use a slightly wider abbreviation or
|
||
* symbol when there may be ambiguity. This is the default behavior.
|
||
*
|
||
* <p>
|
||
* For example, in <em>es-US</em>, the SHORT form for Fahrenheit is "{0} °F", but the NARROW form is "{0}°",
|
||
* since Fahrenheit is the customary unit for temperature in that locale.
|
||
*
|
||
* <p>
|
||
* In CLDR, this option corresponds to the "Short" format for measure units and the "¤" placeholder for
|
||
* currencies.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_UNIT_WIDTH_SHORT,
|
||
|
||
/**
|
||
* Print the full name of the unit, without any abbreviations.
|
||
*
|
||
* <p>
|
||
* In CLDR, this option corresponds to the default format for measure units and the "¤¤¤" placeholder for
|
||
* currencies.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_UNIT_WIDTH_FULL_NAME,
|
||
|
||
/**
|
||
* Use the three-digit ISO XXX code in place of the symbol for displaying currencies. The behavior of this
|
||
* option is currently undefined for use with measure units.
|
||
*
|
||
* <p>
|
||
* In CLDR, this option corresponds to the "¤¤" placeholder for currencies.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_UNIT_WIDTH_ISO_CODE,
|
||
|
||
/**
|
||
* Format the number according to the specified unit, but do not display the unit. For currencies, apply
|
||
* monetary symbols and formats as with SHORT, but omit the currency symbol. For measure units, the behavior is
|
||
* equivalent to not specifying the unit at all.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_UNIT_WIDTH_HIDDEN,
|
||
|
||
#ifndef U_HIDE_INTERNAL_API
|
||
/**
|
||
* One more than the highest UNumberUnitWidth value.
|
||
*
|
||
* @internal ICU 60: The numeric value may change over time; see ICU ticket #12420.
|
||
*/
|
||
UNUM_UNIT_WIDTH_COUNT
|
||
#endif /* U_HIDE_INTERNAL_API */
|
||
} UNumberUnitWidth;
|
||
|
||
/**
|
||
* An enum declaring how to denote positive and negative numbers. Example outputs when formatting 123 and -123 in
|
||
* <em>en-US</em>:
|
||
*
|
||
* <p>
|
||
* <ul>
|
||
* <li>AUTO: "123", "-123"
|
||
* <li>ALWAYS: "+123", "-123"
|
||
* <li>NEVER: "123", "123"
|
||
* <li>ACCOUNTING: "$123", "($123)"
|
||
* <li>ACCOUNTING_ALWAYS: "+$123", "($123)"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* The exact format, including the position and the code point of the sign, differ by locale.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
typedef enum UNumberSignDisplay {
|
||
/**
|
||
* Show the minus sign on negative numbers, and do not show the sign on positive numbers. This is the default
|
||
* behavior.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_SIGN_AUTO,
|
||
|
||
/**
|
||
* Show the minus sign on negative numbers and the plus sign on positive numbers.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_SIGN_ALWAYS,
|
||
|
||
/**
|
||
* Do not show the sign on positive or negative numbers.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_SIGN_NEVER,
|
||
|
||
/**
|
||
* Use the locale-dependent accounting format on negative numbers, and do not show the sign on positive numbers.
|
||
*
|
||
* <p>
|
||
* The accounting format is defined in CLDR and varies by locale; in many Western locales, the format is a pair
|
||
* of parentheses around the number.
|
||
*
|
||
* <p>
|
||
* Note: Since CLDR defines the accounting format in the monetary context only, this option falls back to the
|
||
* AUTO sign display strategy when formatting without a currency unit. This limitation may be lifted in the
|
||
* future.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_SIGN_ACCOUNTING,
|
||
|
||
/**
|
||
* Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers.
|
||
* For more information on the accounting format, see the ACCOUNTING sign display strategy.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_SIGN_ACCOUNTING_ALWAYS,
|
||
|
||
#ifndef U_HIDE_INTERNAL_API
|
||
/**
|
||
* One more than the highest UNumberSignDisplay value.
|
||
*
|
||
* @internal ICU 60: The numeric value may change over time; see ICU ticket #12420.
|
||
*/
|
||
UNUM_SIGN_COUNT
|
||
#endif /* U_HIDE_INTERNAL_API */
|
||
} UNumberSignDisplay;
|
||
|
||
/**
|
||
* An enum declaring how to render the decimal separator.
|
||
*
|
||
* <p>
|
||
* <ul>
|
||
* <li>UNUM_DECIMAL_SEPARATOR_AUTO: "1", "1.1"
|
||
* <li>UNUM_DECIMAL_SEPARATOR_ALWAYS: "1.", "1.1"
|
||
* </ul>
|
||
*/
|
||
typedef enum UNumberDecimalSeparatorDisplay {
|
||
/**
|
||
* Show the decimal separator when there are one or more digits to display after the separator, and do not show
|
||
* it otherwise. This is the default behavior.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_DECIMAL_SEPARATOR_AUTO,
|
||
|
||
/**
|
||
* Always show the decimal separator, even if there are no digits to display after the separator.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
UNUM_DECIMAL_SEPARATOR_ALWAYS,
|
||
|
||
#ifndef U_HIDE_INTERNAL_API
|
||
/**
|
||
* One more than the highest UNumberDecimalSeparatorDisplay value.
|
||
*
|
||
* @internal ICU 60: The numeric value may change over time; see ICU ticket #12420.
|
||
*/
|
||
UNUM_DECIMAL_SEPARATOR_COUNT
|
||
#endif /* U_HIDE_INTERNAL_API */
|
||
} UNumberDecimalMarkDisplay;
|
||
|
||
U_NAMESPACE_BEGIN namespace number { // icu::number
|
||
|
||
// Forward declarations:
|
||
class UnlocalizedNumberFormatter;
|
||
class LocalizedNumberFormatter;
|
||
class FormattedNumber;
|
||
class Notation;
|
||
class ScientificNotation;
|
||
class Rounder;
|
||
class FractionRounder;
|
||
class CurrencyRounder;
|
||
class IncrementRounder;
|
||
class Grouper;
|
||
class IntegerWidth;
|
||
|
||
#ifndef U_HIDE_INTERNAL_API
|
||
namespace impl {
|
||
|
||
// Forward declarations:
|
||
class Padder;
|
||
struct MacroProps;
|
||
struct MicroProps;
|
||
class DecimalQuantity;
|
||
struct NumberFormatterResults;
|
||
class NumberFormatterImpl;
|
||
struct ParsedPatternInfo;
|
||
class ScientificModifier;
|
||
class MultiplierProducer;
|
||
class MutablePatternModifier;
|
||
class LongNameHandler;
|
||
class ScientificHandler;
|
||
class CompactHandler;
|
||
class Modifier;
|
||
class NumberStringBuilder;
|
||
|
||
} // namespace impl
|
||
#endif /* U_HIDE_INTERNAL_API */
|
||
|
||
// Reserve extra names in case they are added as classes in the future:
|
||
typedef Notation CompactNotation;
|
||
typedef Notation SimpleNotation;
|
||
|
||
/**
|
||
* A class that defines the notation style to be used when formatting numbers in NumberFormatter.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API Notation : public UMemory {
|
||
public:
|
||
/**
|
||
* Print the number using scientific notation (also known as scientific form, standard index form, or standard form
|
||
* in the UK). The format for scientific notation varies by locale; for example, many Western locales display the
|
||
* number in the form "#E0", where the number is displayed with one digit before the decimal separator, zero or more
|
||
* digits after the decimal separator, and the corresponding power of 10 displayed after the "E".
|
||
*
|
||
* <p>
|
||
* Example outputs in <em>en-US</em> when printing 8.765E4 through 8.765E-3:
|
||
*
|
||
* <pre>
|
||
* 8.765E4
|
||
* 8.765E3
|
||
* 8.765E2
|
||
* 8.765E1
|
||
* 8.765E0
|
||
* 8.765E-1
|
||
* 8.765E-2
|
||
* 8.765E-3
|
||
* 0E0
|
||
* </pre>
|
||
*
|
||
* @return A ScientificNotation for chaining or passing to the NumberFormatter notation() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static ScientificNotation scientific();
|
||
|
||
/**
|
||
* Print the number using engineering notation, a variant of scientific notation in which the exponent must be
|
||
* divisible by 3.
|
||
*
|
||
* <p>
|
||
* Example outputs in <em>en-US</em> when printing 8.765E4 through 8.765E-3:
|
||
*
|
||
* <pre>
|
||
* 87.65E3
|
||
* 8.765E3
|
||
* 876.5E0
|
||
* 87.65E0
|
||
* 8.765E0
|
||
* 876.5E-3
|
||
* 87.65E-3
|
||
* 8.765E-3
|
||
* 0E0
|
||
* </pre>
|
||
*
|
||
* @return A ScientificNotation for chaining or passing to the NumberFormatter notation() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static ScientificNotation engineering();
|
||
|
||
/**
|
||
* Print the number using short-form compact notation.
|
||
*
|
||
* <p>
|
||
* <em>Compact notation</em>, defined in Unicode Technical Standard #35 Part 3 Section 2.4.1, prints numbers with
|
||
* localized prefixes or suffixes corresponding to different powers of ten. Compact notation is similar to
|
||
* engineering notation in how it scales numbers.
|
||
*
|
||
* <p>
|
||
* Compact notation is ideal for displaying large numbers (over ~1000) to humans while at the same time minimizing
|
||
* screen real estate.
|
||
*
|
||
* <p>
|
||
* In short form, the powers of ten are abbreviated. In <em>en-US</em>, the abbreviations are "K" for thousands, "M"
|
||
* for millions, "B" for billions, and "T" for trillions. Example outputs in <em>en-US</em> when printing 8.765E7
|
||
* through 8.765E0:
|
||
*
|
||
* <pre>
|
||
* 88M
|
||
* 8.8M
|
||
* 876K
|
||
* 88K
|
||
* 8.8K
|
||
* 876
|
||
* 88
|
||
* 8.8
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* When compact notation is specified without an explicit rounding strategy, numbers are rounded off to the closest
|
||
* integer after scaling the number by the corresponding power of 10, but with a digit shown after the decimal
|
||
* separator if there is only one digit before the decimal separator. The default compact notation rounding strategy
|
||
* is equivalent to:
|
||
*
|
||
* <pre>
|
||
* Rounder.integer().withMinDigits(2)
|
||
* </pre>
|
||
*
|
||
* @return A CompactNotation for passing to the NumberFormatter notation() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static CompactNotation compactShort();
|
||
|
||
/**
|
||
* Print the number using long-form compact notation. For more information on compact notation, see
|
||
* {@link #compactShort}.
|
||
*
|
||
* <p>
|
||
* In long form, the powers of ten are spelled out fully. Example outputs in <em>en-US</em> when printing 8.765E7
|
||
* through 8.765E0:
|
||
*
|
||
* <pre>
|
||
* 88 million
|
||
* 8.8 million
|
||
* 876 thousand
|
||
* 88 thousand
|
||
* 8.8 thousand
|
||
* 876
|
||
* 88
|
||
* 8.8
|
||
* </pre>
|
||
*
|
||
* @return A CompactNotation for passing to the NumberFormatter notation() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static CompactNotation compactLong();
|
||
|
||
/**
|
||
* Print the number using simple notation without any scaling by powers of ten. This is the default behavior.
|
||
*
|
||
* <p>
|
||
* Since this is the default behavior, this method needs to be called only when it is necessary to override a
|
||
* previous setting.
|
||
*
|
||
* <p>
|
||
* Example outputs in <em>en-US</em> when printing 8.765E7 through 8.765E0:
|
||
*
|
||
* <pre>
|
||
* 87,650,000
|
||
* 8,765,000
|
||
* 876,500
|
||
* 87,650
|
||
* 8,765
|
||
* 876.5
|
||
* 87.65
|
||
* 8.765
|
||
* </pre>
|
||
*
|
||
* @return A SimpleNotation for passing to the NumberFormatter notation() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static SimpleNotation simple();
|
||
|
||
private:
|
||
enum NotationType {
|
||
NTN_SCIENTIFIC, NTN_COMPACT, NTN_SIMPLE, NTN_ERROR
|
||
} fType;
|
||
|
||
union NotationUnion {
|
||
// For NTN_SCIENTIFIC
|
||
struct ScientificSettings {
|
||
int8_t fEngineeringInterval;
|
||
bool fRequireMinInt;
|
||
int8_t fMinExponentDigits;
|
||
UNumberSignDisplay fExponentSignDisplay;
|
||
} scientific;
|
||
|
||
// For NTN_COMPACT
|
||
UNumberCompactStyle compactStyle;
|
||
|
||
// For NTN_ERROR
|
||
UErrorCode errorCode;
|
||
} fUnion;
|
||
|
||
typedef NotationUnion::ScientificSettings ScientificSettings;
|
||
|
||
Notation(const NotationType &type, const NotationUnion &union_) : fType(type), fUnion(union_) {}
|
||
|
||
Notation(UErrorCode errorCode) : fType(NTN_ERROR) {
|
||
fUnion.errorCode = errorCode;
|
||
}
|
||
|
||
Notation() : fType(NTN_SIMPLE), fUnion() {}
|
||
|
||
UBool copyErrorTo(UErrorCode &status) const {
|
||
if (fType == NTN_ERROR) {
|
||
status = fUnion.errorCode;
|
||
return TRUE;
|
||
}
|
||
return FALSE;
|
||
}
|
||
|
||
// To allow MacroProps to initialize empty instances:
|
||
friend struct impl::MacroProps;
|
||
friend class ScientificNotation;
|
||
|
||
// To allow implementation to access internal types:
|
||
friend class impl::NumberFormatterImpl;
|
||
friend class impl::ScientificModifier;
|
||
friend class impl::ScientificHandler;
|
||
};
|
||
|
||
/**
|
||
* A class that defines the scientific notation style to be used when formatting numbers in NumberFormatter.
|
||
*
|
||
* <p>
|
||
* To create a ScientificNotation, use one of the factory methods in {@link Notation}.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API ScientificNotation : public Notation {
|
||
public:
|
||
/**
|
||
* Sets the minimum number of digits to show in the exponent of scientific notation, padding with zeros if
|
||
* necessary. Useful for fixed-width display.
|
||
*
|
||
* <p>
|
||
* For example, with minExponentDigits=2, the number 123 will be printed as "1.23E02" in <em>en-US</em> instead of
|
||
* the default "1.23E2".
|
||
*
|
||
* @param minExponentDigits
|
||
* The minimum number of digits to show in the exponent.
|
||
* @return A ScientificNotation, for chaining.
|
||
* @draft ICU 60
|
||
*/
|
||
ScientificNotation withMinExponentDigits(int32_t minExponentDigits) const;
|
||
|
||
/**
|
||
* Sets whether to show the sign on positive and negative exponents in scientific notation. The default is AUTO,
|
||
* showing the minus sign but not the plus sign.
|
||
*
|
||
* <p>
|
||
* For example, with exponentSignDisplay=ALWAYS, the number 123 will be printed as "1.23E+2" in <em>en-US</em>
|
||
* instead of the default "1.23E2".
|
||
*
|
||
* @param exponentSignDisplay
|
||
* The strategy for displaying the sign in the exponent.
|
||
* @return A ScientificNotation, for chaining.
|
||
* @draft ICU 60
|
||
*/
|
||
ScientificNotation withExponentSignDisplay(UNumberSignDisplay exponentSignDisplay) const;
|
||
|
||
private:
|
||
// Inherit constructor
|
||
using Notation::Notation;
|
||
|
||
friend class Notation;
|
||
};
|
||
|
||
// Reserve extra names in case they are added as classes in the future:
|
||
typedef Rounder DigitRounder;
|
||
|
||
/**
|
||
* A class that defines the rounding strategy to be used when formatting numbers in NumberFormatter.
|
||
*
|
||
* <p>
|
||
* To create a Rounder, use one of the factory methods.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API Rounder : public UMemory {
|
||
|
||
public:
|
||
/**
|
||
* Show all available digits to full precision.
|
||
*
|
||
* <p>
|
||
* <strong>NOTE:</strong> When formatting a <em>double</em>, this method, along with {@link #minFraction} and
|
||
* {@link #minDigits}, will trigger complex algorithm similar to <em>Dragon4</em> to determine the low-order digits
|
||
* and the number of digits to display based on the value of the double. If the number of fraction places or
|
||
* significant digits can be bounded, consider using {@link #maxFraction} or {@link #maxDigits} instead to maximize
|
||
* performance. For more information, read the following blog post.
|
||
*
|
||
* <p>
|
||
* http://www.serpentine.com/blog/2011/06/29/here-be-dragons-advances-in-problems-you-didnt-even-know-you-had/
|
||
*
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static Rounder unlimited();
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to the nearest integer.
|
||
*
|
||
* @return A FractionRounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static FractionRounder integer();
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator).
|
||
* Additionally, pad with zeros to ensure that this number of places are always shown.
|
||
*
|
||
* <p>
|
||
* Example output with minMaxFractionPlaces = 3:
|
||
*
|
||
* <p>
|
||
* 87,650.000<br>
|
||
* 8,765.000<br>
|
||
* 876.500<br>
|
||
* 87.650<br>
|
||
* 8.765<br>
|
||
* 0.876<br>
|
||
* 0.088<br>
|
||
* 0.009<br>
|
||
* 0.000 (zero)
|
||
*
|
||
* <p>
|
||
* This method is equivalent to {@link #minMaxFraction} with both arguments equal.
|
||
*
|
||
* @param minMaxFractionPlaces
|
||
* The minimum and maximum number of numerals to display after the decimal separator (rounding if too
|
||
* long or padding with zeros if too short).
|
||
* @return A FractionRounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static FractionRounder fixedFraction(int32_t minMaxFractionPlaces);
|
||
|
||
/**
|
||
* Always show at least a certain number of fraction places after the decimal separator, padding with zeros if
|
||
* necessary. Do not perform rounding (display numbers to their full precision).
|
||
*
|
||
* <p>
|
||
* <strong>NOTE:</strong> If you are formatting <em>doubles</em>, see the performance note in {@link #unlimited}.
|
||
*
|
||
* @param minFractionPlaces
|
||
* The minimum number of numerals to display after the decimal separator (padding with zeros if
|
||
* necessary).
|
||
* @return A FractionRounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static FractionRounder minFraction(int32_t minFractionPlaces);
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator).
|
||
* Unlike the other fraction rounding strategies, this strategy does <em>not</em> pad zeros to the end of the
|
||
* number.
|
||
*
|
||
* @param maxFractionPlaces
|
||
* The maximum number of numerals to display after the decimal mark (rounding if necessary).
|
||
* @return A FractionRounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static FractionRounder maxFraction(int32_t maxFractionPlaces);
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator);
|
||
* in addition, always show at least a certain number of places after the decimal separator, padding with zeros if
|
||
* necessary.
|
||
*
|
||
* @param minFractionPlaces
|
||
* The minimum number of numerals to display after the decimal separator (padding with zeros if
|
||
* necessary).
|
||
* @param maxFractionPlaces
|
||
* The maximum number of numerals to display after the decimal separator (rounding if necessary).
|
||
* @return A FractionRounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static FractionRounder minMaxFraction(int32_t minFractionPlaces, int32_t maxFractionPlaces);
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to a certain number of significant digits or significant figures. Additionally,
|
||
* pad with zeros to ensure that this number of significant digits/figures are always shown.
|
||
*
|
||
* <p>
|
||
* This method is equivalent to {@link #minMaxDigits} with both arguments equal.
|
||
*
|
||
* @param minMaxSignificantDigits
|
||
* The minimum and maximum number of significant digits to display (rounding if too long or padding with
|
||
* zeros if too short).
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static DigitRounder fixedDigits(int32_t minMaxSignificantDigits);
|
||
|
||
/**
|
||
* Always show at least a certain number of significant digits/figures, padding with zeros if necessary. Do not
|
||
* perform rounding (display numbers to their full precision).
|
||
*
|
||
* <p>
|
||
* <strong>NOTE:</strong> If you are formatting <em>doubles</em>, see the performance note in {@link #unlimited}.
|
||
*
|
||
* @param minSignificantDigits
|
||
* The minimum number of significant digits to display (padding with zeros if too short).
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static DigitRounder minDigits(int32_t minSignificantDigits);
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to a certain number of significant digits/figures.
|
||
*
|
||
* @param maxSignificantDigits
|
||
* The maximum number of significant digits to display (rounding if too long).
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static DigitRounder maxDigits(int32_t maxSignificantDigits);
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to a certain number of significant digits/figures; in addition, always show at
|
||
* least a certain number of significant digits, padding with zeros if necessary.
|
||
*
|
||
* @param minSignificantDigits
|
||
* The minimum number of significant digits to display (padding with zeros if necessary).
|
||
* @param maxSignificantDigits
|
||
* The maximum number of significant digits to display (rounding if necessary).
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static DigitRounder minMaxDigits(int32_t minSignificantDigits, int32_t maxSignificantDigits);
|
||
|
||
/**
|
||
* Show numbers rounded if necessary to the closest multiple of a certain rounding increment. For example, if the
|
||
* rounding increment is 0.5, then round 1.2 to 1 and round 1.3 to 1.5.
|
||
*
|
||
* <p>
|
||
* In order to ensure that numbers are padded to the appropriate number of fraction places, call
|
||
* withMinFraction() on the return value of this method.
|
||
* For example, to round to the nearest 0.5 and always display 2 numerals after the
|
||
* decimal separator (to display 1.2 as "1.00" and 1.3 as "1.50"), you can run:
|
||
*
|
||
* <pre>
|
||
* Rounder::increment(0.5).withMinFraction(2)
|
||
* </pre>
|
||
*
|
||
* @param roundingIncrement
|
||
* The increment to which to round numbers.
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static IncrementRounder increment(double roundingIncrement);
|
||
|
||
/**
|
||
* Show numbers rounded and padded according to the rules for the currency unit. The most common rounding settings
|
||
* for currencies include <code>Rounder.fixedFraction(2)</code>, <code>Rounder.integer()</code>, and
|
||
* <code>Rounder.increment(0.05)</code> for cash transactions ("nickel rounding").
|
||
*
|
||
* <p>
|
||
* The exact rounding details will be resolved at runtime based on the currency unit specified in the
|
||
* NumberFormatter chain. To round according to the rules for one currency while displaying the symbol for another
|
||
* currency, the withCurrency() method can be called on the return value of this method.
|
||
*
|
||
* @param currencyUsage
|
||
* Either STANDARD (for digital transactions) or CASH (for transactions where the rounding increment may
|
||
* be limited by the available denominations of cash or coins).
|
||
* @return A CurrencyRounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
static CurrencyRounder currency(UCurrencyUsage currencyUsage);
|
||
|
||
/**
|
||
* Sets the rounding mode to use when picking the direction to round (up or down). Common values
|
||
* include HALF_EVEN, HALF_UP, and FLOOR. The default is HALF_EVEN.
|
||
*
|
||
* @param roundingMode
|
||
* The RoundingMode to use.
|
||
* @return A Rounder for passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
Rounder withMode(UNumberFormatRoundingMode roundingMode) const;
|
||
|
||
private:
|
||
enum RounderType {
|
||
RND_BOGUS,
|
||
RND_NONE,
|
||
RND_FRACTION,
|
||
RND_SIGNIFICANT,
|
||
RND_FRACTION_SIGNIFICANT,
|
||
RND_INCREMENT,
|
||
RND_CURRENCY,
|
||
RND_PASS_THROUGH,
|
||
RND_ERROR
|
||
} fType;
|
||
|
||
union RounderUnion {
|
||
struct FractionSignificantSettings {
|
||
// For RND_FRACTION, RND_SIGNIFICANT, and RND_FRACTION_SIGNIFICANT
|
||
int8_t fMinFrac;
|
||
int8_t fMaxFrac;
|
||
int8_t fMinSig;
|
||
int8_t fMaxSig;
|
||
} fracSig;
|
||
struct IncrementSettings {
|
||
double fIncrement;
|
||
int32_t fMinFrac;
|
||
} increment; // For RND_INCREMENT
|
||
UCurrencyUsage currencyUsage; // For RND_CURRENCY
|
||
UErrorCode errorCode; // For RND_ERROR
|
||
} fUnion;
|
||
|
||
typedef RounderUnion::FractionSignificantSettings FractionSignificantSettings;
|
||
typedef RounderUnion::IncrementSettings IncrementSettings;
|
||
|
||
UNumberFormatRoundingMode fRoundingMode;
|
||
|
||
Rounder(const RounderType &type, const RounderUnion &union_, UNumberFormatRoundingMode roundingMode)
|
||
: fType(type), fUnion(union_), fRoundingMode(roundingMode) {}
|
||
|
||
Rounder(UErrorCode errorCode) : fType(RND_ERROR) {
|
||
fUnion.errorCode = errorCode;
|
||
}
|
||
|
||
Rounder() : fType(RND_BOGUS) {}
|
||
|
||
bool isBogus() const {
|
||
return fType == RND_BOGUS;
|
||
}
|
||
|
||
UBool copyErrorTo(UErrorCode &status) const {
|
||
if (fType == RND_ERROR) {
|
||
status = fUnion.errorCode;
|
||
return TRUE;
|
||
}
|
||
return FALSE;
|
||
}
|
||
|
||
// On the parent type so that this method can be called internally on Rounder instances.
|
||
Rounder withCurrency(const CurrencyUnit ¤cy, UErrorCode &status) const;
|
||
|
||
/** NON-CONST: mutates the current instance. */
|
||
void setLocaleData(const CurrencyUnit ¤cy, UErrorCode &status);
|
||
|
||
void apply(impl::DecimalQuantity &value, UErrorCode &status) const;
|
||
|
||
/** Version of {@link #apply} that obeys minInt constraints. Used for scientific notation compatibility mode. */
|
||
void apply(impl::DecimalQuantity &value, int32_t minInt, UErrorCode status);
|
||
|
||
int32_t
|
||
chooseMultiplierAndApply(impl::DecimalQuantity &input, const impl::MultiplierProducer &producer,
|
||
UErrorCode &status);
|
||
|
||
static FractionRounder constructFraction(int32_t minFrac, int32_t maxFrac);
|
||
|
||
static Rounder constructSignificant(int32_t minSig, int32_t maxSig);
|
||
|
||
static Rounder
|
||
constructFractionSignificant(const FractionRounder &base, int32_t minSig, int32_t maxSig);
|
||
|
||
static IncrementRounder constructIncrement(double increment, int32_t minFrac);
|
||
|
||
static CurrencyRounder constructCurrency(UCurrencyUsage usage);
|
||
|
||
static Rounder constructPassThrough();
|
||
|
||
// To allow MacroProps/MicroProps to initialize bogus instances:
|
||
friend struct impl::MacroProps;
|
||
friend struct impl::MicroProps;
|
||
|
||
// To allow NumberFormatterImpl to access isBogus() and other internal methods:
|
||
friend class impl::NumberFormatterImpl;
|
||
|
||
// To give access to apply() and chooseMultiplierAndApply():
|
||
friend class impl::MutablePatternModifier;
|
||
friend class impl::LongNameHandler;
|
||
friend class impl::ScientificHandler;
|
||
friend class impl::CompactHandler;
|
||
|
||
// To allow child classes to call private methods:
|
||
friend class FractionRounder;
|
||
friend class CurrencyRounder;
|
||
friend class IncrementRounder;
|
||
};
|
||
|
||
/**
|
||
* A class that defines a rounding strategy based on a number of fraction places and optionally significant digits to be
|
||
* used when formatting numbers in NumberFormatter.
|
||
*
|
||
* <p>
|
||
* To create a FractionRounder, use one of the factory methods on Rounder.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API FractionRounder : public Rounder {
|
||
public:
|
||
/**
|
||
* Ensure that no less than this number of significant digits are retained when rounding according to fraction
|
||
* rules.
|
||
*
|
||
* <p>
|
||
* For example, with integer rounding, the number 3.141 becomes "3". However, with minimum figures set to 2, 3.141
|
||
* becomes "3.1" instead.
|
||
*
|
||
* <p>
|
||
* This setting does not affect the number of trailing zeros. For example, 3.01 would print as "3", not "3.0".
|
||
*
|
||
* @param minSignificantDigits
|
||
* The number of significant figures to guarantee.
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
Rounder withMinDigits(int32_t minSignificantDigits) const;
|
||
|
||
/**
|
||
* Ensure that no more than this number of significant digits are retained when rounding according to fraction
|
||
* rules.
|
||
*
|
||
* <p>
|
||
* For example, with integer rounding, the number 123.4 becomes "123". However, with maximum figures set to 2, 123.4
|
||
* becomes "120" instead.
|
||
*
|
||
* <p>
|
||
* This setting does not affect the number of trailing zeros. For example, with fixed fraction of 2, 123.4 would
|
||
* become "120.00".
|
||
*
|
||
* @param maxSignificantDigits
|
||
* Round the number to no more than this number of significant figures.
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
Rounder withMaxDigits(int32_t maxSignificantDigits) const;
|
||
|
||
private:
|
||
// Inherit constructor
|
||
using Rounder::Rounder;
|
||
|
||
// To allow parent class to call this class's constructor:
|
||
friend class Rounder;
|
||
};
|
||
|
||
/**
|
||
* A class that defines a rounding strategy parameterized by a currency to be used when formatting numbers in
|
||
* NumberFormatter.
|
||
*
|
||
* <p>
|
||
* To create a CurrencyRounder, use one of the factory methods on Rounder.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API CurrencyRounder : public Rounder {
|
||
public:
|
||
/**
|
||
* Associates a currency with this rounding strategy.
|
||
*
|
||
* <p>
|
||
* <strong>Calling this method is <em>not required</em></strong>, because the currency specified in unit()
|
||
* is automatically applied to currency rounding strategies. However,
|
||
* this method enables you to override that automatic association.
|
||
*
|
||
* <p>
|
||
* This method also enables numbers to be formatted using currency rounding rules without explicitly using a
|
||
* currency format.
|
||
*
|
||
* @param currency
|
||
* The currency to associate with this rounding strategy.
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
* @draft ICU 60
|
||
*/
|
||
Rounder withCurrency(const CurrencyUnit ¤cy) const;
|
||
|
||
private:
|
||
// Inherit constructor
|
||
using Rounder::Rounder;
|
||
|
||
// To allow parent class to call this class's constructor:
|
||
friend class Rounder;
|
||
};
|
||
|
||
/**
|
||
* A class that defines a rounding strategy parameterized by a rounding increment to be used when formatting numbers in
|
||
* NumberFormatter.
|
||
*
|
||
* <p>
|
||
* To create an IncrementRounder, use one of the factory methods on Rounder.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API IncrementRounder : public Rounder {
|
||
public:
|
||
/**
|
||
* Specifies the minimum number of fraction digits to render after the decimal separator, padding with zeros if
|
||
* necessary. By default, no trailing zeros are added.
|
||
*
|
||
* <p>
|
||
* For example, if the rounding increment is 0.5 and minFrac is 2, then the resulting strings include "0.00",
|
||
* "0.50", "1.00", and "1.50".
|
||
*
|
||
* <p>
|
||
* Note: In ICU4J, this functionality is accomplished via the scale of the BigDecimal rounding increment.
|
||
*
|
||
* @param minFrac The minimum number of digits after the decimal separator.
|
||
* @return A Rounder for chaining or passing to the NumberFormatter rounding() setter.
|
||
*/
|
||
Rounder withMinFraction(int32_t minFrac) const;
|
||
|
||
private:
|
||
// Inherit constructor
|
||
using Rounder::Rounder;
|
||
|
||
// To allow parent class to call this class's constructor:
|
||
friend class Rounder;
|
||
};
|
||
|
||
/**
|
||
* @internal This API is a technical preview. It is likely to change in an upcoming release.
|
||
*/
|
||
class U_I18N_API Grouper : public UMemory {
|
||
public:
|
||
/**
|
||
* @internal This API is a technical preview. It is likely to change in an upcoming release.
|
||
*/
|
||
static Grouper defaults();
|
||
|
||
/**
|
||
* @internal This API is a technical preview. It is likely to change in an upcoming release.
|
||
*/
|
||
static Grouper minTwoDigits();
|
||
|
||
/**
|
||
* @internal This API is a technical preview. It is likely to change in an upcoming release.
|
||
*/
|
||
static Grouper none();
|
||
|
||
private:
|
||
int8_t fGrouping1; // -3 means "bogus"; -2 means "needs locale data"; -1 means "no grouping"
|
||
int8_t fGrouping2;
|
||
bool fMin2;
|
||
|
||
Grouper(int8_t grouping1, int8_t grouping2, bool min2)
|
||
: fGrouping1(grouping1), fGrouping2(grouping2), fMin2(min2) {}
|
||
|
||
Grouper() : fGrouping1(-3) {};
|
||
|
||
bool isBogus() const {
|
||
return fGrouping1 == -3;
|
||
}
|
||
|
||
/** NON-CONST: mutates the current instance. */
|
||
void setLocaleData(const impl::ParsedPatternInfo &patternInfo);
|
||
|
||
bool groupAtPosition(int32_t position, const impl::DecimalQuantity &value) const;
|
||
|
||
// To allow MacroProps/MicroProps to initialize empty instances:
|
||
friend struct impl::MacroProps;
|
||
friend struct impl::MicroProps;
|
||
|
||
// To allow NumberFormatterImpl to access isBogus() and perform other operations:
|
||
friend class impl::NumberFormatterImpl;
|
||
};
|
||
|
||
/**
|
||
* A class that defines the strategy for padding and truncating integers before the decimal separator.
|
||
*
|
||
* <p>
|
||
* To create an IntegerWidth, use one of the factory methods.
|
||
*
|
||
* @draft ICU 60
|
||
* @see NumberFormatter
|
||
*/
|
||
class U_I18N_API IntegerWidth : public UMemory {
|
||
public:
|
||
/**
|
||
* Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal separator.
|
||
*
|
||
* <p>
|
||
* For example, with minInt=3, the number 55 will get printed as "055".
|
||
*
|
||
* @param minInt
|
||
* The minimum number of places before the decimal separator.
|
||
* @return An IntegerWidth for chaining or passing to the NumberFormatter integerWidth() setter.
|
||
* @draft ICU 60
|
||
* @see NumberFormatter
|
||
*/
|
||
static IntegerWidth zeroFillTo(int32_t minInt);
|
||
|
||
/**
|
||
* Truncate numbers exceeding a certain number of numerals before the decimal separator.
|
||
*
|
||
* For example, with maxInt=3, the number 1234 will get printed as "234".
|
||
*
|
||
* @param maxInt
|
||
* The maximum number of places before the decimal separator.
|
||
* @return An IntegerWidth for passing to the NumberFormatter integerWidth() setter.
|
||
* @draft ICU 60
|
||
* @see NumberFormatter
|
||
*/
|
||
IntegerWidth truncateAt(int32_t maxInt);
|
||
|
||
private:
|
||
union {
|
||
struct {
|
||
int8_t fMinInt;
|
||
int8_t fMaxInt;
|
||
} minMaxInt;
|
||
UErrorCode errorCode;
|
||
} fUnion;
|
||
bool fHasError = false;
|
||
|
||
IntegerWidth(int8_t minInt, int8_t maxInt);
|
||
|
||
IntegerWidth(UErrorCode errorCode) { // NOLINT
|
||
fUnion.errorCode = errorCode;
|
||
fHasError = true;
|
||
}
|
||
|
||
IntegerWidth() { // NOLINT
|
||
fUnion.minMaxInt.fMinInt = -1;
|
||
}
|
||
|
||
bool isBogus() const {
|
||
return !fHasError && fUnion.minMaxInt.fMinInt == -1;
|
||
}
|
||
|
||
UBool copyErrorTo(UErrorCode &status) const {
|
||
if (fHasError) {
|
||
status = fUnion.errorCode;
|
||
return TRUE;
|
||
}
|
||
return FALSE;
|
||
}
|
||
|
||
void apply(impl::DecimalQuantity &quantity, UErrorCode &status) const;
|
||
|
||
// To allow MacroProps/MicroProps to initialize empty instances:
|
||
friend struct impl::MacroProps;
|
||
friend struct impl::MicroProps;
|
||
|
||
// To allow NumberFormatterImpl to access isBogus() and perform other operations:
|
||
friend class impl::NumberFormatterImpl;
|
||
};
|
||
|
||
#ifndef U_HIDE_INTERNAL_API
|
||
namespace impl {
|
||
|
||
/**
|
||
* Use a default threshold of 3. This means that the third time .format() is called, the data structures get built
|
||
* using the "safe" code path. The first two calls to .format() will trigger the unsafe code path.
|
||
*
|
||
* @internal
|
||
*/
|
||
static uint32_t DEFAULT_THRESHOLD = 3;
|
||
|
||
/** @internal */
|
||
class U_I18N_API SymbolsWrapper : public UMemory {
|
||
public:
|
||
/** @internal */
|
||
SymbolsWrapper() : fType(SYMPTR_NONE), fPtr{nullptr} {}
|
||
|
||
/** @internal */
|
||
SymbolsWrapper(const SymbolsWrapper &other);
|
||
|
||
/** @internal */
|
||
~SymbolsWrapper();
|
||
|
||
/** @internal */
|
||
SymbolsWrapper &operator=(const SymbolsWrapper &other);
|
||
|
||
/**
|
||
* The provided object is copied, but we do not adopt it.
|
||
* @internal
|
||
*/
|
||
void setTo(const DecimalFormatSymbols &dfs);
|
||
|
||
/**
|
||
* Adopt the provided object.
|
||
* @internal
|
||
*/
|
||
void setTo(const NumberingSystem *ns);
|
||
|
||
/**
|
||
* Whether the object is currently holding a DecimalFormatSymbols.
|
||
* @internal
|
||
*/
|
||
bool isDecimalFormatSymbols() const;
|
||
|
||
/**
|
||
* Whether the object is currently holding a NumberingSystem.
|
||
* @internal
|
||
*/
|
||
bool isNumberingSystem() const;
|
||
|
||
/**
|
||
* Get the DecimalFormatSymbols pointer. No ownership change.
|
||
* @internal
|
||
*/
|
||
const DecimalFormatSymbols *getDecimalFormatSymbols() const;
|
||
|
||
/**
|
||
* Get the NumberingSystem pointer. No ownership change.
|
||
* @internal
|
||
*/
|
||
const NumberingSystem *getNumberingSystem() const;
|
||
|
||
/** @internal */
|
||
UBool copyErrorTo(UErrorCode &status) const {
|
||
if (fType == SYMPTR_DFS && fPtr.dfs == nullptr) {
|
||
status = U_MEMORY_ALLOCATION_ERROR;
|
||
return TRUE;
|
||
} else if (fType == SYMPTR_NS && fPtr.ns == nullptr) {
|
||
status = U_MEMORY_ALLOCATION_ERROR;
|
||
return TRUE;
|
||
}
|
||
return FALSE;
|
||
}
|
||
|
||
private:
|
||
enum SymbolsPointerType {
|
||
SYMPTR_NONE, SYMPTR_DFS, SYMPTR_NS
|
||
} fType;
|
||
|
||
union {
|
||
const DecimalFormatSymbols *dfs;
|
||
const NumberingSystem *ns;
|
||
} fPtr;
|
||
|
||
void doCopyFrom(const SymbolsWrapper &other);
|
||
|
||
void doCleanup();
|
||
};
|
||
|
||
/** @internal */
|
||
class U_I18N_API Padder : public UMemory {
|
||
public:
|
||
/** @internal */
|
||
static Padder none();
|
||
|
||
/** @internal */
|
||
static Padder codePoints(UChar32 cp, int32_t targetWidth, UNumberFormatPadPosition position);
|
||
|
||
private:
|
||
UChar32 fWidth; // -3 = error; -2 = bogus; -1 = no padding
|
||
union {
|
||
struct {
|
||
int32_t fCp;
|
||
UNumberFormatPadPosition fPosition;
|
||
} padding;
|
||
UErrorCode errorCode;
|
||
} fUnion;
|
||
|
||
Padder(UChar32 cp, int32_t width, UNumberFormatPadPosition position);
|
||
|
||
Padder(int32_t width);
|
||
|
||
Padder(UErrorCode errorCode) : fWidth(-3) { // NOLINT
|
||
fUnion.errorCode = errorCode;
|
||
}
|
||
|
||
Padder() : fWidth(-2) {} // NOLINT
|
||
|
||
bool isBogus() const {
|
||
return fWidth == -2;
|
||
}
|
||
|
||
UBool copyErrorTo(UErrorCode &status) const {
|
||
if (fWidth == -3) {
|
||
status = fUnion.errorCode;
|
||
return TRUE;
|
||
}
|
||
return FALSE;
|
||
}
|
||
|
||
bool isValid() const {
|
||
return fWidth > 0;
|
||
}
|
||
|
||
int32_t padAndApply(const impl::Modifier &mod1, const impl::Modifier &mod2,
|
||
impl::NumberStringBuilder &string, int32_t leftIndex, int32_t rightIndex,
|
||
UErrorCode &status) const;
|
||
|
||
// To allow MacroProps/MicroProps to initialize empty instances:
|
||
friend struct MacroProps;
|
||
friend struct MicroProps;
|
||
|
||
// To allow NumberFormatterImpl to access isBogus() and perform other operations:
|
||
friend class impl::NumberFormatterImpl;
|
||
};
|
||
|
||
/** @internal */
|
||
struct U_I18N_API MacroProps : public UMemory {
|
||
/** @internal */
|
||
Notation notation;
|
||
|
||
/** @internal */
|
||
MeasureUnit unit; // = NoUnit::base();
|
||
|
||
/** @internal */
|
||
Rounder rounder; // = Rounder(); (bogus)
|
||
|
||
/** @internal */
|
||
Grouper grouper; // = Grouper(); (bogus)
|
||
|
||
/** @internal */
|
||
Padder padder; // = Padder(); (bogus)
|
||
|
||
/** @internal */
|
||
IntegerWidth integerWidth; // = IntegerWidth(); (bogus)
|
||
|
||
/** @internal */
|
||
SymbolsWrapper symbols;
|
||
|
||
// UNUM_XYZ_COUNT denotes null (bogus) values.
|
||
|
||
/** @internal */
|
||
UNumberUnitWidth unitWidth = UNUM_UNIT_WIDTH_COUNT;
|
||
|
||
/** @internal */
|
||
UNumberSignDisplay sign = UNUM_SIGN_COUNT;
|
||
|
||
/** @internal */
|
||
UNumberDecimalSeparatorDisplay decimal = UNUM_DECIMAL_SEPARATOR_COUNT;
|
||
|
||
/** @internal */
|
||
PluralRules *rules = nullptr; // no ownership
|
||
|
||
/** @internal */
|
||
uint32_t threshold = DEFAULT_THRESHOLD;
|
||
Locale locale;
|
||
|
||
/**
|
||
* Check all members for errors.
|
||
* @internal
|
||
*/
|
||
bool copyErrorTo(UErrorCode &status) const {
|
||
return notation.copyErrorTo(status) || rounder.copyErrorTo(status) ||
|
||
padder.copyErrorTo(status) || integerWidth.copyErrorTo(status) ||
|
||
symbols.copyErrorTo(status);
|
||
}
|
||
};
|
||
|
||
} // namespace impl
|
||
#endif /* U_HIDE_INTERNAL_API */
|
||
|
||
/**
|
||
* An abstract base class for specifying settings related to number formatting. This class is implemented by
|
||
* {@link UnlocalizedNumberFormatter} and {@link LocalizedNumberFormatter}.
|
||
*/
|
||
template<typename Derived>
|
||
class U_I18N_API NumberFormatterSettings {
|
||
public:
|
||
/**
|
||
* Specifies the notation style (simple, scientific, or compact) for rendering numbers.
|
||
*
|
||
* <ul>
|
||
* <li>Simple notation: "12,300"
|
||
* <li>Scientific notation: "1.23E4"
|
||
* <li>Compact notation: "12K"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* All notation styles will be properly localized with locale data, and all notation styles are compatible with
|
||
* units, rounding strategies, and other number formatter settings.
|
||
*
|
||
* <p>
|
||
* Pass this method the return value of a {@link Notation} factory method. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().notation(Notation::compactShort())
|
||
* </pre>
|
||
*
|
||
* The default is to use simple notation.
|
||
*
|
||
* @param notation
|
||
* The notation strategy to use.
|
||
* @return The fluent chain.
|
||
* @see Notation
|
||
* @draft ICU 60
|
||
*/
|
||
Derived notation(const Notation ¬ation) const;
|
||
|
||
/**
|
||
* Specifies the unit (unit of measure, currency, or percent) to associate with rendered numbers.
|
||
*
|
||
* <ul>
|
||
* <li>Unit of measure: "12.3 meters"
|
||
* <li>Currency: "$12.30"
|
||
* <li>Percent: "12.3%"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* All units will be properly localized with locale data, and all units are compatible with notation styles,
|
||
* rounding strategies, and other number formatter settings.
|
||
*
|
||
* <p>
|
||
* Pass this method any instance of {@link MeasureUnit}. For units of measure:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter.with().adoptUnit(MeasureUnit::createMeter(status))
|
||
* </pre>
|
||
*
|
||
* Currency:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter.with()::unit(CurrencyUnit(u"USD", status))
|
||
* </pre>
|
||
*
|
||
* Percent:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter.with()::unit(NoUnit.percent())
|
||
* </pre>
|
||
*
|
||
* The default is to render without units (equivalent to NoUnit.base()).
|
||
*
|
||
* @param unit
|
||
* The unit to render.
|
||
* @return The fluent chain.
|
||
* @see MeasureUnit
|
||
* @see Currency
|
||
* @see NoUnit
|
||
* @draft ICU 60
|
||
*/
|
||
Derived unit(const icu::MeasureUnit &unit) const;
|
||
|
||
/**
|
||
* Like unit(), but takes ownership of a pointer. Convenient for use with the MeasureFormat factory
|
||
* methods, which return pointers that need ownership.
|
||
*
|
||
* @param unit
|
||
* The unit to render.
|
||
* @return The fluent chain.
|
||
* @see #unit
|
||
* @see MeasureUnit
|
||
* @draft ICU 60
|
||
*/
|
||
Derived adoptUnit(const icu::MeasureUnit *unit) const;
|
||
|
||
/**
|
||
* Specifies the rounding strategy to use when formatting numbers.
|
||
*
|
||
* <ul>
|
||
* <li>Round to 3 decimal places: "3.142"
|
||
* <li>Round to 3 significant figures: "3.14"
|
||
* <li>Round to the closest nickel: "3.15"
|
||
* <li>Do not perform rounding: "3.1415926..."
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* Pass this method the return value of one of the factory methods on {@link Rounder}. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().rounding(Rounder::fixedFraction(2))
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* In most cases, the default rounding strategy is to round to 6 fraction places; i.e.,
|
||
* <code>Rounder.maxFraction(6)</code>. The exceptions are if compact notation is being used, then the compact
|
||
* notation rounding strategy is used (see {@link Notation#compactShort} for details), or if the unit is a currency,
|
||
* then standard currency rounding is used, which varies from currency to currency (see {@link Rounder#currency} for
|
||
* details).
|
||
*
|
||
* @param rounder
|
||
* The rounding strategy to use.
|
||
* @return The fluent chain.
|
||
* @see Rounder
|
||
* @provisional This API might change or be removed in a future release.
|
||
* @draft ICU 60
|
||
*/
|
||
Derived rounding(const Rounder &rounder) const;
|
||
|
||
#ifndef U_HIDE_INTERNAL_API
|
||
|
||
/**
|
||
* Specifies the grouping strategy to use when formatting numbers.
|
||
*
|
||
* <ul>
|
||
* <li>Default grouping: "12,300" and "1,230"
|
||
* <li>Grouping with at least 2 digits: "12,300" and "1230"
|
||
* <li>No grouping: "12300" and "1230"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* The exact grouping widths will be chosen based on the locale.
|
||
*
|
||
* <p>
|
||
* Pass this method the return value of one of the factory methods on {@link Grouper}. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().grouping(Grouper::min2())
|
||
* </pre>
|
||
*
|
||
* The default is to perform grouping without concern for the minimum grouping digits.
|
||
*
|
||
* @param grouper
|
||
* The grouping strategy to use.
|
||
* @return The fluent chain.
|
||
* @see Grouper
|
||
* @see Notation
|
||
* @internal
|
||
* @internal ICU 60: This API is technical preview.
|
||
*/
|
||
Derived grouping(const Grouper &grouper) const;
|
||
|
||
#endif /* U_HIDE_INTERNAL_API */
|
||
|
||
/**
|
||
* Specifies the minimum and maximum number of digits to render before the decimal mark.
|
||
*
|
||
* <ul>
|
||
* <li>Zero minimum integer digits: ".08"
|
||
* <li>One minimum integer digit: "0.08"
|
||
* <li>Two minimum integer digits: "00.08"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* Pass this method the return value of {@link IntegerWidth#zeroFillTo(int)}. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().integerWidth(IntegerWidth::zeroFillTo(2))
|
||
* </pre>
|
||
*
|
||
* The default is to have one minimum integer digit.
|
||
*
|
||
* @param style
|
||
* The integer width to use.
|
||
* @return The fluent chain.
|
||
* @see IntegerWidth
|
||
* @draft ICU 60
|
||
*/
|
||
Derived integerWidth(const IntegerWidth &style) const;
|
||
|
||
/**
|
||
* Specifies the symbols (decimal separator, grouping separator, percent sign, numerals, etc.) to use when rendering
|
||
* numbers.
|
||
*
|
||
* <ul>
|
||
* <li><em>en_US</em> symbols: "12,345.67"
|
||
* <li><em>fr_FR</em> symbols: "12 345,67"
|
||
* <li><em>de_CH</em> symbols: "12’345.67"
|
||
* <li><em>my_MY</em> symbols: "၁၂,၃၄၅.၆၇"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* Pass this method an instance of {@link DecimalFormatSymbols}. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().symbols(DecimalFormatSymbols(Locale("de_CH"), status))
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* <strong>Note:</strong> DecimalFormatSymbols automatically chooses the best numbering system based on the locale.
|
||
* In the examples above, the first three are using the Latin numbering system, and the fourth is using the Myanmar
|
||
* numbering system.
|
||
*
|
||
* <p>
|
||
* <strong>Note:</strong> The instance of DecimalFormatSymbols will be copied: changes made to the symbols object
|
||
* after passing it into the fluent chain will not be seen.
|
||
*
|
||
* <p>
|
||
* <strong>Note:</strong> Calling this method will override the NumberingSystem previously specified in
|
||
* {@link #symbols(NumberingSystem)}.
|
||
*
|
||
* <p>
|
||
* The default is to choose the symbols based on the locale specified in the fluent chain.
|
||
*
|
||
* @param symbols
|
||
* The DecimalFormatSymbols to use.
|
||
* @return The fluent chain.
|
||
* @see DecimalFormatSymbols
|
||
* @draft ICU 60
|
||
*/
|
||
Derived symbols(const DecimalFormatSymbols &symbols) const;
|
||
|
||
/**
|
||
* Specifies that the given numbering system should be used when fetching symbols.
|
||
*
|
||
* <ul>
|
||
* <li>Latin numbering system: "12,345"
|
||
* <li>Myanmar numbering system: "၁၂,၃၄၅"
|
||
* <li>Math Sans Bold numbering system: "𝟭𝟮,𝟯𝟰𝟱"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* Pass this method an instance of {@link NumberingSystem}. For example, to force the locale to always use the Latin
|
||
* alphabet numbering system (ASCII digits):
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().adoptSymbols(NumberingSystem::createInstanceByName("latn", status))
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* <strong>Note:</strong> Calling this method will override the DecimalFormatSymbols previously specified in
|
||
* {@link #symbols(DecimalFormatSymbols)}.
|
||
*
|
||
* <p>
|
||
* The default is to choose the best numbering system for the locale.
|
||
*
|
||
* <p>
|
||
* This method takes ownership of a pointer in order to work nicely with the NumberingSystem factory methods.
|
||
*
|
||
* @param ns
|
||
* The NumberingSystem to use.
|
||
* @return The fluent chain.
|
||
* @see NumberingSystem
|
||
* @draft ICU 60
|
||
*/
|
||
Derived adoptSymbols(const NumberingSystem *symbols) const;
|
||
|
||
/**
|
||
* Sets the width of the unit (measure unit or currency). Most common values:
|
||
*
|
||
* <ul>
|
||
* <li>Short: "$12.00", "12 m"
|
||
* <li>ISO Code: "USD 12.00"
|
||
* <li>Full name: "12.00 US dollars", "12 meters"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* Pass an element from the {@link UNumberUnitWidth} enum to this setter. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().unitWidth(UNumberUnitWidth::UNUM_UNIT_WIDTH_FULL_NAME)
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* The default is the SHORT width.
|
||
*
|
||
* @param style
|
||
* The width to use when rendering numbers.
|
||
* @return The fluent chain
|
||
* @see UNumberUnitWidth
|
||
* @draft ICU 60
|
||
*/
|
||
Derived unitWidth(const UNumberUnitWidth &width) const;
|
||
|
||
/**
|
||
* Sets the plus/minus sign display strategy. Most common values:
|
||
*
|
||
* <ul>
|
||
* <li>Auto: "123", "-123"
|
||
* <li>Always: "+123", "-123"
|
||
* <li>Accounting: "$123", "($123)"
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* Pass an element from the {@link UNumberSignDisplay} enum to this setter. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().sign(UNumberSignDisplay::UNUM_SIGN_ALWAYS)
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* The default is AUTO sign display.
|
||
*
|
||
* @param style
|
||
* The sign display strategy to use when rendering numbers.
|
||
* @return The fluent chain
|
||
* @see UNumberSignDisplay
|
||
* @provisional This API might change or be removed in a future release.
|
||
* @draft ICU 60
|
||
*/
|
||
Derived sign(const UNumberSignDisplay &width) const;
|
||
|
||
/**
|
||
* Sets the decimal separator display strategy. This affects integer numbers with no fraction part. Most common
|
||
* values:
|
||
*
|
||
* <ul>
|
||
* <li>Auto: "1"
|
||
* <li>Always: "1."
|
||
* </ul>
|
||
*
|
||
* <p>
|
||
* Pass an element from the {@link UNumberDecimalSeparatorDisplay} enum to this setter. For example:
|
||
*
|
||
* <pre>
|
||
* NumberFormatter::with().decimal(UNumberDecimalSeparatorDisplay::UNUM_DECIMAL_SEPARATOR_ALWAYS)
|
||
* </pre>
|
||
*
|
||
* <p>
|
||
* The default is AUTO decimal separator display.
|
||
*
|
||
* @param style
|
||
* The decimal separator display strategy to use when rendering numbers.
|
||
* @return The fluent chain
|
||
* @see UNumberDecimalSeparatorDisplay
|
||
* @provisional This API might change or be removed in a future release.
|
||
* @draft ICU 60
|
||
*/
|
||
Derived decimal(const UNumberDecimalSeparatorDisplay &width) const;
|
||
|
||
#ifndef U_HIDE_INTERNAL_API
|
||
|
||
/**
|
||
* Set the padding strategy. May be added to ICU 61; see #13338.
|
||
*
|
||
* @internal ICU 60: This API is ICU internal only.
|
||
*/
|
||
Derived padding(const impl::Padder &padder) const;
|
||
|
||
/**
|
||
* Internal fluent setter to support a custom regulation threshold. A threshold of 1 causes the data structures to
|
||
* be built right away. A threshold of 0 prevents the data structures from being built.
|
||
*
|
||
* @internal ICU 60: This API is ICU internal only.
|
||
*/
|
||
Derived threshold(uint32_t threshold) const;
|
||
|
||
#endif /* U_HIDE_INTERNAL_API */
|
||
|
||
/**
|
||
* 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 60
|
||
*/
|
||
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);
|
||
}
|
||
|
||
protected:
|
||
impl::MacroProps fMacros;
|
||
|
||
private:
|
||
// Don't construct me directly! Use (Un)LocalizedNumberFormatter.
|
||
NumberFormatterSettings() = default;
|
||
|
||
friend class LocalizedNumberFormatter;
|
||
friend class UnlocalizedNumberFormatter;
|
||
};
|
||
|
||
/**
|
||
* A NumberFormatter that does not yet have a locale. In order to format numbers, a locale must be specified.
|
||
*
|
||
* @see NumberFormatter
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API UnlocalizedNumberFormatter
|
||
: public NumberFormatterSettings<UnlocalizedNumberFormatter>, public UMemory {
|
||
|
||
public:
|
||
LocalizedNumberFormatter locale(const icu::Locale &locale) const;
|
||
|
||
// Make default copy constructor call the NumberFormatterSettings copy constructor.
|
||
UnlocalizedNumberFormatter(const UnlocalizedNumberFormatter &other) : UnlocalizedNumberFormatter(
|
||
static_cast<const NumberFormatterSettings<UnlocalizedNumberFormatter> &>(other)) {}
|
||
|
||
private:
|
||
UnlocalizedNumberFormatter() = default;
|
||
|
||
explicit UnlocalizedNumberFormatter(
|
||
const NumberFormatterSettings<UnlocalizedNumberFormatter> &other);
|
||
|
||
// To give the fluent setters access to this class's constructor:
|
||
friend class NumberFormatterSettings<UnlocalizedNumberFormatter>;
|
||
|
||
// To give NumberFormatter::with() access to this class's constructor:
|
||
friend class NumberFormatter;
|
||
};
|
||
|
||
/**
|
||
* A NumberFormatter that has a locale associated with it; this means .format() methods are available.
|
||
*
|
||
* @see NumberFormatter
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API LocalizedNumberFormatter
|
||
: public NumberFormatterSettings<LocalizedNumberFormatter>, public UMemory {
|
||
public:
|
||
/**
|
||
* Format the given integer number to a string using the settings specified in the NumberFormatter fluent
|
||
* setting chain.
|
||
*
|
||
* @param input
|
||
* The number to format.
|
||
* @param status
|
||
* Set to an ErrorCode if one occured in the setter chain or during formatting.
|
||
* @return A FormattedNumber object; call .toString() to get the string.
|
||
* @draft ICU 60
|
||
*/
|
||
FormattedNumber formatInt(int64_t value, UErrorCode &status) const;
|
||
|
||
/**
|
||
* Format the given float or double to a string using the settings specified in the NumberFormatter fluent setting
|
||
* chain.
|
||
*
|
||
* @param input
|
||
* The number to format.
|
||
* @param status
|
||
* Set to an ErrorCode if one occured in the setter chain or during formatting.
|
||
* @return A FormattedNumber object; call .toString() to get the string.
|
||
* @draft ICU 60
|
||
*/
|
||
FormattedNumber formatDouble(double value, UErrorCode &status) const;
|
||
|
||
/**
|
||
* Format the given decimal number to a string using the settings
|
||
* specified in the NumberFormatter fluent setting chain.
|
||
* The syntax of the unformatted number is a "numeric string"
|
||
* as defined in the Decimal Arithmetic Specification, available at
|
||
* http://speleotrove.com/decimal
|
||
*
|
||
* @param input
|
||
* The number to format.
|
||
* @param status
|
||
* Set to an ErrorCode if one occured in the setter chain or during formatting.
|
||
* @return A FormattedNumber object; call .toString() to get the string.
|
||
* @draft ICU 60
|
||
*/
|
||
FormattedNumber formatDecimal(StringPiece value, UErrorCode &status) const;
|
||
|
||
// Make default copy constructor call the NumberFormatterSettings copy constructor.
|
||
LocalizedNumberFormatter(const LocalizedNumberFormatter &other) : LocalizedNumberFormatter(
|
||
static_cast<const NumberFormatterSettings<LocalizedNumberFormatter> &>(other)) {}
|
||
|
||
~LocalizedNumberFormatter();
|
||
|
||
private:
|
||
UPRV_SUPPRESS_DLL_INTERFACE_WARNING // Member is private and does not need to be exported
|
||
std::atomic<const impl::NumberFormatterImpl *> fCompiled{nullptr};
|
||
UPRV_SUPPRESS_DLL_INTERFACE_WARNING // Member is private and does not need to be exported
|
||
std::atomic<uint32_t> fCallCount{0};
|
||
|
||
LocalizedNumberFormatter() = default;
|
||
|
||
explicit LocalizedNumberFormatter(const NumberFormatterSettings<LocalizedNumberFormatter> &other);
|
||
|
||
LocalizedNumberFormatter(const impl::MacroProps ¯os, const Locale &locale);
|
||
|
||
/**
|
||
* This is the core entrypoint to the number formatting pipeline. It performs self-regulation: a static code path
|
||
* for the first few calls, and compiling a more efficient data structure if called repeatedly.
|
||
*
|
||
* <p>
|
||
* This function is very hot, being called in every call to the number formatting pipeline.
|
||
*
|
||
* @param fq
|
||
* The quantity to be formatted.
|
||
* @return The formatted number result.
|
||
*/
|
||
FormattedNumber formatImpl(impl::NumberFormatterResults *results, UErrorCode &status) const;
|
||
|
||
// To give the fluent setters access to this class's constructor:
|
||
friend class NumberFormatterSettings<UnlocalizedNumberFormatter>;
|
||
friend class NumberFormatterSettings<LocalizedNumberFormatter>;
|
||
|
||
// To give UnlocalizedNumberFormatter::locale() access to this class's constructor:
|
||
friend class UnlocalizedNumberFormatter;
|
||
};
|
||
|
||
/**
|
||
* The result of a number formatting operation. This class allows the result to be exported in several data types,
|
||
* including a UnicodeString and a FieldPositionIterator.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API FormattedNumber : public UMemory {
|
||
public:
|
||
/**
|
||
* Returns a UnicodeString representation of the the formatted number.
|
||
*
|
||
* @return a UnicodeString containing the localized number.
|
||
* @draft ICU 60
|
||
*/
|
||
UnicodeString toString() const;
|
||
|
||
/**
|
||
* Appends the formatted number to an Appendable.
|
||
*
|
||
* @param appendable
|
||
* The Appendable to which to append the formatted number string.
|
||
* @return The same Appendable, for chaining.
|
||
* @draft ICU 60
|
||
* @see Appendable
|
||
*/
|
||
Appendable &appendTo(Appendable &appendable);
|
||
|
||
/**
|
||
* Determine the start and end indices of the first occurrence of the given <em>field</em> in the output string.
|
||
* This allows you to determine the locations of the integer part, fraction part, and sign.
|
||
*
|
||
* <p>
|
||
* If multiple different field attributes are needed, this method can be called repeatedly, or if <em>all</em> field
|
||
* attributes are needed, consider using populateFieldPositionIterator().
|
||
*
|
||
* <p>
|
||
* If a field occurs multiple times in an output string, such as a grouping separator, this method will only ever
|
||
* return the first occurrence. Use populateFieldPositionIterator() to access all occurrences of an attribute.
|
||
*
|
||
* @param fieldPosition
|
||
* The FieldPosition to populate with the start and end indices of the desired field.
|
||
* @param status
|
||
* Set if an error occurs while populating the FieldPosition.
|
||
* @draft ICU 60
|
||
* @see UNumberFormatFields
|
||
*/
|
||
void populateFieldPosition(FieldPosition &fieldPosition, UErrorCode &status);
|
||
|
||
/**
|
||
* Export the formatted number 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.
|
||
*
|
||
* <p>
|
||
* If information on only one field is needed, consider using populateFieldPosition() 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 60
|
||
* @see UNumberFormatFields
|
||
*/
|
||
void populateFieldPositionIterator(FieldPositionIterator &iterator, UErrorCode &status);
|
||
|
||
~FormattedNumber();
|
||
|
||
private:
|
||
// Can't use LocalPointer because NumberFormatterResults is forward-declared
|
||
const impl::NumberFormatterResults *fResults;
|
||
|
||
// Default constructor for error states
|
||
FormattedNumber() : fResults(nullptr) {}
|
||
|
||
explicit FormattedNumber(impl::NumberFormatterResults *results) : fResults(results) {}
|
||
|
||
// To give LocalizedNumberFormatter format methods access to this class's constructor:
|
||
friend class LocalizedNumberFormatter;
|
||
};
|
||
|
||
/**
|
||
* See the main description in numberformatter.h for documentation and examples.
|
||
*
|
||
* @draft ICU 60
|
||
*/
|
||
class U_I18N_API NumberFormatter final {
|
||
public:
|
||
/**
|
||
* Call this method at the beginning of a NumberFormatter fluent chain in which the locale is not currently known at
|
||
* the call site.
|
||
*
|
||
* @return An {@link UnlocalizedNumberFormatter}, to be used for chaining.
|
||
* @draft ICU 60
|
||
*/
|
||
static UnlocalizedNumberFormatter with();
|
||
|
||
/**
|
||
* Call this method at the beginning of a NumberFormatter 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 formatting.
|
||
* @return A {@link LocalizedNumberFormatter}, to be used for chaining.
|
||
* @draft ICU 60
|
||
*/
|
||
static LocalizedNumberFormatter withLocale(const Locale &locale);
|
||
|
||
// Don't construct me!
|
||
NumberFormatter() = delete;
|
||
};
|
||
|
||
} // namespace number
|
||
U_NAMESPACE_END
|
||
|
||
#endif // U_HIDE_DRAFT_API
|
||
|
||
#endif // __NUMBERFORMATTER_H__
|
||
|
||
#endif /* #if !UCONFIG_NO_FORMATTING */
|