Gecko [ dallasfobana2023.variationbd.com ]

Name	Size	Permission
alphaindex.h	26.42 KB	-rw-r--r--
appendable.h	8.43 KB	-rw-r--r--
basictz.h	8.84 KB	-rw-r--r--
brkiter.h	27.64 KB	-rw-r--r--
bytestream.h	9.54 KB	-rw-r--r--
bytestrie.h	19.26 KB	-rw-r--r--
bytestriebuilder.h	7.02 KB	-rw-r--r--
calendar.h	105.06 KB	-rw-r--r--
caniter.h	7.37 KB	-rw-r--r--
casemap.h	25.26 KB	-rw-r--r--
char16ptr.h	7.16 KB	-rw-r--r--
chariter.h	24 KB	-rw-r--r--
choicfmt.h	23.85 KB	-rw-r--r--
coleitr.h	13.7 KB	-rw-r--r--
coll.h	55.59 KB	-rw-r--r--
compactdecimalformat.h	6.81 KB	-rw-r--r--
curramt.h	3.69 KB	-rw-r--r--
currpinf.h	7.24 KB	-rw-r--r--
currunit.h	3.99 KB	-rw-r--r--
datefmt.h	40.37 KB	-rw-r--r--
dbbi.h	1.11 KB	-rw-r--r--
dcfmtsym.h	20.1 KB	-rw-r--r--
decimfmt.h	87.82 KB	-rw-r--r--
docmain.h	6.96 KB	-rw-r--r--
dtfmtsym.h	37.64 KB	-rw-r--r--
dtintrv.h	3.78 KB	-rw-r--r--
dtitvfmt.h	46.56 KB	-rw-r--r--
dtitvinf.h	18.46 KB	-rw-r--r--
dtptngen.h	25.08 KB	-rw-r--r--
dtrule.h	8.62 KB	-rw-r--r--
edits.h	20.67 KB	-rw-r--r--
enumset.h	2.08 KB	-rw-r--r--
errorcode.h	4.78 KB	-rw-r--r--
fieldpos.h	8.63 KB	-rw-r--r--
filteredbrk.h	5.24 KB	-rw-r--r--
fmtable.h	24.36 KB	-rw-r--r--
format.h	12.44 KB	-rw-r--r--
formattedvalue.h	9.73 KB	-rw-r--r--
fpositer.h	2.98 KB	-rw-r--r--
gender.h	3.27 KB	-rw-r--r--
gregocal.h	31.57 KB	-rw-r--r--
icudataver.h	1.03 KB	-rw-r--r--
icuplug.h	11.88 KB	-rw-r--r--
idna.h	12.63 KB	-rw-r--r--
listformatter.h	9.42 KB	-rw-r--r--
localebuilder.h	10.54 KB	-rw-r--r--
localpointer.h	19.69 KB	-rw-r--r--
locdspnm.h	7.06 KB	-rw-r--r--
locid.h	44.94 KB	-rw-r--r--
measfmt.h	11.44 KB	-rw-r--r--
measunit.h	88.17 KB	-rw-r--r--
measure.h	4.26 KB	-rw-r--r--
messagepattern.h	33.65 KB	-rw-r--r--
msgfmt.h	44.04 KB	-rw-r--r--
normalizer2.h	33.97 KB	-rw-r--r--
normlzr.h	30.74 KB	-rw-r--r--
nounit.h	2.63 KB	-rw-r--r--
numberformatter.h	84.62 KB	-rw-r--r--
numberrangeformatter.h	29.93 KB	-rw-r--r--
numfmt.h	49.35 KB	-rw-r--r--
numsys.h	7.13 KB	-rw-r--r--
parseerr.h	3.08 KB	-rw-r--r--
parsepos.h	5.5 KB	-rw-r--r--
platform.h	27.1 KB	-rw-r--r--
plurfmt.h	25.18 KB	-rw-r--r--
plurrule.h	18.33 KB	-rw-r--r--
ptypes.h	3.49 KB	-rw-r--r--
putil.h	6.33 KB	-rw-r--r--
rbbi.h	26.42 KB	-rw-r--r--
rbnf.h	49.79 KB	-rw-r--r--
rbtz.h	15.47 KB	-rw-r--r--
regex.h	84.3 KB	-rw-r--r--
region.h	9.12 KB	-rw-r--r--
reldatefmt.h	22.37 KB	-rw-r--r--
rep.h	9.5 KB	-rw-r--r--
resbund.h	18.01 KB	-rw-r--r--
schriter.h	6.26 KB	-rw-r--r--
scientificnumberformatter.h	6.32 KB	-rw-r--r--
search.h	22.21 KB	-rw-r--r--
selfmt.h	14.24 KB	-rw-r--r--
simpleformatter.h	12.53 KB	-rw-r--r--
simpletz.h	45.3 KB	-rw-r--r--
smpdtfmt.h	70.9 KB	-rw-r--r--
sortkey.h	11.12 KB	-rw-r--r--
std_string.h	1015 B	-rw-r--r--
strenum.h	10.04 KB	-rw-r--r--
stringoptions.h	5.79 KB	-rw-r--r--
stringpiece.h	6.46 KB	-rw-r--r--
stringtriebuilder.h	15.27 KB	-rw-r--r--
stsearch.h	21.29 KB	-rw-r--r--
symtable.h	4.21 KB	-rw-r--r--
tblcoll.h	36.4 KB	-rw-r--r--
timezone.h	41.2 KB	-rw-r--r--
tmunit.h	3.29 KB	-rw-r--r--
tmutamt.h	4.8 KB	-rw-r--r--
tmutfmt.h	7.79 KB	-rw-r--r--
translit.h	65.76 KB	-rw-r--r--
tzfmt.h	42.82 KB	-rw-r--r--
tznames.h	16.79 KB	-rw-r--r--
tzrule.h	35.32 KB	-rw-r--r--
tztrans.h	6.07 KB	-rw-r--r--
ubidi.h	89.56 KB	-rw-r--r--
ubiditransform.h	12.65 KB	-rw-r--r--
ubrk.h	23.97 KB	-rw-r--r--
ucal.h	55.54 KB	-rw-r--r--
ucasemap.h	15.18 KB	-rw-r--r--
ucat.h	5.36 KB	-rw-r--r--
uchar.h	140.66 KB	-rw-r--r--
ucharstrie.h	21.06 KB	-rw-r--r--
ucharstriebuilder.h	7.14 KB	-rw-r--r--
uchriter.h	13.14 KB	-rw-r--r--
uclean.h	11.21 KB	-rw-r--r--
ucnv.h	83.09 KB	-rw-r--r--
ucnv_cb.h	6.59 KB	-rw-r--r--
ucnv_err.h	20.99 KB	-rw-r--r--
ucnvsel.h	6.14 KB	-rw-r--r--
ucol.h	61.39 KB	-rw-r--r--
ucoleitr.h	9.46 KB	-rw-r--r--
uconfig.h	12.05 KB	-rw-r--r--
ucpmap.h	5.58 KB	-rw-r--r--
ucptrie.h	22.29 KB	-rw-r--r--
ucsdet.h	14.67 KB	-rw-r--r--
ucurr.h	16.15 KB	-rw-r--r--
udat.h	60.81 KB	-rw-r--r--
udata.h	15.53 KB	-rw-r--r--
udateintervalformat.h	10.03 KB	-rw-r--r--
udatpg.h	25.94 KB	-rw-r--r--
udisplaycontext.h	5.89 KB	-rw-r--r--
uenum.h	7.78 KB	-rw-r--r--
ufieldpositer.h	4.36 KB	-rw-r--r--
uformattable.h	10.94 KB	-rw-r--r--
uformattedvalue.h	12.14 KB	-rw-r--r--
ugender.h	2 KB	-rw-r--r--
uidna.h	33.37 KB	-rw-r--r--
uiter.h	22.77 KB	-rw-r--r--
uldnames.h	10.45 KB	-rw-r--r--
ulistformatter.h	8.83 KB	-rw-r--r--
uloc.h	50.75 KB	-rw-r--r--
ulocdata.h	11.26 KB	-rw-r--r--
umachine.h	13.19 KB	-rw-r--r--
umisc.h	1.33 KB	-rw-r--r--
umsg.h	24.23 KB	-rw-r--r--
umutablecptrie.h	8.28 KB	-rw-r--r--
unifilt.h	3.63 KB	-rw-r--r--
unifunct.h	3.98 KB	-rw-r--r--
unimatch.h	6.04 KB	-rw-r--r--
unirepl.h	3.32 KB	-rw-r--r--
uniset.h	64.88 KB	-rw-r--r--
unistr.h	170.39 KB	-rw-r--r--
unorm.h	20.45 KB	-rw-r--r--
unorm2.h	24.66 KB	-rw-r--r--
unum.h	53.55 KB	-rw-r--r--
unumberformatter.h	25.19 KB	-rw-r--r--
unumsys.h	7.21 KB	-rw-r--r--
uobject.h	10.85 KB	-rw-r--r--
upluralrules.h	7.88 KB	-rw-r--r--
uregex.h	72.05 KB	-rw-r--r--
uregion.h	9.84 KB	-rw-r--r--
ureldatefmt.h	17.26 KB	-rw-r--r--
urename.h	131.4 KB	-rw-r--r--
urep.h	5.38 KB	-rw-r--r--
ures.h	36.54 KB	-rw-r--r--
uscript.h	26.87 KB	-rw-r--r--
usearch.h	38.12 KB	-rw-r--r--
uset.h	40 KB	-rw-r--r--
usetiter.h	9.49 KB	-rw-r--r--
ushape.h	18 KB	-rw-r--r--
uspoof.h	66.03 KB	-rw-r--r--
usprep.h	8.14 KB	-rw-r--r--
ustdio.h	38.54 KB	-rw-r--r--
ustream.h	1.8 KB	-rw-r--r--
ustring.h	72.47 KB	-rw-r--r--
ustringtrie.h	3.15 KB	-rw-r--r--
utext.h	58.11 KB	-rw-r--r--
utf.h	7.86 KB	-rw-r--r--
utf16.h	22.33 KB	-rw-r--r--
utf32.h	763 B	-rw-r--r--
utf8.h	29.96 KB	-rw-r--r--
utf_old.h	43.78 KB	-rw-r--r--
utmscale.h	13.78 KB	-rw-r--r--
utrace.h	13.89 KB	-rw-r--r--
utrans.h	25.54 KB	-rw-r--r--
utypes.h	30.38 KB	-rw-r--r--
uvernum.h	6.67 KB	-rw-r--r--
uversion.h	6.7 KB	-rw-r--r--
vtzone.h	20.17 KB	-rw-r--r--

