Gecko [ tanishkshah.com ]

Name	Size	Permission	Date
alphaindex.h	26.48 KB	-rw-r--r--	2022-12-20 12:59
appendable.h	8.49 KB	-rw-r--r--	2022-12-20 12:59
basictz.h	9.27 KB	-rw-r--r--	2022-12-20 12:59
brkiter.h	27.8 KB	-rw-r--r--	2022-12-20 12:59
bytestream.h	10.78 KB	-rw-r--r--	2022-12-20 12:59
bytestrie.h	20.77 KB	-rw-r--r--	2022-12-20 12:59
bytestriebuilder.h	7.08 KB	-rw-r--r--	2022-12-20 12:59
calendar.h	105.74 KB	-rw-r--r--	2022-12-20 12:59
caniter.h	7.43 KB	-rw-r--r--	2022-12-20 12:59
casemap.h	25.33 KB	-rw-r--r--	2022-12-20 12:59
char16ptr.h	7.22 KB	-rw-r--r--	2022-12-20 12:59
chariter.h	24.05 KB	-rw-r--r--	2022-12-20 12:59
choicfmt.h	23.91 KB	-rw-r--r--	2022-12-20 12:59
coleitr.h	13.76 KB	-rw-r--r--	2022-12-20 12:59
coll.h	56.23 KB	-rw-r--r--	2022-12-20 12:59
compactdecimalformat.h	6.88 KB	-rw-r--r--	2022-12-20 12:59
curramt.h	3.76 KB	-rw-r--r--	2022-12-20 12:59
currpinf.h	7.3 KB	-rw-r--r--	2022-12-20 12:59
currunit.h	4 KB	-rw-r--r--	2022-12-20 12:59
datefmt.h	40.67 KB	-rw-r--r--	2022-12-20 12:59
dbbi.h	1.19 KB	-rw-r--r--	2022-12-20 12:59
dcfmtsym.h	20.41 KB	-rw-r--r--	2022-12-20 12:59
decimfmt.h	87.19 KB	-rw-r--r--	2022-12-20 12:59
docmain.h	6.97 KB	-rw-r--r--	2022-12-20 12:59
dtfmtsym.h	37.7 KB	-rw-r--r--	2022-12-20 12:59
dtintrv.h	3.84 KB	-rw-r--r--	2022-12-20 12:59
dtitvfmt.h	46.52 KB	-rw-r--r--	2022-12-20 12:59
dtitvinf.h	18.62 KB	-rw-r--r--	2022-12-20 12:59
dtptngen.h	25.8 KB	-rw-r--r--	2022-12-20 12:59
dtrule.h	8.68 KB	-rw-r--r--	2022-12-20 12:59
edits.h	20.74 KB	-rw-r--r--	2022-12-20 12:59
enumset.h	2.08 KB	-rw-r--r--	2022-12-20 12:59
errorcode.h	4.84 KB	-rw-r--r--	2022-12-20 12:59
fieldpos.h	8.69 KB	-rw-r--r--	2022-12-20 12:59
filteredbrk.h	5.37 KB	-rw-r--r--	2022-12-20 12:59
fmtable.h	24.42 KB	-rw-r--r--	2022-12-20 12:59
format.h	12.5 KB	-rw-r--r--	2022-12-20 12:59
formattedvalue.h	9.75 KB	-rw-r--r--	2022-12-20 12:59
fpositer.h	3.04 KB	-rw-r--r--	2022-12-20 12:59
gender.h	3.33 KB	-rw-r--r--	2022-12-20 12:59
gregocal.h	31.71 KB	-rw-r--r--	2022-12-20 12:59
icudataver.h	1.03 KB	-rw-r--r--	2022-12-20 12:59
icuplug.h	11.88 KB	-rw-r--r--	2022-12-20 12:59
idna.h	12.7 KB	-rw-r--r--	2022-12-20 12:59
listformatter.h	9.27 KB	-rw-r--r--	2022-12-20 12:59
localebuilder.h	11.23 KB	-rw-r--r--	2022-12-20 12:59
localematcher.h	24.56 KB	-rw-r--r--	2022-12-20 12:59
localpointer.h	19.36 KB	-rw-r--r--	2022-12-20 12:59
locdspnm.h	7.12 KB	-rw-r--r--	2022-12-20 12:59
locid.h	47.68 KB	-rw-r--r--	2022-12-20 12:59
measfmt.h	11.33 KB	-rw-r--r--	2022-12-20 12:59
measunit.h	95.28 KB	-rw-r--r--	2022-12-20 12:59
measure.h	4.32 KB	-rw-r--r--	2022-12-20 12:59
messagepattern.h	33.71 KB	-rw-r--r--	2022-12-20 12:59
msgfmt.h	44.11 KB	-rw-r--r--	2022-12-20 12:59
normalizer2.h	34.03 KB	-rw-r--r--	2022-12-20 12:59
normlzr.h	30.94 KB	-rw-r--r--	2022-12-20 12:59
nounit.h	2.69 KB	-rw-r--r--	2022-12-20 12:59
numberformatter.h	84.25 KB	-rw-r--r--	2022-12-20 12:59
numberrangeformatter.h	27.95 KB	-rw-r--r--	2022-12-20 12:59
numfmt.h	49.76 KB	-rw-r--r--	2022-12-20 12:59
numsys.h	7.32 KB	-rw-r--r--	2022-12-20 12:59
parseerr.h	3.08 KB	-rw-r--r--	2022-12-20 12:59
parsepos.h	5.56 KB	-rw-r--r--	2022-12-20 12:59
platform.h	28.08 KB	-rw-r--r--	2022-12-20 12:59
plurfmt.h	25.2 KB	-rw-r--r--	2022-12-20 12:59
plurrule.h	18.34 KB	-rw-r--r--	2022-12-20 12:59
ptypes.h	3.49 KB	-rw-r--r--	2022-12-20 12:59
putil.h	6.33 KB	-rw-r--r--	2022-12-20 12:59
rbbi.h	26.58 KB	-rw-r--r--	2022-12-20 12:59
rbnf.h	48.73 KB	-rw-r--r--	2022-12-20 12:59
rbtz.h	15.6 KB	-rw-r--r--	2022-12-20 12:59
regex.h	84.34 KB	-rw-r--r--	2022-12-20 12:59
region.h	9.18 KB	-rw-r--r--	2022-12-20 12:59
reldatefmt.h	22.27 KB	-rw-r--r--	2022-12-20 12:59
rep.h	9.37 KB	-rw-r--r--	2022-12-20 12:59
resbund.h	18.07 KB	-rw-r--r--	2022-12-20 12:59
schriter.h	6.32 KB	-rw-r--r--	2022-12-20 12:59
scientificnumberformatter.h	6.4 KB	-rw-r--r--	2022-12-20 12:59
search.h	22.22 KB	-rw-r--r--	2022-12-20 12:59
selfmt.h	14.3 KB	-rw-r--r--	2022-12-20 12:59
simpleformatter.h	12.59 KB	-rw-r--r--	2022-12-20 12:59
simpletz.h	45.44 KB	-rw-r--r--	2022-12-20 12:59
smpdtfmt.h	71.01 KB	-rw-r--r--	2022-12-20 12:59
sortkey.h	11.18 KB	-rw-r--r--	2022-12-20 12:59
std_string.h	1.05 KB	-rw-r--r--	2022-12-20 12:59
strenum.h	9.92 KB	-rw-r--r--	2022-12-20 12:59
stringoptions.h	5.79 KB	-rw-r--r--	2022-12-20 12:59
stringpiece.h	10.35 KB	-rw-r--r--	2022-12-20 12:59
stringtriebuilder.h	15.33 KB	-rw-r--r--	2022-12-20 12:59
stsearch.h	21.3 KB	-rw-r--r--	2022-12-20 12:59
symtable.h	4.27 KB	-rw-r--r--	2022-12-20 12:59
tblcoll.h	36.61 KB	-rw-r--r--	2022-12-20 12:59
timezone.h	41.02 KB	-rw-r--r--	2022-12-20 12:59
tmunit.h	3.38 KB	-rw-r--r--	2022-12-20 12:59
tmutamt.h	4.9 KB	-rw-r--r--	2022-12-20 12:59
tmutfmt.h	7.85 KB	-rw-r--r--	2022-12-20 12:59
translit.h	65.82 KB	-rw-r--r--	2022-12-20 12:59
tzfmt.h	42.89 KB	-rw-r--r--	2022-12-20 12:59
tznames.h	16.85 KB	-rw-r--r--	2022-12-20 12:59
tzrule.h	35.37 KB	-rw-r--r--	2022-12-20 12:59
tztrans.h	6.12 KB	-rw-r--r--	2022-12-20 12:59
ubidi.h	89.56 KB	-rw-r--r--	2022-12-20 12:59
ubiditransform.h	12.65 KB	-rw-r--r--	2022-12-20 12:59
ubrk.h	23.97 KB	-rw-r--r--	2022-12-20 12:59
ucal.h	56.9 KB	-rw-r--r--	2022-12-20 12:59
ucasemap.h	15.18 KB	-rw-r--r--	2022-12-20 12:59
ucat.h	5.36 KB	-rw-r--r--	2022-12-20 12:59
uchar.h	141.24 KB	-rw-r--r--	2022-12-20 12:59
ucharstrie.h	22.58 KB	-rw-r--r--	2022-12-20 12:59
ucharstriebuilder.h	7.21 KB	-rw-r--r--	2022-12-20 12:59
uchriter.h	13.2 KB	-rw-r--r--	2022-12-20 12:59
uclean.h	11.21 KB	-rw-r--r--	2022-12-20 12:59
ucnv.h	83.09 KB	-rw-r--r--	2022-12-20 12:59
ucnv_cb.h	6.59 KB	-rw-r--r--	2022-12-20 12:59
ucnv_err.h	20.99 KB	-rw-r--r--	2022-12-20 12:59
ucnvsel.h	6.14 KB	-rw-r--r--	2022-12-20 12:59
ucol.h	61.46 KB	-rw-r--r--	2022-12-20 12:59
ucoleitr.h	9.46 KB	-rw-r--r--	2022-12-20 12:59
uconfig.h	12.07 KB	-rw-r--r--	2022-12-20 12:59
ucpmap.h	5.53 KB	-rw-r--r--	2022-12-20 12:59
ucptrie.h	22.46 KB	-rw-r--r--	2022-12-20 12:59
ucsdet.h	14.67 KB	-rw-r--r--	2022-12-20 12:59
ucurr.h	16.12 KB	-rw-r--r--	2022-12-20 12:59
udat.h	61.38 KB	-rw-r--r--	2022-12-20 12:59
udata.h	15.56 KB	-rw-r--r--	2022-12-20 12:59
udateintervalformat.h	10.74 KB	-rw-r--r--	2022-12-20 12:59
udatpg.h	26.8 KB	-rw-r--r--	2022-12-20 12:59
udisplaycontext.h	5.89 KB	-rw-r--r--	2022-12-20 12:59
uenum.h	7.78 KB	-rw-r--r--	2022-12-20 12:59
ufieldpositer.h	4.36 KB	-rw-r--r--	2022-12-20 12:59
uformattable.h	10.94 KB	-rw-r--r--	2022-12-20 12:59
uformattedvalue.h	12.12 KB	-rw-r--r--	2022-12-20 12:59
ugender.h	2 KB	-rw-r--r--	2022-12-20 12:59
uidna.h	33.37 KB	-rw-r--r--	2022-12-20 12:59
uiter.h	22.77 KB	-rw-r--r--	2022-12-20 12:59
uldnames.h	10.45 KB	-rw-r--r--	2022-12-20 12:59
ulistformatter.h	10.83 KB	-rw-r--r--	2022-12-20 12:59
uloc.h	53.16 KB	-rw-r--r--	2022-12-20 12:59
ulocdata.h	11.26 KB	-rw-r--r--	2022-12-20 12:59
umachine.h	14.54 KB	-rw-r--r--	2022-12-20 12:59
umisc.h	1.33 KB	-rw-r--r--	2022-12-20 12:59
umsg.h	24.23 KB	-rw-r--r--	2022-12-20 12:59
umutablecptrie.h	8.24 KB	-rw-r--r--	2022-12-20 12:59
unifilt.h	3.96 KB	-rw-r--r--	2022-12-20 12:59
unifunct.h	4.04 KB	-rw-r--r--	2022-12-20 12:59
unimatch.h	6.1 KB	-rw-r--r--	2022-12-20 12:59
unirepl.h	3.38 KB	-rw-r--r--	2022-12-20 12:59
uniset.h	64.9 KB	-rw-r--r--	2022-12-20 12:59
unistr.h	170.43 KB	-rw-r--r--	2022-12-20 12:59
unorm.h	20.52 KB	-rw-r--r--	2022-12-20 12:59
unorm2.h	24.66 KB	-rw-r--r--	2022-12-20 12:59
unum.h	53.46 KB	-rw-r--r--	2022-12-20 12:59
unumberformatter.h	25.22 KB	-rw-r--r--	2022-12-20 12:59
unumsys.h	7.21 KB	-rw-r--r--	2022-12-20 12:59
uobject.h	10.68 KB	-rw-r--r--	2022-12-20 12:59
upluralrules.h	7.83 KB	-rw-r--r--	2022-12-20 12:59
uregex.h	72.05 KB	-rw-r--r--	2022-12-20 12:59
uregion.h	9.84 KB	-rw-r--r--	2022-12-20 12:59
ureldatefmt.h	17 KB	-rw-r--r--	2022-12-20 12:59
urename.h	131.3 KB	-rw-r--r--	2022-12-20 12:59
urep.h	5.38 KB	-rw-r--r--	2022-12-20 12:59
ures.h	36.54 KB	-rw-r--r--	2022-12-20 12:59
uscript.h	27.21 KB	-rw-r--r--	2022-12-20 12:59
usearch.h	38.12 KB	-rw-r--r--	2022-12-20 12:59
uset.h	40 KB	-rw-r--r--	2022-12-20 12:59
usetiter.h	9.55 KB	-rw-r--r--	2022-12-20 12:59
ushape.h	18 KB	-rw-r--r--	2022-12-20 12:59
uspoof.h	65.9 KB	-rw-r--r--	2022-12-20 12:59
usprep.h	8.14 KB	-rw-r--r--	2022-12-20 12:59
ustdio.h	38.54 KB	-rw-r--r--	2022-12-20 12:59
ustream.h	1.89 KB	-rw-r--r--	2022-12-20 12:59
ustring.h	72.47 KB	-rw-r--r--	2022-12-20 12:59
ustringtrie.h	3.15 KB	-rw-r--r--	2022-12-20 12:59
utext.h	58.13 KB	-rw-r--r--	2022-12-20 12:59
utf.h	7.86 KB	-rw-r--r--	2022-12-20 12:59
utf16.h	23.32 KB	-rw-r--r--	2022-12-20 12:59
utf32.h	763 B	-rw-r--r--	2022-12-20 12:59
utf8.h	30.96 KB	-rw-r--r--	2022-12-20 12:59
utf_old.h	45.83 KB	-rw-r--r--	2022-12-20 12:59
utmscale.h	13.78 KB	-rw-r--r--	2022-12-20 12:59
utrace.h	17.29 KB	-rw-r--r--	2022-12-20 12:59
utrans.h	25.52 KB	-rw-r--r--	2022-12-20 12:59
utypes.h	30.74 KB	-rw-r--r--	2022-12-20 12:59
uvernum.h	6.67 KB	-rw-r--r--	2022-12-20 12:59
uversion.h	6 KB	-rw-r--r--	2022-12-20 12:59
vtzone.h	20.3 KB	-rw-r--r--	2022-12-20 12:59

