1 // © 2017 and later: Unicode, Inc. and others. 2 // License & terms of use: http://www.unicode.org/copyright.html 4 #ifndef __NUMBERFORMATTER_H__ 5 #define __NUMBERFORMATTER_H__ 9 #if U_SHOW_CPLUSPLUS_API 11 #if !UCONFIG_NO_FORMATTING 91 // Forward declarations: 93 classFieldPositionIteratorHandler;
94 classFormattedStringBuilder;
96 namespacenumparse::impl {
98 // Forward declarations: 99 classNumberParserImpl;
100 classMultiplierParseHandler;
102 }
// namespace numparse::impl 106 // Forward declarations: 111 namespacenumber {
// icu::number 113 // Forward declarations: 114 classUnlocalizedNumberFormatter;
115 classLocalizedNumberFormatter;
116 classSimpleNumberFormatter;
117 classFormattedNumber;
119 classScientificNotation;
121 classFractionPrecision;
122 classCurrencyPrecision;
123 classIncrementPrecision;
128 // can't be #ifndef U_HIDE_INTERNAL_API; referenced throughout this file in public classes 136 // can't be #ifndef U_HIDE_INTERNAL_API; needed for struct initialization 143 static constexpr int32_t kInternalDefaultThreshold = 3;
145 // Forward declarations: 149 classDecimalQuantity;
150 classUFormattedNumberData;
151 classNumberFormatterImpl;
152 structParsedPatternInfo;
153 classScientificModifier;
154 classMultiplierProducer;
156 classScientificHandler;
158 classAffixPatternProvider;
159 classNumberPropertyMapper;
160 structDecimalFormatProperties;
161 classMultiplierFormatHandler;
162 classCurrencySymbols;
163 classGeneratorHelpers;
165 classNumberRangeFormatterImpl;
167 structUFormattedNumberImpl;
168 classMutablePatternModifier;
169 classImmutablePatternModifier;
170 structDecimalFormatWarehouse;
171 structSimpleMicroProps;
172 classAdoptingSignumModifierStore;
350 NTN_SCIENTIFIC, NTN_COMPACT, NTN_SIMPLE, NTN_ERROR
354 // For NTN_SCIENTIFIC 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;
392 // To allow MacroProps to initialize empty instances: 393 friendstructimpl::MacroProps;
394 friendclassScientificNotation;
396 // To allow implementation to access internal types: 397 friendclassimpl::NumberFormatterImpl;
398 friendclassimpl::ScientificModifier;
399 friendclassimpl::ScientificHandler;
401 // To allow access to the skeleton generation code: 402 friendclassimpl::GeneratorHelpers;
446 // Inherit constructor 447 using Notation::Notation;
449 // Raw constructor for NumberPropertyMapper 455 // So that NumberPropertyMapper can create instances 456 friendclassimpl::NumberPropertyMapper;
626 int32_t maxSignificantDigits);
708 RND_FRACTION_SIGNIFICANT,
710 // Used for strange increments like 3.14. 713 // Used for increments with 1 as the only digit. This is different than fraction 714 // rounding because it supports having additional trailing zeros. For example, this 715 // class is used to round with the increment 0.010. 718 // Used for increments with 5 as the only digit (nickel rounding). 725 unionPrecisionUnion {
728 // For RND_FRACTION, RND_SIGNIFICANT, and RND_FRACTION_SIGNIFICANT 747 // For RND_INCREMENT, RND_INCREMENT_ONE, and RND_INCREMENT_FIVE 748 // Note: This is a union, so we shouldn't own memory, since 749 // the default destructor would leak it. 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;
787 // On the parent type so that this method can be called internally on Precision instances. 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);
805 // To allow MacroProps/MicroProps to initialize bogus instances: 806 friendstructimpl::MacroProps;
807 friendstructimpl::MicroProps;
809 // To allow NumberFormatterImpl to access isBogus() and other internal methods: 810 friendclassimpl::NumberFormatterImpl;
812 // To allow NumberPropertyMapper to create instances from DecimalFormatProperties: 813 friendclassimpl::NumberPropertyMapper;
815 // To allow access to the main implementation class: 816 friendclassimpl::RoundingImpl;
818 // To allow child classes to call private methods: 819 friendclassFractionPrecision;
820 friendclassCurrencyPrecision;
821 friendclassIncrementPrecision;
823 // To allow access to the skeleton generation code: 824 friendclassimpl::GeneratorHelpers;
826 // To allow access to isBogus and the default (bogus) constructor: 827 friendclassunits::UnitsRouter;
856 int32_t minSignificantDigits,
857 int32_t maxSignificantDigits,
899 // Inherit constructor 900 using Precision::Precision;
902 // To allow parent class to call this class's constructor: 937 // Inherit constructor 938 using Precision::Precision;
940 // To allow parent class to call this class's constructor: 973 // Inherit constructor 974 using Precision::Precision;
976 // To allow parent class to call this class's constructor: 1022 bool fFormatFailIfMoreThanMaxDigits;
1026 bool fHasError =
false;
1028 IntegerWidth(impl::digits_t minInt, impl::digits_t maxInt,
bool formatFailIfMoreThanMaxDigits);
1030 IntegerWidth(
UErrorCode errorCode) {
// NOLINT 1031 fUnion.errorCode = errorCode;
1035 IntegerWidth() {
// NOLINT 1036 fUnion.minMaxInt.fMinInt = -1;
1040 static IntegerWidth standard() {
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;
1058 booloperator==(
const IntegerWidth& other)
const;
1060 // To allow MacroProps/MicroProps to initialize empty instances: 1061 friendstructimpl::MacroProps;
1062 friendstructimpl::MicroProps;
1064 // To allow NumberFormatterImpl to access isBogus(): 1065 friendclassimpl::NumberFormatterImpl;
1067 // To allow the use of this class when formatting: 1068 friendclassimpl::MutablePatternModifier;
1069 friendclassimpl::ImmutablePatternModifier;
1071 // So that NumberPropertyMapper can create instances 1072 friendclassimpl::NumberPropertyMapper;
1074 // To allow access to the skeleton generation code: 1075 friendclassimpl::GeneratorHelpers;
1140 // We need a custom destructor for the DecNum, which means we need to declare 1141 // the copy/move constructor/assignment quartet. 1158 #ifndef U_HIDE_INTERNAL_API 1160 Scale(int32_t magnitude, impl::DecNum* arbitraryToAdopt);
1161 #endif/* U_HIDE_INTERNAL_API */ 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;
1188 // To allow MacroProps/MicroProps to initialize empty instances: 1189 friendstructimpl::MacroProps;
1190 friendstructimpl::MicroProps;
1192 // To allow NumberFormatterImpl to access isBogus() and perform other operations: 1193 friendclassimpl::NumberFormatterImpl;
1195 // To allow the helper class MultiplierFormatHandler access to private fields: 1196 friendclassimpl::MultiplierFormatHandler;
1198 // To allow access to the skeleton generation code: 1199 friendclassimpl::GeneratorHelpers;
1201 // To allow access to parsing code: 1202 friend class ::icu::numparse::impl::NumberParserImpl;
1203 friend class ::icu::numparse::impl::MultiplierParseHandler;
1208 // Do not enclose entire StringProp with #ifndef U_HIDE_INTERNAL_API, needed for a protected field. 1209 // And do not enclose its class boilerplate within #ifndef U_HIDE_INTERNAL_API. 1226 #ifndef U_HIDE_INTERNAL_API 1249 #endif// U_HIDE_INTERNAL_API 1267 // Allow NumberFormatterImpl to access fValue. 1268 friendclassimpl::NumberFormatterImpl;
1270 // Allow skeleton generation code to access private members. 1271 friendclassimpl::GeneratorHelpers;
1273 // Allow MacroProps/MicroProps to initialize empty instances and to call 1275 friendstructimpl::MacroProps;
1278 // Do not enclose entire SymbolsWrapper with #ifndef U_HIDE_INTERNAL_API, needed for a protected field 1300 #ifndef U_HIDE_INTERNAL_API 1338 #endif// U_HIDE_INTERNAL_API 1342 if (fType == SYMPTR_DFS && fPtr.dfs ==
nullptr) {
1345 }
elseif (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);
1369 // Do not enclose entire Grouper with #ifndef U_HIDE_INTERNAL_API, needed for a protected field 1373 #ifndef U_HIDE_INTERNAL_API 1383 // Future: static Grouper forProperties(DecimalFormatProperties& properties); 1387 : fGrouping1(grouping1),
1388 fGrouping2(grouping2),
1389 fMinGrouping(minGrouping),
1390 fStrategy(strategy) {}
1397 #endif// U_HIDE_INTERNAL_API 1418 int16_t fMinGrouping;
1428 bool isBogus()
const{
1429 return fGrouping1 == -3;
1433 void setLocaleData(
const impl::ParsedPatternInfo &patternInfo,
constLocale& locale);
1435 bool groupAtPosition(int32_t position,
const impl::DecimalQuantity &value)
const;
1437 // To allow MacroProps/MicroProps to initialize empty instances: 1438 friendstructMacroProps;
1439 friendstructMicroProps;
1440 friendstructSimpleMicroProps;
1442 // To allow NumberFormatterImpl to access isBogus() and perform other operations: 1443 friendclassNumberFormatterImpl;
1444 friend class ::icu::number::SimpleNumberFormatter;
1446 // To allow NumberParserImpl to perform setLocaleData(): 1447 friend class ::icu::numparse::impl::NumberParserImpl;
1449 // To allow access to the skeleton generation code: 1450 friendclassimpl::GeneratorHelpers;
1453 // Do not enclose entire Padder with #ifndef U_HIDE_INTERNAL_API, needed for a protected field 1457 #ifndef U_HIDE_INTERNAL_API 1466 #endif// U_HIDE_INTERNAL_API 1469 UChar32 fWidth;
// -3 = error; -2 = bogus; -1 = no padding 1480 Padder(int32_t width);
1482 Padder(
UErrorCode errorCode) : fWidth(-3) {
// NOLINT 1483 fUnion.errorCode = errorCode;
1486 Padder() : fWidth(-2) {}
// NOLINT 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,
1508 // To allow MacroProps/MicroProps to initialize empty instances: 1509 friendstructMacroProps;
1510 friendstructMicroProps;
1512 // To allow NumberFormatterImpl to access isBogus() and perform other operations: 1513 friendclassimpl::NumberFormatterImpl;
1515 // To allow access to the skeleton generation code: 1516 friendclassimpl::GeneratorHelpers;
1519 // Do not enclose entire MacroProps with #ifndef U_HIDE_INTERNAL_API, needed for a protected field. 1520 // U_I18N_API because intltest uses it. 1550 // UNUM_XYZ_COUNT denotes null (bogus) values. 1559 bool approximately =
false;
1574 const AffixPatternProvider* affixProvider =
nullptr;
// no ownership 1580 int32_t threshold = kInternalDefaultThreshold;
1585 // NOTE: Uses default copy and move constructors. 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) 1602 // Ignore MSVC warning 4661. This is generated for NumberFormatterSettings<>::toSkeleton() as this method 1603 // is defined elsewhere (in number_skeletons.cpp). The compiler is warning that the explicit template instantiation 1604 // inside this single translation unit (CPP file) is incomplete, and thus it isn't sure if the template class is 1605 // fully defined. However, since each translation unit explicitly instantiates all the necessary template classes, 1606 // they will all be passed to the linker, and the linker will still find and export all the class members. 1607 #pragma warning(push) 1608 #pragma warning(disable: 4661) 1616 template<
typename Derived>
2280 #ifndef U_HIDE_INTERNAL_API 2303 #endif// U_HIDE_INTERNAL_API 2305 #ifndef U_HIDE_INTERNAL_API 2344 #endif/* U_HIDE_INTERNAL_API */ 2395 // Do not overwrite the older error code 2398 fMacros.copyErrorTo(outErrorCode);
2402 // NOTE: Uses default copy and move constructors. 2407 // Don't construct me directly! Use (Un)LocalizedNumberFormatter. 2413 // Give NumberRangeFormatter access to the MacroProps 2415 friendclassimpl::NumberRangeFormatterImpl;
2418 // Explicit instantiations in source/i18n/number_fluent.cpp. 2419 // (MSVC treats imports/exports of explicit instantiations differently.) 2421 externtemplateclassNumberFormatterSettings<UnlocalizedNumberFormatter>;
2422 externtemplateclassNumberFormatterSettings<LocalizedNumberFormatter>;
2502 // To give the fluent setters access to this class's constructor: 2505 // To give NumberFormatter::with() access to this class's constructor: 2508 // To give LNF::withoutLocale() access to this class's constructor: 2565 #ifndef U_HIDE_INTERNAL_API 2595 #endif/* U_HIDE_INTERNAL_API */ 2662 #ifndef U_HIDE_INTERNAL_API 2678 #endif/* U_HIDE_INTERNAL_API */ 2687 // Note: fCompiled can't be a LocalPointer because impl::NumberFormatterImpl is defined in an internal 2688 // header, and LocalPointer needs the full class definition in order to delete the instance. 2689 const impl::NumberFormatterImpl* fCompiled {
nullptr};
2690 char fUnsafeCallCount[8] {};
// internally cast to u_atomic_int32_t 2692 // Owned pointer to a DecimalFormatWarehouse, used when copying a LocalizedNumberFormatter 2693 // from a DecimalFormat. 2694 const impl::DecimalFormatWarehouse* fWarehouse {
nullptr};
2696 explicit LocalizedNumberFormatter(
const NumberFormatterSettings<LocalizedNumberFormatter>& other);
2698 explicit LocalizedNumberFormatter(NumberFormatterSettings<LocalizedNumberFormatter>&& src) noexcept;
2700 LocalizedNumberFormatter(
const impl::MacroProps ¯os,
const Locale &locale);
2702 LocalizedNumberFormatter(impl::MacroProps &¯os,
const Locale &locale);
2704 void resetCompiled();
2706 void lnfMoveHelper(LocalizedNumberFormatter&& src);
2708 void lnfCopyHelper(
const LocalizedNumberFormatter& src,
UErrorCode& status);
2713 bool computeCompiled(
UErrorCode& status)
const;
2715 // To give the fluent setters access to this class's constructor: 2716 friendclassNumberFormatterSettings<UnlocalizedNumberFormatter>;
2717 friendclassNumberFormatterSettings<LocalizedNumberFormatter>;
2719 // To give UnlocalizedNumberFormatter::locale() access to this class's constructor: 2720 friendclassUnlocalizedNumberFormatter;
2723 #if (U_PF_WINDOWS <= U_PLATFORM && U_PLATFORM <= U_PF_CYGWIN) && defined(_MSC_VER) 2725 #pragma warning(pop) 2803 }
// namespace number 2806 #endif/* #if !UCONFIG_NO_FORMATTING */ 2808 #endif/* U_SHOW_CPLUSPLUS_API */ 2810 #endif// __NUMBERFORMATTER_H__ 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.
This class represents the set of symbols needed by DecimalFormat to format numbers.
Represents all the display options that are supported by CLDR such as grammatical case,...
Base class for all formats.
"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.
The result of a number formatting operation.
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 NumberFormatter that has a locale associated with it; this means .format() methods are available.
const DecimalFormatSymbols * getDecimalFormatSymbols() const
const impl::NumberFormatterImpl * getCompiled() const
Internal method for testing.
UnlocalizedNumberFormatter withoutLocale() const &
Disassociate the locale from this formatter.
FormattedNumber formatInt(int64_t value, UErrorCode &status) const
Format the given integer number to a string using the settings specified in the NumberFormatter fluen...
int32_t getCallCount() const
Internal method for testing.
~LocalizedNumberFormatter()
Destruct this LocalizedNumberFormatter, cleaning up any memory it might own.
Format * toFormat(UErrorCode &status) const
Creates a representation of this LocalizedNumberFormat as an icu::Format, enabling the use of this nu...
void formatImpl(impl::UFormattedNumberData *results, UErrorCode &status) const
This is the core entrypoint to the number formatting pipeline.
FormattedNumber formatDecimal(StringPiece value, UErrorCode &status) const
Format the given decimal number to a string using the settings specified in the NumberFormatter fluen...
void getAffixImpl(bool isPrefix, bool isNegative, UnicodeString &result, UErrorCode &status) const
Internal method for DecimalFormat compatibility.
FormattedNumber formatDecimalQuantity(const impl::DecimalQuantity &dq, UErrorCode &status) const
Internal method.
FormattedNumber formatDouble(double value, UErrorCode &status) const
Format the given float or double to a string using the settings specified in the NumberFormatter flue...
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,...
An abstract base class for specifying settings related to number formatting.
Derived unitDisplayCase(StringPiece unitDisplayCase) &&
NOTE: Use displayOptions instead.
Derived adoptSymbols(NumberingSystem *symbols) const &
Specifies that the given numbering system should be used when fetching symbols.
Derived precision(const Precision &precision) const &
Specifies the rounding precision to use when formatting numbers.
Derived decimal(UNumberDecimalSeparatorDisplay style) &&
Overload of decimal() for use on an rvalue reference.
Derived unitWidth(UNumberUnitWidth width) const &
Sets the width of the unit (measure unit or currency).
Derived adoptUnit(icu::MeasureUnit *unit) const &
Like unit(), but takes ownership of a pointer.
Derived perUnit(const icu::MeasureUnit &perUnit) &&
Overload of perUnit() for use on an rvalue reference.
Derived padding(const impl::Padder &padder) &&
Derived adoptSymbols(NumberingSystem *symbols) &&
Overload of adoptSymbols() for use on an rvalue reference.
Derived macros(const impl::MacroProps ¯os) &&
Derived roundingMode(UNumberFormatRoundingMode roundingMode) &&
Overload of roundingMode() for use on an rvalue reference.
Derived integerWidth(const IntegerWidth &style) const &
Specifies the minimum and maximum number of digits to render before the decimal mark.
Derived macros(const impl::MacroProps ¯os) const &
Internal fluent setter to overwrite the entire macros object.
Derived threshold(int32_t threshold) const &
Internal fluent setter to support a custom regulation threshold.
Derived perUnit(const icu::MeasureUnit &perUnit) const &
Sets a unit to be used in the denominator.
Derived integerWidth(const IntegerWidth &style) &&
Overload of integerWidth() for use on an rvalue reference.
Derived unitDisplayCase(StringPiece unitDisplayCase) const &
NOTE: Use displayOptions instead.
Derived grouping(UNumberGroupingStrategy strategy) const &
Specifies the grouping strategy to use when formatting numbers.
Derived unit(const icu::MeasureUnit &unit) const &
Specifies the unit (unit of measure, currency, or percent) to associate with rendered numbers.
Derived displayOptions(const DisplayOptions &displayOptions) const &
Specifies the DisplayOptions.
Derived usage(StringPiece usage) &&
Overload of usage() for use on an rvalue reference.
Derived displayOptions(const DisplayOptions &displayOptions) &&
Overload of displayOptions() for use on an rvalue reference.
Derived adoptPerUnit(icu::MeasureUnit *perUnit) const &
Like perUnit(), but takes ownership of a pointer.
Derived adoptUnit(icu::MeasureUnit *unit) &&
Overload of adoptUnit() for use on an rvalue reference.
Derived scale(const Scale &scale) &&
Overload of scale() for use on an rvalue reference.
Derived precision(const Precision &precision) &&
Overload of precision() for use on an rvalue reference.
Derived symbols(const DecimalFormatSymbols &symbols) &&
Overload of symbols() for use on an rvalue reference.
Derived padding(const impl::Padder &padder) const &
Set the padding strategy.
Derived notation(const Notation ¬ation) const &
Specifies the notation style (simple, scientific, or compact) for rendering numbers.
Derived sign(UNumberSignDisplay style) const &
Sets the plus/minus sign display strategy.
Derived threshold(int32_t threshold) &&
Derived roundingMode(UNumberFormatRoundingMode roundingMode) const &
Specifies how to determine the direction to round a number when it has more digits than fit in the de...
Derived symbols(const DecimalFormatSymbols &symbols) const &
Specifies the symbols (decimal separator, grouping separator, percent sign, numerals,...
Derived macros(impl::MacroProps &¯os) &&
LocalPointer< Derived > clone() const &
Returns the current (Un)LocalizedNumberFormatter as a LocalPointer wrapping a heap-allocated copy of ...
Derived sign(UNumberSignDisplay style) &&
Overload of sign() for use on an rvalue reference.
UnicodeString toSkeleton(UErrorCode &status) const
Creates a skeleton string representation of this number formatter.
Derived grouping(UNumberGroupingStrategy strategy) &&
Overload of grouping() for use on an rvalue reference.
Derived usage(StringPiece usage) const &
Specifies the usage for which numbers will be formatted ("person-height", "road", "rainfall",...
Derived adoptPerUnit(icu::MeasureUnit *perUnit) &&
Overload of adoptPerUnit() for use on an rvalue reference.
Derived unitWidth(UNumberUnitWidth width) &&
Overload of unitWidth() for use on an rvalue reference.
Derived decimal(UNumberDecimalSeparatorDisplay style) const &
Sets the decimal separator display strategy.
Derived unit(const icu::MeasureUnit &unit) &&
Overload of unit() for use on an rvalue reference.
Derived macros(impl::MacroProps &¯os) const &
Derived scale(const Scale &scale) const &
Sets a scale (multiplier) to be used to scale the number by an arbitrary amount before formatting.
Derived notation(const Notation ¬ation) &&
Overload of notation() for use on an rvalue reference.
See the main description in numberformatter.h for documentation and examples.
static UnlocalizedNumberFormatter forSkeleton(const UnicodeString &skeleton, UParseError &perror, UErrorCode &status)
Call this method at the beginning of a NumberFormatter fluent chain to create an instance based on a ...
static UnlocalizedNumberFormatter forSkeleton(const UnicodeString &skeleton, UErrorCode &status)
Call this method at the beginning of a NumberFormatter fluent chain to create an instance based on a ...
static UnlocalizedNumberFormatter with()
Call this method at the beginning of a NumberFormatter fluent chain in which the locale is not curren...
NumberFormatter()=delete
Use factory methods instead of the constructor to create a NumberFormatter.
static LocalizedNumberFormatter withLocale(const Locale &locale)
Call this method at the beginning of a NumberFormatter fluent chain in which the locale is known at t...
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.
Scale & operator=(const Scale &other)
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(Scale &&src) noexcept
static Scale byDouble(double multiplicand)
Multiply numbers by an arbitrary value before formatting.
Scale & operator=(Scale &&src) noexcept
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 ...
A NumberFormatter that does not yet have a locale.
UnlocalizedNumberFormatter()=default
Default constructor: puts the formatter into a valid but undefined state.
UnlocalizedNumberFormatter & operator=(const UnlocalizedNumberFormatter &other)
Copy assignment operator.
UnlocalizedNumberFormatter(const UnlocalizedNumberFormatter &other)
Returns a copy of this UnlocalizedNumberFormatter.
LocalizedNumberFormatter locale(const icu::Locale &locale) &&
Overload of locale() for use on an rvalue reference.
UnlocalizedNumberFormatter(UnlocalizedNumberFormatter &&src) noexcept
Move constructor: The source UnlocalizedNumberFormatter will be left in a valid but undefined state.
UnlocalizedNumberFormatter & operator=(UnlocalizedNumberFormatter &&src) noexcept
Move assignment operator: The source UnlocalizedNumberFormatter will be left in a valid but undefined...
LocalizedNumberFormatter locale(const icu::Locale &locale) const &
Associate the given locale with the number formatter.
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=(const SymbolsWrapper &other)
const NumberingSystem * getNumberingSystem() const
Get the NumberingSystem pointer.
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.
SymbolsWrapper & operator=(SymbolsWrapper &&src) noexcept
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: Formatted number result from various number formatting functions.
C++ API: FieldPosition Iterator.
C++ API: A unit for measuring a quantity.
U_COMMON_API UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
C++ API: units for percent and permille.
int16_t digits_t
Datatype for minimum/maximum fraction digits.
void touchRangeLocales(impl::RangeMacroProps ¯os)
Used for NumberRangeFormatter and implemented in numrange_fluent.cpp.
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
U_I18N_API 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: Localized number formatting; not recommended for C++.
UNumberRoundingPriority
An enum declaring how to resolve conflicts between maximum fraction digits and maximum significant di...
UNumberSignDisplay
An enum declaring how to denote positive and negative numbers.
@ UNUM_SIGN_COUNT
One more than the highest UNumberSignDisplay value.
UNumberDecimalSeparatorDisplay
An enum declaring how to render the decimal separator.
@ UNUM_DECIMAL_SEPARATOR_COUNT
One more than the highest UNumberDecimalSeparatorDisplay value.
UNumberTrailingZeroDisplay
An enum declaring how to render trailing zeros.
@ UNUM_TRAILING_ZERO_AUTO
Display trailing zeros according to the settings for minimum fraction and significant digits.
UNumberUnitWidth
An enum declaring how to render units, including currencies.
@ UNUM_UNIT_WIDTH_COUNT
One more than the highest UNumberUnitWidth value.
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_CLASS
Set to export library symbols from inside the i18n library, and to import them from outside,...
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