Code Editor : unumberformatter.h

// © 2018 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html

#include "unicode/utypes.h"

#if !UCONFIG_NO_FORMATTING
#ifndef __UNUMBERFORMATTER_H__
#define __UNUMBERFORMATTER_H__

#include "unicode/parseerr.h"
#include "unicode/ufieldpositer.h"
#include "unicode/umisc.h"
#include "unicode/uformattedvalue.h"

/**
 * \file
 * \brief C-compatible API for localized number formatting; not recommended for C++.
 *
 * This is the C-compatible version of the NumberFormatter API introduced in ICU 60. C++ users should
 * include unicode/numberformatter.h and use the proper C++ APIs.
 *
 * The C API accepts a number skeleton string for specifying the settings for formatting, which covers a
 * very large subset of all possible number formatting features. For more information on number skeleton
 * strings, see unicode/numberformatter.h.
 *
 * When using UNumberFormatter, which is treated as immutable, the results are exported to a mutable
 * UFormattedNumber object, which you subsequently use for populating your string buffer or iterating over
 * the fields.
 *
 * Example code:
 * <pre>
 * // Setup:
 * UErrorCode ec = U_ZERO_ERROR;
 * UNumberFormatter* uformatter = unumf_openForSkeletonAndLocale(u"precision-integer", -1, "en", &ec);
 * UFormattedNumber* uresult = unumf_openResult(&ec);
 * if (U_FAILURE(ec)) { return; }
 *
 * // Format a double:
 * unumf_formatDouble(uformatter, 5142.3, uresult, &ec);
 * if (U_FAILURE(ec)) { return; }
 *
 * // Export the string to a malloc'd buffer:
 * int32_t len = unumf_resultToString(uresult, NULL, 0, &ec);
 * // at this point, ec == U_BUFFER_OVERFLOW_ERROR
 * ec = U_ZERO_ERROR;
 * UChar* buffer = (UChar*) malloc((len+1)*sizeof(UChar));
 * unumf_resultToString(uresult, buffer, len+1, &ec);
 * if (U_FAILURE(ec)) { return; }
 * // buffer should equal "5,142"
 *
 * // Cleanup:
 * unumf_close(uformatter);
 * unumf_closeResult(uresult);
 * free(buffer);
 * </pre>
 *
 * If you are a C++ user linking against the C libraries, you can use the LocalPointer versions of these
 * APIs. The following example uses LocalPointer with the decimal number and field position APIs:
 *
 * <pre>
 * // Setup:
 * LocalUNumberFormatterPointer uformatter(unumf_openForSkeletonAndLocale(u"percent", -1, "en", &ec));
 * LocalUFormattedNumberPointer uresult(unumf_openResult(&ec));
 * if (U_FAILURE(ec)) { return; }
 *
 * // Format a decimal number:
 * unumf_formatDecimal(uformatter.getAlias(), "9.87E-3", -1, uresult.getAlias(), &ec);
 * if (U_FAILURE(ec)) { return; }
 *
 * // Get the location of the percent sign:
 * UFieldPosition ufpos = {UNUM_PERCENT_FIELD, 0, 0};
 * unumf_resultNextFieldPosition(uresult.getAlias(), &ufpos, &ec);
 * // ufpos should contain beginIndex=7 and endIndex=8 since the string is "0.00987%"
 *
 * // No need to do any cleanup since we are using LocalPointer.
 * </pre>
 */