Rename

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

#ifndef __UFORMATTEDVALUE_H__
#define __UFORMATTEDVALUE_H__

#include "unicode/utypes.h"

#if !UCONFIG_NO_FORMATTING

#include "unicode/ufieldpositer.h"

/**
 * \file
 * \brief C API: Abstract operations for localized strings.
 * 
 * This file contains declarations for classes that deal with formatted strings. A number
 * of APIs throughout ICU use these classes for expressing their localized output.
 */

/**
 * All possible field categories in ICU. Every entry in this enum corresponds
 * to another enum that exists in ICU.
 * 
 * In the APIs that take a UFieldCategory, an int32_t type is used. Field
 * categories having any of the top four bits turned on are reserved as
 * private-use for external APIs implementing FormattedValue. This means that
 * categories 2^28 and higher or below zero (with the highest bit turned on)
 * are private-use and will not be used by ICU in the future.
 *
 * @stable ICU 64
 */
typedef enum UFieldCategory {
    /**
     * For an undefined field category.
     * 
     * @stable ICU 64
     */
    UFIELD_CATEGORY_UNDEFINED = 0,

/**
     * For fields in UDateFormatField (udat.h), from ICU 3.0.
     *
     * @stable ICU 64
     */
    UFIELD_CATEGORY_DATE,

/**
     * For fields in UNumberFormatFields (unum.h), from ICU 49.
     *
     * @stable ICU 64
     */
    UFIELD_CATEGORY_NUMBER,

/**
     * For fields in UListFormatterField (ulistformatter.h), from ICU 63.
     *
     * @stable ICU 64
     */
    UFIELD_CATEGORY_LIST,

/**
     * For fields in URelativeDateTimeFormatterField (ureldatefmt.h), from ICU 64.
     *
     * @stable ICU 64
     */
    UFIELD_CATEGORY_RELATIVE_DATETIME,

/**
     * Reserved for possible future fields in UDateIntervalFormatField.
     *
     * @internal
     */
    UFIELD_CATEGORY_DATE_INTERVAL,

#ifndef U_HIDE_INTERNAL_API
    /** @internal */
    UFIELD_CATEGORY_COUNT,
#endif  /* U_HIDE_INTERNAL_API */

/**
     * Category for spans in a list.
     *
     * @stable ICU 64
     */
    UFIELD_CATEGORY_LIST_SPAN = 0x1000 + UFIELD_CATEGORY_LIST,

/**
     * Category for spans in a date interval.
     *
     * @stable ICU 64
     */
    UFIELD_CATEGORY_DATE_INTERVAL_SPAN = 0x1000 + UFIELD_CATEGORY_DATE_INTERVAL,

} UFieldCategory;

