ICU 66.1 66.1
numfmt.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4********************************************************************************
5* Copyright (C) 1997-2016, International Business Machines Corporation and others.
6* All Rights Reserved.
7********************************************************************************
8*
9* File NUMFMT.H
10*
11* Modification History:
12*
13* Date Name Description
14* 02/19/97 aliu Converted from java.
15* 03/18/97 clhuang Updated per C++ implementation.
16* 04/17/97 aliu Changed DigitCount to int per code review.
17* 07/20/98 stephen JDK 1.2 sync up. Added scientific support.
18* Changed naming conventions to match C++ guidelines
19* Derecated Java style constants (eg, INTEGER_FIELD)
20********************************************************************************
21*/
22
23#ifndef NUMFMT_H
24#define NUMFMT_H
25
26
27#include "unicode/utypes.h"
28
29#if U_SHOW_CPLUSPLUS_API
30
36#if !UCONFIG_NO_FORMATTING
37
38#include "unicode/unistr.h"
39#include "unicode/format.h"
40#include "unicode/unum.h" // UNumberFormatStyle
41#include "unicode/locid.h"
42#include "unicode/stringpiece.h"
43#include "unicode/curramt.h"
45
46class NumberFormatTest;
47
48U_NAMESPACE_BEGIN
49
50class SharedNumberFormat;
51
52#if !UCONFIG_NO_SERVICE
53class NumberFormatFactory;
54class StringEnumeration;
55#endif
56
176public:
191 kRoundHalfEven,
193 kRoundHalfDown,
195 kRoundHalfUp,
201 kRoundUnnecessary
202 };
203
221 kIntegerField = UNUM_INTEGER_FIELD,
223 kFractionField = UNUM_FRACTION_FIELD,
225 kDecimalSeparatorField = UNUM_DECIMAL_SEPARATOR_FIELD,
227 kExponentSymbolField = UNUM_EXPONENT_SYMBOL_FIELD,
229 kExponentSignField = UNUM_EXPONENT_SIGN_FIELD,
231 kExponentField = UNUM_EXPONENT_FIELD,
233 kGroupingSeparatorField = UNUM_GROUPING_SEPARATOR_FIELD,
235 kCurrencyField = UNUM_CURRENCY_FIELD,
237 kPercentField = UNUM_PERCENT_FIELD,
239 kPermillField = UNUM_PERMILL_FIELD,
241 kSignField = UNUM_SIGN_FIELD,
242#ifndef U_HIDE_DRAFT_API
244 kMeasureUnitField = UNUM_MEASURE_UNIT_FIELD,
246 kCompactField = UNUM_COMPACT_FIELD,
247#endif // U_HIDE_DRAFT_API
248
254 INTEGER_FIELD = UNUM_INTEGER_FIELD,
256 FRACTION_FIELD = UNUM_FRACTION_FIELD
257 };
258
263 virtual ~NumberFormat();
264
271 virtual NumberFormat* clone() const = 0;
272
279 virtual UBool operator==(const Format& other) const;
280
281
282 using Format::format;
283
299 virtual UnicodeString& format(const Formattable& obj,
300 UnicodeString& appendTo,
301 FieldPosition& pos,
302 UErrorCode& status) const;
303
320 virtual UnicodeString& format(const Formattable& obj,
321 UnicodeString& appendTo,
322 FieldPositionIterator* posIter,
323 UErrorCode& status) const;
324
353 virtual void parseObject(const UnicodeString& source,
354 Formattable& result,
355 ParsePosition& parse_pos) const;
356
367 UnicodeString& format( double number,
368 UnicodeString& appendTo) const;
369
380 UnicodeString& format( int32_t number,
381 UnicodeString& appendTo) const;
382
393 UnicodeString& format( int64_t number,
394 UnicodeString& appendTo) const;
395
408 virtual UnicodeString& format(double number,
409 UnicodeString& appendTo,
410 FieldPosition& pos) const = 0;
425 virtual UnicodeString& format(double number,
426 UnicodeString& appendTo,
427 FieldPosition& pos,
428 UErrorCode &status) const;
443 virtual UnicodeString& format(double number,
444 UnicodeString& appendTo,
445 FieldPositionIterator* posIter,
446 UErrorCode& status) const;
459 virtual UnicodeString& format(int32_t number,
460 UnicodeString& appendTo,
461 FieldPosition& pos) const = 0;
462
476 virtual UnicodeString& format(int32_t number,
477 UnicodeString& appendTo,
478 FieldPosition& pos,
479 UErrorCode &status) const;
480
495 virtual UnicodeString& format(int32_t number,
496 UnicodeString& appendTo,
497 FieldPositionIterator* posIter,
498 UErrorCode& status) const;
512 virtual UnicodeString& format(int64_t number,
513 UnicodeString& appendTo,
514 FieldPosition& pos) const;
515
530 virtual UnicodeString& format(int64_t number,
531 UnicodeString& appendTo,
532 FieldPosition& pos,
533 UErrorCode& status) const;
548 virtual UnicodeString& format(int64_t number,
549 UnicodeString& appendTo,
550 FieldPositionIterator* posIter,
551 UErrorCode& status) const;
552
570 UnicodeString& appendTo,
571 FieldPositionIterator* posIter,
572 UErrorCode& status) const;
573
574// Can't use #ifndef U_HIDE_INTERNAL_API because these are virtual methods
575
593 virtual UnicodeString& format(const number::impl::DecimalQuantity &number,
594 UnicodeString& appendTo,
595 FieldPositionIterator* posIter,
596 UErrorCode& status) const;
597
615 virtual UnicodeString& format(const number::impl::DecimalQuantity &number,
616 UnicodeString& appendTo,
617 FieldPosition& pos,
618 UErrorCode& status) const;
619
639 virtual void parse(const UnicodeString& text,
640 Formattable& result,
641 ParsePosition& parsePosition) const = 0;
642
658 virtual void parse(const UnicodeString& text,
659 Formattable& result,
660 UErrorCode& status) const;
661
682 ParsePosition& pos) const;
683
695 UBool isParseIntegerOnly(void) const;
696
704 virtual void setParseIntegerOnly(UBool value);
705
713 virtual void setLenient(UBool enable);
714
723 virtual UBool isLenient(void) const;
724
734
744 static NumberFormat* U_EXPORT2 createInstance(const Locale& inLocale,
745 UErrorCode&);
746
758 static NumberFormat* U_EXPORT2 createInstance(const Locale& desiredLocale,
759 UNumberFormatStyle style,
760 UErrorCode& errorCode);
761
762#ifndef U_HIDE_INTERNAL_API
763
770 const Locale& desiredLocale,
771 UNumberFormatStyle style,
772 UErrorCode& errorCode);
773
781 static const SharedNumberFormat* U_EXPORT2 createSharedInstance(
782 const Locale& inLocale, UNumberFormatStyle style, UErrorCode& status);
783
784#endif /* U_HIDE_INTERNAL_API */
785
794
803 static NumberFormat* U_EXPORT2 createCurrencyInstance(const Locale& inLocale,
804 UErrorCode&);
805
814
823 static NumberFormat* U_EXPORT2 createPercentInstance(const Locale& inLocale,
824 UErrorCode&);
825
834
843 static NumberFormat* U_EXPORT2 createScientificInstance(const Locale& inLocale,
844 UErrorCode&);
845
851 static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
852
853#if !UCONFIG_NO_SERVICE
864 static URegistryKey U_EXPORT2 registerFactory(NumberFormatFactory* toAdopt, UErrorCode& status);
865
878 static UBool U_EXPORT2 unregister(URegistryKey key, UErrorCode& status);
879
886 static StringEnumeration* U_EXPORT2 getAvailableLocales(void);
887#endif /* UCONFIG_NO_SERVICE */
888
899
906 virtual void setGroupingUsed(UBool newValue);
907
916 int32_t getMaximumIntegerDigits(void) const;
917
930 virtual void setMaximumIntegerDigits(int32_t newValue);
931
940 int32_t getMinimumIntegerDigits(void) const;
941
952 virtual void setMinimumIntegerDigits(int32_t newValue);
953
962 int32_t getMaximumFractionDigits(void) const;
963
974 virtual void setMaximumFractionDigits(int32_t newValue);
975
984 int32_t getMinimumFractionDigits(void) const;
985
996 virtual void setMinimumFractionDigits(int32_t newValue);
997
1010 virtual void setCurrency(const char16_t* theCurrency, UErrorCode& ec);
1011
1019 const char16_t* getCurrency() const;
1020
1030 virtual void setContext(UDisplayContext value, UErrorCode& status);
1031
1043
1050 virtual ERoundingMode getRoundingMode(void) const;
1051
1057 virtual void setRoundingMode(ERoundingMode roundingMode);
1058
1059public:
1060
1069 static UClassID U_EXPORT2 getStaticClassID(void);
1070
1082 virtual UClassID getDynamicClassID(void) const = 0;
1083
1084protected:
1085
1091
1097
1103
1112 virtual void getEffectiveCurrency(char16_t* result, UErrorCode& ec) const;
1113
1114#ifndef U_HIDE_INTERNAL_API
1121 static NumberFormat* makeInstance(const Locale& desiredLocale,
1122 UNumberFormatStyle style,
1123 UBool mustBeDecimalFormat,
1124 UErrorCode& errorCode);
1125#endif /* U_HIDE_INTERNAL_API */
1126
1127private:
1128
1129 static UBool isStyleSupported(UNumberFormatStyle style);
1130
1138 static NumberFormat* makeInstance(const Locale& desiredLocale,
1139 UNumberFormatStyle style,
1140 UErrorCode& errorCode);
1141
1142 UBool fGroupingUsed;
1143 int32_t fMaxIntegerDigits;
1144 int32_t fMinIntegerDigits;
1145 int32_t fMaxFractionDigits;
1146 int32_t fMinFractionDigits;
1147
1148 protected:
1150 static const int32_t gDefaultMaxIntegerDigits;
1152 static const int32_t gDefaultMinIntegerDigits;
1153
1154 private:
1155 UBool fParseIntegerOnly;
1156 UBool fLenient; // TRUE => lenient parse is enabled
1157
1158 // ISO currency code
1159 char16_t fCurrency[4];
1160
1161 UDisplayContext fCapitalizationContext;
1162
1163 friend class ICUNumberFormatFactory; // access to makeInstance
1164 friend class ICUNumberFormatService;
1165 friend class ::NumberFormatTest; // access to isStyleSupported()
1166};
1167
1168#if !UCONFIG_NO_SERVICE
1178public:
1179
1185
1192 virtual UBool visible(void) const = 0;
1193
1199 virtual const UnicodeString * getSupportedIDs(int32_t &count, UErrorCode& status) const = 0;
1200
1208 virtual NumberFormat* createFormat(const Locale& loc, UNumberFormatStyle formatType) = 0;
1209};
1210
1216protected:
1222
1228
1229public:
1233 SimpleNumberFormatFactory(const Locale& locale, UBool visible = TRUE);
1234
1239
1243 virtual UBool visible(void) const;
1244
1248 virtual const UnicodeString * getSupportedIDs(int32_t &count, UErrorCode& status) const;
1249};
1250#endif /* #if !UCONFIG_NO_SERVICE */
1251
1252// -------------------------------------
1253
1254inline UBool
1255NumberFormat::isParseIntegerOnly() const
1256{
1257 return fParseIntegerOnly;
1258}
1259
1260inline UBool
1261NumberFormat::isLenient() const
1262{
1263 return fLenient;
1264}
1265
1266U_NAMESPACE_END
1267
1268#endif /* #if !UCONFIG_NO_FORMATTING */
1269
1270#endif /* U_SHOW_CPLUSPLUS_API */
1271
1272#endif // _NUMFMT
1273//eof
A currency together with a numeric amount, such as 200 USD.
Definition: curramt.h:39
FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...
Definition: fpositer.h:58
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition: fieldpos.h:110
Base class for all formats.
Definition: format.h:98
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition: fmtable.h:64
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
A NumberFormatFactory is used to register new number formats.
Definition: numfmt.h:1177
virtual NumberFormat * createFormat(const Locale &loc, UNumberFormatStyle formatType)=0
Return a number format of the appropriate type.
virtual const UnicodeString * getSupportedIDs(int32_t &count, UErrorCode &status) const =0
Return the locale names directly supported by this factory.
virtual ~NumberFormatFactory()
Destructor.
virtual UBool visible(void) const =0
Return true if this factory will be visible.
virtual void getEffectiveCurrency(char16_t *result, UErrorCode &ec) const
Returns the currency in effect for this formatter.
virtual void setMinimumIntegerDigits(int32_t newValue)
Sets the minimum number of digits allowed in the integer portion of a number.
virtual UnicodeString & format(double number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
Format a double number.
virtual void setParseIntegerOnly(UBool value)
Sets whether or not numbers should be parsed as integers only.
virtual void setMaximumIntegerDigits(int32_t newValue)
Sets the maximum number of digits allowed in the integer portion of a number.
virtual UDisplayContext getContext(UDisplayContextType type, UErrorCode &status) const
Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYP...
static const Locale * getAvailableLocales(int32_t &count)
Get the set of Locales for which NumberFormats are installed.
virtual void setContext(UDisplayContext value, UErrorCode &status)
Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALO...
UnicodeString & format(int64_t number, UnicodeString &appendTo) const
Format an int64 number.
virtual UBool operator==(const Format &other) const
Return true if the given Format objects are semantically equal.
NumberFormat & operator=(const NumberFormat &)
Assignment operator.
static NumberFormat * createCurrencyInstance(UErrorCode &)
Returns a currency format for the current default locale.
virtual UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
Format an object to produce a string.
virtual ERoundingMode getRoundingMode(void) const
Get the rounding mode.
virtual UClassID getDynamicClassID(void) const =0
Returns a unique class ID POLYMORPHICALLY.
virtual NumberFormat * clone() const =0
Clones this object polymorphically.
static NumberFormat * createPercentInstance(const Locale &inLocale, UErrorCode &)
Returns a percentage format for the specified locale.
static const int32_t gDefaultMaxIntegerDigits
Definition: numfmt.h:1150
virtual void setLenient(UBool enable)
Sets whether lenient parsing should be enabled (it is off by default).
virtual UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Format an object to produce a string.
const char16_t * getCurrency() const
Gets the currency used to display currency amounts.
virtual UnicodeString & format(const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
Format a decimal number.
int32_t getMinimumFractionDigits(void) const
Returns the minimum number of digits allowed in the fraction portion of a number.
static NumberFormat * makeInstance(const Locale &desiredLocale, UNumberFormatStyle style, UBool mustBeDecimalFormat, UErrorCode &errorCode)
Creates the specified number format style of the desired locale.
virtual ~NumberFormat()
Destructor.
static NumberFormat * internalCreateInstance(const Locale &desiredLocale, UNumberFormatStyle style, UErrorCode &errorCode)
ICU use only.
virtual void setMinimumFractionDigits(int32_t newValue)
Sets the minimum number of digits allowed in the fraction portion of a number.
virtual UnicodeString & format(int32_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
Format an int32 number.
UnicodeString & format(double number, UnicodeString &appendTo) const
Format a double number.
NumberFormat()
Default constructor for subclass use only.
virtual UnicodeString & format(int32_t number, UnicodeString &appendTo, FieldPosition &pos) const =0
Format a long number.
static const int32_t gDefaultMinIntegerDigits
Definition: numfmt.h:1152
static NumberFormat * createScientificInstance(UErrorCode &)
Returns a scientific format for the current default locale.
virtual UnicodeString & format(int64_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Format an int64 number.
EAlignmentFields
Alignment Field constants used to construct a FieldPosition object.
Definition: numfmt.h:219
static NumberFormat * createInstance(UErrorCode &)
Create a default style NumberFormat for the current default locale.
virtual void setGroupingUsed(UBool newValue)
Set whether or not grouping will be used in this format.
static URegistryKey registerFactory(NumberFormatFactory *toAdopt, UErrorCode &status)
Register a new NumberFormatFactory.
virtual void setCurrency(const char16_t *theCurrency, UErrorCode &ec)
Sets the currency used to display currency amounts.
virtual void setMaximumFractionDigits(int32_t newValue)
Sets the maximum number of digits allowed in the fraction portion of a number.
virtual UnicodeString & format(const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Format a decimal number.
virtual UnicodeString & format(StringPiece number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
Format a decimal number.
ERoundingMode
Rounding mode.
Definition: numfmt.h:186
@ kRoundDown
Round towards zero.
Definition: numfmt.h:189
@ kRoundFloor
Round towards negative infinity.
Definition: numfmt.h:188
@ kRoundCeiling
Round towards positive infinity.
Definition: numfmt.h:187
@ kRoundUp
Round away from zero.
Definition: numfmt.h:190
UnicodeString & format(int32_t number, UnicodeString &appendTo) const
Format a long number.
int32_t getMaximumIntegerDigits(void) const
Returns the maximum number of digits allowed in the integer portion of a number.
static StringEnumeration * getAvailableLocales(void)
Return a StringEnumeration over the locales available at the time of the call, including registered l...
virtual UnicodeString & format(int64_t number, UnicodeString &appendTo, FieldPosition &pos) const
Format an int64 number.
virtual UnicodeString & format(double number, UnicodeString &appendTo, FieldPosition &pos) const =0
Format a double number.
static NumberFormat * createScientificInstance(const Locale &inLocale, UErrorCode &)
Returns a scientific format for the specified locale.
virtual void parseObject(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const
Parse a string to produce an object.
static NumberFormat * createInstance(const Locale &inLocale, UErrorCode &)
Create a default style NumberFormat for the specified locale.
static NumberFormat * createCurrencyInstance(const Locale &inLocale, UErrorCode &)
Returns a currency format for the specified locale.
virtual void setRoundingMode(ERoundingMode roundingMode)
Set the rounding mode.
int32_t getMaximumFractionDigits(void) const
Returns the maximum number of digits allowed in the fraction portion of a number.
virtual UnicodeString & format(int32_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Format a long number.
virtual UnicodeString & format(int64_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
Format an int64 number.
static UBool unregister(URegistryKey key, UErrorCode &status)
Unregister a previously-registered NumberFormatFactory using the key returned from the register call.
static NumberFormat * createInstance(const Locale &desiredLocale, UNumberFormatStyle style, UErrorCode &errorCode)
Create a specific style NumberFormat for the specified locale.
virtual void parse(const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const =0
Return a long if possible (e.g.
UBool isGroupingUsed(void) const
Returns true if grouping is used in this format.
static NumberFormat * createPercentInstance(UErrorCode &)
Returns a percentage format for the current default locale.
static const SharedNumberFormat * createSharedInstance(const Locale &inLocale, UNumberFormatStyle style, UErrorCode &status)
ICU use only.
virtual UnicodeString & format(double number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Format a double number.
virtual CurrencyAmount * parseCurrency(const UnicodeString &text, ParsePosition &pos) const
Parses text from the given string as a currency amount.
NumberFormat(const NumberFormat &)
Copy constructor.
virtual void parse(const UnicodeString &text, Formattable &result, UErrorCode &status) const
Parse a string as a numeric value, and return a Formattable numeric object.
static UClassID getStaticClassID(void)
Return the class ID for this class.
int32_t getMinimumIntegerDigits(void) const
Returns the minimum number of digits allowed in the integer portion of a number.
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition: parsepos.h:52
A NumberFormatFactory that supports a single locale.
Definition: numfmt.h:1215
SimpleNumberFormatFactory(const Locale &locale, UBool visible=TRUE)
virtual const UnicodeString * getSupportedIDs(int32_t &count, UErrorCode &status) const
virtual UBool visible(void) const
UnicodeString _id
The locale supported by this factory, as a UnicodeString.
Definition: numfmt.h:1227
const UBool _visible
True if the locale supported by this factory is visible.
Definition: numfmt.h:1221
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:61
A string-like object that points to a sized piece of memory.
Definition: stringpiece.h:60
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:295
C++ API: Currency Amount Object.
C++ API: Base class for all formats.
C++ API: Locale ID object.
C++ API: StringPiece: Read-only byte string wrapper class.
C API: Display context types (enum values)
UDisplayContextType
Display context types, for getting values of a particular setting.
UDisplayContext
Display context settings.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:261
#define TRUE
The TRUE value of a UBool.
Definition: umachine.h:265
const void * URegistryKey
Opaque type returned by registerInstance, registerFactory and unregister for service registration.
Definition: umisc.h:57
C++ API: Unicode String.
C API: Compatibility APIs for number formatting.
UNumberFormatStyle
The possible number format styles.
Definition: unum.h:146
@ UNUM_MEASURE_UNIT_FIELD
Definition: unum.h:382
@ UNUM_COMPACT_FIELD
Definition: unum.h:384
@ UNUM_INTEGER_FIELD
Definition: unum.h:359
@ UNUM_PERCENT_FIELD
Definition: unum.h:375
@ UNUM_PERMILL_FIELD
Definition: unum.h:377
@ UNUM_EXPONENT_SYMBOL_FIELD
Definition: unum.h:365
@ UNUM_GROUPING_SEPARATOR_FIELD
Definition: unum.h:371
@ UNUM_DECIMAL_SEPARATOR_FIELD
Definition: unum.h:363
@ UNUM_SIGN_FIELD
Definition: unum.h:379
@ UNUM_CURRENCY_FIELD
Definition: unum.h:373
@ UNUM_FRACTION_FIELD
Definition: unum.h:361
@ UNUM_EXPONENT_SIGN_FIELD
Definition: unum.h:367
@ UNUM_EXPONENT_FIELD
Definition: unum.h:369
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301