Unicode processing functions with UTF-8 character encoding. More...

Data Structures
struct	GUI_STRING_UNICODE_t
	UNICODE processing information structure. More...

Enumerations
enum	GUI_STRING_UNICODE_Result_t { UNICODE_OK = 0x00, UNICODE_ERROR, UNICODE_PROGRESS }
	UNICODE processing result information. More...

Functions
void	gui_string_unicode_init (GUI_STRING_UNICODE_t *s)
	Initialize unicode processing structure. More...

GUI_STRING_UNICODE_Result_t	gui_string_unicode_decode (GUI_STRING_UNICODE_t *s, const GUI_Char c)
	Decodes single input byte of unicode formatted text. More...

uint8_t	gui_string_unicode_encode (const uint32_t c, GUI_Char *out)
	Encodes input character to UNICODE sequence of 1-4 bytes. More...

Detailed Description

Unicode processing functions with UTF-8 character encoding.

Enumeration Type Documentation

UNICODE processing result information.

Enumerator
UNICODE_OK	Indicates function successfully decode unicode sequence of 1-4 bytes
UNICODE_ERROR	Indicates function got an error with input data from 2nd to 4th byte in UTF-8 encoding
UNICODE_PROGRESS	Indicates function decoding is still in progress and it waits for new character

GUI_STRING_UNICODE_Result_t gui_string_unicode_decode	(	GUI_STRING_UNICODE_t *	s,
		const GUI_Char	c
	)

Decodes single input byte of unicode formatted text.

Parameters

[in,out]	*s	Pointer to working GUI_STRING_UNICODE_t structure for processing
[in]	c	Character to be used for decoding

Return values

Member of GUI_STRING_UNICODE_Result_t indicating decoding status

uint8_t gui_string_unicode_encode	(	const uint32_t	c,
		GUI_Char *	out
	)

Encodes input character to UNICODE sequence of 1-4 bytes.

Parameters

[in]	c	Character to encode to UNICODE sequence
[out]	out	Pointer to 4-bytes long array to store UNICODE information to

Return values

Number of bytes required for character encoding

void gui_string_unicode_init ( GUI_STRING_UNICODE_t * s )

Initialize unicode processing structure.

Parameters

[in] s Pointer to GUI_STRING_UNICODE_t to initialize to default values