struct UConstrainedFieldPosition;
/**
 * Represents a span of a string containing a given field.
 *
 * This struct differs from UFieldPosition in the following ways:
 *
 *   1. It has information on the field category.
 *   2. It allows you to set constraints to use when iterating over field positions.
 *   3. It is used for the newer FormattedValue APIs.
 *
 * @stable ICU 64
 */
typedef struct UConstrainedFieldPosition UConstrainedFieldPosition;

/**
 * Creates a new UConstrainedFieldPosition.
 *
 * By default, the UConstrainedFieldPosition has no iteration constraints.
 *
 * @param ec Set if an error occurs.
 * @return The new object, or NULL if an error occurs.
 * @stable ICU 64
 */
U_STABLE UConstrainedFieldPosition* U_EXPORT2
ucfpos_open(UErrorCode* ec);

/**
 * Resets a UConstrainedFieldPosition to its initial state, as if it were newly created.
 *
 * Removes any constraints that may have been set on the instance.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param ec Set if an error occurs.
 * @stable ICU 64
 */
U_STABLE void U_EXPORT2
ucfpos_reset(
    UConstrainedFieldPosition* ucfpos,
    UErrorCode* ec);

/**
 * Destroys a UConstrainedFieldPosition and releases its memory.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @stable ICU 64
 */
