🐐 GOAT

🐐 GOAT Shell

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

⬆️ Go up: include

✏️ Editing: ucpmap.h

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

// ucpmap.h
// created: 2018sep03 Markus W. Scherer

#ifndef __UCPMAP_H__
#define __UCPMAP_H__

#include "unicode/utypes.h"

U_CDECL_BEGIN

/**
 * \file
 *
 * This file defines an abstract map from Unicode code points to integer values.
 *
 * @see UCPMap
 * @see UCPTrie
 * @see UMutableCPTrie
 */

/**
 * Abstract map from Unicode code points (U+0000..U+10FFFF) to integer values.
 *
 * @see UCPTrie
 * @see UMutableCPTrie
 * @stable ICU 63
 */
typedef struct UCPMap UCPMap;

/**
 * Selectors for how ucpmap_getRange() etc. should report value ranges overlapping with surrogates.
 * Most users should use UCPMAP_RANGE_NORMAL.
 *
 * @see ucpmap_getRange
 * @see ucptrie_getRange
 * @see umutablecptrie_getRange
 * @stable ICU 63
 */
enum UCPMapRangeOption {
    /**
     * ucpmap_getRange() enumerates all same-value ranges as stored in the map.
     * Most users should use this option.
     * @stable ICU 63
     */
    UCPMAP_RANGE_NORMAL,
    /**
     * ucpmap_getRange() enumerates all same-value ranges as stored in the map,
     * except that lead surrogates (U+D800..U+DBFF) are treated as having the
     * surrogateValue, which is passed to getRange() as a separate parameter.
     * The surrogateValue is not transformed via filter().
     * See U_IS_LEAD(c).
     *
     * Most users should use UCPMAP_RANGE_NORMAL instead.
     *
     * This option is useful for maps that map surrogate code *units* to
     * special values optimized for UTF-16 string processing
     * or for special error behavior for unpaired surrogates,
     * but those values are not to be associated with the lead surrogate code *points*.
     * @stable ICU 63
     */
    UCPMAP_RANGE_FIXED_LEAD_SURROGATES,
    /**
     * ucpmap_getRange() enumerates all same-value ranges as stored in the map,
     * except that all surrogates (U+D800..U+DFFF) are treated as having the
     * surrogateValue, which is passed to getRange() as a separate parameter.
     * The surrogateValue is not transformed via filter().
     * See U_IS_SURROGATE(c).
     *
     * Most users should use UCPMAP_RANGE_NORMAL instead.
     *
     * This option is useful for maps that map surrogate code *units* to
     * special values optimized for UTF-16 string processing
     * or for special error behavior for unpaired surrogates,
     * but those values are not to be associated with the lead surrogate code *points*.
     * @stable ICU 63
     */
    UCPMAP_RANGE_FIXED_ALL_SURROGATES
};
#ifndef U_IN_DOXYGEN
typedef enum UCPMapRangeOption UCPMapRangeOption;
#endif

/**
 * Returns the value for a code point as stored in the map, with range checking.
 * Returns an implementation-defined error value if c is not in the range 0..U+10FFFF.
 *
 * @param map the map
 * @param c the code point
 * @return the map value,
 *         or an implementation-defined error value if the code point is not in the range 0..U+10FFFF
 * @stable ICU 63
 */
U_CAPI uint32_t U_EXPORT2
ucpmap_get(const UCPMap *map, UChar32 c);

/**
 * Callback function type: Modifies a map value.
 * Optionally called by ucpmap_getRange()/ucptrie_getRange()/umutablecptrie_getRange().
 * The modified value will be returned by the getRange function.
 *
 * Can be used to ignore some of the value bits,
 * make a filter for one of several values,
 * return a value index computed from the map value, etc.
 *
 * @param context an opaque pointer, as passed into the getRange function
 * @param value a value from the map
 * @return the modified value
 * @stable ICU 63
 */
typedef uint32_t U_CALLCONV
UCPMapValueFilter(const void *context, uint32_t value);

