Unicode String

---

These functions provide basic unicode string handling.

Eina_Unicode is a type that holds unicode codepoints.

Functions
size_t	eina_unicode_strnlen (const Eina_Unicode *ustr, int n)
	Returns the length of a Eina_Unicode string, up to a limit.
Eina_Unicode *	eina_unicode_strdup (const Eina_Unicode *text)
	Same as the standard strdup just with Eina_Unicode instead of char.
Eina_Unicode *	eina_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_Unicode *	eina_unicode_strcpy (Eina_Unicode *dest, const Eina_Unicode *source) 2)
	Same as the standard strcpy just with Eina_Unicode instead of char.
Eina_Unicode *	eina_unicode_strstr (const Eina_Unicode *haystack, const Eina_Unicode *needle) 2)
	Same as the standard strstr just with Eina_Unicode instead of char.
Eina_Unicode *	eina_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_Unicode *	eina_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_Unicode *	eina_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

Eina_Unicode

A type that holds Unicode codepoints.

---

Function Documentation

Eina_Unicode* eina_unicode_escape

(

const Eina_Unicode *

str

)

See also:

eina_str_escape()

Parameters:

str	The 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.

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.

Since :

2.3

Eina_Unicode* eina_unicode_strdup

(

const Eina_Unicode *

text

)

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

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.

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:

text	The text to duplicate.
n	The 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 (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:

ustr	String to search
n	Max 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.

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:

uni	the Eina_Unicode string
_len	the 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:

uni	the Eina_Unicode string
ulen	the length in the unicode string to convert.
_len	the 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:

buf	the 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:

buf	the string
iindex	the 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 à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:

buf	the string
iindex	the 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:

buf	the string
iindex	the 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:

utf	the string in utf-8
_len	the length of the returned Eina_Unicode string.

Returns:

the newly allocated Eina_Unicode string.

Since (EFL) :

1.1.0

Since :

2.3

---

Variable Documentation

const Eina_Unicode* EINA_UNICODE_EMPTY_STRING

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

Since :

2.3