U_STABLE void U_EXPORT2
ucfpos_close(UConstrainedFieldPosition* ucfpos);

/**
 * Sets a constraint on the field category.
 * 
 * When this instance of UConstrainedFieldPosition is passed to ufmtval_nextPosition,
 * positions are skipped unless they have the given category.
 *
 * Any previously set constraints are cleared.
 *
 * For example, to loop over only the number-related fields:
 *
 *     UConstrainedFieldPosition* ucfpos = ucfpos_open(ec);
 *     ucfpos_constrainCategory(ucfpos, UFIELDCATEGORY_NUMBER_FORMAT, ec);
 *     while (ufmtval_nextPosition(ufmtval, ucfpos, ec)) {
 *         // handle the number-related field position
 *     }
 *     ucfpos_close(ucfpos);
 *
 * Changing the constraint while in the middle of iterating over a FormattedValue
 * does not generally have well-defined behavior.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param category The field category to fix when iterating.
 * @param ec Set if an error occurs.
 * @stable ICU 64
 */
U_STABLE void U_EXPORT2
ucfpos_constrainCategory(
    UConstrainedFieldPosition* ucfpos,
    int32_t category,
    UErrorCode* ec);

/**
 * Sets a constraint on the category and field.
 * 
 * When this instance of UConstrainedFieldPosition is passed to ufmtval_nextPosition,
 * positions are skipped unless they have the given category and field.
 *
 * Any previously set constraints are cleared.
 *
 * For example, to loop over all grouping separators:
 *
 *     UConstrainedFieldPosition* ucfpos = ucfpos_open(ec);
 *     ucfpos_constrainField(ucfpos, UFIELDCATEGORY_NUMBER_FORMAT, UNUM_GROUPING_SEPARATOR_FIELD, ec);
 *     while (ufmtval_nextPosition(ufmtval, ucfpos, ec)) {
 *         // handle the grouping separator position
 *     }
 *     ucfpos_close(ucfpos);
 *
 * Changing the constraint while in the middle of iterating over a FormattedValue
 * does not generally have well-defined behavior.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param category The field category to fix when iterating.
 * @param field The field to fix when iterating.
 * @param ec Set if an error occurs.
 * @stable ICU 64
 */