#ifndef U_HIDE_DRAFT_API
/**
 * An enum declaring how to render units, including currencies. Example outputs when formatting 123 USD and 123
 * meters in en-CA:
 *
 * 
 * <ul>
 * <li>NARROW*: "$123.00" and "123 m"
 * <li>SHORT: "US$ 123.00" and "123 m"
 * <li>FULL_NAME: "123.00 US dollars" and "123 meters"
 * <li>ISO_CODE: "USD 123.00" and undefined behavior
 * <li>HIDDEN: "123.00" and "123"
 * </ul>
 *
 * 
 * This enum is similar to {@link UMeasureFormatWidth}.
 *
 * @draft ICU 60
 */
typedef enum UNumberUnitWidth {
 /**
 * Print an abbreviated version of the unit name. Similar to SHORT, but always use the shortest available
 * abbreviation or symbol. This option can be used when the context hints at the identity of the unit. For more
 * information on the difference between NARROW and SHORT, see SHORT.
 *
 * 
 * In CLDR, this option corresponds to the "Narrow" format for measure units and the "¤¤¤¤¤" placeholder for
 * currencies.
 *
 * @draft ICU 60
 */
 UNUM_UNIT_WIDTH_NARROW,

/**
 * Print an abbreviated version of the unit name. Similar to NARROW, but use a slightly wider abbreviation or
 * symbol when there may be ambiguity. This is the default behavior.
 *
 * 
 * For example, in es-US, the SHORT form for Fahrenheit is "{0} °F", but the NARROW form is "{0}°",
 * since Fahrenheit is the customary unit for temperature in that locale.
 *
 * 
 * In CLDR, this option corresponds to the "Short" format for measure units and the "¤" placeholder for
 * currencies.
 *
 * @draft ICU 60
 */
 UNUM_UNIT_WIDTH_SHORT,

/**
 * Print the full name of the unit, without any abbreviations.
 *
 * 
 * In CLDR, this option corresponds to the default format for measure units and the "¤¤¤" placeholder for
 * currencies.
 *
 * @draft ICU 60
 */
 UNUM_UNIT_WIDTH_FULL_NAME,

/**
 * Use the three-digit ISO XXX code in place of the symbol for displaying currencies. The behavior of this
 * option is currently undefined for use with measure units.
 *
 * 
 * In CLDR, this option corresponds to the "¤¤" placeholder for currencies.
 *
 * @draft ICU 60
 */
 UNUM_UNIT_WIDTH_ISO_CODE,

/**
     * Format the number according to the specified unit, but do not display the unit. For currencies, apply
     * monetary symbols and formats as with SHORT, but omit the currency symbol. For measure units, the behavior is
     * equivalent to not specifying the unit at all.
     *
     * @draft ICU 60
     */
            UNUM_UNIT_WIDTH_HIDDEN,

/**
     * One more than the highest UNumberUnitWidth value.
     *
     * @internal ICU 60: The numeric value may change over time; see ICU ticket #12420.
     */
            UNUM_UNIT_WIDTH_COUNT
} UNumberUnitWidth;
#endif  /* U_HIDE_DRAFT_API */

