Gecko [ dallasfobana2023.variationbd.com ]

Name	Size	Permission
alphaindex.h	26.54 KB	-rw-r--r--
appendable.h	8.54 KB	-rw-r--r--
basictz.h	9.99 KB	-rw-r--r--
brkiter.h	27.86 KB	-rw-r--r--
bytestream.h	10.75 KB	-rw-r--r--
bytestrie.h	20.8 KB	-rw-r--r--
bytestriebuilder.h	7.48 KB	-rw-r--r--
calendar.h	106.52 KB	-rw-r--r--
caniter.h	7.47 KB	-rw-r--r--
casemap.h	25.42 KB	-rw-r--r--
char16ptr.h	7.22 KB	-rw-r--r--
chariter.h	24.06 KB	-rw-r--r--
choicfmt.h	24 KB	-rw-r--r--
coleitr.h	13.78 KB	-rw-r--r--
coll.h	56.3 KB	-rw-r--r--
compactdecimalformat.h	6.88 KB	-rw-r--r--
curramt.h	3.67 KB	-rw-r--r--
currpinf.h	7.3 KB	-rw-r--r--
currunit.h	4.02 KB	-rw-r--r--
datefmt.h	40.72 KB	-rw-r--r--
dbbi.h	1.19 KB	-rw-r--r--
dcfmtsym.h	20.94 KB	-rw-r--r--
decimfmt.h	87.54 KB	-rw-r--r--
displayoptions.h	7.08 KB	-rw-r--r--
docmain.h	7.3 KB	-rw-r--r--
dtfmtsym.h	38.23 KB	-rw-r--r--
dtintrv.h	3.85 KB	-rw-r--r--
dtitvfmt.h	49.26 KB	-rw-r--r--
dtitvinf.h	18.63 KB	-rw-r--r--
dtptngen.h	28.64 KB	-rw-r--r--
dtrule.h	8.69 KB	-rw-r--r--
edits.h	20.73 KB	-rw-r--r--
enumset.h	2.08 KB	-rw-r--r--
errorcode.h	4.84 KB	-rw-r--r--
fieldpos.h	8.7 KB	-rw-r--r--
filteredbrk.h	5.37 KB	-rw-r--r--
fmtable.h	24.45 KB	-rw-r--r--
format.h	12.5 KB	-rw-r--r--
formattednumber.h	6.15 KB	-rw-r--r--
formattedvalue.h	9.75 KB	-rw-r--r--
fpositer.h	3.03 KB	-rw-r--r--
gender.h	3.35 KB	-rw-r--r--
gregocal.h	30.03 KB	-rw-r--r--
icudataver.h	1.02 KB	-rw-r--r--
icuplug.h	12.1 KB	-rw-r--r--
idna.h	12.71 KB	-rw-r--r--
listformatter.h	8.59 KB	-rw-r--r--
localebuilder.h	11.08 KB	-rw-r--r--
localematcher.h	26.83 KB	-rw-r--r--
localpointer.h	19.44 KB	-rw-r--r--
locdspnm.h	7.12 KB	-rw-r--r--
locid.h	48.27 KB	-rw-r--r--
measfmt.h	11.42 KB	-rw-r--r--
measunit.h	107.38 KB	-rw-r--r--
measure.h	4.69 KB	-rw-r--r--
messagepattern.h	33.72 KB	-rw-r--r--
msgfmt.h	44.21 KB	-rw-r--r--
normalizer2.h	34.73 KB	-rw-r--r--
normlzr.h	30.97 KB	-rw-r--r--
nounit.h	2.25 KB	-rw-r--r--
numberformatter.h	90.03 KB	-rw-r--r--
numberrangeformatter.h	25.32 KB	-rw-r--r--
numfmt.h	50.26 KB	-rw-r--r--
numsys.h	7.23 KB	-rw-r--r--
parseerr.h	3.08 KB	-rw-r--r--
parsepos.h	5.57 KB	-rw-r--r--
platform.h	27.8 KB	-rw-r--r--
plurfmt.h	25.25 KB	-rw-r--r--
plurrule.h	20.64 KB	-rw-r--r--
ptypes.h	3.49 KB	-rw-r--r--
putil.h	6.32 KB	-rw-r--r--
rbbi.h	32.07 KB	-rw-r--r--
rbnf.h	49.92 KB	-rw-r--r--
rbtz.h	15.77 KB	-rw-r--r--
regex.h	84.45 KB	-rw-r--r--
region.h	9.2 KB	-rw-r--r--
reldatefmt.h	22.36 KB	-rw-r--r--
rep.h	9.38 KB	-rw-r--r--
resbund.h	18.11 KB	-rw-r--r--
schriter.h	6.1 KB	-rw-r--r--
scientificnumberformatter.h	6.44 KB	-rw-r--r--
search.h	22.24 KB	-rw-r--r--
selfmt.h	14.35 KB	-rw-r--r--
simpleformatter.h	12.6 KB	-rw-r--r--
simplenumberformatter.h	8.88 KB	-rw-r--r--
simpletz.h	45.65 KB	-rw-r--r--
smpdtfmt.h	71.85 KB	-rw-r--r--
sortkey.h	11.19 KB	-rw-r--r--
std_string.h	1.05 KB	-rw-r--r--
strenum.h	9.96 KB	-rw-r--r--
stringoptions.h	5.79 KB	-rw-r--r--
stringpiece.h	10.05 KB	-rw-r--r--
stringtriebuilder.h	15.5 KB	-rw-r--r--
stsearch.h	21.44 KB	-rw-r--r--
symtable.h	4.28 KB	-rw-r--r--
tblcoll.h	36.94 KB	-rw-r--r--
timezone.h	45.67 KB	-rw-r--r--
tmunit.h	3.4 KB	-rw-r--r--
tmutamt.h	4.91 KB	-rw-r--r--
tmutfmt.h	7.42 KB	-rw-r--r--
translit.h	65.83 KB	-rw-r--r--
tzfmt.h	42.96 KB	-rw-r--r--
tznames.h	16.85 KB	-rw-r--r--
tzrule.h	34.86 KB	-rw-r--r--
tztrans.h	6.13 KB	-rw-r--r--
ubidi.h	89.61 KB	-rw-r--r--
ubiditransform.h	12.71 KB	-rw-r--r--
ubrk.h	24.43 KB	-rw-r--r--
ucal.h	64.28 KB	-rw-r--r--
ucasemap.h	15.21 KB	-rw-r--r--
ucat.h	5.35 KB	-rw-r--r--
uchar.h	145.7 KB	-rw-r--r--
ucharstrie.h	22.56 KB	-rw-r--r--
ucharstriebuilder.h	7.48 KB	-rw-r--r--
uchriter.h	13.42 KB	-rw-r--r--
uclean.h	11.21 KB	-rw-r--r--
ucnv.h	83.46 KB	-rw-r--r--
ucnv_cb.h	6.58 KB	-rw-r--r--
ucnv_err.h	20.98 KB	-rw-r--r--
ucnvsel.h	6.24 KB	-rw-r--r--
ucol.h	62.7 KB	-rw-r--r--
ucoleitr.h	9.82 KB	-rw-r--r--
uconfig.h	12.31 KB	-rw-r--r--
ucpmap.h	5.54 KB	-rw-r--r--
ucptrie.h	22.51 KB	-rw-r--r--
ucsdet.h	14.69 KB	-rw-r--r--
ucurr.h	16.72 KB	-rw-r--r--
udat.h	62.36 KB	-rw-r--r--
udata.h	15.63 KB	-rw-r--r--
udateintervalformat.h	11.93 KB	-rw-r--r--
udatpg.h	30.13 KB	-rw-r--r--
udisplaycontext.h	5.94 KB	-rw-r--r--
udisplayoptions.h	8.86 KB	-rw-r--r--
uenum.h	7.79 KB	-rw-r--r--
ufieldpositer.h	4.41 KB	-rw-r--r--
uformattable.h	10.97 KB	-rw-r--r--
uformattednumber.h	8.09 KB	-rw-r--r--
uformattedvalue.h	12.25 KB	-rw-r--r--
ugender.h	2.06 KB	-rw-r--r--
uidna.h	33.43 KB	-rw-r--r--
uiter.h	22.75 KB	-rw-r--r--
uldnames.h	10.48 KB	-rw-r--r--
ulistformatter.h	10.78 KB	-rw-r--r--
uloc.h	54.66 KB	-rw-r--r--
ulocale.h	6.35 KB	-rw-r--r--
ulocbuilder.h	16.72 KB	-rw-r--r--
ulocdata.h	11.3 KB	-rw-r--r--
umachine.h	15 KB	-rw-r--r--
umisc.h	1.34 KB	-rw-r--r--
umsg.h	24.25 KB	-rw-r--r--
umutablecptrie.h	8.3 KB	-rw-r--r--
unifilt.h	4 KB	-rw-r--r--
unifunct.h	4.05 KB	-rw-r--r--
unimatch.h	6.1 KB	-rw-r--r--
unirepl.h	3.38 KB	-rw-r--r--
uniset.h	66.85 KB	-rw-r--r--
unistr.h	171.35 KB	-rw-r--r--
unorm.h	20.55 KB	-rw-r--r--
unorm2.h	25.71 KB	-rw-r--r--
unum.h	55.16 KB	-rw-r--r--
unumberformatter.h	19.68 KB	-rw-r--r--
unumberoptions.h	5.23 KB	-rw-r--r--
unumberrangeformatter.h	15.35 KB	-rw-r--r--
unumsys.h	7.26 KB	-rw-r--r--
uobject.h	10.66 KB	-rw-r--r--
upluralrules.h	8.79 KB	-rw-r--r--
uregex.h	71.99 KB	-rw-r--r--
uregion.h	9.81 KB	-rw-r--r--
ureldatefmt.h	16.98 KB	-rw-r--r--
urename.h	140.82 KB	-rw-r--r--
urep.h	5.38 KB	-rw-r--r--
ures.h	36.65 KB	-rw-r--r--
uscript.h	27.8 KB	-rw-r--r--
usearch.h	39.21 KB	-rw-r--r--
uset.h	45.61 KB	-rw-r--r--
usetiter.h	9.63 KB	-rw-r--r--
ushape.h	18 KB	-rw-r--r--
usimplenumberformatter.h	7.46 KB	-rw-r--r--
uspoof.h	80.32 KB	-rw-r--r--
usprep.h	8.19 KB	-rw-r--r--
ustdio.h	38.56 KB	-rw-r--r--
ustream.h	1.89 KB	-rw-r--r--
ustring.h	72.13 KB	-rw-r--r--
ustringtrie.h	3.15 KB	-rw-r--r--
utext.h	58.1 KB	-rw-r--r--
utf.h	7.87 KB	-rw-r--r--
utf16.h	23.35 KB	-rw-r--r--
utf32.h	763 B	-rw-r--r--
utf8.h	30.83 KB	-rw-r--r--
utf_old.h	45.8 KB	-rw-r--r--
utmscale.h	13.78 KB	-rw-r--r--
utrace.h	17.18 KB	-rw-r--r--
utrans.h	25.54 KB	-rw-r--r--
utypes.h	31.06 KB	-rw-r--r--
uvernum.h	6.33 KB	-rw-r--r--
uversion.h	5.99 KB	-rw-r--r--
vtzone.h	20.69 KB	-rw-r--r--