U_STABLE void U_EXPORT2
ucfpos_constrainField(
    UConstrainedFieldPosition* ucfpos,
    int32_t category,
    int32_t field,
    UErrorCode* ec);

/**
 * Gets the field category for the current position.
 *
 * If a category or field constraint was set, this function returns the constrained
 * category. Otherwise, the return value is well-defined only after
 * ufmtval_nextPosition returns TRUE.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param ec Set if an error occurs.
 * @return The field category saved in the instance.
 * @stable ICU 64
 */
U_STABLE int32_t U_EXPORT2
ucfpos_getCategory(
    const UConstrainedFieldPosition* ucfpos,
    UErrorCode* ec);

/**
 * Gets the field for the current position.
 *
 * If a field constraint was set, this function returns the constrained
 * field. Otherwise, the return value is well-defined only after
 * ufmtval_nextPosition returns TRUE.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param ec Set if an error occurs.
 * @return The field saved in the instance.
 * @stable ICU 64
 */
U_STABLE int32_t U_EXPORT2
ucfpos_getField(
    const UConstrainedFieldPosition* ucfpos,
    UErrorCode* ec);

/**
 * Gets the INCLUSIVE start and EXCLUSIVE end index stored for the current position.
 *
 * The output values are well-defined only after ufmtval_nextPosition returns TRUE.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param pStart Set to the start index saved in the instance. Ignored if nullptr.
 * @param pLimit Set to the end index saved in the instance. Ignored if nullptr.
 * @param ec Set if an error occurs.
 * @stable ICU 64
 */