#ifndef U_HIDE_DRAFT_API
/**
 * An enum declaring the strategy for when and how to display grouping separators (i.e., the
 * separator, often a comma or period, after every 2-3 powers of ten). The choices are several
 * pre-built strategies for different use cases that employ locale data whenever possible. Example
 * outputs for 1234 and 1234567 in en-IN:
 *
 * <ul>
 * <li>OFF: 1234 and 12345
 * <li>MIN2: 1234 and 12,34,567
 * <li>AUTO: 1,234 and 12,34,567
 * <li>ON_ALIGNED: 1,234 and 12,34,567
 * <li>THOUSANDS: 1,234 and 1,234,567
 * </ul>
 *
 * 
 * The default is AUTO, which displays grouping separators unless the locale data says that grouping
 * is not customary. To force grouping for all numbers greater than 1000 consistently across locales,
 * use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2
 * or OFF. See the docs of each option for details.
 *
 * 
 * Note: This enum specifies the strategy for grouping sizes. To set which character to use as the
 * grouping separator, use the "symbols" setter.
 *
 * @draft ICU 63
 */
typedef enum UNumberGroupingStrategy {
 /**
 * Do not display grouping separators in any locale.
 *
 * @draft ICU 61
 */
 UNUM_GROUPING_OFF,

/**
 * Display grouping using locale defaults, except do not show grouping on values smaller than
 * 10000 (such that there is a minimum of two digits before the first separator).
 *
 * 
 * Note that locales may restrict grouping separators to be displayed only on 1 million or
 * greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).
 *
 * 
 * Locale data is used to determine whether to separate larger numbers into groups of 2
 * (customary in South Asia) or groups of 3 (customary in Europe and the Americas).
 *
 * @draft ICU 61
 */
 UNUM_GROUPING_MIN2,

/**
 * Display grouping using the default strategy for all locales. This is the default behavior.
 *
 * 
 * Note that locales may restrict grouping separators to be displayed only on 1 million or
 * greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).
 *
 * 
 * Locale data is used to determine whether to separate larger numbers into groups of 2
 * (customary in South Asia) or groups of 3 (customary in Europe and the Americas).
 *
 * @draft ICU 61
 */
 UNUM_GROUPING_AUTO,

/**
 * Always display the grouping separator on values of at least 1000.
 *
 * 
 * This option ignores the locale data that restricts or disables grouping, described in MIN2 and
 * AUTO. This option may be useful to normalize the alignment of numbers, such as in a
 * spreadsheet.
 *
 * 
 * Locale data is used to determine whether to separate larger numbers into groups of 2
 * (customary in South Asia) or groups of 3 (customary in Europe and the Americas).
 *
 * @draft ICU 61
 */
 UNUM_GROUPING_ON_ALIGNED,

/**
     * Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater. Do not use
     * locale data for determining the grouping strategy.
     *
     * @draft ICU 61
     */
            UNUM_GROUPING_THOUSANDS

#ifndef U_HIDE_INTERNAL_API
    ,
    /**
     * One more than the highest UNumberGroupingStrategy value.
     *
     * @internal ICU 62: The numeric value may change over time; see ICU ticket #12420.
     */
            UNUM_GROUPING_COUNT
#endif  /* U_HIDE_INTERNAL_API */

} UNumberGroupingStrategy;

