Pointer to utf8 encoded character data. More...

#include <unicode.h>

Public Member Functions
char *	c_str (void) const
	Get c string we point to.
void	dec (void)
	Iterative decrement of a utf8 pointer to prior codepoint.
void	inc (void)
	Iterative increment of a utf8 pointer to next codepoint.
size_t	len (void) const
	Get length of null terminated utf8 string in codepoints.
	operator bool () const
	Check if text is valid pointer.
	operator char * () const
	Convert utf8 pointer to a generic string pointer.
bool	operator! () const
	Check if text is an invalid pointer.
bool	operator!= (const char *string) const
	check if pointer does not equal another string.
ucs4_t	operator* () const
	Get unicode character pointed to by pointer.
utf8_pointer	operator+ (long offset) const
	Get new utf8 string after adding a codepoint offset.
utf8_pointer &	operator++ ()
	Iterative increment of a utf8 pointer to prior codepoint.
utf8_pointer &	operator+= (long offset)
	Adjust utf8 pointer by specified codepoints forward.
utf8_pointer	operator- (long offset) const
	Get new utf8 string after subtracting a codepoint offset.
utf8_pointer &	operator-- ()
	Iterative decrement of a utf8 pointer to next codepoint.
utf8_pointer &	operator-= (long offset)
	Adjust utf8 pointer by specified codepoints backward.
utf8_pointer &	operator= (const char *string)
	Assign a utf8 string to point to.
bool	operator== (const char *string) const
	check if pointer equals another string.
ucs4_t	operator[] (long codepoint) const
	Extract a unicode character from a specified codepoint.
	utf8_pointer ()
	Create a utf8 pointer set to NULL.
	utf8_pointer (const char *string)
	Create a utf8 pointer for an existing char pointer.
	utf8_pointer (const utf8_pointer &copy)
	Create a utf8 pointer as a copy of existing utf8 pointer.

Protected Attributes
uint8_t *	text

Detailed Description

Pointer to utf8 encoded character data.

This is a kind of "char *" for utf8 text.

Author: David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 403 of file unicode.h.

Constructor & Destructor Documentation

◆ utf8_pointer() [1/2]

ucommon::utf8_pointer::utf8_pointer ( const char * string )

Create a utf8 pointer for an existing char pointer.

Parameters

string pointer to use.

◆ utf8_pointer() [2/2]

ucommon::utf8_pointer::utf8_pointer ( const utf8_pointer & copy )

Create a utf8 pointer as a copy of existing utf8 pointer.

Parameters

copy	of object to use.

Here is the call graph for this function:

Member Function Documentation

◆ c_str()

char * ucommon::utf8_pointer::c_str ( void ) const

inline

Get c string we point to.

Returns: string we point to.

Definition at line 536 of file unicode.h.

◆ len()

size_t ucommon::utf8_pointer::len ( void ) const

inline

Get length of null terminated utf8 string in codepoints.

Returns: codepoint length of string.

Definition at line 552 of file unicode.h.

Here is the call graph for this function:

◆ operator bool()

ucommon::utf8_pointer::operator bool ( ) const

inline

Check if text is valid pointer.

Returns: true if not NULL.

Definition at line 470 of file unicode.h.

◆ operator char *()

ucommon::utf8_pointer::operator char * ( ) const

inline

Convert utf8 pointer to a generic string pointer.

Returns: generic string pointer.

Definition at line 544 of file unicode.h.

◆ operator!()

bool ucommon::utf8_pointer::operator! ( ) const

inline

Check if text is an invalid pointer.

Returns: false if not NULL.

Definition at line 478 of file unicode.h.

◆ operator!=()

bool ucommon::utf8_pointer::operator!= ( const char * string ) const

inline

check if pointer does not equal another string.

Parameters

string to check.

Returns: false if same memory address.

Definition at line 520 of file unicode.h.

◆ operator*()

ucs4_t ucommon::utf8_pointer::operator* ( ) const

inline

Get unicode character pointed to by pointer.

Returns: unicode character we are pointing to.

Definition at line 528 of file unicode.h.

Here is the call graph for this function:

◆ operator+()

utf8_pointer ucommon::utf8_pointer::operator+ ( long offset ) const

Get new utf8 string after adding a codepoint offset.

Parameters

offset to add.

Returns: new utf8 pointer pointing to specified offset.

Here is the call graph for this function:

◆ operator++()

utf8_pointer & ucommon::utf8_pointer::operator++ ( )

Iterative increment of a utf8 pointer to prior codepoint.

Returns: object incremented.

Here is the call graph for this function:

◆ operator+=()

utf8_pointer & ucommon::utf8_pointer::operator+= ( long offset )

Adjust utf8 pointer by specified codepoints forward.

Parameters

offset to increment by.

Returns: object incremented.

Here is the call graph for this function:

◆ operator-()

utf8_pointer ucommon::utf8_pointer::operator- ( long offset ) const

Get new utf8 string after subtracting a codepoint offset.

Parameters

offset to subtract.

Returns: new utf8 pointer pointing to specified offset.

Here is the call graph for this function:

◆ operator--()

utf8_pointer & ucommon::utf8_pointer::operator-- ( )

Iterative decrement of a utf8 pointer to next codepoint.

Returns: object decremented.

Here is the call graph for this function:

◆ operator-=()

utf8_pointer & ucommon::utf8_pointer::operator-= ( long offset )

Adjust utf8 pointer by specified codepoints backward.

Parameters

offset to decrement by.

Returns: object decremented.

Here is the call graph for this function:

◆ operator=()

utf8_pointer & ucommon::utf8_pointer::operator= ( const char * string )

Assign a utf8 string to point to.

Parameters

string to point to.

Returns: current object after set to string.

Here is the call graph for this function:

◆ operator==()

bool ucommon::utf8_pointer::operator== ( const char * string ) const

inline

check if pointer equals another string.

Parameters

string to check.

Returns: true if same memory address.

Definition at line 511 of file unicode.h.

◆ operator[]()

ucs4_t ucommon::utf8_pointer::operator[] ( long codepoint ) const

Extract a unicode character from a specified codepoint.

Parameters

codepoint offset to extract character from.

Returns: unicode character or 0.

Field Documentation

◆ text

uint8_t* ucommon::utf8_pointer::text

protected

Definition at line 406 of file unicode.h.

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

/builddir/build/BUILD/ucommon-7.0.0-build/ucommon-7.0.0/inc/ucommon/unicode.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ utf8_pointer() [1/2]

◆ utf8_pointer() [2/2]

Member Function Documentation

◆ c_str()

◆ len()

◆ operator bool()

◆ operator char *()

◆ operator!()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator++()

◆ operator+=()

◆ operator-()

◆ operator--()

◆ operator-=()

◆ operator=()

◆ operator==()

◆ operator[]()

Field Documentation

◆ text