U_STABLE void U_EXPORT2
ucfpos_getIndexes(
    const UConstrainedFieldPosition* ucfpos,
    int32_t* pStart,
    int32_t* pLimit,
    UErrorCode* ec);

/**
 * Gets an int64 that FormattedValue implementations may use for storage.
 *
 * The initial value is zero.
 *
 * Users of FormattedValue should not need to call this method.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param ec Set if an error occurs.
 * @return The current iteration context from ucfpos_setInt64IterationContext.
 * @stable ICU 64
 */
U_STABLE int64_t U_EXPORT2
ucfpos_getInt64IterationContext(
    const UConstrainedFieldPosition* ucfpos,
    UErrorCode* ec);

/**
 * Sets an int64 that FormattedValue implementations may use for storage.
 *
 * Intended to be used by FormattedValue implementations.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param context The new iteration context.
 * @param ec Set if an error occurs.
 * @stable ICU 64
 */
U_STABLE void U_EXPORT2
ucfpos_setInt64IterationContext(
    UConstrainedFieldPosition* ucfpos,
    int64_t context,
    UErrorCode* ec);

/**
 * Determines whether a given field should be included given the
 * constraints.
 *
 * Intended to be used by FormattedValue implementations.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param category The category to test.
 * @param field The field to test.
 * @param ec Set if an error occurs.
 * @stable ICU 64
 */
