Unicode String

Typedefs

typedef uint32_t Eina_Unicode
 A type that holds Unicode codepoints.

Functions

size_t eina_unicode_strlen (const Eina_Unicode *ustr)
size_t eina_unicode_strnlen (const Eina_Unicode *ustr, int n)
 Returns the length of a Eina_Unicode string, up to a limit.
Eina_Unicodeeina_unicode_strdup (const Eina_Unicode *text)
 Same as the standard strdup just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_strndup (const Eina_Unicode *text, size_t n)
 Same as strdup but cuts on the given size.
int eina_unicode_strcmp (const Eina_Unicode *a, const Eina_Unicode *b)
 Same as the standard strcmp just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_strcpy (Eina_Unicode *dest, const Eina_Unicode *source)
 Same as the standard strcpy just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_strstr (const Eina_Unicode *haystack, const Eina_Unicode *needle)
 Same as the standard strstr just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_strncpy (Eina_Unicode *dest, const Eina_Unicode *source, size_t n)
 Same as the standard strncpy just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_escape (const Eina_Unicode *str)
Eina_Unicode eina_unicode_utf8_get_next (const char *buf, int *iindex)
 Reads UTF8 bytes from buf, starting at iindex and returns the decoded code point at iindex offset, and advances iindex to the next code point after this.
Eina_Unicode eina_unicode_utf8_get_prev (const char *buf, int *iindex)
 Reads UTF8 bytes from buf, starting at iindex and returns the decoded code point at iindex offset, and moves àp iindex to the previous code point.
int eina_unicode_utf8_get_len (const char *buf)
 Returns the number of unicode characters in the string.
Eina_Unicodeeina_unicode_utf8_to_unicode (const char *utf, int *_len)
 Converts a utf-8 string to a newly allocated Eina_Unicode string.
char * eina_unicode_unicode_to_utf8 (const Eina_Unicode *uni, int *_len)
 Converts an Eina_Unicode string to a newly allocated utf-8 string.

Variables

const Eina_UnicodeEINA_UNICODE_EMPTY_STRING
 Same as the standard strlen just with Eina_Unicode instead of char.

Detailed Description

These functions provide basic unicode string handling

Eina_Unicode is a type that holds unicode codepoints.

Function Documentation

◆ eina_unicode_strnlen()

size_t eina_unicode_strnlen ( const Eina_Unicode * ustr,
int n )

Returns the length of a Eina_Unicode string, up to a limit.

This function returns the number of characters in string, up to a maximum of n. If the terminating character is not found in the string, it returns n.

Parameters
ustrString to search
nMax length to search
Returns
Number of characters or n.

◆ eina_unicode_strndup()

Eina_Unicode * eina_unicode_strndup ( const Eina_Unicode * text,
size_t n )

Same as strdup but cuts on the given size.

Assumes n < len

Parameters
textThe text to duplicate.
nThe maximum size of the text to duplicate.
Returns
The duplicated string.

This function duplicates text. The resuting string is cut on n. n is assumed to be lesser (<) than the length of text. When not needed anymore, the returned string must be freed.

Since
1.1.0

Referenced by eina_unicode_strdup().

◆ eina_unicode_escape()

Eina_Unicode * eina_unicode_escape ( const Eina_Unicode * str)
See also
eina_str_escape()
Parameters
strThe string to escape.
Returns
The escaped string.

◆ eina_unicode_utf8_get_next()

Eina_Unicode eina_unicode_utf8_get_next ( const char * buf,
int * iindex )

Reads UTF8 bytes from buf, starting at iindex and returns the decoded code point at iindex offset, and advances iindex to the next code point after this.

iindex is always advanced, unless if the advancement is after the NULL. On error: return a codepoint between DC80 to DCFF where the low 8 bits are the byte's value.

Parameters
bufthe string
iindexthe index to look at and return by.
Returns
the codepoint found.
Since
1.1.0

Referenced by eina_unicode_utf8_get_len(), eina_unicode_utf8_get_prev(), and eina_unicode_utf8_to_unicode().

◆ eina_unicode_utf8_get_prev()

Eina_Unicode eina_unicode_utf8_get_prev ( const char * buf,
int * iindex )

Reads UTF8 bytes from buf, starting at iindex and returns the decoded code point at iindex offset, and moves àp iindex to the previous code point.

iindex is always moved, as long as it's not past the start of the string. On error: return a codepoint between DC80 to DCFF where the low 8 bits are the byte's value.

Parameters
bufthe string
iindexthe index to look at and return by.
Returns
the codepoint found.
Since
1.1.0

References eina_unicode_utf8_get_next().

◆ eina_unicode_utf8_get_len()

int eina_unicode_utf8_get_len ( const char * buf)

Returns the number of unicode characters in the string.

That is, the number of Eina_Unicodes it'll take to store this string in an Eina_Unicode string.

Parameters
bufthe string
Returns
the number of unicode characters (not bytes) in the string
Since
1.1.0

References eina_unicode_utf8_get_next().

Referenced by eina_unicode_utf8_to_unicode().

◆ eina_unicode_utf8_to_unicode()

Eina_Unicode * eina_unicode_utf8_to_unicode ( const char * utf,
int * _len )

Converts a utf-8 string to a newly allocated Eina_Unicode string.

Parameters
utfthe string in utf-8
_lenthe length of the returned Eina_Unicode string.
Returns
the newly allocated Eina_Unicode string.
Since
1.1.0

References eina_unicode_utf8_get_len(), and eina_unicode_utf8_get_next().

◆ eina_unicode_unicode_to_utf8()

char * eina_unicode_unicode_to_utf8 ( const Eina_Unicode * uni,
int * _len )

Converts an Eina_Unicode string to a newly allocated utf-8 string.

Parameters
unithe Eina_Unicode string
_lenthe length byte length of the return utf8 string.
Returns
the newly allocated utf-8 string.
Since
1.1.0