4#ifndef __NUMBERFORMATTER_H__
5#define __NUMBERFORMATTER_H__
9#if U_SHOW_CPLUSPLUS_API
11#if !UCONFIG_NO_FORMATTING
93class FieldPositionIteratorHandler;
94class FormattedStringBuilder;
100class NumberParserImpl;
101class MultiplierParseHandler;
116class UnlocalizedNumberFormatter;
117class LocalizedNumberFormatter;
118class SimpleNumberFormatter;
119class FormattedNumber;
121class ScientificNotation;
123class FractionPrecision;
124class CurrencyPrecision;
125class IncrementPrecision;
145static constexpr int32_t kInternalDefaultThreshold = 3;
151class DecimalQuantity;
153class NumberFormatterImpl;
155class ScientificModifier;
158class ScientificHandler;
161class NumberPropertyMapper;
163class MultiplierFormatHandler;
165class GeneratorHelpers;
167class NumberRangeFormatterImpl;
169struct UFormattedNumberImpl;
170class MutablePatternModifier;
171class ImmutablePatternModifier;
173struct SimpleMicroProps;
352 NTN_SCIENTIFIC, NTN_COMPACT, NTN_SIMPLE, NTN_ERROR
355 union NotationUnion {
378 Notation(
const NotationType &type,
const NotationUnion &
union_) : fType(type), fUnion(
union_) {}
381 fUnion.errorCode = errorCode;
384 Notation() : fType(NTN_SIMPLE), fUnion() {}
387 if (fType == NTN_ERROR) {
388 status = fUnion.errorCode;
395 friend struct impl::MacroProps;
396 friend class ScientificNotation;
399 friend class impl::NumberFormatterImpl;
400 friend class impl::ScientificModifier;
401 friend class impl::ScientificHandler;
404 friend class impl::GeneratorHelpers;
449 using Notation::Notation;
458 friend class impl::NumberPropertyMapper;
710 RND_FRACTION_SIGNIFICANT,
727 union PrecisionUnion {
769 : fType(type), fUnion(
union_) {}
772 fUnion.errorCode = errorCode;
775 Precision() : fType(RND_BOGUS) {}
777 bool isBogus()
const {
778 return fType == RND_BOGUS;
782 if (fType == RND_ERROR) {
783 status = fUnion.errorCode;
790 Precision withCurrency(
const CurrencyUnit ¤cy,
UErrorCode &status)
const;
792 static FractionPrecision constructFraction(int32_t minFrac, int32_t maxFrac);
794 static Precision constructSignificant(int32_t minSig, int32_t maxSig);
796 static Precision constructFractionSignificant(
797 const FractionPrecision &base,
803 static IncrementPrecision constructIncrement(uint64_t increment, impl::digits_t magnitude);
808 friend struct impl::MacroProps;
809 friend struct impl::MicroProps;
812 friend class impl::NumberFormatterImpl;
815 friend class impl::NumberPropertyMapper;
818 friend class impl::RoundingImpl;
821 friend class FractionPrecision;
822 friend class CurrencyPrecision;
823 friend class IncrementPrecision;
826 friend class impl::GeneratorHelpers;
829 friend class units::UnitsRouter;
902 using Precision::Precision;
940 using Precision::Precision;
976 using Precision::Precision;
1024 bool fFormatFailIfMoreThanMaxDigits;
1028 bool fHasError =
false;
1033 fUnion.errorCode = errorCode;
1038 fUnion.minMaxInt.fMinInt = -1;
1042 static IntegerWidth standard() {
1043 return IntegerWidth::zeroFillTo(1);
1046 bool isBogus()
const {
1047 return !fHasError && fUnion.minMaxInt.fMinInt == -1;
1052 status = fUnion.errorCode;
1058 void apply(impl::DecimalQuantity &quantity,
UErrorCode &status)
const;
1060 bool operator==(
const IntegerWidth& other)
const;
1063 friend struct impl::MacroProps;
1064 friend struct impl::MicroProps;
1067 friend class impl::NumberFormatterImpl;
1070 friend class impl::MutablePatternModifier;
1071 friend class impl::ImmutablePatternModifier;
1074 friend class impl::NumberPropertyMapper;
1077 friend class impl::GeneratorHelpers;
1160#ifndef U_HIDE_INTERNAL_API
1167 impl::DecNum* fArbitrary;
1174 bool isValid()
const {
1175 return fMagnitude != 0 || fArbitrary !=
nullptr;
1186 void applyTo(impl::DecimalQuantity& quantity)
const;
1188 void applyReciprocalTo(impl::DecimalQuantity& quantity)
const;
1191 friend struct impl::MacroProps;
1192 friend struct impl::MicroProps;
1195 friend class impl::NumberFormatterImpl;
1198 friend class impl::MultiplierFormatHandler;
1201 friend class impl::GeneratorHelpers;
1204 friend class ::icu::numparse::impl::NumberParserImpl;
1205 friend class ::icu::numparse::impl::MultiplierParseHandler;
1228#ifndef U_HIDE_INTERNAL_API
1271 friend class impl::NumberFormatterImpl;
1274 friend class impl::GeneratorHelpers;
1278 friend struct impl::MacroProps;
1303#ifndef U_HIDE_INTERNAL_API
1345 if (fType == SYMPTR_DFS && fPtr.dfs ==
nullptr) {
1348 }
else if (fType == SYMPTR_NS && fPtr.ns ==
nullptr) {
1356 enum SymbolsPointerType {
1357 SYMPTR_NONE, SYMPTR_DFS, SYMPTR_NS
1365 void doCopyFrom(
const SymbolsWrapper &
other);
1367 void doMoveFrom(SymbolsWrapper&&
src);
1376#ifndef U_HIDE_INTERNAL_API
1431 bool isBogus()
const {
1432 return fGrouping1 == -3;
1436 void setLocaleData(
const impl::ParsedPatternInfo &
patternInfo,
const Locale& locale);
1438 bool groupAtPosition(
int32_t position,
const impl::DecimalQuantity &value)
const;
1441 friend struct MacroProps;
1442 friend struct MicroProps;
1443 friend struct SimpleMicroProps;
1446 friend class NumberFormatterImpl;
1447 friend class ::icu::number::SimpleNumberFormatter;
1450 friend class ::icu::numparse::impl::NumberParserImpl;
1453 friend class impl::GeneratorHelpers;
1460#ifndef U_HIDE_INTERNAL_API
1486 fUnion.errorCode = errorCode;
1489 Padder() : fWidth(-2) {}
1491 bool isBogus()
const {
1492 return fWidth == -2;
1497 status = fUnion.errorCode;
1503 bool isValid()
const {
1507 int32_t padAndApply(
const impl::Modifier &mod1,
const impl::Modifier &mod2,
1508 FormattedStringBuilder &
string, int32_t leftIndex, int32_t rightIndex,
1512 friend struct MacroProps;
1513 friend struct MicroProps;
1516 friend class impl::NumberFormatterImpl;
1519 friend class impl::GeneratorHelpers;
1561 bool approximately =
false;
1594 return notation.copyErrorTo(
status) || precision.copyErrorTo(
status) ||
1595 padder.copyErrorTo(
status) || integerWidth.copyErrorTo(
status) ||
1597 unitDisplayCase.copyErrorTo(
status);
1603#if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER)
1609#pragma warning(push)
1610#pragma warning(disable: 4661)
1618template<
typename Derived>
2282#ifndef U_HIDE_INTERNAL_API
2307#ifndef U_HIDE_INTERNAL_API
2417 friend class impl::NumberRangeFormatterImpl;
2560#ifndef U_HIDE_INTERNAL_API
2640#ifndef U_HIDE_INTERNAL_API
2667 const impl::NumberFormatterImpl* fCompiled {
nullptr};
2668 char fUnsafeCallCount[8] {};
2672 const impl::DecimalFormatWarehouse* fWarehouse {
nullptr};
2674 explicit LocalizedNumberFormatter(
const NumberFormatterSettings<LocalizedNumberFormatter>& other);
2676 explicit LocalizedNumberFormatter(NumberFormatterSettings<LocalizedNumberFormatter>&& src)
noexcept;
2678 LocalizedNumberFormatter(
const impl::MacroProps ¯os,
const Locale &locale);
2680 LocalizedNumberFormatter(impl::MacroProps &¯os,
const Locale &locale);
2682 void resetCompiled();
2684 void lnfMoveHelper(LocalizedNumberFormatter&& src);
2686 void lnfCopyHelper(
const LocalizedNumberFormatter& src,
UErrorCode& status);
2691 bool computeCompiled(
UErrorCode& status)
const;
2694 friend class NumberFormatterSettings<UnlocalizedNumberFormatter>;
2695 friend class NumberFormatterSettings<LocalizedNumberFormatter>;
2698 friend class UnlocalizedNumberFormatter;
2701#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" base class; do not use directly: use LocalPointer etc.
"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.