UText Struct Reference

#include <utext.h>

Public Attributes
uint32_t	magic
int32_t	flags
int32_t	providerProperties
int32_t	sizeOfStruct
int64_t	chunkNativeLimit
int32_t	extraSize
int32_t	nativeIndexingLimit
int64_t	chunkNativeStart
int32_t	chunkOffset
int32_t	chunkLength
const UChar *	chunkContents
const UTextFuncs *	pFuncs
void *	pExtra
const void *	context
const void *	p
const void *	q
const void *	r
void *	privP
int64_t	a
int32_t	b
int32_t	c
int64_t	privA
int32_t	privB
int32_t	privC

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.

ICU 3.6

Member Data Documentation

a

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. ICU 3.4

b

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. ICU 3.4

c

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. ICU 3.4

chunkContents

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. ICU 3.6

chunkLength

int32_t UText::chunkLength

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

chunkNativeLimit

int64_t UText::chunkNativeLimit

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

chunkNativeStart

int64_t UText::chunkNativeStart

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

chunkOffset

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

context

const void * UText::context

(protected) Pointer to string or text-containin 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. ICU 3.4

extraSize

int32_t UText::extraSize

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

flags

int32_t UText::flags

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

magic

uint32_t UText::magic

(private) Magic. Used to help detect when UText functions are handed invalid or unitialized 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.

nativeIndexingLimit

int32_t UText::nativeIndexingLimit

(protected) The highest chunk offset where native indexing and chunk (UTF-16) indexing correspond. For UTF-16 sources, value will be equal to chunkLength.

ICU 3.6

p

const void * UText::p

(protected) Pointer fields available for use by the text provider. Not used by UText common code. ICU 3.6

pExtra

void * UText::pExtra

(protected) Pointer to additional space requested by the text provider during the utext_open operation. ICU 3.4

pFuncs

const UTextFuncs * UText::pFuncs

(public) Pointer to Dispatch table for accessing functions for this UText. ICU 3.6

privA

int64_t UText::privA

Private field reserved for future use by the UText framework itself. This is not to be touched by the text providers.

privB

int32_t UText::privB

Private field reserved for future use by the UText framework itself. This is not to be touched by the text providers.

privC

int32_t UText::privC

Private field reserved for future use by the UText framework itself. This is not to be touched by the text providers.

privP

void * UText::privP

Private field reserved for future use by the UText framework itself. This is not to be touched by the text providers.

providerProperties

int32_t UText::providerProperties

Text provider properties. This set of flags is maintainted by the text provider implementation. ICU 3.4

q

const void * UText::q

(protected) Pointer fields available for use by the text provider. Not used by UText common code. ICU 3.6

r

const void * UText::r

(protected) Pointer fields available for use by the text provider. Not used by UText common code. ICU 3.6

sizeOfStruct

int32_t UText::sizeOfStruct

(public) sizeOfStruct=sizeof(UText) Allows possible backward compatible extension.

ICU 3.4

---

The documentation for this struct was generated from the following file:

• DerivedData/WebKit/Build/Products/Debug/WebCore.framework/Versions/A/PrivateHeaders/icu/unicode/utext.h