#endif  /* U_HIDE_DRAFT_API */

#ifndef U_HIDE_DRAFT_API
/**
 * An enum declaring how to denote positive and negative numbers. Example outputs when formatting
 * 123, 0, and -123 in en-US:
 *
 * <ul>
 * <li>AUTO: "123", "0", and "-123"
 * <li>ALWAYS: "+123", "+0", and "-123"
 * <li>NEVER: "123", "0", and "123"
 * <li>ACCOUNTING: "$123", "$0", and "($123)"
 * <li>ACCOUNTING_ALWAYS: "+$123", "+$0", and "($123)"
 * <li>EXCEPT_ZERO: "+123", "0", and "-123"
 * <li>ACCOUNTING_EXCEPT_ZERO: "+$123", "$0", and "($123)"
 * </ul>
 *
 * 
 * The exact format, including the position and the code point of the sign, differ by locale.
 *
 * @draft ICU 60
 */
typedef enum UNumberSignDisplay {
 /**
 * Show the minus sign on negative numbers, and do not show the sign on positive numbers. This is the default
 * behavior.
 *
 * @draft ICU 60
 */
 UNUM_SIGN_AUTO,

/**
     * Show the minus sign on negative numbers and the plus sign on positive numbers, including zero.
     * To hide the sign on zero, see {@link UNUM_SIGN_EXCEPT_ZERO}.
     *
     * @draft ICU 60
     */
            UNUM_SIGN_ALWAYS,

/**
     * Do not show the sign on positive or negative numbers.
     *
     * @draft ICU 60
     */
            UNUM_SIGN_NEVER,

/**
 * Use the locale-dependent accounting format on negative numbers, and do not show the sign on positive numbers.
 *
 * 
 * The accounting format is defined in CLDR and varies by locale; in many Western locales, the format is a pair
 * of parentheses around the number.
 *
 * 
 * Note: Since CLDR defines the accounting format in the monetary context only, this option falls back to the
 * AUTO sign display strategy when formatting without a currency unit. This limitation may be lifted in the
 * future.
 *
 * @draft ICU 60
 */
 UNUM_SIGN_ACCOUNTING,

/**
     * Use the locale-dependent accounting format on negative numbers, and show the plus sign on
     * positive numbers, including zero. For more information on the accounting format, see the
     * ACCOUNTING sign display strategy. To hide the sign on zero, see
     * {@link UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO}.
     *
     * @draft ICU 60
     */
            UNUM_SIGN_ACCOUNTING_ALWAYS,

/**
     * Show the minus sign on negative numbers and the plus sign on positive numbers. Do not show a
     * sign on zero.
     *
     * @draft ICU 61
     */
            UNUM_SIGN_EXCEPT_ZERO,

/**
     * Use the locale-dependent accounting format on negative numbers, and show the plus sign on
     * positive numbers. Do not show a sign on zero. For more information on the accounting format,
     * see the ACCOUNTING sign display strategy.
     *
     * @draft ICU 61
     */
            UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO,

/**
     * One more than the highest UNumberSignDisplay value.
     *
     * @internal ICU 60: The numeric value may change over time; see ICU ticket #12420.
     */
            UNUM_SIGN_COUNT
} UNumberSignDisplay;
#endif  /* U_HIDE_DRAFT_API */

