File Manager

X7ROOT File Manager

Current Path: /opt/alt/libicu65/usr/include/unicode

opt / alt / libicu65 / usr / include / unicode /

ðŸ“ ..
ðŸ“„ alphaindex.h(26.48 KB)
ðŸ“„ appendable.h(8.49 KB)
ðŸ“„ basictz.h(9.15 KB)
ðŸ“„ brkiter.h(27.8 KB)
ðŸ“„ bytestream.h(9.6 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.05 KB)
ðŸ“„ datefmt.h(40.67 KB)
ðŸ“„ dbbi.h(1.19 KB)
ðŸ“„ dcfmtsym.h(20.13 KB)
ðŸ“„ decimfmt.h(87.38 KB)
ðŸ“„ docmain.h(6.97 KB)
ðŸ“„ dtfmtsym.h(37.7 KB)
ðŸ“„ dtintrv.h(3.84 KB)
ðŸ“„ dtitvfmt.h(46.63 KB)
ðŸ“„ dtitvinf.h(18.51 KB)
ðŸ“„ dtptngen.h(25.08 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(10.27 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.47 KB)
ðŸ“„ localebuilder.h(11.27 KB)
ðŸ“„ localematcher.h(22.5 KB)
ðŸ“„ localpointer.h(19.69 KB)
ðŸ“„ locdspnm.h(7.12 KB)
ðŸ“„ locid.h(47.4 KB)
ðŸ“„ measfmt.h(11.33 KB)
ðŸ“„ measunit.h(93.31 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(86.31 KB)
ðŸ“„ numberrangeformatter.h(30.14 KB)
ðŸ“„ numfmt.h(49.81 KB)
ðŸ“„ numsys.h(7.19 KB)
ðŸ“„ parseerr.h(3.08 KB)
ðŸ“„ parsepos.h(5.56 KB)
ðŸ“„ platform.h(28.08 KB)
ðŸ“„ plurfmt.h(25.2 KB)
ðŸ“„ plurrule.h(18.39 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.36 KB)
ðŸ“„ region.h(9.18 KB)
ðŸ“„ reldatefmt.h(22.62 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(70.97 KB)
ðŸ“„ sortkey.h(11.18 KB)
ðŸ“„ std_string.h(1.05 KB)
ðŸ“„ strenum.h(9.92 KB)
ðŸ“„ stringoptions.h(5.79 KB)
ðŸ“„ stringpiece.h(7.38 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(140.56 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(60.88 KB)
ðŸ“„ udata.h(15.56 KB)
ðŸ“„ udateintervalformat.h(10.03 KB)
ðŸ“„ udatpg.h(26.01 KB)
ðŸ“„ udisplaycontext.h(5.89 KB)
ðŸ“„ uenum.h(7.78 KB)
ðŸ“„ ufieldpositer.h(4.36 KB)
ðŸ“„ uformattable.h(10.94 KB)
ðŸ“„ uformattedvalue.h(12.14 KB)
ðŸ“„ ugender.h(2 KB)
ðŸ“„ uidna.h(33.37 KB)
ðŸ“„ uiter.h(22.77 KB)
ðŸ“„ uldnames.h(10.45 KB)
ðŸ“„ ulistformatter.h(8.83 KB)
ðŸ“„ uloc.h(52.54 KB)
ðŸ“„ ulocdata.h(11.26 KB)
ðŸ“„ umachine.h(14.53 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.62 KB)
ðŸ“„ unumberformatter.h(25.36 KB)
ðŸ“„ unumsys.h(7.21 KB)
ðŸ“„ uobject.h(10.68 KB)
ðŸ“„ upluralrules.h(7.88 KB)
ðŸ“„ uregex.h(72.05 KB)
ðŸ“„ uregion.h(9.84 KB)
ðŸ“„ ureldatefmt.h(17.26 KB)
ðŸ“„ urename.h(130.97 KB)
ðŸ“„ urep.h(5.38 KB)
ðŸ“„ ures.h(36.54 KB)
ðŸ“„ uscript.h(26.87 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(15.73 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)

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"

#ifndef U_HIDE_DRAFT_API

/**
 * \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.
 *
 * @draft ICU 64
 */
typedef enum UFieldCategory {
    /**
     * For an undefined field category.
     * 
     * @draft ICU 64
     */
    UFIELD_CATEGORY_UNDEFINED = 0,

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

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

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

/**
     * For fields in URelativeDateTimeFormatterField (ureldatefmt.h), from ICU 64.
     *
     * @draft 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.
     *
     * @draft ICU 64
     */
    UFIELD_CATEGORY_LIST_SPAN = 0x1000 + UFIELD_CATEGORY_LIST,

/**
     * Category for spans in a date interval.
     *
     * @draft 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.
 *
 * @draft 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT void U_EXPORT2
ucfpos_reset(
    UConstrainedFieldPosition* ucfpos,
    UErrorCode* ec);

/**
 * Destroys a UConstrainedFieldPosition and releases its memory.
 *
 * @param ucfpos The instance of UConstrainedFieldPosition.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 *
 * @draft 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.
 * @draft ICU 64
 */
U_DRAFT 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.
 * @draft ICU 64
 */
U_DRAFT 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()
 *
 * @draft ICU 64
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUConstrainedFieldPositionPointer,
    UConstrainedFieldPosition,
    ucfpos_close);

U_NAMESPACE_END
#endif // U_SHOW_CPLUSPLUS_API

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

X7ROOT File Manager

Editing: uformattedvalue.h

Upload File

Create Folder