Go to the documentation of this file.
4 #ifndef __NUMBERFORMATTER_H__
5 #define __NUMBERFORMATTER_H__
9 #if U_SHOW_CPLUSPLUS_API
11 #if !UCONFIG_NO_FORMATTING
88 class FieldPositionIteratorHandler;
89 class FormattedStringBuilder;
95 class NumberParserImpl;
96 class MultiplierParseHandler;
111 class UnlocalizedNumberFormatter;
112 class LocalizedNumberFormatter;
113 class FormattedNumber;
115 class ScientificNotation;
117 class FractionPrecision;
118 class CurrencyPrecision;
119 class IncrementPrecision;
139 static constexpr int32_t kInternalDefaultThreshold = 3;
145 class DecimalQuantity;
146 class UFormattedNumberData;
147 class NumberFormatterImpl;
148 struct ParsedPatternInfo;
149 class ScientificModifier;
150 class MultiplierProducer;
152 class ScientificHandler;
154 class AffixPatternProvider;
155 class NumberPropertyMapper;
156 struct DecimalFormatProperties;
157 class MultiplierFormatHandler;
158 class CurrencySymbols;
159 class GeneratorHelpers;
161 class NumberRangeFormatterImpl;
163 struct UFormattedNumberImpl;
164 class MutablePatternModifier;
165 class ImmutablePatternModifier;
166 struct DecimalFormatWarehouse;
344 NTN_SCIENTIFIC, NTN_COMPACT, NTN_SIMPLE, NTN_ERROR
347 union NotationUnion {
370 Notation(
const NotationType &type,
const NotationUnion &union_) : fType(type), fUnion(union_) {}
373 fUnion.errorCode = errorCode;
376 Notation() : fType(NTN_SIMPLE), fUnion() {}
379 if (fType == NTN_ERROR) {
380 status = fUnion.errorCode;
387 friend struct impl::MacroProps;
388 friend class ScientificNotation;
391 friend class impl::NumberFormatterImpl;
392 friend class impl::ScientificModifier;
393 friend class impl::ScientificHandler;
396 friend class impl::GeneratorHelpers;
441 using Notation::Notation;
450 friend class impl::NumberPropertyMapper;
620 int32_t maxSignificantDigits);
662 #ifndef U_HIDE_DRAFT_API
671 #endif // U_HIDE_DRAFT_API
679 RND_FRACTION_SIGNIFICANT,
696 union PrecisionUnion {
730 Precision(
const PrecisionType& type,
const PrecisionUnion& union_)
731 : fType(type), fUnion(union_) {}
734 fUnion.errorCode = errorCode;
737 Precision() : fType(RND_BOGUS) {}
739 bool isBogus()
const {
740 return fType == RND_BOGUS;
744 if (fType == RND_ERROR) {
745 status = fUnion.errorCode;
752 Precision withCurrency(
const CurrencyUnit ¤cy,
UErrorCode &status)
const;
754 static FractionPrecision constructFraction(int32_t minFrac, int32_t maxFrac);
756 static Precision constructSignificant(int32_t minSig, int32_t maxSig);
758 static Precision constructFractionSignificant(
759 const FractionPrecision &base,
764 static IncrementPrecision constructIncrement(
double increment, int32_t minFrac);
769 friend struct impl::MacroProps;
770 friend struct impl::MicroProps;
773 friend class impl::NumberFormatterImpl;
776 friend class impl::NumberPropertyMapper;
779 friend class impl::RoundingImpl;
782 friend class FractionPrecision;
783 friend class CurrencyPrecision;
784 friend class IncrementPrecision;
787 friend class impl::GeneratorHelpers;
790 friend class units::UnitsRouter;
804 #ifndef U_HIDE_DRAFT_API
820 int32_t minSignificantDigits,
821 int32_t maxSignificantDigits,
823 #endif // U_HIDE_DRAFT_API
865 using Precision::Precision;
903 using Precision::Precision;
939 using Precision::Precision;
987 bool fFormatFailIfMoreThanMaxDigits;
991 bool fHasError =
false;
993 IntegerWidth(impl::digits_t minInt, impl::digits_t maxInt,
bool formatFailIfMoreThanMaxDigits);
996 fUnion.errorCode = errorCode;
1001 fUnion.minMaxInt.fMinInt = -1;
1005 static IntegerWidth standard() {
1006 return IntegerWidth::zeroFillTo(1);
1009 bool isBogus()
const {
1010 return !fHasError && fUnion.minMaxInt.fMinInt == -1;
1015 status = fUnion.errorCode;
1021 void apply(impl::DecimalQuantity &quantity,
UErrorCode &status)
const;
1023 bool operator==(
const IntegerWidth& other)
const;
1026 friend struct impl::MacroProps;
1027 friend struct impl::MicroProps;
1030 friend class impl::NumberFormatterImpl;
1033 friend class impl::MutablePatternModifier;
1034 friend class impl::ImmutablePatternModifier;
1037 friend class impl::NumberPropertyMapper;
1040 friend class impl::GeneratorHelpers;
1123 #ifndef U_HIDE_INTERNAL_API
1125 Scale(int32_t magnitude, impl::DecNum* arbitraryToAdopt);
1130 impl::DecNum* fArbitrary;
1133 Scale(
UErrorCode error) : fMagnitude(0), fArbitrary(nullptr), fError(error) {}
1137 bool isValid()
const {
1138 return fMagnitude != 0 || fArbitrary !=
nullptr;
1149 void applyTo(impl::DecimalQuantity& quantity)
const;
1151 void applyReciprocalTo(impl::DecimalQuantity& quantity)
const;
1154 friend struct impl::MacroProps;
1155 friend struct impl::MicroProps;
1158 friend class impl::NumberFormatterImpl;
1161 friend class impl::MultiplierFormatHandler;
1164 friend class impl::GeneratorHelpers;
1167 friend class ::icu::numparse::impl::NumberParserImpl;
1168 friend class ::icu::numparse::impl::MultiplierParseHandler;
1180 #ifndef U_HIDE_INTERNAL_API
1213 #endif // U_HIDE_INTERNAL_API
1233 friend class impl::NumberFormatterImpl;
1236 friend class impl::GeneratorHelpers;
1240 friend struct impl::MacroProps;
1265 #ifndef U_HIDE_INTERNAL_API
1303 #endif // U_HIDE_INTERNAL_API
1307 if (fType == SYMPTR_DFS && fPtr.dfs ==
nullptr) {
1310 }
else if (fType == SYMPTR_NS && fPtr.ns ==
nullptr) {
1318 enum SymbolsPointerType {
1319 SYMPTR_NONE, SYMPTR_DFS, SYMPTR_NS
1327 void doCopyFrom(
const SymbolsWrapper &other);
1329 void doMoveFrom(SymbolsWrapper&& src);
1338 #ifndef U_HIDE_INTERNAL_API
1352 : fGrouping1(grouping1),
1353 fGrouping2(grouping2),
1354 fMinGrouping(minGrouping),
1355 fStrategy(strategy) {}
1362 #endif // U_HIDE_INTERNAL_API
1383 int16_t fMinGrouping;
1393 bool isBogus()
const {
1394 return fGrouping1 == -3;
1398 void setLocaleData(
const impl::ParsedPatternInfo &patternInfo,
const Locale& locale);
1400 bool groupAtPosition(int32_t position,
const impl::DecimalQuantity &value)
const;
1403 friend struct MacroProps;
1404 friend struct MicroProps;
1407 friend class NumberFormatterImpl;
1410 friend class ::icu::numparse::impl::NumberParserImpl;
1413 friend class impl::GeneratorHelpers;
1420 #ifndef U_HIDE_INTERNAL_API
1429 #endif // U_HIDE_INTERNAL_API
1443 Padder(int32_t width);
1446 fUnion.errorCode = errorCode;
1449 Padder() : fWidth(-2) {}
1451 bool isBogus()
const {
1452 return fWidth == -2;
1457 status = fUnion.errorCode;
1463 bool isValid()
const {
1467 int32_t padAndApply(
const impl::Modifier &mod1,
const impl::Modifier &mod2,
1468 FormattedStringBuilder &
string, int32_t leftIndex, int32_t rightIndex,
1472 friend struct MacroProps;
1473 friend struct MicroProps;
1476 friend class impl::NumberFormatterImpl;
1479 friend class impl::GeneratorHelpers;
1533 const AffixPatternProvider* affixProvider =
nullptr;
1539 int32_t threshold = kInternalDefaultThreshold;
1551 return notation.copyErrorTo(status) || precision.copyErrorTo(status) ||
1552 padder.copyErrorTo(status) || integerWidth.copyErrorTo(status) ||
1553 symbols.
copyErrorTo(status) || scale.copyErrorTo(status) || usage.copyErrorTo(status) ||
1554 unitDisplayCase.copyErrorTo(status);
1560 #if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER)
1566 #pragma warning(push)
1567 #pragma warning(disable: 4661)
1575 template<
typename Derived>
2167 #ifndef U_HIDE_DRAFT_API
2220 #endif // U_HIDE_DRAFT_API
2222 #ifndef U_HIDE_DRAFT_API
2223 #ifndef U_HIDE_INTERNAL_API
2238 #endif // U_HIDE_INTERNAL_API
2239 #endif // U_HIDE_DRAFT_API
2241 #ifndef U_HIDE_INTERNAL_API
2334 fMacros.copyErrorTo(outErrorCode);
2351 friend class impl::NumberRangeFormatterImpl;
2487 #ifndef U_HIDE_INTERNAL_API
2561 #ifndef U_HIDE_INTERNAL_API
2588 const impl::NumberFormatterImpl* fCompiled {
nullptr};
2589 char fUnsafeCallCount[8] {};
2593 const impl::DecimalFormatWarehouse* fWarehouse {
nullptr};
2595 explicit LocalizedNumberFormatter(
const NumberFormatterSettings<LocalizedNumberFormatter>& other);
2597 explicit LocalizedNumberFormatter(NumberFormatterSettings<LocalizedNumberFormatter>&& src)
U_NOEXCEPT;
2599 LocalizedNumberFormatter(
const impl::MacroProps ¯os,
const Locale &locale);
2601 LocalizedNumberFormatter(impl::MacroProps &¯os,
const Locale &locale);
2603 void resetCompiled();
2605 void lnfMoveHelper(LocalizedNumberFormatter&& src);
2607 void lnfCopyHelper(
const LocalizedNumberFormatter& src,
UErrorCode& status);
2612 bool computeCompiled(
UErrorCode& status)
const;
2615 friend class NumberFormatterSettings<UnlocalizedNumberFormatter>;
2616 friend class NumberFormatterSettings<LocalizedNumberFormatter>;
2619 friend class UnlocalizedNumberFormatter;
2622 #if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER)
2624 #pragma warning(pop)
2715 template<typename StringClass>
2716 inline StringClass toDecimalNumber(
UErrorCode& status) const;
2718 #ifndef U_HIDE_DRAFT_API
2739 #endif // U_HIDE_DRAFT_API
2741 #ifndef U_HIDE_INTERNAL_API
2759 const impl::UFormattedNumberData *fData;
2772 : fData(nullptr), fErrorCode(errorCode) {}
2777 friend class LocalizedNumberFormatter;
2780 friend struct impl::UFormattedNumberImpl;
2783 template<
typename StringClass>
2784 StringClass FormattedNumber::toDecimalNumber(
UErrorCode& status)
const {
2787 toDecimalNumber(sink, status);
2873 #endif // __NUMBERFORMATTER_H__
A class that defines a quantity by which a number should be multiplied when formatting.
ScientificNotation withMinExponentDigits(int32_t minExponentDigits) const
Sets the minimum number of digits to show in the exponent of scientific notation, padding with zeros ...
int8_t fEngineeringInterval
A unit such as length, mass, volume, currency, etc.
static ScientificNotation engineering()
Print the number using engineering notation, a variant of scientific notation in which the exponent m...
C++ API: FieldPosition Iterator.
static Scale byDoubleAndPowerOfTen(double multiplicand, int32_t power)
Multiply a number by both a power of ten and by an arbitrary double value.
C API: Parse Error Information.
Precision withMinDigits(int32_t minSignificantDigits) const
Ensure that no less than this number of significant digits are retained when rounding according to fr...
UNumberRoundingPriority fPriority
Basic definitions for ICU, for both C and C++ APIs.
A unit of currency, such as USD (U.S.
A class that defines the strategy for padding and truncating integers before the decimal separator.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
static IntegerWidth zeroFillTo(int32_t minInt)
Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal ...
int8_t UBool
The ICU boolean type, a signed-byte integer.
A class that defines a rounding precision parameterized by a rounding increment to be used when forma...
void setTo(const NumberingSystem *ns)
Adopt the provided object.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
#define U_OVERRIDE
Defined to the C++11 "override" keyword if available.
Defines rules for mapping non-negative numeric values onto a small set of keywords.
static Grouper forStrategy(UNumberGroupingStrategy grouping)
static Grouper forProperties(const DecimalFormatProperties &properties)
Resolve the values in Properties to a Grouper object.
UCurrencyUsage
Currency Usage used for Decimal Format.
"Smart pointer" class, deletes objects via the standard C++ delete operator.
static Scale byDecimal(StringPiece multiplicand)
Multiply numbers by an arbitrary value before formatting.
static SimpleNotation simple()
Print the number using simple notation without any scaling by powers of ten.
Scale & operator=(Scale &&src) U_NOEXCEPT
static CurrencyPrecision currency(UCurrencyUsage currencyUsage)
Show numbers rounded and padded according to the rules for the currency unit.
Scale & operator=(const Scale &other)
Precision withMinFraction(int32_t minFrac) const
Specifies the minimum number of fraction digits to render after the decimal separator,...
static FractionPrecision maxFraction(int32_t maxFractionPlaces)
Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal ...
bool isNumberingSystem() const
Whether the object is currently holding a NumberingSystem.
@ U_MEMORY_ALLOCATION_ERROR
Memory allocation error.
A UParseError struct is used to returned detailed information about parsing errors.
static SignificantDigitsPrecision minSignificantDigits(int32_t minSignificantDigits)
Always show at least a certain number of significant digits/figures, padding with zeros if necessary.
static CompactNotation compactShort()
Print the number using short-form compact notation.
SymbolsWrapper(SymbolsWrapper &&src) U_NOEXCEPT
C++ API: FieldPosition identifies the fields in a formatted output.
C API: Compatibility APIs for number formatting.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
static FractionPrecision minMaxFraction(int32_t minFractionPlaces, int32_t maxFractionPlaces)
Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal ...
SymbolsWrapper(const SymbolsWrapper &other)
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
impl::digits_t fMinExponentDigits
StringProp unitDisplayCase
#define U_FAILURE(x)
Does the error code indicate a failure?
static SignificantDigitsPrecision fixedSignificantDigits(int32_t minMaxSignificantDigits)
Show numbers rounded if necessary to a certain number of significant digits or significant figures.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Precision trailingZeroDisplay(UNumberTrailingZeroDisplay trailingZeroDisplay) const
Configure how trailing zeros are displayed on numbers.
SymbolsWrapper & operator=(SymbolsWrapper &&src) U_NOEXCEPT
static FractionPrecision minFraction(int32_t minFractionPlaces)
Always show at least a certain number of fraction places after the decimal separator,...
UNumberSignDisplay fExponentSignDisplay
static SignificantDigitsPrecision maxSignificantDigits(int32_t maxSignificantDigits)
Show numbers rounded if necessary to a certain number of significant digits/figures.
A ByteSink can be filled with bytes.
IntegerWidth integerWidth
A class that defines the rounding precision to be used when formatting numbers in NumberFormatter.
UMemory is the common ICU base class.
StringProp & operator=(StringProp &&src) U_NOEXCEPT
StringProp & operator=(const StringProp &other)
static Scale powerOfTen(int32_t power)
Multiply numbers by a power of ten before formatting.
bool isDecimalFormatSymbols() const
Whether the object is currently holding a DecimalFormatSymbols.
C++ API: Symbols for formatting numbers.
static Padder codePoints(UChar32 cp, int32_t targetWidth, UNumberFormatPadPosition position)
ScientificNotation withExponentSignDisplay(UNumberSignDisplay exponentSignDisplay) const
Sets whether to show the sign on positive and negative exponents in scientific notation.
@ U_ZERO_ERROR
No error, no warning.
StringProp(StringProp &&src) U_NOEXCEPT
C++ API: Appendable class: Sink for Unicode code points and 16-bit code units (char16_ts).
int16_t getPrimary() const
Manages NumberFormatterSettings::usage()'s char* instance on the heap.
void setTo(const DecimalFormatSymbols &dfs)
The provided object is copied, but we do not adopt it.
int16_t getSecondary() const
static Padder forProperties(const DecimalFormatProperties &properties)
A class that defines a rounding precision based on a number of fraction places and optionally signifi...
C API: Encapsulates information about a currency.
A class that defines a rounding precision parameterized by a currency to be used when formatting numb...
@ UNUM_ROUND_HALFEVEN
Half-even rounding.
Base class for objects to which Unicode characters and strings can be appended.
static Scale byDouble(double multiplicand)
Multiply numbers by an arbitrary value before formatting.
SymbolsWrapper & operator=(const SymbolsWrapper &other)
Grouper(int16_t grouping1, int16_t grouping2, int16_t minGrouping, UNumberGroupingStrategy strategy)
Defines numbering systems.
UBool copyErrorTo(UErrorCode &status) const
static ScientificNotation scientific()
Print the number using scientific notation (also known as scientific form, standard index form,...
static Scale none()
Do not change the value of numbers when formatting or parsing.
A class that defines the notation style to be used when formatting numbers in NumberFormatter.
A class that defines the scientific notation style to be used when formatting numbers in NumberFormat...
UNumberFormatRoundingMode
The possible number format rounding modes.
static CompactNotation compactLong()
Print the number using long-form compact notation.
Implementation of ByteSink that writes to a "string".
Precision withCurrency(const CurrencyUnit ¤cy) const
Associates a currency with this rounding precision.
static Precision unlimited()
Show all available digits to full precision.
Precision withSignificantDigits(int32_t minSignificantDigits, int32_t maxSignificantDigits, UNumberRoundingPriority priority) const
Override maximum fraction digits with maximum significant digits depending on the magnitude of the nu...
static FractionPrecision integer()
Show numbers rounded if necessary to the nearest integer.
Precision withMaxDigits(int32_t maxSignificantDigits) const
Ensure that no more than this number of significant digits are retained when rounding according to fr...
static SignificantDigitsPrecision minMaxSignificantDigits(int32_t minSignificantDigits, int32_t maxSignificantDigits)
Show numbers rounded if necessary to a certain number of significant digits/figures; in addition,...
StringProp(const StringProp &other)
C++ API: Common ICU base class UObject.
C++ API: units for percent and permille.
C++ API: PluralRules object.
@ U_INVALID_STATE_ERROR
Requested operation can not be completed with ICU in its current state.
void set(StringPiece value)
const DecimalFormatSymbols * getDecimalFormatSymbols() const
Get the DecimalFormatSymbols pointer.
C++ API: A unit for measuring a quantity.
UNumberFormatPadPosition
The possible number format pad positions.
A string-like object that points to a sized piece of memory.
C++ API: Interface for writing bytes, and implementation classes.
C++ API: Currency Unit Information.
Scale(int32_t magnitude, impl::DecNum *arbitraryToAdopt)
IntegerWidth truncateAt(int32_t maxInt)
Truncate numbers exceeding a certain number of numerals before the decimal separator.
static FractionPrecision fixedFraction(int32_t minMaxFractionPlaces)
Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal ...
Scale(const Scale &other)
A Locale object represents a specific geographical, political, or cultural region.
const NumberingSystem * getNumberingSystem() const
Get the NumberingSystem pointer.
static IncrementPrecision increment(double roundingIncrement)
Show numbers rounded if necessary to the closest multiple of a certain rounding increment.
Scale(Scale &&src) U_NOEXCEPT
bool copyErrorTo(UErrorCode &status) const
Check all members for errors.
Represents a span of a string containing a given field.
UNumberCompactStyle
Constants for specifying short or long format.