FM / unicode

/usr/include/unicode

Name	Size	Mode	Actions
alphaindex.h	27118	0644	edit dl rm
appendable.h	8694	0644	edit dl rm
basictz.h	9491	0644	edit dl rm
brkiter.h	28464	0644	edit dl rm
bytestream.h	11037	0644	edit dl rm
bytestrie.h	21266	0644	edit dl rm
bytestriebuilder.h	7248	0644	edit dl rm
calendar.h	108278	0644	edit dl rm
caniter.h	7611	0644	edit dl rm
casemap.h	25933	0644	edit dl rm
char16ptr.h	7393	0644	edit dl rm
chariter.h	24632	0644	edit dl rm
choicfmt.h	24482	0644	edit dl rm
coleitr.h	14094	0644	edit dl rm
coll.h	57581	0644	edit dl rm
compactdecimalformat.h	7047	0644	edit dl rm
curramt.h	3851	0644	edit dl rm
currpinf.h	7473	0644	edit dl rm
currunit.h	4094	0644	edit dl rm
datefmt.h	41641	0644	edit dl rm
dbbi.h	1223	0644	edit dl rm
dcfmtsym.h	20897	0644	edit dl rm
decimfmt.h	89278	0644	edit dl rm
docmain.h	7142	0644	edit dl rm
dtfmtsym.h	38609	0644	edit dl rm
dtintrv.h	3930	0644	edit dl rm
dtitvfmt.h	47634	0644	edit dl rm
dtitvinf.h	19064	0644	edit dl rm
dtptngen.h	26419	0644	edit dl rm
dtrule.h	8888	0644	edit dl rm
edits.h	21237	0644	edit dl rm
enumset.h	2130	0644	edit dl rm
errorcode.h	4956	0644	edit dl rm
fieldpos.h	8899	0644	edit dl rm
filteredbrk.h	5501	0644	edit dl rm
fmtable.h	25007	0644	edit dl rm
format.h	12802	0644	edit dl rm
formattedvalue.h	9987	0644	edit dl rm
fpositer.h	3109	0644	edit dl rm
gender.h	3408	0644	edit dl rm
gregocal.h	32472	0644	edit dl rm
icudataver.h	1051	0644	edit dl rm
icuplug.h	12166	0644	edit dl rm
idna.h	13000	0644	edit dl rm
listformatter.h	9493	0644	edit dl rm
localebuilder.h	11502	0644	edit dl rm
localematcher.h	25147	0644	edit dl rm
localpointer.h	19829	0644	edit dl rm
locdspnm.h	7292	0644	edit dl rm
locid.h	48821	0644	edit dl rm
measfmt.h	11603	0644	edit dl rm
measunit.h	97563	0644	edit dl rm
measure.h	4423	0644	edit dl rm
messagepattern.h	34521	0644	edit dl rm
msgfmt.h	45168	0644	edit dl rm
normalizer2.h	34851	0644	edit dl rm
normlzr.h	31682	0644	edit dl rm
nounit.h	2754	0644	edit dl rm
numberformatter.h	86276	0644	edit dl rm
numberrangeformatter.h	28617	0644	edit dl rm
numfmt.h	50950	0644	edit dl rm
numsys.h	7500	0644	edit dl rm
parseerr.h	3155	0644	edit dl rm
parsepos.h	5692	0644	edit dl rm
platform.h	28751	0644	edit dl rm
plurfmt.h	25800	0644	edit dl rm
plurrule.h	18780	0644	edit dl rm
ptypes.h	3577	0644	edit dl rm
putil.h	6487	0644	edit dl rm
rbbi.h	27218	0644	edit dl rm
rbnf.h	49899	0644	edit dl rm
rbtz.h	15979	0644	edit dl rm
regex.h	86367	0644	edit dl rm
region.h	9404	0644	edit dl rm
reldatefmt.h	22801	0644	edit dl rm
rep.h	9599	0644	edit dl rm
resbund.h	18503	0644	edit dl rm
schriter.h	6475	0644	edit dl rm
scientificnumberformatter.h	6553	0644	edit dl rm
search.h	22757	0644	edit dl rm
selfmt.h	14643	0644	edit dl rm
simpleformatter.h	12888	0644	edit dl rm
simpletz.h	46527	0644	edit dl rm
smpdtfmt.h	72713	0644	edit dl rm
sortkey.h	11444	0644	edit dl rm
std_string.h	1076	0644	edit dl rm
strenum.h	10158	0644	edit dl rm
stringoptions.h	5926	0644	edit dl rm
stringpiece.h	10597	0644	edit dl rm
stringtriebuilder.h	15698	0644	edit dl rm
stsearch.h	21810	0644	edit dl rm
symtable.h	4374	0644	edit dl rm
tblcoll.h	37489	0644	edit dl rm
timezone.h	42005	0644	edit dl rm
tmunit.h	3461	0644	edit dl rm
tmutamt.h	5015	0644	edit dl rm
tmutfmt.h	8042	0644	edit dl rm
translit.h	67400	0644	edit dl rm
tzfmt.h	43916	0644	edit dl rm
tznames.h	17252	0644	edit dl rm
tzrule.h	36215	0644	edit dl rm
tztrans.h	6271	0644	edit dl rm
ubidi.h	91711	0644	edit dl rm
ubiditransform.h	12950	0644	edit dl rm
ubrk.h	24547	0644	edit dl rm
ucal.h	58265	0644	edit dl rm
ucasemap.h	15546	0644	edit dl rm
ucat.h	5484	0644	edit dl rm
uchar.h	144630	0644	edit dl rm
ucharstrie.h	23120	0644	edit dl rm
ucharstriebuilder.h	7378	0644	edit dl rm
uchriter.h	13521	0644	edit dl rm
uclean.h	11474	0644	edit dl rm
ucnv.h	85085	0644	edit dl rm
ucnvsel.h	6283	0644	edit dl rm
ucnv_cb.h	6748	0644	edit dl rm
ucnv_err.h	21492	0644	edit dl rm
ucol.h	62939	0644	edit dl rm
ucoleitr.h	9684	0644	edit dl rm
uconfig.h	12356	0644	edit dl rm
ucpmap.h	5663	0644	edit dl rm
ucptrie.h	23002	0644	edit dl rm
ucsdet.h	15018	0644	edit dl rm
ucurr.h	16507	0644	edit dl rm
udat.h	62851	0644	edit dl rm
udata.h	15930	0644	edit dl rm
udateintervalformat.h	10995	0644	edit dl rm
udatpg.h	27447	0644	edit dl rm
udisplaycontext.h	6029	0644	edit dl rm
uenum.h	7970	0644	edit dl rm
ufieldpositer.h	4461	0644	edit dl rm
uformattable.h	11198	0644	edit dl rm
uformattedvalue.h	12413	0644	edit dl rm
ugender.h	2052	0644	edit dl rm
uidna.h	34169	0644	edit dl rm
uiter.h	23319	0644	edit dl rm
uldnames.h	10702	0644	edit dl rm
ulistformatter.h	11086	0644	edit dl rm
uloc.h	54432	0644	edit dl rm
ulocdata.h	11533	0644	edit dl rm
umachine.h	14884	0644	edit dl rm
umisc.h	1365	0644	edit dl rm
umsg.h	24812	0644	edit dl rm
umutablecptrie.h	8435	0644	edit dl rm
unifilt.h	4055	0644	edit dl rm
unifunct.h	4141	0644	edit dl rm
unimatch.h	6244	0644	edit dl rm
unirepl.h	3464	0644	edit dl rm
uniset.h	66459	0644	edit dl rm
unistr.h	174523	0644	edit dl rm
unorm.h	21015	0644	edit dl rm
unorm2.h	25254	0644	edit dl rm
unum.h	54743	0644	edit dl rm
unumberformatter.h	25824	0644	edit dl rm
unumsys.h	7387	0644	edit dl rm
uobject.h	10936	0644	edit dl rm
upluralrules.h	8013	0644	edit dl rm
uregex.h	73784	0644	edit dl rm
uregion.h	10073	0644	edit dl rm
ureldatefmt.h	17409	0644	edit dl rm
urename.h	134449	0644	edit dl rm
urep.h	5507	0644	edit dl rm
ures.h	37415	0644	edit dl rm
uscript.h	27867	0644	edit dl rm
usearch.h	39039	0644	edit dl rm
uset.h	40958	0644	edit dl rm
usetiter.h	9781	0644	edit dl rm
ushape.h	18432	0644	edit dl rm
uspoof.h	67480	0644	edit dl rm
usprep.h	8331	0644	edit dl rm
ustdio.h	39469	0644	edit dl rm
ustream.h	1934	0644	edit dl rm
ustring.h	74211	0644	edit dl rm
ustringtrie.h	3224	0644	edit dl rm
utext.h	59527	0644	edit dl rm
utf.h	8046	0644	edit dl rm
utf8.h	31700	0644	edit dl rm
utf16.h	23878	0644	edit dl rm
utf32.h	763	0644	edit dl rm
utf_old.h	46929	0644	edit dl rm
utmscale.h	14113	0644	edit dl rm
utrace.h	17706	0644	edit dl rm
utrans.h	26130	0644	edit dl rm
utypes.h	31481	0644	edit dl rm
uvernum.h	6832	0644	edit dl rm
uversion.h	6145	0644	edit dl rm
vtzone.h	20784	0644	edit dl rm

