OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	05/14/2024 03:54:45 PM	rwxr-xr-x
📄 alphaindex.h	26.52 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 appendable.h	8.53 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 basictz.h	9.86 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 brkiter.h	27.81 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 bytestream.h	10.75 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 bytestrie.h	20.77 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 bytestriebuilder.h	7.46 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 calendar.h	105.88 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 caniter.h	7.44 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 casemap.h	25.33 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 char16ptr.h	7.22 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 chariter.h	24.06 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 choicfmt.h	23.97 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 coleitr.h	13.77 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 coll.h	56.26 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 compactdecimalformat.h	6.88 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 curramt.h	3.78 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 currpinf.h	7.3 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 currunit.h	4.02 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 datefmt.h	40.71 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dbbi.h	1.19 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 dcfmtsym.h	20.61 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 decimfmt.h	87.57 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 docmain.h	7.21 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 dtfmtsym.h	38.21 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtintrv.h	3.84 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 dtitvfmt.h	49.27 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtitvinf.h	18.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtptngen.h	28.84 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtrule.h	8.69 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 edits.h	20.74 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 enumset.h	2.08 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 errorcode.h	4.84 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 fieldpos.h	8.7 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 filteredbrk.h	5.37 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 fmtable.h	24.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 format.h	12.5 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 formattedvalue.h	9.75 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 fpositer.h	3.03 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 gender.h	3.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 gregocal.h	31.88 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 icudataver.h	1.02 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 icuplug.h	11.83 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 idna.h	12.7 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 listformatter.h	8.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 localebuilder.h	11.08 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 localematcher.h	26.84 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 localpointer.h	19.36 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 locdspnm.h	7.12 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 locid.h	47.66 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 measfmt.h	11.42 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 measunit.h	104.97 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 measure.h	4.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 messagepattern.h	33.71 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 msgfmt.h	44.22 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 normalizer2.h	33.66 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 normlzr.h	30.95 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 nounit.h	2.25 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numberformatter.h	94.15 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numberrangeformatter.h	25.19 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numfmt.h	49.84 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numsys.h	7.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 parseerr.h	3.08 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 parsepos.h	5.57 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 platform.h	28.09 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 plurfmt.h	25.24 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 plurrule.h	20.82 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ptypes.h	3.49 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 putil.h	6.32 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rbbi.h	28.64 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rbnf.h	48.85 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rbtz.h	15.77 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 regex.h	84.36 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 region.h	9.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 reldatefmt.h	22.22 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rep.h	9.37 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 resbund.h	18.08 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 schriter.h	6.36 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 scientificnumberformatter.h	6.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 search.h	22.22 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 selfmt.h	14.34 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 simpleformatter.h	12.59 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 simpletz.h	45.64 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 smpdtfmt.h	71.07 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 sortkey.h	11.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 std_string.h	1.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 strenum.h	9.92 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stringoptions.h	5.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stringpiece.h	10.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stringtriebuilder.h	15.47 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stsearch.h	21.41 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 symtable.h	4.27 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tblcoll.h	36.92 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 timezone.h	43.81 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tmunit.h	3.4 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tmutamt.h	4.91 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tmutfmt.h	7.42 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 translit.h	65.82 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tzfmt.h	42.93 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tznames.h	16.85 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tzrule.h	35.6 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tztrans.h	6.13 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ubidi.h	89.61 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ubiditransform.h	12.7 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ubrk.h	24.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucal.h	60.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucasemap.h	15.21 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucat.h	5.35 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uchar.h	144.64 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucharstrie.h	22.53 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucharstriebuilder.h	7.47 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uchriter.h	13.42 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uclean.h	11.2 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnv.h	83.46 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnv_cb.h	6.58 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnv_err.h	20.98 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnvsel.h	6.19 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucol.h	61.95 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucoleitr.h	9.82 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uconfig.h	12.07 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucpmap.h	5.53 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucptrie.h	22.5 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucsdet.h	14.69 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucurr.h	16.72 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udat.h	62.4 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udata.h	15.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udateintervalformat.h	11.93 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udatpg.h	30.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udisplaycontext.h	5.94 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uenum.h	7.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ufieldpositer.h	4.41 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uformattable.h	10.97 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uformattedvalue.h	12.3 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ugender.h	2.06 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uidna.h	33.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uiter.h	22.75 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uldnames.h	10.48 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ulistformatter.h	10.78 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uloc.h	54.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ulocdata.h	11.3 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umachine.h	16.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umisc.h	1.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umsg.h	24.25 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umutablecptrie.h	8.29 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unifilt.h	4 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unifunct.h	4.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unimatch.h	6.1 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unirepl.h	3.38 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uniset.h	66.46 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unistr.h	170.53 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unorm.h	20.55 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unorm2.h	24.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unounclass.h	735 bytes	12/01/2022 11:12:33 AM	rw-r--r--
📄 unum.h	55.31 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unumberformatter.h	30.28 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unumberrangeformatter.h	15.37 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unumsys.h	7.26 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uobject.h	10.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 upluralrules.h	8.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uregex.h	71.99 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uregion.h	9.81 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ureldatefmt.h	17.04 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 urename.h	135 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 urep.h	5.38 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ures.h	36.54 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uscript.h	27.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 usearch.h	39.21 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uset.h	44.29 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 usetiter.h	9.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ushape.h	18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uspoof.h	65.84 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 usprep.h	8.19 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustdio.h	38.56 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustream.h	1.89 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustring.h	72.36 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustringtrie.h	3.15 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utext.h	58.08 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf.h	7.87 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf16.h	23.35 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf32.h	763 bytes	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf8.h	30.83 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf_old.h	45.83 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utmscale.h	13.78 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utrace.h	17.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utrans.h	25.54 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utypes.h	31.06 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uvernum.h	6.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uversion.h	5.99 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 vtzone.h	20.74 KB	12/01/2022 11:12:33 AM	rw-r--r--

Editing: uformattedvalue.h

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

#ifndef U_HIDE_DRAFT_API
    /**
     * Category for spans in a number range.
     *
     * @draft ICU 69
     */
    UFIELD_CATEGORY_NUMBER_RANGE_SPAN = 0x1000 + UFIELD_CATEGORY_NUMBER,
#endif // U_HIDE_DRAFT_API

} 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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_CAPI 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__