4 #ifndef __NUMBERFORMATTER_H__ 5 #define __NUMBERFORMATTER_H__ 9 #if U_SHOW_CPLUSPLUS_API 11 #if !UCONFIG_NO_FORMATTING 93 class FieldPositionIteratorHandler;
94 class FormattedStringBuilder;
96 namespace numparse::impl {
99 class NumberParserImpl;
100 class MultiplierParseHandler;
114 class UnlocalizedNumberFormatter;
115 class LocalizedNumberFormatter;
116 class SimpleNumberFormatter;
117 class FormattedNumber;
119 class ScientificNotation;
121 class FractionPrecision;
122 class CurrencyPrecision;
123 class IncrementPrecision;
143 static constexpr int32_t kInternalDefaultThreshold = 3;
149 class DecimalQuantity;
150 class UFormattedNumberData;
151 class NumberFormatterImpl;
152 struct ParsedPatternInfo;
153 class ScientificModifier;
154 class MultiplierProducer;
156 class ScientificHandler;
158 class AffixPatternProvider;
159 class NumberPropertyMapper;
160 struct DecimalFormatProperties;
161 class MultiplierFormatHandler;
162 class CurrencySymbols;
163 class GeneratorHelpers;
165 class NumberRangeFormatterImpl;
167 struct UFormattedNumberImpl;
168 class MutablePatternModifier;
169 class ImmutablePatternModifier;
170 struct DecimalFormatWarehouse;
171 struct SimpleMicroProps;
172 class AdoptingSignumModifierStore;
350 NTN_SCIENTIFIC, NTN_COMPACT, NTN_SIMPLE, NTN_ERROR
353 union NotationUnion {
376 Notation(
const NotationType &type,
const NotationUnion &union_) : fType(type), fUnion(union_) {}
379 fUnion.errorCode = errorCode;
382 Notation() : fType(NTN_SIMPLE), fUnion() {}
385 if (fType == NTN_ERROR) {
386 status = fUnion.errorCode;
393 friend struct impl::MacroProps;
394 friend class ScientificNotation;
397 friend class impl::NumberFormatterImpl;
398 friend class impl::ScientificModifier;
399 friend class impl::ScientificHandler;
402 friend class impl::GeneratorHelpers;
447 using Notation::Notation;
456 friend class impl::NumberPropertyMapper;
573 static FractionPrecision minMaxFraction(int32_t minFractionPlaces, int32_t maxFractionPlaces);
626 int32_t maxSignificantDigits);
708 RND_FRACTION_SIGNIFICANT,
725 union PrecisionUnion {
766 Precision(
const PrecisionType& type,
const PrecisionUnion& union_)
767 : fType(type), fUnion(union_) {}
770 fUnion.errorCode = errorCode;
773 Precision() : fType(RND_BOGUS) {}
775 bool isBogus()
const {
776 return fType == RND_BOGUS;
780 if (fType == RND_ERROR) {
781 status = fUnion.errorCode;
788 Precision withCurrency(
const CurrencyUnit ¤cy,
UErrorCode &status)
const;
790 static FractionPrecision constructFraction(int32_t minFrac, int32_t maxFrac);
792 static Precision constructSignificant(int32_t minSig, int32_t maxSig);
794 static Precision constructFractionSignificant(
795 const FractionPrecision &base,
801 static IncrementPrecision constructIncrement(uint64_t increment, impl::digits_t magnitude);
806 friend struct impl::MacroProps;
807 friend struct impl::MicroProps;
810 friend class impl::NumberFormatterImpl;
813 friend class impl::NumberPropertyMapper;
816 friend class impl::RoundingImpl;
819 friend class FractionPrecision;
820 friend class CurrencyPrecision;
821 friend class IncrementPrecision;
824 friend class impl::GeneratorHelpers;
827 friend class units::UnitsRouter;
856 int32_t minSignificantDigits,
857 int32_t maxSignificantDigits,
877 Precision withMinDigits(int32_t minSignificantDigits)
const;
896 Precision withMaxDigits(int32_t maxSignificantDigits)
const;
900 using Precision::Precision;
938 using Precision::Precision;
970 Precision withMinFraction(int32_t minFrac)
const;
974 using Precision::Precision;
1022 bool fFormatFailIfMoreThanMaxDigits;
1026 bool fHasError =
false;
1031 fUnion.errorCode = errorCode;
1036 fUnion.minMaxInt.fMinInt = -1;
1041 return IntegerWidth::zeroFillTo(1);
1044 bool isBogus()
const {
1045 return !fHasError && fUnion.minMaxInt.fMinInt == -1;
1050 status = fUnion.errorCode;
1056 void apply(impl::DecimalQuantity &quantity,
UErrorCode &status)
const;
1062 friend struct impl::MicroProps;
1065 friend class impl::NumberFormatterImpl;
1068 friend class impl::MutablePatternModifier;
1069 friend class impl::ImmutablePatternModifier;
1072 friend class impl::NumberPropertyMapper;
1075 friend class impl::GeneratorHelpers;
1094 static Scale none();
1106 static Scale powerOfTen(int32_t power);
1130 static Scale byDouble(
double multiplicand);
1138 static Scale byDoubleAndPowerOfTen(
double multiplicand, int32_t power);
1158 #ifndef U_HIDE_INTERNAL_API 1160 Scale(int32_t magnitude, impl::DecNum* arbitraryToAdopt);
1165 impl::DecNum* fArbitrary;
1168 Scale(
UErrorCode error) : fMagnitude(0), fArbitrary(
nullptr), fError(error) {}
1172 bool isValid()
const {
1173 return fMagnitude != 0 || fArbitrary !=
nullptr;
1184 void applyTo(impl::DecimalQuantity& quantity)
const;
1186 void applyReciprocalTo(impl::DecimalQuantity& quantity)
const;
1190 friend struct impl::MicroProps;
1193 friend class impl::NumberFormatterImpl;
1196 friend class impl::MultiplierFormatHandler;
1199 friend class impl::GeneratorHelpers;
1202 friend class ::icu::numparse::impl::NumberParserImpl;
1203 friend class ::icu::numparse::impl::MultiplierParseHandler;
1226 #ifndef U_HIDE_INTERNAL_API 1249 #endif // U_HIDE_INTERNAL_API 1269 friend class impl::NumberFormatterImpl;
1272 friend class impl::GeneratorHelpers;
1276 friend struct impl::MacroProps;
1287 SymbolsWrapper(
const SymbolsWrapper &other);
1290 SymbolsWrapper &operator=(
const SymbolsWrapper &other);
1293 SymbolsWrapper(SymbolsWrapper&& src) noexcept;
1296 SymbolsWrapper &operator=(SymbolsWrapper&& src) noexcept;
1301 #ifndef U_HIDE_INTERNAL_API 1319 bool isDecimalFormatSymbols()
const;
1325 bool isNumberingSystem()
const;
1339 #endif // U_HIDE_INTERNAL_API 1343 if (fType == SYMPTR_DFS && fPtr.dfs ==
nullptr) {
1346 }
else if (fType == SYMPTR_NS && fPtr.ns ==
nullptr) {
1354 enum SymbolsPointerType {
1355 SYMPTR_NONE, SYMPTR_DFS, SYMPTR_NS
1363 void doCopyFrom(
const SymbolsWrapper &other);
1365 void doMoveFrom(SymbolsWrapper&& src);
1374 #ifndef U_HIDE_INTERNAL_API 1382 static Grouper forProperties(
const DecimalFormatProperties& properties);
1388 : fGrouping1(grouping1),
1389 fGrouping2(grouping2),
1390 fMinGrouping(minGrouping),
1391 fStrategy(strategy) {}
1394 int16_t getPrimary()
const;
1397 int16_t getSecondary()
const;
1398 #endif // U_HIDE_INTERNAL_API 1419 int16_t fMinGrouping;
1429 bool isBogus()
const {
1430 return fGrouping1 == -3;
1434 void setLocaleData(
const impl::ParsedPatternInfo &patternInfo,
const Locale& locale);
1436 bool groupAtPosition(int32_t position,
const impl::DecimalQuantity &value)
const;
1439 friend struct MacroProps;
1440 friend struct MicroProps;
1441 friend struct SimpleMicroProps;
1444 friend class NumberFormatterImpl;
1445 friend class ::icu::number::SimpleNumberFormatter;
1448 friend class ::icu::numparse::impl::NumberParserImpl;
1451 friend class impl::GeneratorHelpers;
1458 #ifndef U_HIDE_INTERNAL_API 1466 static Padder forProperties(
const DecimalFormatProperties& properties);
1467 #endif // U_HIDE_INTERNAL_API 1484 fUnion.errorCode = errorCode;
1489 bool isBogus()
const {
1490 return fWidth == -2;
1495 status = fUnion.errorCode;
1501 bool isValid()
const {
1505 int32_t padAndApply(
const impl::Modifier &mod1,
const impl::Modifier &mod2,
1506 FormattedStringBuilder &
string, int32_t leftIndex, int32_t rightIndex,
1511 friend struct MicroProps;
1514 friend class impl::NumberFormatterImpl;
1517 friend class impl::GeneratorHelpers;
1559 bool approximately =
false;
1574 const AffixPatternProvider* affixProvider =
nullptr;
1580 int32_t threshold = kInternalDefaultThreshold;
1592 return notation.copyErrorTo(status) || precision.copyErrorTo(status) ||
1593 padder.copyErrorTo(status) || integerWidth.copyErrorTo(status) ||
1594 symbols.
copyErrorTo(status) || scale.copyErrorTo(status) || usage.copyErrorTo(status) ||
1595 unitDisplayCase.copyErrorTo(status);
1601 #if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER) 1607 #pragma warning(push) 1608 #pragma warning(disable: 4661) 1616 template<
typename Derived>
1647 Derived notation(
const Notation ¬ation)
const &;
1658 Derived notation(
const Notation ¬ation) &&;
1838 Derived precision(
const Precision& precision)
const &;
1849 Derived precision(
const Precision& precision) &&;
1945 Derived integerWidth(
const IntegerWidth &style)
const &;
2195 Derived scale(
const Scale &scale)
const &;
2206 Derived scale(
const Scale &scale) &&;
2269 Derived displayOptions(
const DisplayOptions &displayOptions)
const &;
2280 #ifndef U_HIDE_INTERNAL_API 2291 Derived unitDisplayCase(
StringPiece unitDisplayCase)
const &;
2302 Derived unitDisplayCase(
StringPiece unitDisplayCase) &&;
2303 #endif // U_HIDE_INTERNAL_API 2305 #ifndef U_HIDE_INTERNAL_API 2323 Derived threshold(int32_t threshold)
const &;
2326 Derived threshold(int32_t threshold) &&;
2398 fMacros.copyErrorTo(outErrorCode);
2415 friend class impl::NumberRangeFormatterImpl;
2421 extern template class NumberFormatterSettings<UnlocalizedNumberFormatter>;
2422 extern template class NumberFormatterSettings<LocalizedNumberFormatter>;
2565 #ifndef U_HIDE_INTERNAL_API 2587 const impl::NumberFormatterImpl* getCompiled()
const;
2593 int32_t getCallCount()
const;
2612 #ifndef U_HIDE_DRAFT_API 2629 #endif // U_HIDE_DRAFT_API 2664 #ifndef U_HIDE_INTERNAL_API 2678 void formatImpl(impl::UFormattedNumberData *results,
UErrorCode &status)
const;
2691 const impl::NumberFormatterImpl* fCompiled {
nullptr};
2692 char fUnsafeCallCount[8] {};
2696 const impl::DecimalFormatWarehouse* fWarehouse {
nullptr};
2706 void resetCompiled();
2715 bool computeCompiled(
UErrorCode& status)
const;
2725 #if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER) 2727 #pragma warning(pop) 2812 #endif // __NUMBERFORMATTER_H__
C++ API: Display options class.
A unit such as length, mass, volume, currency, etc.
C++ API: Currency Unit Information.
#define U_FAILURE(x)
Does the error code indicate a failure?
A class that defines the strategy for padding and truncating integers before the decimal separator...
C++ API: FieldPosition Iterator.
UNumberGroupingStrategy
An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten).
"Smart pointer" class, deletes objects via the standard C++ delete operator.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
Defines numbering systems.
C++ API: Appendable class: Sink for Unicode code points and 16-bit code units (char16_ts).
C++ API: units for percent and permille.
C++ API: PluralRules object.
A class that defines a rounding precision parameterized by a rounding increment to be used when forma...
Defines rules for mapping non-negative numeric values onto a small set of keywords.
bool fRetain
Whether to retain trailing zeros based on the looser strategy.
UNumberSignDisplay fExponentSignDisplay
C API: Header-only input options for various number formatting APIs.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
StringProp unitDisplayCase
C++ API: FieldPosition identifies the fields in a formatted output.
A class that defines the notation style to be used when formatting numbers in NumberFormatter.
impl::digits_t fMinExponentDigits
C++ API: Interface for writing bytes, and implementation classes.
IntegerWidth integerWidth
C++ API: A unit for measuring a quantity.
C API: Encapsulates information about a currency.
Represents all the display options that are supported by CLDR such as grammatical case...
A class that defines a rounding precision based on a number of fraction places and optionally signifi...
UCurrencyUsage
Currency Usage used for Decimal Format.
Manages NumberFormatterSettings::usage()'s char* instance on the heap.
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
impl::digits_t fIncrementMagnitude
A class that defines a rounding precision parameterized by a currency to be used when formatting numb...
A unit of currency, such as USD (U.S.
UNumberFormatPadPosition
The possible number format pad positions.
C++ API: Common ICU base class UObject.
UNumberCompactStyle
Constants for specifying short or long format.
C API: Parse Error Information.
UNumberFormatRoundingMode
The possible number format rounding modes.
A class that defines a quantity by which a number should be multiplied when formatting.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
C++ API: Symbols for formatting numbers.
A class that defines the scientific notation style to be used when formatting numbers in NumberFormat...
A UParseError struct is used to returned detailed information about parsing errors.
Basic definitions for ICU, for both C and C++ APIs.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Grouper(int16_t grouping1, int16_t grouping2, int16_t minGrouping, UNumberGroupingStrategy strategy)
UNumberRoundingPriority fPriority
A string-like object that points to a sized piece of memory.
UMemory is the common ICU base class.
A class that defines the rounding precision to be used when formatting numbers in NumberFormatter...
int8_t fEngineeringInterval
bool copyErrorTo(UErrorCode &status) const
Check all members for errors.
int8_t UBool
The ICU boolean type, a signed-byte integer.
C API: Compatibility APIs for number formatting.
UBool copyErrorTo(UErrorCode &status) const
A Locale object represents a specific geographical, political, or cultural region.