Code Editor : uformattednumber.h

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

#ifndef __UFORMATTEDNUMBER_H__
#define __UFORMATTEDNUMBER_H__

#include "unicode/utypes.h"

#if !UCONFIG_NO_FORMATTING

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

/**
 * \file
 * \brief C API: Formatted number result from various number formatting functions.
 *
 * Create a `UFormattedNumber` to hold the result of a number formatting operation. The same
 * `UFormattedNumber` can be reused multiple times.
 *
 * <pre>
 * LocalUFormattedNumberPointer uresult(unumf_openResult(status));
 *
 * // pass uresult.getAlias() to your number formatter
 *
 * int32_t length;
 * const UChar* s = ufmtval_getString(unumf_resultAsValue(uresult.getAlias(), status), &length, status));
 *
 * // The string result is in `s` with the given `length` (it is also NUL-terminated).
 * </pre>
 */

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 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_CAPI UFormattedNumber* U_EXPORT2
unumf_openResult(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_CAPI 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_CAPI 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 <em>field</em> 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_CAPI 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_CAPI void U_EXPORT2
unumf_resultGetAllFieldPositions(const UFormattedNumber* uresult, UFieldPositionIterator* ufpositer,
                                 UErrorCode* ec);

/**
 * Extracts the formatted number as a "numeric string" conforming to the
 * syntax defined in the Decimal Arithmetic Specification, available at
 * http://speleotrove.com/decimal
 *
 * This endpoint is useful for obtaining the exact number being printed
 * after scaling and rounding have been applied by the number formatter.
 *
 * @param uresult        The input object containing the formatted number.
 * @param  dest          the 8-bit char buffer into which the decimal number is placed
 * @param  destCapacity  The size, in chars, of the destination buffer.  May be zero
 *                       for precomputing the required size.
 * @param  ec            receives any error status.
 *                       If U_BUFFER_OVERFLOW_ERROR: Returns number of chars for
 *                       preflighting.
 * @return Number of chars in the data.  Does not include a trailing NUL.
 * @stable ICU 68
 */
U_CAPI int32_t U_EXPORT2
unumf_resultToDecimalNumber(
       const UFormattedNumber* uresult,
       char* dest,
       int32_t destCapacity,
       UErrorCode* ec);

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

#if U_SHOW_CPLUSPLUS_API
U_NAMESPACE_BEGIN

/**
 * \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 /* #if !UCONFIG_NO_FORMATTING */
#endif //__UFORMATTEDNUMBER_H__

${this.title}

Code Editor : uformattednumber.h