Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

utrans.h File Reference

C API: Transliterator. More...

#include "unicode/utypes.h"
#include "unicode/urep.h"
#include "unicode/parseerr.h"

Go to the source code of this file.

Compounds

struct  _UTransPosition

Typedefs

typedef void* UTransliterator
 An opaque transliterator for use in C. More...

typedef enum _UTransDirection  UTransDirection
 Direction constant indicating the direction in a transliterator, e.g., the forward or reverse rules of a RuleBasedTransliterator. More...

typedef struct _UTransPosition  UTransPosition
 Position structure for utrans_transIncremental() incremental transliteration. More...


Enumerations

enum  _UTransDirection { UTRANS_FORWARD, UTRANS_REVERSE }
 Direction constant indicating the direction in a transliterator, e.g., the forward or reverse rules of a RuleBasedTransliterator. More...


Functions

U_CAPI UTransliteratorutrans_open (const char* id, UTransDirection dir, UErrorCode* status)
 Open a system transliterator, given its ID. More...

U_CAPI UTransliteratorutrans_openRules (const char* id, const UChar* rules, int32_t rulesLength, UTransDirection dir, UParseError* parseErr, UErrorCode* status)
 Open a custom transliterator, given a custom rules string. More...

U_CAPI UTransliteratorutrans_openInverse (const UTransliterator* trans, UErrorCode* status)
 Open an inverse of an existing transliterator. More...

U_CAPI UTransliteratorutrans_clone (const UTransliterator* trans, UErrorCode* status)
 Create a copy of a transliterator. More...

U_CAPI void utrans_close (UTransliterator* trans)
 Close a transliterator. More...

U_CAPI int32_t utrans_getID (const UTransliterator* trans, char* buf, int32_t bufCapacity)
 Return the programmatic identifier for this transliterator. More...

U_CAPI void utrans_register (UTransliterator* adoptedTrans, UErrorCode* status)
 Register an open transliterator with the system. More...

U_CAPI void utrans_unregister (const char* id)
 Unregister a transliterator from the system. More...

U_CAPI void utrans_setFilter (UTransliterator* trans, const UChar* filterPattern, int32_t filterPatternLen, UErrorCode* status)
 Set the filter used by a transliterator. More...

U_CAPI int32_t utrans_countAvailableIDs (void)
 Return the number of system transliterators. More...

U_CAPI int32_t utrans_getAvailableID (int32_t index, char* buf, int32_t bufCapacity)
 Return the ID of the index-th system transliterator. More...

U_CAPI void utrans_trans (const UTransliterator* trans, UReplaceable* rep, UReplaceableCallbacks* repFunc, int32_t start, int32_t* limit, UErrorCode* status)
 Transliterate a segment of a UReplaceable string. More...

U_CAPI void 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. More...

U_CAPI void 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. More...

U_CAPI void 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. More...


Detailed Description

C API: Transliterator.

Transliteration

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 rbt.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.

Definition in file utrans.h.


Typedef Documentation

typedef enum _UTransDirection UTransDirection
 

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.

Draft:

typedef struct _UTransPosition UTransPosition
 

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

Draft:

typedef void* UTransliterator
 

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.

See also:
Transliterator
Draft:

Definition at line 50 of file utrans.h.


Enumeration Type Documentation

enum _UTransDirection
 

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.

Draft:
Enumeration values:
UTRANS_FORWARD   UTRANS_FORWARD means from <source> to <target> for a transliterator with ID <source>-<target>.

For a transliterator opened using a rule, it means forward direction rules, e.g., "A > B".

UTRANS_REVERSE   UTRANS_REVERSE means from <target> to <source> for a transliterator with ID <source>-<target>.

For a transliterator opened using a rule, it means reverse direction rules, e.g., "A < B".

Definition at line 60 of file utrans.h.


Function Documentation

U_CAPI UTransliterator * utrans_clone ( const UTransliterator * trans,
UErrorCode * status )
 

Create a copy of a transliterator.

Any non-NULL result from this function should later be closed with utrans_close().

Parameters:
trans   the transliterator to be copied.
status   a pointer to the UErrorCode
Returns:
a transliterator pointer that may be passed to other utrans_xxx() functions, or NULL if the clone call fails.
Draft:

U_CAPI void utrans_close ( UTransliterator * trans )
 

Close a transliterator.

Any non-NULL pointer returned by utrans_openXxx() or utrans_clone() should eventually be closed.

Draft:

U_CAPI int32_t utrans_countAvailableIDs ( void )
 

Return the number of system transliterators.

Draft:

U_CAPI int32_t utrans_getAvailableID ( int32_t index,
char * buf,
int32_t bufCapacity )
 

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.

Parameters:
index   the number of the transliterator to return. Must satisfy 0 <= index < utrans_countAvailableIDs(). If index is out of range then it is treated as if it were 0.
buf   the buffer in which to receive the ID. This may be NULL, in which case no characters are copied.
bufCapacity   the capacity of the buffer. Ignored if buf is NULL.
Returns:
the actual length of the index-th ID, not including zero-termination. This may be greater than bufCapacity.
Draft:

U_CAPI int32_t utrans_getID ( const UTransliterator * trans,
char * buf,
int32_t bufCapacity )
 

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.

Parameters:
trans   the transliterator to return the ID of.
buf   the buffer in which to receive the ID. This may be NULL, in which case no characters are copied.
bufCapacity   the capacity of the buffer. Ignored if buf is NULL.
Returns:
the actual length of the ID, not including zero-termination. This may be greater than bufCapacity.
Draft:

