#include "unicode/utypes.h"
#include "unicode/urep.h"
#include "unicode/parseerr.h"
#include "unicode/uenum.h"
Go to the source code of this file.
Data Structures | |
struct | UTransPosition |
Position structure for utrans_transIncremental() incremental transliteration. More... | |
Typedefs | |
typedef void * | UTransliterator |
An opaque transliterator for use in C. | |
typedef enum UTransDirection | UTransDirection |
Direction constant indicating the direction in a transliterator, e.g. | |
typedef UTransPosition | UTransPosition |
Position structure for utrans_transIncremental() incremental transliteration. | |
Enumerations | |
enum | UTransDirection { UTRANS_FORWARD, UTRANS_REVERSE } |
Direction constant indicating the direction in a transliterator, e.g. More... | |
Functions | |
U_STABLE UTransliterator *U_EXPORT2 | utrans_openU (const UChar *id, int32_t idLength, UTransDirection dir, const UChar *rules, int32_t rulesLength, UParseError *parseError, UErrorCode *pErrorCode) |
Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. | |
U_STABLE UTransliterator *U_EXPORT2 | utrans_openInverse (const UTransliterator *trans, UErrorCode *status) |
Open an inverse of an existing transliterator. | |
U_STABLE UTransliterator *U_EXPORT2 | utrans_clone (const UTransliterator *trans, UErrorCode *status) |
Create a copy of a transliterator. | |
U_STABLE void U_EXPORT2 | utrans_close (UTransliterator *trans) |
Close a transliterator. | |
U_STABLE const UChar *U_EXPORT2 | utrans_getUnicodeID (const UTransliterator *trans, int32_t *resultLength) |
Return the programmatic identifier for this transliterator. | |
U_STABLE void U_EXPORT2 | utrans_register (UTransliterator *adoptedTrans, UErrorCode *status) |
Register an open transliterator with the system. | |
U_STABLE void U_EXPORT2 | utrans_unregisterID (const UChar *id, int32_t idLength) |
Unregister a transliterator from the system. | |
U_STABLE void U_EXPORT2 | utrans_setFilter (UTransliterator *trans, const UChar *filterPattern, int32_t filterPatternLen, UErrorCode *status) |
Set the filter used by a transliterator. | |
U_STABLE int32_t U_EXPORT2 | utrans_countAvailableIDs (void) |
Return the number of system transliterators. | |
U_STABLE UEnumeration *U_EXPORT2 | utrans_openIDs (UErrorCode *pErrorCode) |
Return a UEnumeration for the available transliterators. | |
U_STABLE void U_EXPORT2 | utrans_trans (const UTransliterator *trans, UReplaceable *rep, UReplaceableCallbacks *repFunc, int32_t start, int32_t *limit, UErrorCode *status) |
Transliterate a segment of a UReplaceable string. | |
U_STABLE void U_EXPORT2 | utrans_transIncremental (const UTransliterator *trans, UReplaceable *rep, UReplaceableCallbacks *repFunc, UTransPosition *pos, UErrorCode *status) |
Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly. | |
U_STABLE void U_EXPORT2 | utrans_transUChars (const UTransliterator *trans, UChar *text, int32_t *textLength, int32_t textCapacity, int32_t start, int32_t *limit, UErrorCode *status) |
Transliterate a segment of a UChar* string. | |
U_STABLE void U_EXPORT2 | utrans_transIncrementalUChars (const UTransliterator *trans, UChar *text, int32_t *textLength, int32_t textCapacity, UTransPosition *pos, UErrorCode *status) |
Transliterate the portion of the UChar* text buffer that can be transliterated unambiguosly. | |
U_DEPRECATED UTransliterator *U_EXPORT2 | utrans_open (const char *id, UTransDirection dir, const UChar *rules, int32_t rulesLength, UParseError *parseError, UErrorCode *status) |
Deprecated, use utrans_openU() instead. | |
U_DEPRECATED int32_t U_EXPORT2 | utrans_getID (const UTransliterator *trans, char *buf, int32_t bufCapacity) |
Deprecated, use utrans_getUnicodeID() instead. | |
U_DEPRECATED void U_EXPORT2 | utrans_unregister (const char *id) |
Deprecated, use utrans_unregisterID() instead. | |
U_DEPRECATED int32_t U_EXPORT2 | utrans_getAvailableID (int32_t index, char *buf, int32_t bufCapacity) |
Deprecated, use utrans_openIDs() instead. |
The data structures and functions described in this header provide transliteration services. Transliteration services are implemented as C++ classes. The comments and documentation in this header assume the reader is familiar with the C++ headers translit.h and associated documentation.
A significant but incomplete subset of the C++ transliteration services are available to C code through this header. In order to access more complex transliteration services, refer to the C++ headers and documentation.
There are two sets of functions for working with transliterator IDs:
An old, deprecated set uses char * IDs, which works for true and pure identifiers that these APIs were designed for, for example "Cyrillic-Latin". It does not work when the ID contains filters ("[:Script=Cyrl:]") or even a complete set of rules because then the ID string contains more than just "invariant" characters (see utypes.h).
A new set of functions replaces the old ones and uses UChar * IDs, paralleling the UnicodeString IDs in the C++ API. (New in ICU 2.8.)
Definition in file utrans.h.
|
Direction constant indicating the direction in a transliterator, e.g. , the forward or reverse rules of a RuleBasedTransliterator. Specified when a transliterator is opened. An "A-B" transliterator transliterates A to B when operating in the forward direction, and B to A when operating in the reverse direction.
|
|
An opaque transliterator for use in C. Open with utrans_openxxx() and close with utrans_close() when done. Equivalent to the C++ class Transliterator and its subclasses.
|
|
Position structure for utrans_transIncremental() incremental transliteration. This structure defines two substrings of the text being transliterated. The first region, [contextStart, contextLimit), defines what characters the transliterator will read as context. The second region, [start, limit), defines what characters will actually be transliterated. The second region should be a subset of the first. After a transliteration operation, some of the indices in this structure will be modified. See the field descriptions for details. contextStart <= start <= limit <= contextLimit Note: All index values in this structure must be at code point boundaries. That is, none of them may occur between two code units of a surrogate pair. If any index does split a surrogate pair, results are unspecified.
|
|
|
Create a copy of a transliterator. Any non-NULL result from this function should later be closed with utrans_close().
|
|
Close a transliterator. Any non-NULL pointer returned by utrans_openXxx() or utrans_clone() should eventually be closed.
|
|
Return the number of system transliterators. It is recommended to use utrans_openIDs() instead.
|
|
Deprecated, use utrans_openIDs() instead. Return the ID of the index-th system transliterator. The result is placed in the given buffer. If the given buffer is too small, the initial substring is copied to buf. The result in buf is always zero-terminated.
|
|
Deprecated, use utrans_getUnicodeID() instead. Return the programmatic identifier for this transliterator. If this identifier is passed to utrans_open(), it will open a transliterator equivalent to this one, if the ID has been registered.
|
|
Return the programmatic identifier for this transliterator. If this identifier is passed to utrans_openU(), it will open a transliterator equivalent to this one, if the ID has been registered.
|
|
Deprecated, use utrans_openU() instead. Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. Any non-NULL result from this function should later be closed with utrans_close().
|
|
Return a UEnumeration for the available transliterators.
|
|
Open an inverse of an existing transliterator. For this to work, the inverse must be registered with the system. For example, if the Transliterator "A-B" is opened, and then its inverse is opened, the result is the Transliterator "B-A", if such a transliterator is registered with the system. Otherwise the result is NULL and a failing UErrorCode is set. Any non-NULL result from this function should later be closed with utrans_close().
|
|
Open a custom transliterator, given a custom rules string OR a system transliterator, given its ID. Any non-NULL result from this function should later be closed with utrans_close().
|
|
Register an open transliterator with the system. When utrans_open() is called with an ID string that is equal to that returned by utrans_getID(adoptedTrans,...), then utrans_clone(adoptedTrans,...) is returned. NOTE: After this call the system owns the adoptedTrans and will close it. The user must not call utrans_close() on adoptedTrans.
|
|
Set the filter used by a transliterator. A filter can be used to make the transliterator pass certain characters through untouched. The filter is expressed using a UnicodeSet pattern. If the filterPattern is NULL or the empty string, then the transliterator will be reset to use no filter.
|
|
Transliterate a segment of a UReplaceable string. The string is passed in as a UReplaceable pointer rep and a UReplaceableCallbacks function pointer struct repFunc. Functions in the repFunc struct will be called in order to modify the rep string.
|
|
Transliterate the portion of the UReplaceable text buffer that can be transliterated unambiguosly.
This method is typically called after new text has been inserted, e.g. as a result of a keyboard event. The transliterator will try to transliterate characters of
Upon return, values in
Typical usage of this method begins with an initial call with This method assumes that future calls may be made that will insert new text into the buffer. As a result, it only performs unambiguous transliterations. After the last call to this method, there may be untransliterated text that is waiting for more input to resolve an ambiguity. In order to perform these pending transliterations, clients should call utrans_trans() with a start of index.start and a limit of index.end after the last call to this method has been made.
|
|
Transliterate the portion of the UChar* text buffer that can be transliterated unambiguosly. See utrans_transIncremental(). The string is passed in in a UChar* buffer. The string is modified in place. If the result is longer than textCapacity, it is truncated. The actual length of the result is returned in *textLength, if textLength is non-NULL. *textLength may be greater than textCapacity, but only textCapacity UChars will be written to *text, including the zero terminator. See utrans_transIncremental() for usage details.
|
|
Transliterate a segment of a UChar* string. The string is passed in in a UChar* buffer. The string is modified in place. If the result is longer than textCapacity, it is truncated. The actual length of the result is returned in *textLength, if textLength is non-NULL. *textLength may be greater than textCapacity, but only textCapacity UChars will be written to *text, including the zero terminator.
|
|
Deprecated, use utrans_unregisterID() instead. Unregister a transliterator from the system. After this call the system will no longer recognize the given ID when passed to utrans_open(). If the id is invalid then nothing is done.
|
|
Unregister a transliterator from the system. After this call the system will no longer recognize the given ID when passed to utrans_open(). If the ID is invalid then nothing is done.
|