#ifndef U_HIDE_DRAFT_API
/**
 * An enum declaring how to render the decimal separator.
 *
 * 
 * <ul>
 * <li>UNUM_DECIMAL_SEPARATOR_AUTO: "1", "1.1"
 * <li>UNUM_DECIMAL_SEPARATOR_ALWAYS: "1.", "1.1"
 * </ul>
 *
 * @draft ICU 60
 */
typedef enum UNumberDecimalSeparatorDisplay {
 /**
 * Show the decimal separator when there are one or more digits to display after the separator, and do not show
 * it otherwise. This is the default behavior.
 *
 * @draft ICU 60
 */
 UNUM_DECIMAL_SEPARATOR_AUTO,

/**
     * Always show the decimal separator, even if there are no digits to display after the separator.
     *
     * @draft ICU 60
     */
            UNUM_DECIMAL_SEPARATOR_ALWAYS,

/**
     * One more than the highest UNumberDecimalSeparatorDisplay value.
     *
     * @internal ICU 60: The numeric value may change over time; see ICU ticket #12420.
     */
            UNUM_DECIMAL_SEPARATOR_COUNT
} UNumberDecimalSeparatorDisplay;
#endif  /* U_HIDE_DRAFT_API */

struct UNumberFormatter;
/**
 * C-compatible version of icu::number::LocalizedNumberFormatter.
 *
 * NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.
 *
 * @stable ICU 62
 */
typedef struct UNumberFormatter UNumberFormatter;

struct UFormattedNumber;
/**
 * C-compatible version of icu::number::FormattedNumber.
 *
 * NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.
 *
 * @stable ICU 62
 */
typedef struct UFormattedNumber UFormattedNumber;

/**
 * Creates a new UNumberFormatter for the given skeleton string and locale. This is currently the only
 * method for creating a new UNumberFormatter.
 *
 * Objects of type UNumberFormatter returned by this method are threadsafe.
 *
 * For more details on skeleton strings, see the documentation in numberformatter.h. For more details on
 * the usage of this API, see the documentation at the top of unumberformatter.h.
 *
 * NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.
 *
 * @param skeleton The skeleton string, like u"percent precision-integer"
 * @param skeletonLen The number of UChars in the skeleton string, or -1 it it is NUL-terminated.
 * @param locale The NUL-terminated locale ID.
 * @param ec Set if an error occurs.
 * @stable ICU 62
 */
U_STABLE UNumberFormatter* U_EXPORT2
unumf_openForSkeletonAndLocale(const UChar* skeleton, int32_t skeletonLen, const char* locale,
                               UErrorCode* ec);

#ifndef U_HIDE_DRAFT_API
/**
 * Like unumf_openForSkeletonAndLocale, but accepts a UParseError, which will be populated with the
 * location of a skeleton syntax error if such a syntax error exists.
 *
 * @param skeleton The skeleton string, like u"percent precision-integer"
 * @param skeletonLen The number of UChars in the skeleton string, or -1 it it is NUL-terminated.
 * @param locale The NUL-terminated locale ID.
 * @param perror A parse error struct populated if an error occurs when parsing. Can be NULL.
 *               If no error occurs, perror->offset will be set to -1.
 * @param ec Set if an error occurs.
 * @draft ICU 64
 */
U_DRAFT UNumberFormatter* U_EXPORT2
unumf_openForSkeletonAndLocaleWithError(
       const UChar* skeleton, int32_t skeletonLen, const char* locale, UParseError* perror, UErrorCode* ec);
#endif  // U_HIDE_DRAFT_API

/**
 * Creates an object to hold the result of a UNumberFormatter
 * operation. The object can be used repeatedly; it is cleared whenever
 * passed to a format function.
 *
 * @param ec Set if an error occurs.
 * @stable ICU 62
 */