U_STABLE UBool U_EXPORT2
ucfpos_matchesField(
    const UConstrainedFieldPosition* ucfpos,
    int32_t category,
    int32_t field,
    UErrorCode* ec);

/**
 * Sets new values for the primary public getters.
 *
 * Intended to be used by FormattedValue implementations.
 *
 * It is up to the implementation to ensure that the user-requested
 * constraints are satisfied. This method does not check!
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @param category The new field category.
 * @param field The new field.
 * @param start The new inclusive start index.
 * @param limit The new exclusive end index.
 * @param ec Set if an error occurs.
 * @stable ICU 64
 */
U_STABLE void U_EXPORT2
ucfpos_setState(
    UConstrainedFieldPosition* ucfpos,
    int32_t category,
    int32_t field,
    int32_t start,
    int32_t limit,
    UErrorCode* ec);

struct UFormattedValue;
/**
 * An abstract formatted value: a string with associated field attributes.
 * Many formatters format to types compatible with UFormattedValue.
 *
 * @stable ICU 64
 */
typedef struct UFormattedValue UFormattedValue;

/**
 * Returns a pointer to the formatted string. The pointer is owned by the UFormattedValue. The
 * return value is valid only as long as the UFormattedValue is present and unchanged in memory.
 *
 * The return value is NUL-terminated but could contain internal NULs.
 *
 * @param ufmtval
 *         The object containing the formatted string and attributes.
 * @param pLength Output variable for the length of the string. Ignored if NULL.
 * @param ec Set if an error occurs.
 * @return A NUL-terminated char16 string owned by the UFormattedValue.
 * @stable ICU 64
 */
U_STABLE const UChar* U_EXPORT2
ufmtval_getString(
    const UFormattedValue* ufmtval,
    int32_t* pLength,
    UErrorCode* ec);

/**
 * Iterates over field positions in the UFormattedValue. This lets you determine the position
 * of specific types of substrings, like a month or a decimal separator.
 *
 * To loop over all field positions:
 *
 *     UConstrainedFieldPosition* ucfpos = ucfpos_open(ec);
 *     while (ufmtval_nextPosition(ufmtval, ucfpos, ec)) {
 *         // handle the field position; get information from ucfpos
 *     }
 *     ucfpos_close(ucfpos);
 *
 * @param ufmtval
 *         The object containing the formatted string and attributes.
 * @param ucfpos
 *         The object used for iteration state; can provide constraints to iterate over only
 *         one specific category or field;
 *         see ucfpos_constrainCategory
 *         and ucfpos_constrainField.
 * @param ec Set if an error occurs.
 * @return TRUE if another position was found; FALSE otherwise.
 * @stable ICU 64
 */
U_STABLE UBool U_EXPORT2
ufmtval_nextPosition(
    const UFormattedValue* ufmtval,
    UConstrainedFieldPosition* ucfpos,
    UErrorCode* ec);

#if U_SHOW_CPLUSPLUS_API
U_NAMESPACE_BEGIN

/**
 * \class LocalUConstrainedFieldPositionPointer
 * "Smart pointer" class; closes a UConstrainedFieldPosition via ucfpos_close().
 * For most methods see the LocalPointerBase base class.
 *
 * Usage:
 *
 *     LocalUConstrainedFieldPositionPointer ucfpos(ucfpos_open(ec));
 *     // no need to explicitly call ucfpos_close()
 *
 * @stable ICU 64
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUConstrainedFieldPositionPointer,
    UConstrainedFieldPosition,
    ucfpos_close);

U_NAMESPACE_END
#endif // U_SHOW_CPLUSPLUS_API

#endif /* #if !UCONFIG_NO_FORMATTING */
#endif // __UFORMATTEDVALUE_H__