Edit: /usr/include/unicode/unumberformatter.h (25824B)

// © 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>
 */

/**
 * 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}.
 *
 * @stable 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.
 *
 * @stable 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.
 *
 * @stable 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.
 *
 * @stable 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.
 *
 * @stable 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.
     *
     * @stable 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;

/**
 * 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.
 *
 * @stable ICU 63
 */
typedef enum UNumberGroupingStrategy {
 /**
 * Do not display grouping separators in any locale.
 *
 * @stable 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).
 *
 * @stable 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).
 *
 * @stable 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).
 *
 * @stable 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.
     *
     * @stable 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;

/**
 * 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.
 *
 * @stable 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.
 *
 * @stable 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}.
     *
     * @stable ICU 60
     */
            UNUM_SIGN_ALWAYS,

/**
     * Do not show the sign on positive or negative numbers.
     *
     * @stable 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.
 *
 * @stable 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}.
     *
     * @stable 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, numbers that round to zero, or NaN.
     *
     * @stable 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, numbers that round to zero, or NaN. For more
     * information on the accounting format, see the ACCOUNTING sign display strategy.
     *
     * @stable 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;

/**
 * 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>
 *
 * @stable 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.
 *
 * @stable ICU 60
 */
 UNUM_DECIMAL_SEPARATOR_AUTO,

/**
     * Always show the decimal separator, even if there are no digits to display after the separator.
     *
     * @stable 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;

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 if 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);

/**
 * 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 if 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.
 * @stable ICU 64
 */
U_STABLE UNumberFormatter* U_EXPORT2
unumf_openForSkeletonAndLocaleWithError(
       const UChar* skeleton, int32_t skeletonLen, const char* locale, UParseError* perror, UErrorCode* ec);

/**
 * 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);

/**
 * 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.
 * @stable ICU 64
 */
U_STABLE const UFormattedValue* U_EXPORT2
unumf_resultAsValue(const UFormattedNumber* uresult, UErrorCode* ec);

/**
 * 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);

// TODO(ICU-20775): Propose this as API.
// NOTE: This is not currently implemented.
// U_DRAFT int32_t U_EXPORT2
// unumf_resultToDecimalNumber(const UFormattedNumber* uresult, char* buffer, int32_t bufferCapacity,
//                             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 */

cmd: