UText Struct Reference

#include <utext.h>

Data Fields
uint32_t	magic
	(private) Magic.
int32_t	flags
	(private) Flags for managing the allocation and freeing of memory associated with this UText.
int32_t	providerProperties
	Text provider properties.
int32_t	sizeOfStruct
	(public) sizeOfStruct=sizeof(UText) Allows possible backward compatible extension.
int64_t	chunkNativeLimit
	(protected) Native index of the first character position following the current chunk.
int32_t	extraSize
	(protected) Size in bytes of the extra space (pExtra).
int32_t	nativeIndexingLimit
	(protected) The highest chunk offset where native indexing and chunk (UTF-16) indexing correspond.
int64_t	chunkNativeStart
	(protected) Native index of the first character in the text chunk.
int32_t	chunkOffset
	(protected) Current iteration position within the text chunk (UTF-16 buffer).
int32_t	chunkLength
	(protected) Length the text chunk (UTF-16 buffer), in UChars.
const UChar *	chunkContents
	(protected) pointer to a chunk of text in UTF-16 format.
const UTextFuncs *	pFuncs
	(public) Pointer to Dispatch table for accessing functions for this UText.
void *	pExtra
	(protected) Pointer to additional space requested by the text provider during the utext_open operation.
const void *	context
	(protected) Pointer to string or text-containing object or similar.
const void *	p
	(protected) Pointer fields available for use by the text provider.
const void *	q
	(protected) Pointer fields available for use by the text provider.
const void *	r
	(protected) Pointer fields available for use by the text provider.
void *	privP
	Private field reserved for future use by the UText framework itself.
int64_t	a
	(protected) Integer field reserved for use by the text provider.
int32_t	b
	(protected) Integer field reserved for use by the text provider.
int32_t	c
	(protected) Integer field reserved for use by the text provider.
int64_t	privA
	Private field reserved for future use by the UText framework itself.
int32_t	privB
	Private field reserved for future use by the UText framework itself.
int32_t	privC
	Private field reserved for future use by the UText framework itself.

Detailed Description

UText struct.

Provides the interface between the generic UText access code and the UText provider code that works on specific kinds of text (UTF-8, noncontiguous UTF-16, whatever.)

Applications that are using predefined types of text providers to pass text data to ICU services will have no need to view the internals of the UText structs that they open.

Stable:: ICU 3.6

Definition at line 1345 of file utext.h.

Field Documentation

int64_t UText::a

(protected) Integer field reserved for use by the text provider.

Not used by the UText framework, or by the client (user) of the UText.

Stable:: ICU 3.4

Definition at line 1499 of file utext.h.

int32_t UText::b

(protected) Integer field reserved for use by the text provider.

Not used by the UText framework, or by the client (user) of the UText.

Stable:: ICU 3.4

Definition at line 1506 of file utext.h.

int32_t UText::c

(protected) Integer field reserved for use by the text provider.

Not used by the UText framework, or by the client (user) of the UText.

Stable:: ICU 3.4

Definition at line 1513 of file utext.h.

const UChar* UText::chunkContents

(protected) pointer to a chunk of text in UTF-16 format.

May refer either to original storage of the source of the text, or if conversion was required, to a buffer owned by the UText.

Stable:: ICU 3.6

Definition at line 1439 of file utext.h.

int32_t UText::chunkLength

(protected) Length the text chunk (UTF-16 buffer), in UChars.

Stable:: ICU 3.6

Definition at line 1428 of file utext.h.

int64_t UText::chunkNativeLimit

(protected) Native index of the first character position following the current chunk.

Stable:: ICU 3.6

Definition at line 1392 of file utext.h.

int64_t UText::chunkNativeStart

(protected) Native index of the first character in the text chunk.

Stable:: ICU 3.6

Definition at line 1415 of file utext.h.

int32_t UText::chunkOffset

(protected) Current iteration position within the text chunk (UTF-16 buffer).

This is the index to the character that will be returned by utext_next32().

Stable:: ICU 3.6

Definition at line 1422 of file utext.h.

const void* UText::context

(protected) Pointer to string or text-containing object or similar.

This is the source of the text that this UText is wrapping, in a format that is known to the text provider functions.

Stable:: ICU 3.4

Definition at line 1460 of file utext.h.

int32_t UText::extraSize

(protected) Size in bytes of the extra space (pExtra).

Stable:: ICU 3.4

Definition at line 1398 of file utext.h.

int32_t UText::flags

(private) Flags for managing the allocation and freeing of memory associated with this UText.

Internal:: Do not use. This API is for internal use only.

Definition at line 1366 of file utext.h.

uint32_t UText::magic

(private) Magic.

Used to help detect when UText functions are handed invalid or uninitialized UText structs. utext_openXYZ() functions take an initialized, but not necessarily open, UText struct as an optional fill-in parameter. This magic field is used to check for that initialization. Text provider close functions must NOT clear the magic field because that would prevent reuse of the UText struct.