ICU 75.1 75.1

usimplenumberformatter.h
Go to the documentation of this file.
1 // © 2022 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3
4 #ifndef __USIMPLENUMBERFORMATTER_H__
5 #define __USIMPLENUMBERFORMATTER_H__
6
7 #include "unicode/utypes.h"
8
9 #if !UCONFIG_NO_FORMATTING
10
11 #include "unicode/uformattednumber.h"
12 #include "unicode/unumberoptions.h"
13
58 typedef enum USimpleNumberSign {
64 UNUM_SIMPLE_NUMBER_PLUS_SIGN,
70 UNUM_SIMPLE_NUMBER_NO_SIGN,
76 UNUM_SIMPLE_NUMBER_MINUS_SIGN,
77 } USimpleNumberSign;
78
79
80 struct USimpleNumber;
86 typedef struct USimpleNumber USimpleNumber;
87
88
89 struct USimpleNumberFormatter;
95 typedef struct USimpleNumberFormatter USimpleNumberFormatter;
96
97
103 U_CAPI USimpleNumber* U_EXPORT2
104 usnum_openForInt64(int64_t value, UErrorCode* ec);
105
106
114 U_CAPI void U_EXPORT2
115 usnum_setToInt64(USimpleNumber* unumber, int64_t value, UErrorCode* ec);
116
117
125 U_CAPI void U_EXPORT2
126 usnum_multiplyByPowerOfTen(USimpleNumber* unumber, int32_t power, UErrorCode* ec);
127
128
137 U_CAPI void U_EXPORT2
138 usnum_roundTo(USimpleNumber* unumber, int32_t power, UNumberFormatRoundingMode roundingMode, UErrorCode* ec);
139
140
146 U_CAPI void U_EXPORT2
147 usnum_setMinimumIntegerDigits(USimpleNumber* unumber, int32_t minimumIntegerDigits, UErrorCode* ec);
148
149
155 U_CAPI void U_EXPORT2
156 usnum_setMinimumFractionDigits(USimpleNumber* unumber, int32_t minimumFractionDigits, UErrorCode* ec);
157
158
159 #ifndef U_HIDE_DRAFT_API
165 U_CAPI void U_EXPORT2
166 usnum_setMaximumIntegerDigits(USimpleNumber* unumber, int32_t maximumIntegerDigits, UErrorCode* ec);
167 #endif // U_HIDE_DRAFT_API
168
169
170 #ifndef U_HIDE_DEPRECATED_API
177 U_CAPI void U_EXPORT2
178 usnum_truncateStart(USimpleNumber* unumber, int32_t maximumIntegerDigits, UErrorCode* ec);
179 #endif // U_HIDE_DEPRECATED_API
180
181
191 U_CAPI void U_EXPORT2
192 usnum_setSign(USimpleNumber* unumber, USimpleNumberSign sign, UErrorCode* ec);
193
194
200 U_CAPI USimpleNumberFormatter* U_EXPORT2
201 usnumf_openForLocale(const char* locale, UErrorCode* ec);
202
203
209 U_CAPI USimpleNumberFormatter* U_EXPORT2
210 usnumf_openForLocaleAndGroupingStrategy(
211 const char* locale, UNumberGroupingStrategy groupingStrategy, UErrorCode* ec);
212
213
222 U_CAPI void U_EXPORT2
223 usnumf_format(
224 const USimpleNumberFormatter* uformatter,
225 USimpleNumber* unumber,
226 UFormattedNumber* uresult,
227 UErrorCode* ec);
228
229
237 U_CAPI void U_EXPORT2
238 usnumf_formatInt64(
239 const USimpleNumberFormatter* uformatter,
240 int64_t value,
241 UFormattedNumber* uresult,
242 UErrorCode* ec);
243
244
252 U_CAPI void U_EXPORT2
253 usnum_close(USimpleNumber* unumber);
254
255
261 U_CAPI void U_EXPORT2
262 usnumf_close(USimpleNumberFormatter* uformatter);
263
264
265 #if U_SHOW_CPLUSPLUS_API
266 U_NAMESPACE_BEGIN
267
286 U_DEFINE_LOCAL_OPEN_POINTER(LocalUSimpleNumberPointer, USimpleNumber, usnum_close);
287
303 U_DEFINE_LOCAL_OPEN_POINTER(LocalUSimpleNumberFormatterPointer, USimpleNumberFormatter, usnumf_close);
304
305 U_NAMESPACE_END
306 #endif // U_SHOW_CPLUSPLUS_API
307
308 #endif /* #if !UCONFIG_NO_FORMATTING */
309 #endif //__USIMPLENUMBERFORMATTER_H__
LocalUSimpleNumberFormatterPointer
"Smart pointer" class; closes a USimpleNumberFormatter via usnumf_close().
Definition: usimplenumberformatter.h:286
LocalUSimpleNumberPointer
"Smart pointer" class; closes a USimpleNumber via usnum_close().
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:550
uformattednumber.h
C API: Formatted number result from various number formatting functions.
UFormattedNumber
struct UFormattedNumber UFormattedNumber
C-compatible version of icu::number::FormattedNumber.
Definition: uformattednumber.h:43
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
unumberoptions.h
C API: Header-only input options for various number formatting APIs.
UNumberFormatRoundingMode
UNumberFormatRoundingMode
The possible number format rounding modes.
Definition: unumberoptions.h:28
UNumberGroupingStrategy
UNumberGroupingStrategy
An enum declaring the strategy for when and how to display grouping separators (i....
Definition: unumberoptions.h:96
usnum_openForInt64
U_CAPI USimpleNumber * usnum_openForInt64(int64_t value, UErrorCode *ec)
Creates a new USimpleNumber to be formatted with a USimpleNumberFormatter.
USimpleNumberSign
USimpleNumberSign
An explicit sign option for a SimpleNumber.
Definition: usimplenumberformatter.h:58
UNUM_SIMPLE_NUMBER_MINUS_SIGN
@ UNUM_SIMPLE_NUMBER_MINUS_SIGN
Render a minus sign.
Definition: usimplenumberformatter.h:76
UNUM_SIMPLE_NUMBER_NO_SIGN
@ UNUM_SIMPLE_NUMBER_NO_SIGN
Render no sign.
Definition: usimplenumberformatter.h:70
UNUM_SIMPLE_NUMBER_PLUS_SIGN
@ UNUM_SIMPLE_NUMBER_PLUS_SIGN
Render a plus sign.
Definition: usimplenumberformatter.h:64
usnum_setSign
U_CAPI void usnum_setSign(USimpleNumber *unumber, USimpleNumberSign sign, UErrorCode *ec)
Sets the sign of the number: an explicit plus sign, explicit minus sign, or no sign.
usnum_roundTo
U_CAPI void usnum_roundTo(USimpleNumber *unumber, int32_t power, UNumberFormatRoundingMode roundingMode, UErrorCode *ec)
Rounds the value currently stored in the USimpleNumber to the given power of 10, which can be before ...
usnum_truncateStart
U_CAPI void usnum_truncateStart(USimpleNumber *unumber, int32_t maximumIntegerDigits, UErrorCode *ec)
Alias for setMaximumIntegerDigits.
usnumf_openForLocale
U_CAPI USimpleNumberFormatter * usnumf_openForLocale(const char *locale, UErrorCode *ec)
Creates a new USimpleNumberFormatter with all locale defaults.
usnum_close
U_CAPI void usnum_close(USimpleNumber *unumber)
Frees the memory held by a USimpleNumber.
usnum_setToInt64
U_CAPI void usnum_setToInt64(USimpleNumber *unumber, int64_t value, UErrorCode *ec)
Overwrites the value in a USimpleNumber to an int64_t.
usnumf_formatInt64
U_CAPI void usnumf_formatInt64(const USimpleNumberFormatter *uformatter, int64_t value, UFormattedNumber *uresult, UErrorCode *ec)
Formats an integer using this SimpleNumberFormatter.
usnum_setMaximumIntegerDigits
U_CAPI void usnum_setMaximumIntegerDigits(USimpleNumber *unumber, int32_t maximumIntegerDigits, UErrorCode *ec)
Sets the number of integer digits to the given amount, truncating if necessary.
usnum_setMinimumIntegerDigits
U_CAPI void usnum_setMinimumIntegerDigits(USimpleNumber *unumber, int32_t minimumIntegerDigits, UErrorCode *ec)
Pads the beginning of the number with zeros up to the given minimum number of integer digits.
USimpleNumberFormatter
struct USimpleNumberFormatter USimpleNumberFormatter
C-compatible version of icu::number::SimpleNumberFormatter.
Definition: usimplenumberformatter.h:95
usnumf_close
U_CAPI void usnumf_close(USimpleNumberFormatter *uformatter)
Frees the memory held by a USimpleNumberFormatter.
usnumf_format
U_CAPI void usnumf_format(const USimpleNumberFormatter *uformatter, USimpleNumber *unumber, UFormattedNumber *uresult, UErrorCode *ec)
Formats a number using this SimpleNumberFormatter.
usnumf_openForLocaleAndGroupingStrategy
U_CAPI USimpleNumberFormatter * usnumf_openForLocaleAndGroupingStrategy(const char *locale, UNumberGroupingStrategy groupingStrategy, UErrorCode *ec)
Creates a new USimpleNumberFormatter, overriding the grouping strategy.
USimpleNumber
struct USimpleNumber USimpleNumber
C-compatible version of icu::number::SimpleNumber.
Definition: usimplenumberformatter.h:86
usnum_setMinimumFractionDigits
U_CAPI void usnum_setMinimumFractionDigits(USimpleNumber *unumber, int32_t minimumFractionDigits, UErrorCode *ec)
Pads the end of the number with zeros up to the given minimum number of fraction digits.
usnum_multiplyByPowerOfTen
U_CAPI void usnum_multiplyByPowerOfTen(USimpleNumber *unumber, int32_t power, UErrorCode *ec)
Changes the value of the USimpleNumber by a power of 10.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415