/**
 * Returns the last code point such that all those from start to there have the same value.
 * Can be used to efficiently iterate over all same-value ranges in a map.
 * (This is normally faster than iterating over code points and get()ting each value,
 * but much slower than a data structure that stores ranges directly.)
 *
 * If the UCPMapValueFilter function pointer is not NULL, then
 * the value to be delivered is passed through that function, and the return value is the end
 * of the range where all values are modified to the same actual value.
 * The value is unchanged if that function pointer is NULL.
 *
 * Example:
 * \code
 * UChar32 start = 0, end;
 * uint32_t value;
 * while ((end = ucpmap_getRange(map, start, UCPMAP_RANGE_NORMAL, 0,
 *                               NULL, NULL, &value)) >= 0) {
 *     // Work with the range start..end and its value.
 *     start = end + 1;
 * }
 * \endcode
 *
 * @param map the map
 * @param start range start
 * @param option defines whether surrogates are treated normally,
 *               or as having the surrogateValue; usually UCPMAP_RANGE_NORMAL
 * @param surrogateValue value for surrogates; ignored if option==UCPMAP_RANGE_NORMAL
 * @param filter a pointer to a function that may modify the map data value,
 *     or NULL if the values from the map are to be used unmodified
 * @param context an opaque pointer that is passed on to the filter function
 * @param pValue if not NULL, receives the value that every code point start..end has;
 *     may have been modified by filter(context, map value)
 *     if that function pointer is not NULL
 * @return the range end code point, or -1 if start is not a valid code point
 * @stable ICU 63
 */
U_CAPI UChar32 U_EXPORT2
ucpmap_getRange(const UCPMap *map, UChar32 start,
                UCPMapRangeOption option, uint32_t surrogateValue,
                UCPMapValueFilter *filter, const void *context, uint32_t *pValue);

U_CDECL_END

#endif

📄 alphaindex.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 appendable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 basictz.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 brkiter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 bytestream.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 bytestrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 bytestriebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 calendar.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 caniter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 casemap.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 char16ptr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 chariter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 choicfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 coleitr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 coll.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 compactdecimalformat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 curramt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 currpinf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 currunit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 datefmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dbbi.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dcfmtsym.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 decimfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 docmain.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtfmtsym.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtintrv.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtitvfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtitvinf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtptngen.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 dtrule.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 edits.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 enumset.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 errorcode.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 fieldpos.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 filteredbrk.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 fmtable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 format.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 formattedvalue.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 fpositer.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 gender.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 gregocal.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 icudataver.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 icuplug.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 idna.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 listformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 localebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 localematcher.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 localpointer.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 locdspnm.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 locid.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 measfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 measunit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 measure.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 messagepattern.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 msgfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 normalizer2.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 normlzr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 nounit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numberformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numberrangeformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 numsys.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 parseerr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 parsepos.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 platform.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 plurfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 plurrule.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ptypes.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 putil.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rbbi.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rbnf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rbtz.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 regex.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 region.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 reldatefmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 rep.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 resbund.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 schriter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 scientificnumberformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 search.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 selfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 simpleformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 simpletz.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 smpdtfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 sortkey.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 std_string.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 strenum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stringoptions.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stringpiece.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stringtriebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 stsearch.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 symtable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tblcoll.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 timezone.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tmunit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tmutamt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tmutfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 translit.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tzfmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tznames.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tzrule.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 tztrans.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ubidi.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ubiditransform.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ubrk.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucal.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucasemap.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uchar.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucharstrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucharstriebuilder.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uchriter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uclean.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnv.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnvsel.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnv_cb.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucnv_err.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucol.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucoleitr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uconfig.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucpmap.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucptrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucsdet.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ucurr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udata.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udateintervalformat.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udatpg.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 udisplaycontext.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uenum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ufieldpositer.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uformattable.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uformattedvalue.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ugender.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uidna.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uiter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uldnames.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ulistformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uloc.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ulocdata.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umachine.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umisc.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umsg.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 umutablecptrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unifilt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unifunct.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unimatch.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unirepl.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uniset.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unistr.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unorm.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unorm2.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unumberformatter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 unumsys.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uobject.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 upluralrules.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uregex.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uregion.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ureldatefmt.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 urename.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 urep.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ures.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uscript.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 usearch.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uset.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 usetiter.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ushape.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uspoof.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 usprep.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustdio.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustream.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustring.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 ustringtrie.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utext.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf8.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf16.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf32.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utf_old.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utmscale.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utrace.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utrans.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 utypes.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uvernum.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 uversion.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete
📄 vtzone.h | ✏️ Edit | ✏️ Rename | 🗑️ Delete

🐐 GOAT Shell

✏️ Editing: ucpmap.h

📤 Upload File

📁 Create Folder