U_STABLE UFormattedNumber* U_EXPORT2
unumf_openResult(UErrorCode* ec);

/**
 * Uses a UNumberFormatter to format an integer to a UFormattedNumber. A string, field position, and other
 * information can be retrieved from the UFormattedNumber.
 *
 * The UNumberFormatter can be shared between threads. Each thread should have its own local
 * UFormattedNumber, however, for storing the result of the formatting operation.
 *
 * NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.
 *
 * @param uformatter A formatter object created by unumf_openForSkeletonAndLocale or similar.
 * @param value The number to be formatted.
 * @param uresult The object that will be mutated to store the result; see unumf_openResult.
 * @param ec Set if an error occurs.
 * @stable ICU 62
 */
U_STABLE void U_EXPORT2
unumf_formatInt(const UNumberFormatter* uformatter, int64_t value, UFormattedNumber* uresult,
                UErrorCode* ec);

/**
 * Uses a UNumberFormatter to format a double to a UFormattedNumber. A string, field position, and other
 * information can be retrieved from the UFormattedNumber.
 *
 * The UNumberFormatter can be shared between threads. Each thread should have its own local
 * UFormattedNumber, however, for storing the result of the formatting operation.
 *
 * NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.
 *
 * @param uformatter A formatter object created by unumf_openForSkeletonAndLocale or similar.
 * @param value The number to be formatted.
 * @param uresult The object that will be mutated to store the result; see unumf_openResult.
 * @param ec Set if an error occurs.
 * @stable ICU 62
 */
U_STABLE void U_EXPORT2
unumf_formatDouble(const UNumberFormatter* uformatter, double value, UFormattedNumber* uresult,
                   UErrorCode* ec);

/**
 * Uses a UNumberFormatter to format a decimal number to a UFormattedNumber. A string, field position, and
 * other information can be retrieved from the UFormattedNumber.
 *
 * The UNumberFormatter can be shared between threads. Each thread should have its own local
 * UFormattedNumber, however, for storing the result of the formatting operation.
 *
 * The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic
 * Specification, available at http://speleotrove.com/decimal
 *
 * NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.
 *
 * @param uformatter A formatter object created by unumf_openForSkeletonAndLocale or similar.
 * @param value The numeric string to be formatted.
 * @param valueLen The length of the numeric string, or -1 if it is NUL-terminated.
 * @param uresult The object that will be mutated to store the result; see unumf_openResult.
 * @param ec Set if an error occurs.
 * @stable ICU 62
 */
U_STABLE void U_EXPORT2
unumf_formatDecimal(const UNumberFormatter* uformatter, const char* value, int32_t valueLen,
                    UFormattedNumber* uresult, UErrorCode* ec);

#ifndef U_HIDE_DRAFT_API
/**
 * Returns a representation of a UFormattedNumber as a UFormattedValue,
 * which can be subsequently passed to any API requiring that type.
 *
 * The returned object is owned by the UFormattedNumber and is valid
 * only as long as the UFormattedNumber is present and unchanged in memory.
 *
 * You can think of this method as a cast between types.
 *
 * @param uresult The object containing the formatted string.
 * @param ec Set if an error occurs.
 * @return A UFormattedValue owned by the input object.
 * @draft ICU 64
 */
U_DRAFT const UFormattedValue* U_EXPORT2
unumf_resultAsValue(const UFormattedNumber* uresult, UErrorCode* ec);
#endif  /* U_HIDE_DRAFT_API */

/**
 * Extracts the result number string out of a UFormattedNumber to a UChar buffer if possible.
 * If bufferCapacity is greater than the required length, a terminating NUL is written.
 * If bufferCapacity is less than the required length, an error code is set.
 *
 * Also see ufmtval_getString, which returns a NUL-terminated string:
 *
 *     int32_t len;
 *     const UChar* str = ufmtval_getString(unumf_resultAsValue(uresult, &ec), &len, &ec);
 *
 * NOTE: This is a C-compatible API; C++ users should build against numberformatter.h instead.
 *
 * @param uresult The object containing the formatted number.
 * @param buffer Where to save the string output.
 * @param bufferCapacity The number of UChars available in the buffer.
 * @param ec Set if an error occurs.
 * @return The required length.
 * @stable ICU 62
 */
U_STABLE int32_t U_EXPORT2
unumf_resultToString(const UFormattedNumber* uresult, UChar* buffer, int32_t bufferCapacity,
                     UErrorCode* ec);

