FM / unicode

/usr/include/unicode

Name	Size	Mode	Actions
alphaindex.h	27158	0644	edit dl rm
appendable.h	8739	0644	edit dl rm
basictz.h	10163	0644	edit dl rm
brkiter.h	28478	0644	edit dl rm
bytestream.h	11013	0644	edit dl rm
bytestrie.h	21268	0644	edit dl rm
bytestriebuilder.h	7640	0644	edit dl rm
calendar.h	108424	0644	edit dl rm
caniter.h	7621	0644	edit dl rm
casemap.h	25933	0644	edit dl rm
char16ptr.h	7393	0644	edit dl rm
chariter.h	24638	0644	edit dl rm
choicfmt.h	24544	0644	edit dl rm
coleitr.h	14102	0644	edit dl rm
coll.h	57615	0644	edit dl rm
compactdecimalformat.h	7047	0644	edit dl rm
curramt.h	3869	0644	edit dl rm
currpinf.h	7479	0644	edit dl rm
currunit.h	4112	0644	edit dl rm
datefmt.h	41690	0644	edit dl rm
dbbi.h	1223	0644	edit dl rm
dcfmtsym.h	21101	0644	edit dl rm
decimfmt.h	89676	0644	edit dl rm
docmain.h	7380	0644	edit dl rm
dtfmtsym.h	39126	0644	edit dl rm
dtintrv.h	3935	0644	edit dl rm
dtitvfmt.h	50448	0644	edit dl rm
dtitvinf.h	19072	0644	edit dl rm
dtptngen.h	26692	0644	edit dl rm
dtrule.h	8898	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	8906	0644	edit dl rm
filteredbrk.h	5501	0644	edit dl rm
fmtable.h	25020	0644	edit dl rm
format.h	12802	0644	edit dl rm
formattedvalue.h	9987	0644	edit dl rm
fpositer.h	3107	0644	edit dl rm
gender.h	3408	0644	edit dl rm
gregocal.h	32642	0644	edit dl rm
icudataver.h	1049	0644	edit dl rm
icuplug.h	12109	0644	edit dl rm
idna.h	13000	0644	edit dl rm
listformatter.h	9004	0644	edit dl rm
localebuilder.h	11350	0644	edit dl rm
localematcher.h	27467	0644	edit dl rm
localpointer.h	19825	0644	edit dl rm
locdspnm.h	7292	0644	edit dl rm
locid.h	48804	0644	edit dl rm
measfmt.h	11690	0644	edit dl rm
measunit.h	107613	0644	edit dl rm
measure.h	4431	0644	edit dl rm
messagepattern.h	34517	0644	edit dl rm
msgfmt.h	45278	0644	edit dl rm
normalizer2.h	34466	0644	edit dl rm
normlzr.h	31690	0644	edit dl rm
nounit.h	2305	0644	edit dl rm
numberformatter.h	94505	0644	edit dl rm
numberrangeformatter.h	25790	0644	edit dl rm
numfmt.h	51034	0644	edit dl rm
numsys.h	7509	0644	edit dl rm
parseerr.h	3155	0644	edit dl rm
parsepos.h	5699	0644	edit dl rm
platform.h	28768	0644	edit dl rm
plurfmt.h	25847	0644	edit dl rm
plurrule.h	21316	0644	edit dl rm
ptypes.h	3577	0644	edit dl rm
putil.h	6471	0644	edit dl rm
rbbi.h	28413	0644	edit dl rm
rbnf.h	50021	0644	edit dl rm
rbtz.h	16210	0644	edit dl rm
regex.h	86385	0644	edit dl rm
region.h	9402	0644	edit dl rm
reldatefmt.h	22751	0644	edit dl rm
rep.h	9599	0644	edit dl rm
resbund.h	18513	0644	edit dl rm
schriter.h	6511	0644	edit dl rm
scientificnumberformatter.h	6589	0644	edit dl rm
search.h	22755	0644	edit dl rm
selfmt.h	14686	0644	edit dl rm
simpleformatter.h	12888	0644	edit dl rm
simpletz.h	46798	0644	edit dl rm
smpdtfmt.h	72778	0644	edit dl rm
sortkey.h	11452	0644	edit dl rm
std_string.h	1076	0644	edit dl rm
strenum.h	10157	0644	edit dl rm
stringoptions.h	5926	0644	edit dl rm
stringpiece.h	10287	0644	edit dl rm
stringtriebuilder.h	15842	0644	edit dl rm
stsearch.h	21926	0644	edit dl rm
symtable.h	4374	0644	edit dl rm
tblcoll.h	37801	0644	edit dl rm
timezone.h	44858	0644	edit dl rm
tmunit.h	3479	0644	edit dl rm
tmutamt.h	5029	0644	edit dl rm
tmutfmt.h	7602	0644	edit dl rm
translit.h	67397	0644	edit dl rm
tzfmt.h	43961	0644	edit dl rm
tznames.h	17251	0644	edit dl rm
tzrule.h	36450	0644	edit dl rm
tztrans.h	6278	0644	edit dl rm
ubidi.h	91759	0644	edit dl rm
ubiditransform.h	13003	0644	edit dl rm
ubrk.h	25043	0644	edit dl rm
ucal.h	62463	0644	edit dl rm
ucasemap.h	15579	0644	edit dl rm
ucat.h	5478	0644	edit dl rm
uchar.h	148111	0644	edit dl rm
ucharstrie.h	23066	0644	edit dl rm
ucharstriebuilder.h	7645	0644	edit dl rm
uchriter.h	13747	0644	edit dl rm
uclean.h	11468	0644	edit dl rm
ucnv.h	85051	0644	edit dl rm
ucnvsel.h	6339	0644	edit dl rm
ucnv_cb.h	6738	0644	edit dl rm
ucnv_err.h	21481	0644	edit dl rm
ucol.h	62987	0644	edit dl rm
ucoleitr.h	10056	0644	edit dl rm
uconfig.h	12356	0644	edit dl rm
ucpmap.h	5663	0644	edit dl rm
ucptrie.h	23044	0644	edit dl rm
ucsdet.h	15043	0644	edit dl rm
ucurr.h	17122	0644	edit dl rm
udat.h	63902	0644	edit dl rm
udata.h	16004	0644	edit dl rm
udateintervalformat.h	12218	0644	edit dl rm
udatpg.h	27405	0644	edit dl rm
udisplaycontext.h	6084	0644	edit dl rm
uenum.h	7981	0644	edit dl rm
ufieldpositer.h	4513	0644	edit dl rm
uformattable.h	11233	0644	edit dl rm
uformattedvalue.h	12600	0644	edit dl rm
ugender.h	2106	0644	edit dl rm
uidna.h	34229	0644	edit dl rm
uiter.h	23299	0644	edit dl rm
uldnames.h	10733	0644	edit dl rm
ulistformatter.h	11043	0644	edit dl rm
uloc.h	55936	0644	edit dl rm
ulocdata.h	11572	0644	edit dl rm
umachine.h	16439	0644	edit dl rm
umisc.h	1365	0644	edit dl rm
umsg.h	24832	0644	edit dl rm
umutablecptrie.h	8490	0644	edit dl rm
unifilt.h	4091	0644	edit dl rm
unifunct.h	4151	0644	edit dl rm
unimatch.h	6244	0644	edit dl rm
unirepl.h	3464	0644	edit dl rm
uniset.h	68108	0644	edit dl rm
unistr.h	174627	0644	edit dl rm
unorm.h	21042	0644	edit dl rm
unorm2.h	25269	0644	edit dl rm
unum.h	56269	0644	edit dl rm
unumberformatter.h	31177	0644	edit dl rm
unumberrangeformatter.h	15737	0644	edit dl rm
unumsys.h	7430	0644	edit dl rm
uobject.h	10934	0644	edit dl rm
upluralrules.h	8997	0644	edit dl rm
uregex.h	73719	0644	edit dl rm
uregion.h	10047	0644	edit dl rm
ureldatefmt.h	17448	0644	edit dl rm
urename.h	137853	0644	edit dl rm
urep.h	5507	0644	edit dl rm
ures.h	37418	0644	edit dl rm
uscript.h	28291	0644	edit dl rm
usearch.h	40153	0644	edit dl rm
uset.h	45503	0644	edit dl rm
usetiter.h	9910	0644	edit dl rm
ushape.h	18430	0644	edit dl rm
uspoof.h	67425	0644	edit dl rm
usprep.h	8382	0644	edit dl rm
ustdio.h	39482	0644	edit dl rm
ustream.h	1934	0644	edit dl rm
ustring.h	74096	0644	edit dl rm
ustringtrie.h	3224	0644	edit dl rm
utext.h	59471	0644	edit dl rm
utf.h	8057	0644	edit dl rm
utf8.h	31572	0644	edit dl rm
utf16.h	23910	0644	edit dl rm
utf32.h	763	0644	edit dl rm
utf_old.h	46929	0644	edit dl rm
utmscale.h	14107	0644	edit dl rm
utrace.h	17595	0644	edit dl rm
utrans.h	26157	0644	edit dl rm
utypes.h	31807	0644	edit dl rm
uvernum.h	6839	0644	edit dl rm
uversion.h	6137	0644	edit dl rm
vtzone.h	21303	0644	edit dl rm

Edit: /usr/include/unicode/uformattedvalue.h (12600B)

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

cmd: