ICU 70.1  70.1
unum.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-2015, International Business Machines Corporation and others.
6 * All Rights Reserved.
7 * Modification History:
8 *
9 * Date Name Description
10 * 06/24/99 helena Integrated Alan's NF enhancements and Java2 bug fixes
11 *******************************************************************************
12 */
13 
14 #ifndef _UNUM
15 #define _UNUM
16 
17 #include "unicode/utypes.h"
18 
19 #if !UCONFIG_NO_FORMATTING
20 
21 #include "unicode/uloc.h"
22 #include "unicode/ucurr.h"
23 #include "unicode/umisc.h"
24 #include "unicode/parseerr.h"
25 #include "unicode/uformattable.h"
27 #include "unicode/ufieldpositer.h"
28 
29 #if U_SHOW_CPLUSPLUS_API
30 #include "unicode/localpointer.h"
31 #endif // U_SHOW_CPLUSPLUS_API
32 
144 typedef void* UNumberFormat;
145 
149 typedef enum UNumberFormatStyle {
253 
254 #ifndef U_HIDE_DEPRECATED_API
255 
260 #endif /* U_HIDE_DEPRECATED_API */
261 
273 
283  UNUM_ROUND_CEILING,
284  UNUM_ROUND_FLOOR,
285  UNUM_ROUND_DOWN,
286  UNUM_ROUND_UP,
292 #ifndef U_HIDE_DEPRECATED_API
293 
298 #endif /* U_HIDE_DEPRECATED_API */
299  UNUM_ROUND_HALFDOWN = UNUM_ROUND_HALFEVEN + 1,
300  UNUM_ROUND_HALFUP,
306 #ifndef U_HIDE_DRAFT_API
307 
322 #endif // U_HIDE_DRAFT_API
324 
329  UNUM_PAD_BEFORE_PREFIX,
330  UNUM_PAD_AFTER_PREFIX,
331  UNUM_PAD_BEFORE_SUFFIX,
332  UNUM_PAD_AFTER_SUFFIX
334 
339 typedef enum UNumberCompactStyle {
346 
358 
359  /* Do not conditionalize the following with #ifndef U_HIDE_DEPRECATED_API,
360  * it is needed for layout of DecimalFormatSymbols object. */
361 #ifndef U_FORCE_HIDE_DEPRECATED_API
362 
367 #endif // U_FORCE_HIDE_DEPRECATED_API
368 };
377 typedef enum UNumberFormatFields {
404 
405 #ifndef U_HIDE_DEPRECATED_API
406 
411 #endif /* U_HIDE_DEPRECATED_API */
413 
414 
436 
474 U_CAPI UNumberFormat* U_EXPORT2
476  const UChar* pattern,
477  int32_t patternLength,
478  const char* locale,
479  UParseError* parseErr,
480  UErrorCode* status);
481 
482 
489 U_CAPI void U_EXPORT2
491 
492 #if U_SHOW_CPLUSPLUS_API
493 
494 U_NAMESPACE_BEGIN
495 
506 
507 U_NAMESPACE_END
508 
509 #endif
510 
519 U_CAPI UNumberFormat* U_EXPORT2
520 unum_clone(const UNumberFormat *fmt,
521  UErrorCode *status);
522 
547 U_CAPI int32_t U_EXPORT2
548 unum_format( const UNumberFormat* fmt,
549  int32_t number,
550  UChar* result,
551  int32_t resultLength,
552  UFieldPosition *pos,
553  UErrorCode* status);
554 
579 U_CAPI int32_t U_EXPORT2
581  int64_t number,
582  UChar* result,
583  int32_t resultLength,
584  UFieldPosition *pos,
585  UErrorCode* status);
586 
611 U_CAPI int32_t U_EXPORT2
612 unum_formatDouble( const UNumberFormat* fmt,
613  double number,
614  UChar* result,
615  int32_t resultLength,
616  UFieldPosition *pos, /* 0 if ignore */
617  UErrorCode* status);
618 
661 U_CAPI int32_t U_EXPORT2
663  double number,
664  UChar* result,
665  int32_t resultLength,
666  UFieldPositionIterator* fpositer,
667  UErrorCode* status);
668 
669 
698 U_CAPI int32_t U_EXPORT2
700  const char * number,
701  int32_t length,
702  UChar* result,
703  int32_t resultLength,
704  UFieldPosition *pos, /* 0 if ignore */
705  UErrorCode* status);
706 
737 U_CAPI int32_t U_EXPORT2
739  double number,
740  UChar* currency,
741  UChar* result,
742  int32_t resultLength,
743  UFieldPosition* pos,
744  UErrorCode* status);
745 
766 U_CAPI int32_t U_EXPORT2
768  const UFormattable *number,
769  UChar *result,
770  int32_t resultLength,
771  UFieldPosition *pos,
772  UErrorCode *status);
773 
793 U_CAPI int32_t U_EXPORT2
794 unum_parse( const UNumberFormat* fmt,
795  const UChar* text,
796  int32_t textLength,
797  int32_t *parsePos /* 0 = start */,
798  UErrorCode *status);
799 
819 U_CAPI int64_t U_EXPORT2
820 unum_parseInt64(const UNumberFormat* fmt,
821  const UChar* text,
822  int32_t textLength,
823  int32_t *parsePos /* 0 = start */,
824  UErrorCode *status);
825 
845 U_CAPI double U_EXPORT2
846 unum_parseDouble( const UNumberFormat* fmt,
847  const UChar* text,
848  int32_t textLength,
849  int32_t *parsePos /* 0 = start */,
850  UErrorCode *status);
851 
852 
880 U_CAPI int32_t U_EXPORT2
882  const UChar* text,
883  int32_t textLength,
884  int32_t *parsePos /* 0 = start */,
885  char *outBuf,
886  int32_t outBufLength,
887  UErrorCode *status);
888 
908 U_CAPI double U_EXPORT2
910  const UChar* text,
911  int32_t textLength,
912  int32_t* parsePos, /* 0 = start */
913  UChar* currency,
914  UErrorCode* status);
915 
936 U_CAPI UFormattable* U_EXPORT2
938  UFormattable *result,
939  const UChar* text,
940  int32_t textLength,
941  int32_t* parsePos, /* 0 = start */
942  UErrorCode* status);
943 
960 U_CAPI void U_EXPORT2
962  UBool localized,
963  const UChar *pattern,
964  int32_t patternLength,
965  UParseError *parseError,
966  UErrorCode *status
967  );
968 
979 U_CAPI const char* U_EXPORT2
980 unum_getAvailable(int32_t localeIndex);
981 
991 U_CAPI int32_t U_EXPORT2
992 unum_countAvailable(void);
993 
994 #if UCONFIG_HAVE_PARSEALLINPUT
995 /* The UNumberFormatAttributeValue type cannot be #ifndef U_HIDE_INTERNAL_API, needed for .h variable declaration */
999 typedef enum UNumberFormatAttributeValue {
1000 #ifndef U_HIDE_INTERNAL_API
1001 
1002  UNUM_NO = 0,
1004  UNUM_YES = 1,
1006  UNUM_MAYBE = 2
1007 #else
1008 
1009  UNUM_FORMAT_ATTRIBUTE_VALUE_HIDDEN
1010 #endif /* U_HIDE_INTERNAL_API */
1011 } UNumberFormatAttributeValue;
1012 #endif
1013 
1061 #if UCONFIG_HAVE_PARSEALLINPUT
1062 
1066  UNUM_PARSE_ALL_INPUT = 20,
1067 #endif
1068 
1080 
1090 
1098 
1099 #ifndef U_HIDE_INTERNAL_API
1100 
1104 #endif /* U_HIDE_INTERNAL_API */
1105 
1119 
1129 
1136 
1145 
1146 #ifndef U_HIDE_INTERNAL_API
1147 
1151 #endif /* U_HIDE_INTERNAL_API */
1152 
1154 
1172 U_CAPI int32_t U_EXPORT2
1173 unum_getAttribute(const UNumberFormat* fmt,
1174  UNumberFormatAttribute attr);
1175 
1195 U_CAPI void U_EXPORT2
1198  int32_t newValue);
1199 
1200 
1215 U_CAPI double U_EXPORT2
1217  UNumberFormatAttribute attr);
1218 
1233 U_CAPI void U_EXPORT2
1236  double newValue);
1237 
1271 
1290 U_CAPI int32_t U_EXPORT2
1293  UChar* result,
1294  int32_t resultLength,
1295  UErrorCode* status);
1296 
1313 U_CAPI void U_EXPORT2
1316  const UChar* newValue,
1317  int32_t newValueLength,
1318  UErrorCode *status);
1319 
1336 U_CAPI int32_t U_EXPORT2
1337 unum_toPattern( const UNumberFormat* fmt,
1338  UBool isPatternLocalized,
1339  UChar* result,
1340  int32_t resultLength,
1341  UErrorCode* status);
1342 
1343 
1348 typedef enum UNumberFormatSymbol {
1424 
1429 
1430 #ifndef U_HIDE_INTERNAL_API
1431 
1435 #endif
1436 
1437 #ifndef U_HIDE_DEPRECATED_API
1438 
1443 #endif /* U_HIDE_DEPRECATED_API */
1445 
1462 U_CAPI int32_t U_EXPORT2
1463 unum_getSymbol(const UNumberFormat *fmt,
1464  UNumberFormatSymbol symbol,
1465  UChar *buffer,
1466  int32_t size,
1467  UErrorCode *status);
1468 
1482 U_CAPI void U_EXPORT2
1484  UNumberFormatSymbol symbol,
1485  const UChar *value,
1486  int32_t length,
1487  UErrorCode *status);
1488 
1489 
1499 U_CAPI const char* U_EXPORT2
1501  ULocDataLocaleType type,
1502  UErrorCode* status);
1503 
1512 U_CAPI void U_EXPORT2
1514 
1524 U_CAPI UDisplayContext U_EXPORT2
1525 unum_getContext(const UNumberFormat *fmt, UDisplayContextType type, UErrorCode* status);
1526 
1527 #endif /* #if !UCONFIG_NO_FORMATTING */
1528 
1529 #endif
UNUM_APPROXIMATELY_SIGN_SYMBOL
@ UNUM_APPROXIMATELY_SIGN_SYMBOL
Approximately sign.
Definition: unum.h:1434
UNUM_INTL_CURRENCY_SYMBOL
@ UNUM_INTL_CURRENCY_SYMBOL
The international currency symbol.
Definition: unum.h:1368
UNUM_MONETARY_SEPARATOR_SYMBOL
@ UNUM_MONETARY_SEPARATOR_SYMBOL
The monetary separator.
Definition: unum.h:1370
unum_open
U_CAPI UNumberFormat * unum_open(UNumberFormatStyle style, const UChar *pattern, int32_t patternLength, const char *locale, UParseError *parseErr, UErrorCode *status)
Create and return a new UNumberFormat for formatting and parsing numbers.
UNUM_SIGNIFICANT_DIGIT_SYMBOL
@ UNUM_SIGNIFICANT_DIGIT_SYMBOL
Significant digit symbol.
Definition: unum.h:1383
unum_getDoubleAttribute
U_CAPI double unum_getDoubleAttribute(const UNumberFormat *fmt, UNumberFormatAttribute attr)
Get a numeric attribute associated with a UNumberFormat.
UNUM_CURRENCY_STANDARD
@ UNUM_CURRENCY_STANDARD
Currency format with a currency symbol, e.g., "$1.00", using non-accounting style for negative values...
Definition: unum.h:252
UNUM_SIGN_ALWAYS_SHOWN
@ UNUM_SIGN_ALWAYS_SHOWN
Formatting: if set to 1, whether to show the plus sign on non-negative numbers.
Definition: unum.h:1144
parseerr.h
C API: Parse Error Information.
UNUM_CURRENCY_CODE
@ UNUM_CURRENCY_CODE
The ISO currency code.
Definition: unum.h:1251
UNUM_PLUS_SIGN_SYMBOL
@ UNUM_PLUS_SIGN_SYMBOL
The plus sign.
Definition: unum.h:1364
UNUM_MINIMUM_GROUPING_DIGITS_AUTO
@ UNUM_MINIMUM_GROUPING_DIGITS_AUTO
Display grouping using the default strategy for all locales.
Definition: unum.h:427
UNUM_NAN_SYMBOL
@ UNUM_NAN_SYMBOL
Nan symbol.
Definition: unum.h:1380
UNUM_LONG
@ UNUM_LONG
Definition: unum.h:343
unum_setContext
U_CAPI void unum_setContext(UNumberFormat *fmt, UDisplayContext value, UErrorCode *status)
Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALO...
UNUM_DECIMAL_COMPACT_SHORT
@ UNUM_DECIMAL_COMPACT_SHORT
Decimal format expressed using compact notation (short form, corresponds to UNumberCompactStyle=UNUM_...
Definition: unum.h:238
UNUM_INTEGER_FIELD
@ UNUM_INTEGER_FIELD
Definition: unum.h:379
UFormattable
void * UFormattable
Opaque type representing various types of data which may be used for formatting and parsing operation...
Definition: uformattable.h:72
unum_formatDoubleForFields
U_CAPI int32_t unum_formatDoubleForFields(const UNumberFormat *format, double number, UChar *result, int32_t resultLength, UFieldPositionIterator *fpositer, UErrorCode *status)
Format a double using a UNumberFormat according to the UNumberFormat's locale, and initialize a UFiel...
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UNumberFormatFields
UNumberFormatFields
FieldPosition and UFieldPosition selectors for format fields defined by NumberFormat and UNumberForma...
Definition: unum.h:377
unum_setDoubleAttribute
U_CAPI void unum_setDoubleAttribute(UNumberFormat *fmt, UNumberFormatAttribute attr, double newValue)
Set a numeric attribute associated with a UNumberFormat.
LocalUNumberFormatPointer
UNUM_CURRENCY_SPACING_COUNT
@ UNUM_CURRENCY_SPACING_COUNT
One more than the highest normal UCurrencySpacing value.
Definition: unum.h:366
UNUM_CASH_CURRENCY
@ UNUM_CASH_CURRENCY
Currency format with a currency symbol given CASH usage, e.g., "NT$3" instead of "NT$3....
Definition: unum.h:231
UNUM_DEFAULT_RULESET
@ UNUM_DEFAULT_RULESET
The default rule set, such as "%spellout-numbering-year:", "%spellout-cardinal:", "%spellout-ordinal-...
Definition: unum.h:1260
UNUM_LIMIT_BOOLEAN_ATTRIBUTE
@ UNUM_LIMIT_BOOLEAN_ATTRIBUTE
Limit of boolean attributes.
Definition: unum.h:1150
UNUM_COMPACT_FIELD
@ UNUM_COMPACT_FIELD
Definition: unum.h:403
UNUM_PUBLIC_RULESETS
@ UNUM_PUBLIC_RULESETS
The public rule sets.
Definition: unum.h:1269
UNUM_FRACTION_DIGITS
@ UNUM_FRACTION_DIGITS
Fraction digits.
Definition: unum.h:1033
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
UNUM_ROUND_HALF_FLOOR
@ UNUM_ROUND_HALF_FLOOR
Rounds ties toward -∞.
Definition: unum.h:321
unum_formatDecimal
U_CAPI int32_t unum_formatDecimal(const UNumberFormat *fmt, const char *number, int32_t length, UChar *result, int32_t resultLength, UFieldPosition *pos, UErrorCode *status)
Format a decimal number using a UNumberFormat.
UNUM_SHORT
@ UNUM_SHORT
Definition: unum.h:341
ULocDataLocaleType
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition: uloc.h:338
UNUM_EXPONENT_SIGN_FIELD
@ UNUM_EXPONENT_SIGN_FIELD
Definition: unum.h:387
unum_setTextAttribute
U_CAPI void unum_setTextAttribute(UNumberFormat *fmt, UNumberFormatTextAttribute tag, const UChar *newValue, int32_t newValueLength, UErrorCode *status)
Set a text attribute associated with a UNumberFormat.
UNUM_DECIMAL_COMPACT_LONG
@ UNUM_DECIMAL_COMPACT_LONG
Decimal format expressed using compact notation (long form, corresponds to UNumberCompactStyle=UNUM_L...
Definition: unum.h:245
UNUM_SPELLOUT
@ UNUM_SPELLOUT
Spellout rule-based format.
Definition: unum.h:185
UNUM_CURRENCY_ISO
@ UNUM_CURRENCY_ISO
Currency format with an ISO currency code, e.g., "USD1.00".
Definition: unum.h:212
UNUM_GROUPING_SIZE
@ UNUM_GROUPING_SIZE
Grouping size.
Definition: unum.h:1037
unum_parseDoubleCurrency
U_CAPI double unum_parseDoubleCurrency(const UNumberFormat *fmt, const UChar *text, int32_t textLength, int32_t *parsePos, UChar *currency, UErrorCode *status)
Parse a string into a double and a currency using a UNumberFormat.
UNUM_MONETARY_GROUPING_SEPARATOR_SYMBOL
@ UNUM_MONETARY_GROUPING_SEPARATOR_SYMBOL
The monetary grouping separator.
Definition: unum.h:1387
UNUM_MIN_FRACTION_DIGITS
@ UNUM_MIN_FRACTION_DIGITS
Minimum fraction digits.
Definition: unum.h:1031
unum_getSymbol
U_CAPI int32_t unum_getSymbol(const UNumberFormat *fmt, UNumberFormatSymbol symbol, UChar *buffer, int32_t size, UErrorCode *status)
Get a symbol associated with a UNumberFormat.
unum_format
U_CAPI int32_t unum_format(const UNumberFormat *fmt, int32_t number, UChar *result, int32_t resultLength, UFieldPosition *pos, UErrorCode *status)
Format an integer using a UNumberFormat.
UNUM_PATTERN_DECIMAL
@ UNUM_PATTERN_DECIMAL
Decimal format defined by a pattern string.
Definition: unum.h:154
UNUM_DIGIT_SYMBOL
@ UNUM_DIGIT_SYMBOL
Character representing a digit in the pattern.
Definition: unum.h:1360
unum_applyPattern
U_CAPI void unum_applyPattern(UNumberFormat *format, UBool localized, const UChar *pattern, int32_t patternLength, UParseError *parseError, UErrorCode *status)
Set the pattern used by a UNumberFormat.
UNUM_CURRENCY_PLURAL
@ UNUM_CURRENCY_PLURAL
Currency format with a pluralized currency name, e.g., "1.00 US dollar" and "3.00 US dollars".
Definition: unum.h:218
UNUM_DECIMAL_ALWAYS_SHOWN
@ UNUM_DECIMAL_ALWAYS_SHOWN
Always show decimal point.
Definition: unum.h:1021
UNUM_DECIMAL_SEPARATOR_FIELD
@ UNUM_DECIMAL_SEPARATOR_FIELD
Definition: unum.h:383
UNUM_THREE_DIGIT_SYMBOL
@ UNUM_THREE_DIGIT_SYMBOL
Three.
Definition: unum.h:1399
unum_parseDouble
U_CAPI double unum_parseDouble(const UNumberFormat *fmt, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status)
Parse a string into a double using a UNumberFormat.
UDisplayContextType
UDisplayContextType
Display context types, for getting values of a particular setting.
Definition: udisplaycontext.h:27
UNUM_FRACTION_FIELD
@ UNUM_FRACTION_FIELD
Definition: unum.h:381
unum_close
U_CAPI void unum_close(UNumberFormat *fmt)
Close a UNumberFormat.
UFieldPositionIterator
struct UFieldPositionIterator UFieldPositionIterator
C typedef for struct UFieldPositionIterator.
Definition: ufieldpositer.h:46
uformattable.h
C API: UFormattable is a thin wrapper for primitive types used for formatting and parsing.
UNUM_CURRENCY_FIELD
@ UNUM_CURRENCY_FIELD
Definition: unum.h:393
umisc.h
C API:misc definitions.
UParseError
A UParseError struct is used to returned detailed information about parsing errors.
Definition: parseerr.h:58
UNumberFormatAttribute
UNumberFormatAttribute
The possible UNumberFormat numeric attributes.
Definition: unum.h:1015
UNUM_EXPONENTIAL_SYMBOL
@ UNUM_EXPONENTIAL_SYMBOL
The exponential symbol.
Definition: unum.h:1372
UNUM_CURRENCY_SURROUNDING_MATCH
@ UNUM_CURRENCY_SURROUNDING_MATCH
Definition: unum.h:355
UNUM_PERMILL_FIELD
@ UNUM_PERMILL_FIELD
Definition: unum.h:397
UNUM_MEASURE_UNIT_FIELD
@ UNUM_MEASURE_UNIT_FIELD
Definition: unum.h:401
UNUM_FORMAT_WIDTH
@ UNUM_FORMAT_WIDTH
The width to which the output of format() is padded.
Definition: unum.h:1043
UNUM_PARSE_NO_EXPONENT
@ UNUM_PARSE_NO_EXPONENT
if this attribute is set to 1, specifies that, if the pattern doesn't contain an exponent,...
Definition: unum.h:1118
unum_setAttribute
U_CAPI void unum_setAttribute(UNumberFormat *fmt, UNumberFormatAttribute attr, int32_t newValue)
Set a numeric attribute associated with a UNumberFormat.
unum_parseToUFormattable
U_CAPI UFormattable * unum_parseToUFormattable(const UNumberFormat *fmt, UFormattable *result, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status)
Parse a UChar string into a UFormattable.
UNUM_MAX_NONBOOLEAN_ATTRIBUTE
@ UNUM_MAX_NONBOOLEAN_ATTRIBUTE
One below the first bitfield-boolean item.
Definition: unum.h:1103
uloc.h
C API: Locale.
UNUM_FORMAT_SYMBOL_COUNT
@ UNUM_FORMAT_SYMBOL_COUNT
One more than the highest normal UNumberFormatSymbol value.
Definition: unum.h:1442
UNUM_PARSE_INT_ONLY
@ UNUM_PARSE_INT_ONLY
Parse integers only.
Definition: unum.h:1017
UNUM_EXPONENT_FIELD
@ UNUM_EXPONENT_FIELD
Definition: unum.h:389
UNUM_ROUND_UNNECESSARY
@ UNUM_ROUND_UNNECESSARY
ROUND_UNNECESSARY reports an error if formatted result is not exact.
Definition: unum.h:305
unum_formatDoubleCurrency
U_CAPI int32_t unum_formatDoubleCurrency(const UNumberFormat *fmt, double number, UChar *currency, UChar *result, int32_t resultLength, UFieldPosition *pos, UErrorCode *status)
Format a double currency amount using a UNumberFormat.
UNUM_PARSE_CASE_SENSITIVE
@ UNUM_PARSE_CASE_SENSITIVE
Parsing: if set to 1, parsing is sensitive to case (lowercase/uppercase).
Definition: unum.h:1135
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
UNUM_FORMAT_FAIL_IF_MORE_THAN_MAX_DIGITS
@ UNUM_FORMAT_FAIL_IF_MORE_THAN_MAX_DIGITS
If 1, specifies that if setting the "max integer digits" attribute would truncate a value,...
Definition: unum.h:1111
UNUM_POSITIVE_SUFFIX
@ UNUM_POSITIVE_SUFFIX
Positive suffix.
Definition: unum.h:1243
UNumberFormatMinimumGroupingDigits
UNumberFormatMinimumGroupingDigits
Selectors with special numeric values to use locale default minimum grouping digits for the DecimalFo...
Definition: unum.h:422
UNUM_SECONDARY_GROUPING_SIZE
@ UNUM_SECONDARY_GROUPING_SIZE
Secondary grouping size.
Definition: unum.h:1047
UNUM_GROUPING_SEPARATOR_SYMBOL
@ UNUM_GROUPING_SEPARATOR_SYMBOL
The grouping separator.
Definition: unum.h:1352
UNUM_EIGHT_DIGIT_SYMBOL
@ UNUM_EIGHT_DIGIT_SYMBOL
Eight.
Definition: unum.h:1419
UNUM_INTEGER_DIGITS
@ UNUM_INTEGER_DIGITS
Integer digits.
Definition: unum.h:1027
UNUM_NINE_DIGIT_SYMBOL
@ UNUM_NINE_DIGIT_SYMBOL
Nine.
Definition: unum.h:1423
UNUM_POSITIVE_PREFIX
@ UNUM_POSITIVE_PREFIX
Positive prefix.
Definition: unum.h:1241
UNUM_PATTERN_SEPARATOR_SYMBOL
@ UNUM_PATTERN_SEPARATOR_SYMBOL
The pattern separator.
Definition: unum.h:1354
UNUM_LENIENT_PARSE
@ UNUM_LENIENT_PARSE
Lenient parse mode used by rule-based formats.
Definition: unum.h:1060
UNUM_ROUND_HALF_CEILING
@ UNUM_ROUND_HALF_CEILING
Rounds ties toward +∞.
Definition: unum.h:316
UNUM_MINUS_SIGN_SYMBOL
@ UNUM_MINUS_SIGN_SYMBOL
The minus sign.
Definition: unum.h:1362
unum_formatInt64
U_CAPI int32_t unum_formatInt64(const UNumberFormat *fmt, int64_t number, UChar *result, int32_t resultLength, UFieldPosition *pos, UErrorCode *status)
Format an int64 using a UNumberFormat.
UCurrencySpacing
UCurrencySpacing
Constants for specifying currency spacing.
Definition: unum.h:351
unum_countAvailable
U_CAPI int32_t unum_countAvailable(void)
Determine how many locales have decimal formatting patterns available.
unum_clone
U_CAPI UNumberFormat * unum_clone(const UNumberFormat *fmt, UErrorCode *status)
Open a copy of a UNumberFormat.
unum_parseDecimal
U_CAPI int32_t unum_parseDecimal(const UNumberFormat *fmt, const UChar *text, int32_t textLength, int32_t *parsePos, char *outBuf, int32_t outBufLength, UErrorCode *status)
Parse a number from a string into an unformatted numeric string using a UNumberFormat.
unum_formatUFormattable
U_CAPI int32_t unum_formatUFormattable(const UNumberFormat *fmt, const UFormattable *number, UChar *result, int32_t resultLength, UFieldPosition *pos, UErrorCode *status)
Format a UFormattable into a string.
UNUM_FOUR_DIGIT_SYMBOL
@ UNUM_FOUR_DIGIT_SYMBOL
Four.
Definition: unum.h:1403
UNUM_PADDING_POSITION
@ UNUM_PADDING_POSITION
The position at which padding will take place.
Definition: unum.h:1045
UNUM_PADDING_CHARACTER
@ UNUM_PADDING_CHARACTER
The character used to pad to the format width.
Definition: unum.h:1249
UNUM_FOUND_HALFEVEN
@ UNUM_FOUND_HALFEVEN
Half-even rounding, misspelled name.
Definition: unum.h:297
UNUM_PARSE_DECIMAL_MARK_REQUIRED
@ UNUM_PARSE_DECIMAL_MARK_REQUIRED
if this attribute is set to 1, specifies that, if the pattern contains a decimal mark the input is re...
Definition: unum.h:1128
UNUM_EXPONENT_MULTIPLICATION_SYMBOL
@ UNUM_EXPONENT_MULTIPLICATION_SYMBOL
Multiplication sign.
Definition: unum.h:1428
UNUM_MIN_SIGNIFICANT_DIGITS
@ UNUM_MIN_SIGNIFICANT_DIGITS
Minimum significant digits.
Definition: unum.h:1053
UNUM_ROUNDING_MODE
@ UNUM_ROUNDING_MODE
Rounding Mode.
Definition: unum.h:1039
ufieldpositer.h
C API: UFieldPositionIterator for use with format APIs.
unum_getContext
U_CAPI UDisplayContext unum_getContext(const UNumberFormat *fmt, UDisplayContextType type, UErrorCode *status)
Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYP...
UNUM_DECIMAL_SEPARATOR_SYMBOL
@ UNUM_DECIMAL_SEPARATOR_SYMBOL
The decimal separator.
Definition: unum.h:1350
unum_parseInt64
U_CAPI int64_t unum_parseInt64(const UNumberFormat *fmt, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status)
Parse a string into an int64 using a UNumberFormat.
UNumberFormatStyle
UNumberFormatStyle
The possible number format styles.
Definition: unum.h:149
UNUM_INFINITY_SYMBOL
@ UNUM_INFINITY_SYMBOL
Infinity symbol.
Definition: unum.h:1378
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
Definition: localpointer.h:550
UFieldPosition
A struct representing a range of text containing a specific field.
Definition: umisc.h:34
UNUM_SEVEN_DIGIT_SYMBOL
@ UNUM_SEVEN_DIGIT_SYMBOL
Seven.
Definition: unum.h:1415
UNUM_SIGNIFICANT_DIGITS_USED
@ UNUM_SIGNIFICANT_DIGITS_USED
Use significant digits.
Definition: unum.h:1050
UNUM_MAX_SIGNIFICANT_DIGITS
@ UNUM_MAX_SIGNIFICANT_DIGITS
Maximum significant digits.
Definition: unum.h:1056
unum_setSymbol
U_CAPI void unum_setSymbol(UNumberFormat *fmt, UNumberFormatSymbol symbol, const UChar *value, int32_t length, UErrorCode *status)
Set a symbol associated with a UNumberFormat.
ucurr.h
C API: Encapsulates information about a currency.
UNUM_PERCENT
@ UNUM_PERCENT
Percent format.
Definition: unum.h:173
unum_getAttribute
U_CAPI int32_t unum_getAttribute(const UNumberFormat *fmt, UNumberFormatAttribute attr)
Get a numeric attribute associated with a UNumberFormat.
UNUM_GROUPING_SEPARATOR_FIELD
@ UNUM_GROUPING_SEPARATOR_FIELD
Definition: unum.h:391
UNUM_ROUND_HALFEVEN
@ UNUM_ROUND_HALFEVEN
Half-even rounding.
Definition: unum.h:291
UNUM_NEGATIVE_SUFFIX
@ UNUM_NEGATIVE_SUFFIX
Negative suffix.
Definition: unum.h:1247
UNUM_FIELD_COUNT
@ UNUM_FIELD_COUNT
One more than the highest normal UNumberFormatFields value.
Definition: unum.h:410
UNumberFormatSymbol
UNumberFormatSymbol
Constants for specifying a number format symbol.
Definition: unum.h:1348
UNUM_CURRENCY_MATCH
@ UNUM_CURRENCY_MATCH
Definition: unum.h:353
UNUM_PERCENT_SYMBOL
@ UNUM_PERCENT_SYMBOL
The percent sign.
Definition: unum.h:1356
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
unum_getTextAttribute
U_CAPI int32_t unum_getTextAttribute(const UNumberFormat *fmt, UNumberFormatTextAttribute tag, UChar *result, int32_t resultLength, UErrorCode *status)
Get a text attribute associated with a UNumberFormat.
unum_getAvailable
const U_CAPI char * unum_getAvailable(int32_t localeIndex)
Get a locale for which decimal formatting patterns are available.
UNUM_MAX_INTEGER_DIGITS
@ UNUM_MAX_INTEGER_DIGITS
Maximum integer digits.
Definition: unum.h:1023
UNUM_CURRENCY_USAGE
@ UNUM_CURRENCY_USAGE
if this attribute is set to 0, it is set to UNUM_CURRENCY_STANDARD purpose, otherwise it is UNUM_CASH...
Definition: unum.h:1097
unum_getLocaleByType
const U_CAPI char * unum_getLocaleByType(const UNumberFormat *fmt, ULocDataLocaleType type, UErrorCode *status)
Get the locale for this number format object.
UNUM_CURRENCY_SYMBOL
@ UNUM_CURRENCY_SYMBOL
The currency symbol.
Definition: unum.h:1366
UNUM_IGNORE
@ UNUM_IGNORE
Alias for UNUM_PATTERN_DECIMAL.
Definition: unum.h:271
UNUM_ZERO_DIGIT_SYMBOL
@ UNUM_ZERO_DIGIT_SYMBOL
Zero.
Definition: unum.h:1358
UNUM_DURATION
@ UNUM_DURATION
Duration rule-based format.
Definition: unum.h:197
UNumberFormatRoundingMode
UNumberFormatRoundingMode
The possible number format rounding modes.
Definition: unum.h:282
UDisplayContext
UDisplayContext
Display context settings.
Definition: udisplaycontext.h:64
unum_parse
U_CAPI int32_t unum_parse(const UNumberFormat *fmt, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status)
Parse a string into an integer using a UNumberFormat.
UNumberFormat
void * UNumberFormat
A number formatter.
Definition: unum.h:144
UNUM_CURRENCY_INSERT
@ UNUM_CURRENCY_INSERT
Definition: unum.h:357
UNUM_SCIENTIFIC
@ UNUM_SCIENTIFIC
Scientific format.
Definition: unum.h:178
UNUM_SCALE
@ UNUM_SCALE
Scale, which adjusts the position of the decimal point when formatting.
Definition: unum.h:1079
UNumberFormatTextAttribute
UNumberFormatTextAttribute
The possible UNumberFormat text attributes.
Definition: unum.h:1239
UNUM_MINIMUM_GROUPING_DIGITS_MIN2
@ UNUM_MINIMUM_GROUPING_DIGITS_MIN2
Display grouping using locale defaults, except do not show grouping on values smaller than 10000 (suc...
Definition: unum.h:434
UNUM_SIGN_FIELD
@ UNUM_SIGN_FIELD
Definition: unum.h:399
UNUM_NEGATIVE_PREFIX
@ UNUM_NEGATIVE_PREFIX
Negative prefix.
Definition: unum.h:1245
UNUM_MAX_FRACTION_DIGITS
@ UNUM_MAX_FRACTION_DIGITS
Maximum fraction digits.
Definition: unum.h:1029
UChar
char16_t UChar
Definition: umachine.h:418
UNUM_MIN_INTEGER_DIGITS
@ UNUM_MIN_INTEGER_DIGITS
Minimum integer digits.
Definition: unum.h:1025
UNUM_ONE_DIGIT_SYMBOL
@ UNUM_ONE_DIGIT_SYMBOL
One.
Definition: unum.h:1391
udisplaycontext.h
C API: Display context types (enum values)
UNUM_DEFAULT
@ UNUM_DEFAULT
Default format.
Definition: unum.h:266
unum_formatDouble
U_CAPI int32_t unum_formatDouble(const UNumberFormat *fmt, double number, UChar *result, int32_t resultLength, UFieldPosition *pos, UErrorCode *status)
Format a double using a UNumberFormat.
UNUM_SIX_DIGIT_SYMBOL
@ UNUM_SIX_DIGIT_SYMBOL
Six.
Definition: unum.h:1411
UNUM_PERCENT_FIELD
@ UNUM_PERCENT_FIELD
Definition: unum.h:395
UNUM_ROUND_HALF_ODD
@ UNUM_ROUND_HALF_ODD
Rounds ties toward the odd number.
Definition: unum.h:311
UNUM_PERMILL_SYMBOL
@ UNUM_PERMILL_SYMBOL
Per mill symbol.
Definition: unum.h:1374
UNUM_CURRENCY
@ UNUM_CURRENCY
Currency format (generic).
Definition: unum.h:168
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
UNUM_GROUPING_USED
@ UNUM_GROUPING_USED
Use grouping separator.
Definition: unum.h:1019
UNUM_MINIMUM_GROUPING_DIGITS
@ UNUM_MINIMUM_GROUPING_DIGITS
Minimum grouping digits; most commonly set to 2 to print "1000" instead of "1,000".
Definition: unum.h:1089
UNumberFormatPadPosition
UNumberFormatPadPosition
The possible number format pad positions.
Definition: unum.h:328
UNUM_FORMAT_STYLE_COUNT
@ UNUM_FORMAT_STYLE_COUNT
One more than the highest normal UNumberFormatStyle value.
Definition: unum.h:259
UNUM_CURRENCY_ACCOUNTING
@ UNUM_CURRENCY_ACCOUNTING
Currency format for accounting, e.g., "($3.00)" for negative currency amount instead of "-$3....
Definition: unum.h:225
UNUM_NUMBERING_SYSTEM
@ UNUM_NUMBERING_SYSTEM
Numbering system rule-based format.
Definition: unum.h:202
UNUM_MULTIPLIER
@ UNUM_MULTIPLIER
Multiplier.
Definition: unum.h:1035
UNUM_PATTERN_RULEBASED
@ UNUM_PATTERN_RULEBASED
Rule-based format defined by a pattern string.
Definition: unum.h:207
UNUM_PAD_ESCAPE_SYMBOL
@ UNUM_PAD_ESCAPE_SYMBOL
Escape padding character.
Definition: unum.h:1376
UNUM_ROUNDING_INCREMENT
@ UNUM_ROUNDING_INCREMENT
Rounding increment.
Definition: unum.h:1041
UNUM_EXPONENT_SYMBOL_FIELD
@ UNUM_EXPONENT_SYMBOL_FIELD
Definition: unum.h:385
UNUM_ORDINAL
@ UNUM_ORDINAL
Ordinal rule-based format .
Definition: unum.h:192
UNUM_FIVE_DIGIT_SYMBOL
@ UNUM_FIVE_DIGIT_SYMBOL
Five.
Definition: unum.h:1407
UNUM_TWO_DIGIT_SYMBOL
@ UNUM_TWO_DIGIT_SYMBOL
Two.
Definition: unum.h:1395
unum_toPattern
U_CAPI int32_t unum_toPattern(const UNumberFormat *fmt, UBool isPatternLocalized, UChar *result, int32_t resultLength, UErrorCode *status)
Extract the pattern from a UNumberFormat.
UNumberCompactStyle
UNumberCompactStyle
Constants for specifying short or long format.
Definition: unum.h:339
UNUM_DECIMAL
@ UNUM_DECIMAL
Decimal format ("normal" style).
Definition: unum.h:159