/**
 * Determines the start and end indices of the next occurrence of the given field in the
 * output string. This allows you to determine the locations of, for example, the integer part,
 * fraction part, or symbols.
 *
 * This is a simpler but less powerful alternative to {@link ufmtval_nextPosition}.
 *
 * If a field occurs just once, calling this method will find that occurrence and return it. If a
 * field occurs multiple times, this method may be called repeatedly with the following pattern:
 *
 * <pre>
 * UFieldPosition ufpos = {UNUM_GROUPING_SEPARATOR_FIELD, 0, 0};
 * while (unumf_resultNextFieldPosition(uresult, ufpos, &ec)) {
 * // do something with ufpos.
 * }
 * </pre>
 *
 * This method is useful if you know which field to query. If you want all available field position
 * information, use unumf_resultGetAllFieldPositions().
 *
 * NOTE: All fields of the UFieldPosition must be initialized before calling this method.
 *
 * @param uresult The object containing the formatted number.
 * @param ufpos
 * Input+output variable. On input, the "field" property determines which field to look up,
 * and the "endIndex" property determines where to begin the search. On output, the
 * "beginIndex" field is set to the beginning of the first occurrence of the field after the
 * input "endIndex", and "endIndex" is set to the end of that occurrence of the field
 * (exclusive index). If a field position is not found, the FieldPosition is not changed and
 * the method returns FALSE.
 * @param ec Set if an error occurs.
 * @stable ICU 62
 */
U_STABLE UBool U_EXPORT2
unumf_resultNextFieldPosition(const UFormattedNumber* uresult, UFieldPosition* ufpos, UErrorCode* ec);

/**
 * Populates the given iterator with all fields in the formatted output string. This allows you to
 * determine the locations of the integer part, fraction part, and sign.
 *
 * This is an alternative to the more powerful {@link ufmtval_nextPosition} API.
 *
 * If you need information on only one field, use {@link ufmtval_nextPosition} or
 * {@link unumf_resultNextFieldPosition}.
 *
 * @param uresult The object containing the formatted number.
 * @param ufpositer
 *         A pointer to a UFieldPositionIterator created by {@link #ufieldpositer_open}. Iteration
 *         information already present in the UFieldPositionIterator is deleted, and the iterator is reset
 *         to apply to the fields in the formatted string created by this function call. The field values
 *         and indexes returned by {@link #ufieldpositer_next} represent fields denoted by
 *         the UNumberFormatFields enum. Fields are not returned in a guaranteed order. Fields cannot
 *         overlap, but they may nest. For example, 1234 could format as "1,234" which might consist of a
 *         grouping separator field for ',' and an integer field encompassing the entire string.
 * @param ec Set if an error occurs.
 * @stable ICU 62
 */
U_STABLE void U_EXPORT2
unumf_resultGetAllFieldPositions(const UFormattedNumber* uresult, UFieldPositionIterator* ufpositer,
                                 UErrorCode* ec);

/**
 * Releases the UNumberFormatter created by unumf_openForSkeletonAndLocale().
 *
 * @param uformatter An object created by unumf_openForSkeletonAndLocale().
 * @stable ICU 62
 */
U_STABLE void U_EXPORT2
unumf_close(UNumberFormatter* uformatter);

/**
 * Releases the UFormattedNumber created by unumf_openResult().
 *
 * @param uresult An object created by unumf_openResult().
 * @stable ICU 62
 */
U_STABLE void U_EXPORT2
unumf_closeResult(UFormattedNumber* uresult);

#if U_SHOW_CPLUSPLUS_API
U_NAMESPACE_BEGIN

/**
 * \class LocalUNumberFormatterPointer
 * "Smart pointer" class; closes a UNumberFormatter via unumf_close().
 * For most methods see the LocalPointerBase base class.
 *
 * Usage:
 * <pre>
 * LocalUNumberFormatterPointer uformatter(unumf_openForSkeletonAndLocale(...));
 * // no need to explicitly call unumf_close()
 * </pre>
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @stable ICU 62
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUNumberFormatterPointer, UNumberFormatter, unumf_close);

/**
 * \class LocalUFormattedNumberPointer
 * "Smart pointer" class; closes a UFormattedNumber via unumf_closeResult().
 * For most methods see the LocalPointerBase base class.
 *
 * Usage:
 * <pre>
 * LocalUFormattedNumberPointer uformatter(unumf_openResult(...));
 * // no need to explicitly call unumf_closeResult()
 * </pre>
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @stable ICU 62
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattedNumberPointer, UFormattedNumber, unumf_closeResult);

U_NAMESPACE_END
#endif // U_SHOW_CPLUSPLUS_API

#endif //__UNUMBERFORMATTER_H__
#endif /* #if !UCONFIG_NO_FORMATTING */

${this.title}

Code Editor : unumberformatter.h