U_CAPI UTransliterator * utrans_open ( const char * id,
UTransDirection dir,
UErrorCode * status )
 

Open a system transliterator, given its ID.

Any non-NULL result from this function should later be closed with utrans_close().

Parameters:
id   a valid ID, as returned by utrans_getAvailableID()
dir   the desired direction
status   a pointer to the UErrorCode
Returns:
a transliterator pointer that may be passed to other utrans_xxx() functions, or NULL if the open call fails.
Draft:

U_CAPI UTransliterator * utrans_openInverse ( const UTransliterator * trans,
UErrorCode * status )
 

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().

Parameters:
trans   the transliterator to open the inverse of.
status   a pointer to the UErrorCode
Returns:
a pointer to a newly-opened transliterator that is the inverse of trans, or NULL if the open call fails.
Draft:

U_CAPI UTransliterator * utrans_openRules ( const char * id,
const UChar * rules,
int32_t rulesLength,
UTransDirection dir,
UParseError * parseErr,
UErrorCode * status )
 

Open a custom transliterator, given a custom rules string.

Any non-NULL result from this function should later be closed with utrans_close().

Parameters:
id   an ID to be assigned to the given transliterator. This ID is for informational use only; it is not registered with the system.
rules   the transliterator rules. See the C++ header rbt.h for rules syntax.
rulesLength   the length of the rules, or -1 if the rules are zero-terminated.
dir   the desired direction
parseErr   a pointer to a UParseError struct to receive the details of any parsing errors. This parameter may be NULL if no parsing error details are desired.
status   a pointer to the UErrorCode
Returns:
a transliterator pointer that may be passed to other utrans_xxx() functions, or NULL if the open call fails.
Draft:

U_CAPI void utrans_register ( UTransliterator * adoptedTrans,
UErrorCode * status )
 

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.

Parameters:
trans   a transliterator, typically the result of utrans_openRules(), to be registered with the system.
status   a pointer to the UErrorCode
Draft:

U_CAPI void utrans_setFilter ( UTransliterator * trans,
const UChar * filterPattern,
int32_t filterPatternLen,
UErrorCode * status )
 

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.

Parameters:
trans   the transliterator
filterPattern   a pattern string, in the form accepted by UnicodeSet, specifying which characters to apply the transliteration to. May be NULL or the empty string to indicate no filter.
filterPatternLen   the length of filterPattern, or -1 if filterPattern is zero-terminated
status   a pointer to the UErrorCode
See also:
UnicodeSet
Draft:

U_CAPI void utrans_trans ( const UTransliterator * trans,
UReplaceable * rep,
UReplaceableCallbacks * repFunc,
int32_t start,
int32_t * limit,
UErrorCode * status )
 

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.

Parameters:
trans   the transliterator
rep   a pointer to the string. This will be passed to the repFunc functions.
repFunc   a set of function pointers that will be used to modify the string pointed to by rep.
start   the beginning index, inclusive; 0 <= start <= limit.
limit   pointer to the ending index, exclusive; start <= limit <= repFunc->length(rep). Upon return, *limit will contain the new limit index. The text previously occupying [start, limit) has been transliterated, possibly to a string of a different length, at [start, new-limit), where new-limit is the return value.
status   a pointer to the UErrorCode
Draft:

U_CAPI void 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.

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 rep between index.cursor and index.limit. Characters before index.cursor will not be changed.

Upon return, values in index will be updated. index.start will be advanced to the first character that future calls to this method will read. index.cursor and index.limit will be adjusted to delimit the range of text that future calls to this method may change.

Typical usage of this method begins with an initial call with index.start and index.limit set to indicate the portion of text to be transliterated, and index.cursor == index.start. Thereafter, index can be used without modification in future calls, provided that all changes to text are made via this method.

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.

Parameters:
trans   the transliterator
rep   a pointer to the string. This will be passed to the repFunc functions.
repFunc   a set of function pointers that will be used to modify the string pointed to by rep.
pos   a struct containing the start and limit indices of the text to be read and the text to be transliterated
status   a pointer to the UErrorCode
Draft:

U_CAPI void 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.

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.

Parameters:
trans   the transliterator
text   a pointer to a buffer containing the text to be transliterated on input and the result text on output.
textLength   a pointer to the length of the string in text. If the length is -1 then the string is assumed to be zero-terminated. Upon return, the new length is stored in *textLength. If textLength is NULL then the string is assumed to be zero-terminated.
textCapacity   the length of the text buffer
pos   a struct containing the start and limit indices of the text to be read and the text to be transliterated
status   a pointer to the UErrorCode
See also:
utrans_transIncremental
Draft:

U_CAPI void 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.

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.

Parameters:
trans   the transliterator
text   a pointer to a buffer containing the text to be transliterated on input and the result text on output.
textLength   a pointer to the length of the string in text. If the length is -1 then the string is assumed to be zero-terminated. Upon return, the new length is stored in *textLength. If textLength is NULL then the string is assumed to be zero-terminated.
textCapacity   a pointer to the length of the text buffer. Upon return,
start   the beginning index, inclusive; 0 <= start <= limit.
limit   pointer to the ending index, exclusive; start <= limit <= repFunc->length(rep). Upon return, *limit will contain the new limit index. The text previously occupying [start, limit) has been transliterated, possibly to a string of a different length, at [start, new-limit), where new-limit is the return value.
status   a pointer to the UErrorCode
Draft:

U_CAPI void utrans_unregister ( const char * id )
 

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.

Parameters:
id   a zero-terminated ID
Draft:


Generated at Thu Mar 22 16:12:57 2001 for ICU 1.8 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000