Tizen(Headed) Native API  6.5
Unicode String

These functions provide basic unicode string handling.

Eina_Unicode is 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. Assumes n < len.
int eina_unicode_strcmp (const Eina_Unicode *a, const Eina_Unicode *b) 2)
 Same as the standard strcmp just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_strcpy (Eina_Unicode *dest, const Eina_Unicode *source) 2)
 Same as the standard strcpy just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_strstr (const Eina_Unicode *haystack, const Eina_Unicode *needle) 2)
 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) 2)
 Same as the standard strncpy just with Eina_Unicode instead of char.
Eina_Unicodeeina_unicode_escape (const Eina_Unicode *str)
static Eina_Unicode eina_unicode_utf8_next_get (const char *buf, int *iindex) 2)
Eina_Unicode eina_unicode_utf8_get_next (const char *buf, int *iindex) 2)
Eina_Unicode eina_unicode_utf8_get_prev (const char *buf, int *iindex) 2)
int eina_unicode_utf8_get_len (const char *buf)
Eina_Unicodeeina_unicode_utf8_to_unicode (const char *utf, int *_len)
char * eina_unicode_unicode_to_utf8_range (const Eina_Unicode *uni, int ulen, int *_len)
char * eina_unicode_unicode_to_utf8 (const Eina_Unicode *uni, int *_len)

Typedefs

typedef uint32_t Eina_Unicode

Typedef Documentation

A type that holds Unicode codepoints.


Function Documentation

See also:
eina_str_escape()
Parameters:
[in]strThe string to escape.
Returns:
The escaped string.
Since :
2.3
int eina_unicode_strcmp ( const Eina_Unicode a,
const Eina_Unicode b 
)

Same as the standard strcmp just with Eina_Unicode instead of char.

Parameters:
[in]aThe text to be compared.
[in]bThe text to be compared.
Returns:
An integer value indicating the ordinal relation of a to b.
Since :
2.3
Eina_Unicode* eina_unicode_strcpy ( Eina_Unicode dest,
const Eina_Unicode source 
)

Same as the standard strcpy just with Eina_Unicode instead of char.

Parameters:
[out]destThe text which source is to be copied.
[in]sourceThe text to copy from.
Returns:
dest is returned.
Since :
2.3

Same as the standard strdup just with Eina_Unicode instead of char.

Parameters:
[in]textThe text to duplicate.
Returns:
The duplicated string.
Since :
2.3
size_t eina_unicode_strlen ( const Eina_Unicode ustr)
Since :
2.3
Eina_Unicode* eina_unicode_strncpy ( Eina_Unicode dest,
const Eina_Unicode source,
size_t  n 
)

Same as the standard strncpy just with Eina_Unicode instead of char.

Parameters:
[out]destThe text which source is to be copied.
[in]sourceThe text to copy from.
[in]nMaximum number of characters to be copied from source.
Returns:
dest is returned.
Since :
2.3
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:
[in]textThe text to duplicate.
[in]nThe maximum size of the text to duplicate.
Returns:
The duplicated string.

This function duplicates text. The resulting 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 (EFL) :
1.1.0
Since :
2.3
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:
[in]ustrString to search
[in]nMax length to search
Returns:
Number of characters or n.
Since :
2.3
Eina_Unicode* eina_unicode_strstr ( const Eina_Unicode haystack,
const Eina_Unicode needle 
)

Same as the standard strstr just with Eina_Unicode instead of char.

Parameters:
[in]haystackThe text to be searched.
[in]needleThe text to search for
Returns:
The substring of haystack which starts with needle when needle is founded in haystack, or NULL is returned.
Since :
2.3
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:
[in]unithe Eina_Unicode string
[out]_lenthe length byte length of the return utf8 string.
Returns:
the newly allocated utf-8 string.
Since (EFL) :
1.1.0
Since :
2.3
char* eina_unicode_unicode_to_utf8_range ( const Eina_Unicode uni,
int  ulen,
int *  _len 
)

Converts an Eina_Unicode string to a newly allocated utf-8 substring at given length.

Parameters:
[in]unithe Eina_Unicode string
[in]ulenthe length in the unicode string to convert.
[out]_lenthe length byte length of the return utf8 substring.
Returns:
the newly allocated utf-8 substring.
Since (EFL) :
1.17
Since :
3.0
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:
[in]bufthe string
Returns:
the number of unicode characters (not bytes) in the string
Since (EFL) :
1.1.0
Since :
2.3
Eina_Unicode eina_unicode_utf8_get_next ( const char *  buf,
int *  iindex 
)
Deprecated:
use eina_unicode_utf8_next_get Deprecated since Tizen 2.4 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:
[in]bufthe string
[in,out]iindexthe index to look at and return by.
Returns:
the codepoint found, 0 if buf or iindex are NULL
Since (EFL) :
1.1.0
Since :
2.3
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 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:
[in]bufthe string
[in,out]iindexthe index to look at and return by.
Returns:
the codepoint found.
Since (EFL) :
1.1.0
Since :
2.3
static Eina_Unicode eina_unicode_utf8_next_get ( const char *  buf,
int *  iindex 
) [static]

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:
[in]bufthe string
[in,out]iindexthe index to look at and return by.
Returns:
the codepoint found, 0 if buf or iindex are NULL
Since (EFL) :
1.8.0
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:
[in]utfthe string in utf-8
[out]_lenthe length of the returned Eina_Unicode string.
Returns:
the newly allocated Eina_Unicode string.
Since (EFL) :
1.1.0
Since :
2.3

Variable Documentation

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

Since :
3.0