4#ifndef __NUMBERFORMATTER_H__
5#define __NUMBERFORMATTER_H__
9#if U_SHOW_CPLUSPLUS_API
11#if !UCONFIG_NO_FORMATTING
90class FieldPositionIteratorHandler;
91class FormattedStringBuilder;
97class NumberParserImpl;
98class MultiplierParseHandler;
113class UnlocalizedNumberFormatter;
114class LocalizedNumberFormatter;
115class SimpleNumberFormatter;
116class FormattedNumber;
118class ScientificNotation;
120class FractionPrecision;
121class CurrencyPrecision;
122class IncrementPrecision;
142static constexpr int32_t kInternalDefaultThreshold = 3;
148class DecimalQuantity;
149class UFormattedNumberData;
150class NumberFormatterImpl;
151struct ParsedPatternInfo;
152class ScientificModifier;
153class MultiplierProducer;
155class ScientificHandler;
157class AffixPatternProvider;
158class NumberPropertyMapper;
159struct DecimalFormatProperties;
160class MultiplierFormatHandler;
161class CurrencySymbols;
162class GeneratorHelpers;
164class NumberRangeFormatterImpl;
166struct UFormattedNumberImpl;
167class MutablePatternModifier;
168class ImmutablePatternModifier;
169struct DecimalFormatWarehouse;
170struct SimpleMicroProps;
171class AdoptingSignumModifierStore;
349 NTN_SCIENTIFIC, NTN_COMPACT, NTN_SIMPLE, NTN_ERROR
352 union NotationUnion {
375 Notation(
const NotationType &type,
const NotationUnion &union_) : fType(type), fUnion(union_) {}
378 fUnion.errorCode = errorCode;
381 Notation() : fType(NTN_SIMPLE), fUnion() {}
384 if (fType == NTN_ERROR) {
385 status = fUnion.errorCode;
392 friend struct impl::MacroProps;
393 friend class ScientificNotation;
396 friend class impl::NumberFormatterImpl;
397 friend class impl::ScientificModifier;
398 friend class impl::ScientificHandler;
401 friend class impl::GeneratorHelpers;
446 using Notation::Notation;
455 friend class impl::NumberPropertyMapper;
625 int32_t maxSignificantDigits);
707 RND_FRACTION_SIGNIFICANT,
724 union PrecisionUnion {
765 Precision(
const PrecisionType& type,
const PrecisionUnion& union_)
766 : fType(type), fUnion(union_) {}
769 fUnion.errorCode = errorCode;
772 Precision() : fType(RND_BOGUS) {}
774 bool isBogus()
const {
775 return fType == RND_BOGUS;
779 if (fType == RND_ERROR) {
780 status = fUnion.errorCode;
787 Precision withCurrency(
const CurrencyUnit ¤cy,
UErrorCode &status)
const;
789 static FractionPrecision constructFraction(int32_t minFrac, int32_t maxFrac);
791 static Precision constructSignificant(int32_t minSig, int32_t maxSig);
793 static Precision constructFractionSignificant(
794 const FractionPrecision &base,
800 static IncrementPrecision constructIncrement(uint64_t increment, impl::digits_t magnitude);
805 friend struct impl::MacroProps;
806 friend struct impl::MicroProps;
809 friend class impl::NumberFormatterImpl;
812 friend class impl::NumberPropertyMapper;
815 friend class impl::RoundingImpl;
818 friend class FractionPrecision;
819 friend class CurrencyPrecision;
820 friend class IncrementPrecision;
823 friend class impl::GeneratorHelpers;
826 friend class units::UnitsRouter;
855 int32_t minSignificantDigits,
856 int32_t maxSignificantDigits,
899 using Precision::Precision;
937 using Precision::Precision;
973 using Precision::Precision;
1021 bool fFormatFailIfMoreThanMaxDigits;
1025 bool fHasError =
false;
1027 IntegerWidth(impl::digits_t minInt, impl::digits_t maxInt,
bool formatFailIfMoreThanMaxDigits);
1030 fUnion.errorCode = errorCode;
1035 fUnion.minMaxInt.fMinInt = -1;
1039 static IntegerWidth standard() {
1040 return IntegerWidth::zeroFillTo(1);
1043 bool isBogus()
const {
1044 return !fHasError && fUnion.minMaxInt.fMinInt == -1;
1049 status = fUnion.errorCode;
1055 void apply(impl::DecimalQuantity &quantity,
UErrorCode &status)
const;
1057 bool operator==(
const IntegerWidth& other)
const;
1060 friend struct impl::MacroProps;
1061 friend struct impl::MicroProps;
1064 friend class impl::NumberFormatterImpl;
1067 friend class impl::MutablePatternModifier;
1068 friend class impl::ImmutablePatternModifier;
1071 friend class impl::NumberPropertyMapper;
1074 friend class impl::GeneratorHelpers;
1157#ifndef U_HIDE_INTERNAL_API
1159 Scale(int32_t magnitude, impl::DecNum* arbitraryToAdopt);
1164 impl::DecNum* fArbitrary;
1167 Scale(
UErrorCode error) : fMagnitude(0), fArbitrary(nullptr), fError(error) {}
1171 bool isValid()
const {
1172 return fMagnitude != 0 || fArbitrary !=
nullptr;
1183 void applyTo(impl::DecimalQuantity& quantity)
const;
1185 void applyReciprocalTo(impl::DecimalQuantity& quantity)
const;
1188 friend struct impl::MacroProps;
1189 friend struct impl::MicroProps;
1192 friend class impl::NumberFormatterImpl;
1195 friend class impl::MultiplierFormatHandler;
1198 friend class impl::GeneratorHelpers;
1201 friend class ::icu::numparse::impl::NumberParserImpl;
1202 friend class ::icu::numparse::impl::MultiplierParseHandler;
1225#ifndef U_HIDE_INTERNAL_API
1268 friend class impl::NumberFormatterImpl;
1271 friend class impl::GeneratorHelpers;
1275 friend struct impl::MacroProps;
1300#ifndef U_HIDE_INTERNAL_API
1342 if (fType == SYMPTR_DFS && fPtr.dfs ==
nullptr) {
1345 }
else if (fType == SYMPTR_NS && fPtr.ns ==
nullptr) {
1353 enum SymbolsPointerType {
1354 SYMPTR_NONE, SYMPTR_DFS, SYMPTR_NS
1362 void doCopyFrom(
const SymbolsWrapper &other);
1364 void doMoveFrom(SymbolsWrapper&& src);
1373#ifndef U_HIDE_INTERNAL_API
1387 : fGrouping1(grouping1),
1388 fGrouping2(grouping2),
1389 fMinGrouping(minGrouping),
1390 fStrategy(strategy) {}
1418 int16_t fMinGrouping;
1428 bool isBogus()
const {
1429 return fGrouping1 == -3;
1433 void setLocaleData(
const impl::ParsedPatternInfo &patternInfo,
const Locale& locale);
1435 bool groupAtPosition(int32_t position,
const impl::DecimalQuantity &value)
const;
1438 friend struct MacroProps;
1439 friend struct MicroProps;
1440 friend struct SimpleMicroProps;
1443 friend class NumberFormatterImpl;
1444 friend class ::icu::number::SimpleNumberFormatter;
1447 friend class ::icu::numparse::impl::NumberParserImpl;
1450 friend class impl::GeneratorHelpers;
1457#ifndef U_HIDE_INTERNAL_API
1480 Padder(int32_t width);
1483 fUnion.errorCode = errorCode;
1486 Padder() : fWidth(-2) {}
1488 bool isBogus()
const {
1489 return fWidth == -2;
1494 status = fUnion.errorCode;
1500 bool isValid()
const {
1504 int32_t padAndApply(
const impl::Modifier &mod1,
const impl::Modifier &mod2,
1505 FormattedStringBuilder &
string, int32_t leftIndex, int32_t rightIndex,
1509 friend struct MacroProps;
1510 friend struct MicroProps;
1513 friend class impl::NumberFormatterImpl;
1516 friend class impl::GeneratorHelpers;
1558 bool approximately =
false;
1573 const AffixPatternProvider* affixProvider =
nullptr;
1579 int32_t threshold = kInternalDefaultThreshold;
1591 return notation.copyErrorTo(status) || precision.copyErrorTo(status) ||
1592 padder.copyErrorTo(status) || integerWidth.copyErrorTo(status) ||
1593 symbols.
copyErrorTo(status) || scale.copyErrorTo(status) || usage.copyErrorTo(status) ||
1594 unitDisplayCase.copyErrorTo(status);
1600#if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER)
1606#pragma warning(push)
1607#pragma warning(disable: 4661)
1615template<
typename Derived>
2260#ifndef U_HIDE_DRAFT_API
2281#ifndef U_HIDE_INTERNAL_API
2306#ifndef U_HIDE_INTERNAL_API
2399 fMacros.copyErrorTo(outErrorCode);
2416 friend class impl::NumberRangeFormatterImpl;
2422extern template class NumberFormatterSettings<UnlocalizedNumberFormatter>;
2423extern template class NumberFormatterSettings<LocalizedNumberFormatter>;
2559#ifndef U_HIDE_INTERNAL_API
2639#ifndef U_HIDE_INTERNAL_API
2666 const impl::NumberFormatterImpl* fCompiled {
nullptr};
2667 char fUnsafeCallCount[8] {};
2671 const impl::DecimalFormatWarehouse* fWarehouse {
nullptr};
2673 explicit LocalizedNumberFormatter(
const NumberFormatterSettings<LocalizedNumberFormatter>& other);
2675 explicit LocalizedNumberFormatter(NumberFormatterSettings<LocalizedNumberFormatter>&& src)
noexcept;
2677 LocalizedNumberFormatter(
const impl::MacroProps ¯os,
const Locale &locale);
2679 LocalizedNumberFormatter(impl::MacroProps &¯os,
const Locale &locale);
2681 void resetCompiled();
2683 void lnfMoveHelper(LocalizedNumberFormatter&& src);
2685 void lnfCopyHelper(
const LocalizedNumberFormatter& src,
UErrorCode& status);
2690 bool computeCompiled(
UErrorCode& status)
const;
2693 friend class NumberFormatterSettings<UnlocalizedNumberFormatter>;
2694 friend class NumberFormatterSettings<LocalizedNumberFormatter>;
2697 friend class UnlocalizedNumberFormatter;
2700#if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER)
C++ API: Appendable class: Sink for Unicode code points and 16-bit code units (char16_ts).
C++ API: Interface for writing bytes, and implementation classes.
A unit of currency, such as USD (U.S.
Represents all the display options that are supported by CLDR such as grammatical case,...
"Smart pointer" class, deletes objects via the standard C++ delete operator.
A Locale object represents a specific geographical, political, or cultural region.
A unit such as length, mass, volume, currency, etc.
Defines numbering systems.
Defines rules for mapping non-negative numeric values onto a small set of keywords.
A string-like object that points to a sized piece of memory.
UMemory is the common ICU base class.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
A class that defines a rounding precision parameterized by a currency to be used when formatting numb...
Precision withCurrency(const CurrencyUnit ¤cy) const
Associates a currency with this rounding precision.
A class that defines a rounding precision based on a number of fraction places and optionally signifi...
Precision withMinDigits(int32_t minSignificantDigits) const
Ensure that no less than this number of significant digits are retained when rounding according to fr...
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...
Precision withMaxDigits(int32_t maxSignificantDigits) const
Ensure that no more than this number of significant digits are retained when rounding according to fr...
A class that defines a rounding precision parameterized by a rounding increment to be used when forma...
Precision withMinFraction(int32_t minFrac) const
Specifies the minimum number of fraction digits to render after the decimal separator,...
A class that defines the strategy for padding and truncating integers before the decimal separator.
static IntegerWidth zeroFillTo(int32_t minInt)
Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal ...
IntegerWidth truncateAt(int32_t maxInt)
Truncate numbers exceeding a certain number of numerals before the decimal separator.
A class that defines the notation style to be used when formatting numbers in NumberFormatter.
static CompactNotation compactShort()
Print the number using short-form compact notation.
static ScientificNotation engineering()
Print the number using engineering notation, a variant of scientific notation in which the exponent m...
static CompactNotation compactLong()
Print the number using long-form compact notation.
static SimpleNotation simple()
Print the number using simple notation without any scaling by powers of ten.
static ScientificNotation scientific()
Print the number using scientific notation (also known as scientific form, standard index form,...
A class that defines the rounding precision to be used when formatting numbers in NumberFormatter.
static SignificantDigitsPrecision maxSignificantDigits(int32_t maxSignificantDigits)
Show numbers rounded if necessary to a certain number of significant digits/figures.
static FractionPrecision fixedFraction(int32_t minMaxFractionPlaces)
Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal ...
static SignificantDigitsPrecision minSignificantDigits(int32_t minSignificantDigits)
Always show at least a certain number of significant digits/figures, padding with zeros if necessary.
static FractionPrecision maxFraction(int32_t maxFractionPlaces)
Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal ...
static IncrementPrecision increment(double roundingIncrement)
Show numbers rounded if necessary to the closest multiple of a certain rounding increment.
static CurrencyPrecision currency(UCurrencyUsage currencyUsage)
Show numbers rounded and padded according to the rules for the currency unit.
static FractionPrecision minFraction(int32_t minFractionPlaces)
Always show at least a certain number of fraction places after the decimal separator,...
Precision trailingZeroDisplay(UNumberTrailingZeroDisplay trailingZeroDisplay) const
Configure how trailing zeros are displayed on numbers.
static Precision unlimited()
Show all available digits to full precision.
static FractionPrecision integer()
Show numbers rounded if necessary to the nearest integer.
static SignificantDigitsPrecision fixedSignificantDigits(int32_t minMaxSignificantDigits)
Show numbers rounded if necessary to a certain number of significant digits or significant figures.
static IncrementPrecision incrementExact(uint64_t mantissa, int16_t magnitude)
Version of Precision::increment() that takes an integer at a particular power of 10.
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 ...
static SignificantDigitsPrecision minMaxSignificantDigits(int32_t minSignificantDigits, int32_t maxSignificantDigits)
Show numbers rounded if necessary to a certain number of significant digits/figures; in addition,...
A class that defines a quantity by which a number should be multiplied when formatting.
static Scale none()
Do not change the value of numbers when formatting or parsing.
static Scale powerOfTen(int32_t power)
Multiply numbers by a power of ten before formatting.
Scale(const Scale &other)
static Scale byDoubleAndPowerOfTen(double multiplicand, int32_t power)
Multiply a number by both a power of ten and by an arbitrary double value.
static Scale byDecimal(StringPiece multiplicand)
Multiply numbers by an arbitrary value before formatting.
Scale(int32_t magnitude, impl::DecNum *arbitraryToAdopt)
Scale & operator=(const Scale &other)
Scale(Scale &&src) noexcept
Scale & operator=(Scale &&src) noexcept
static Scale byDouble(double multiplicand)
Multiply numbers by an arbitrary value before formatting.
A class that defines the scientific notation style to be used when formatting numbers in NumberFormat...
ScientificNotation withExponentSignDisplay(UNumberSignDisplay exponentSignDisplay) const
Sets whether to show the sign on positive and negative exponents in scientific notation.
ScientificNotation withMinExponentDigits(int32_t minExponentDigits) const
Sets the minimum number of digits to show in the exponent of scientific notation, padding with zeros ...
static Grouper forStrategy(UNumberGroupingStrategy grouping)
Grouper(int16_t grouping1, int16_t grouping2, int16_t minGrouping, UNumberGroupingStrategy strategy)
int16_t getSecondary() const
static Grouper forProperties(const DecimalFormatProperties &properties)
Resolve the values in Properties to a Grouper object.
int16_t getPrimary() const
static Padder forProperties(const DecimalFormatProperties &properties)
static Padder codePoints(UChar32 cp, int32_t targetWidth, UNumberFormatPadPosition position)
Manages NumberFormatterSettings::usage()'s char* instance on the heap.
StringProp(StringProp &&src) noexcept
StringProp(const StringProp &other)
StringProp & operator=(StringProp &&src) noexcept
StringProp & operator=(const StringProp &other)
void set(StringPiece value)
SymbolsWrapper & operator=(SymbolsWrapper &&src) noexcept
SymbolsWrapper & operator=(const SymbolsWrapper &other)
bool isNumberingSystem() const
Whether the object is currently holding a NumberingSystem.
const DecimalFormatSymbols * getDecimalFormatSymbols() const
Get the DecimalFormatSymbols pointer.
SymbolsWrapper(const SymbolsWrapper &other)
SymbolsWrapper(SymbolsWrapper &&src) noexcept
void setTo(const DecimalFormatSymbols &dfs)
The provided object is copied, but we do not adopt it.
const NumberingSystem * getNumberingSystem() const
Get the NumberingSystem pointer.
void setTo(const NumberingSystem *ns)
Adopt the provided object.
UBool copyErrorTo(UErrorCode &status) const
bool isDecimalFormatSymbols() const
Whether the object is currently holding a DecimalFormatSymbols.
C++ API: Currency Unit Information.
C++ API: Symbols for formatting numbers.
C++ API: Display options class.
C++ API: FieldPosition identifies the fields in a formatted output.
C++ API: FieldPosition Iterator.
C++ API: A unit for measuring a quantity.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
C++ API: units for percent and permille.
C API: Parse Error Information.
C++ API: PluralRules object.
A UParseError struct is used to returned detailed information about parsing errors.
impl::digits_t fMinExponentDigits
UNumberSignDisplay fExponentSignDisplay
int8_t fEngineeringInterval
bool fRetain
Whether to retain trailing zeros based on the looser strategy.
UNumberRoundingPriority fPriority
impl::digits_t fIncrementMagnitude
bool copyErrorTo(UErrorCode &status) const
Check all members for errors.
StringProp unitDisplayCase
IntegerWidth integerWidth
C API: Encapsulates information about a currency.
UCurrencyUsage
Currency Usage used for Decimal Format.
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
int8_t UBool
The ICU boolean type, a signed-byte integer.
C API: Compatibility APIs for number formatting.
UNumberCompactStyle
Constants for specifying short or long format.
UNumberFormatPadPosition
The possible number format pad positions.
C API: Header-only input options for various number formatting APIs.
UNumberFormatRoundingMode
The possible number format rounding modes.
@ UNUM_ROUND_HALFEVEN
Half-even rounding.
UNumberGroupingStrategy
An enum declaring the strategy for when and how to display grouping separators (i....
C++ API: Common ICU base class UObject.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
@ U_MEMORY_ALLOCATION_ERROR
Memory allocation error.
@ U_ZERO_ERROR
No error, no warning.
#define U_FAILURE(x)
Does the error code indicate a failure?
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.