2 ******************************************************************************
3 * Copyright (C) 1997-2005, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 ******************************************************************************
6 * Date Name Description
7 * 06/23/00 aliu Creation.
8 ******************************************************************************
14 #include "unicode/utypes.h"
18 /********************************************************************
20 ********************************************************************
25 * Talk about "can truncate result if out of memory"
28 /********************************************************************
30 ********************************************************************/
33 * \brief C API: Callbacks for UReplacebale
36 * An opaque replaceable text object. This will be manipulated only
37 * through the caller-supplied UReplaceableFunctor struct. Related
38 * to the C++ class Replaceable.
39 * This is currently only used in the Transliterator C API, see utrans.h .
42 typedef void* UReplaceable;
45 * A set of function pointers that transliterators use to manipulate a
46 * UReplaceable. The caller should supply the required functions to
47 * manipulate their text appropriately. Related to the C++ class
51 typedef struct UReplaceableCallbacks {
54 * Function pointer that returns the number of UChar code units in
57 * @param rep A pointer to "this" UReplaceable object.
58 * @return The length of the text.
61 int32_t (*length)(const UReplaceable* rep);
64 * Function pointer that returns a UChar code units at the given
65 * offset into this text; 0 <= offset < n, where n is the value
66 * returned by (*length)(rep). See unistr.h for a description of
67 * charAt() vs. char32At().
69 * @param rep A pointer to "this" UReplaceable object.
70 * @param offset The index at which to fetch the UChar (code unit).
71 * @return The UChar (code unit) at offset, or U+FFFF if the offset is out of bounds.
74 UChar (*charAt)(const UReplaceable* rep,
78 * Function pointer that returns a UChar32 code point at the given
79 * offset into this text. See unistr.h for a description of
80 * charAt() vs. char32At().
82 * @param rep A pointer to "this" UReplaceable object.
83 * @param offset The index at which to fetch the UChar32 (code point).
84 * @return The UChar32 (code point) at offset, or U+FFFF if the offset is out of bounds.
87 UChar32 (*char32At)(const UReplaceable* rep,
91 * Function pointer that replaces text between start and limit in
92 * this text with the given text. Attributes (out of band info)
95 * @param rep A pointer to "this" UReplaceable object.
96 * @param start the starting index of the text to be replaced,
98 * @param limit the ending index of the text to be replaced,
100 * @param text the new text to replace the UChars from
102 * @param textLength the number of UChars at text, or -1 if text
103 * is null-terminated.
106 void (*replace)(UReplaceable* rep,
113 * Function pointer that copies the characters in the range
114 * [<tt>start</tt>, <tt>limit</tt>) into the array <tt>dst</tt>.
116 * @param rep A pointer to "this" UReplaceable object.
117 * @param start offset of first character which will be copied
119 * @param limit offset immediately following the last character to
121 * @param dst array in which to copy characters. The length of
122 * <tt>dst</tt> must be at least <tt>(limit - start)</tt>.
125 void (*extract)(UReplaceable* rep,
131 * Function pointer that copies text between start and limit in
132 * this text to another index in the text. Attributes (out of
133 * band info) should be retained. After this call, there will be
134 * (at least) two copies of the characters originally located at
137 * @param rep A pointer to "this" UReplaceable object.
138 * @param start the starting index of the text to be copied,
140 * @param limit the ending index of the text to be copied,
142 * @param dest the index at which the copy of the UChars should be
146 void (*copy)(UReplaceable* rep,
151 } UReplaceableCallbacks;