GOLDEN HOUR

DIR: /usr/include/unicode

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

Edit: 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,

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

GOLDEN HOUR

Edit: uformattedvalue.h

TERMINAL