gp_utf.h File Reference

Unicode helper macros and functions. More...

#include <stdint.h>
#include <stddef.h>

Go to the source code of this file.

Macros
#define	GP_UTF8_IS_ASCII(ch)
#define	GP_UTF8_IS_NBYTE(ch)
#define	GP_UTF8_IS_2BYTE(ch)
#define	GP_UTF8_IS_3BYTE(ch)
#define	GP_UTF8_IS_4BYTE(ch)

Functions
static uint32_t	gp_utf8_next (const char **str)
	Parses next unicode character in UTF-8 string.
int8_t	gp_utf8_next_chsz (const char *str, size_t off)
	Returns number of bytes next character is occupying in an UTF-8 string.
int8_t	gp_utf8_prev_chsz (const char *str, size_t off)
	Returns number of bytes previous character is occupying in an UTF-8 string.
size_t	gp_utf8_strlen (const char *str)
	Returns a number of characters in UTF-8 string.
static unsigned int	gp_utf8_bytes (uint32_t unicode)
	Returns a number of bytes needed to store unicode character into UTF-8.
static int	gp_to_utf8 (uint32_t unicode, char *buf)
	Writes an unicode character into a UTF-8 buffer.
static size_t	gp_utf16_to_utf8_size (uint16_t *chars, size_t chars_len)
	Calculates a size for an utf8 string to hold utf16 characters.
static void	gp_utf16_to_utf8 (uint16_t *chars, size_t chars_len, char *dest)
	Convers utf16 characters into an utf8 string.
static size_t	gp_utf32_to_utf8_size (uint32_t *chars, size_t chars_len)
	Calculates a size for an utf8 string to hold utf32 characters.
static void	gp_utf32_to_utf8 (uint32_t *chars, size_t chars_len, char *dest)
	Convers utf32 characters into an utf8 string.
uint32_t	gp_utf_fallback (uint32_t ch)
	Attempts to strip diacritics from an unicode character.

Detailed Description

Unicode helper macros and functions.

Definition in file gp_utf.h.

Macro Definition Documentation

GP_UTF8_IS_2BYTE

#define GP_UTF8_IS_2BYTE

(

ch

)

Value:

(((ch) & 0xe0) == 0xc0)

Returns true if we have first unicode byte of two byte sequence

Definition at line 22 of file gp_utf.h.

Referenced by gp_utf8_next().

GP_UTF8_IS_3BYTE

#define GP_UTF8_IS_3BYTE

(

ch

)

Value:

(((ch) & 0xf0) == 0xe0)

Returns true if we have first unicode byte of three byte sequence

Definition at line 24 of file gp_utf.h.

Referenced by gp_utf8_next().

GP_UTF8_IS_4BYTE

#define GP_UTF8_IS_4BYTE

(

ch

)

Value:

(((ch) & 0xf8) == 0xf0)

Returns true if we have first unicode byte of four byte sequence

Definition at line 26 of file gp_utf.h.

Referenced by gp_utf8_next().

GP_UTF8_IS_ASCII

#define GP_UTF8_IS_ASCII

(

ch

)

Value:

(!((ch) & 0x80))

Returns true if unicode byte is ASCII

Definition at line 18 of file gp_utf.h.

Referenced by gp_utf8_next().

GP_UTF8_IS_NBYTE

#define GP_UTF8_IS_NBYTE

(

ch

)

Value:

(((ch) & 0xc0) == 0x80)

Returns true if we have first unicode byte of single byte sequence

Definition at line 20 of file gp_utf.h.

Referenced by gp_utf8_next().

Function Documentation

gp_to_utf8()

static int gp_to_utf8 ( uint32_t unicode, char * buf )

inlinestatic

Writes an unicode character into a UTF-8 buffer.

The buffer must be large enough!

Parameters

unicode	A unicode character.
buf	A byte buffer.

Returns

A number of bytes written.

Definition at line 141 of file gp_utf.h.

Referenced by gp_utf16_to_utf8(), gp_utf32_to_utf8(), and gp_vec_ins_utf8().

gp_utf16_to_utf8()

static void gp_utf16_to_utf8 ( uint16_t * chars, size_t chars_len, char * dest )

inlinestatic

Convers utf16 characters into an utf8 string.

Parameters

chars	An array of utf16 characters.
chars_len	The lenth of the utf16 array.
dest	A buffer large enough to store the utf16 characters and terminating null character. This can be calculated by gp_utf16_to_utf8_size().

Definition at line 204 of file gp_utf.h.

References gp_to_utf8().

gp_utf16_to_utf8_size()

static size_t gp_utf16_to_utf8_size ( uint16_t * chars, size_t chars_len )

inlinestatic

Calculates a size for an utf8 string to hold utf16 characters.

Parameters

chars	An array of utf16 characters.
chars_len	The lenth of the utf16 array.

Returns

A size of the buffer or zero in a case of a size_t overflow. The returned size includes space for a terminating null character.

Definition at line 177 of file gp_utf.h.

References gp_utf8_bytes().

gp_utf32_to_utf8()

static void gp_utf32_to_utf8 ( uint32_t * chars, size_t chars_len, char * dest )

inlinestatic

Convers utf32 characters into an utf8 string.

Parameters

chars	An array of utf32 characters.
chars_len	The lenth of the utf16 array.
dest	A buffer large enough to store the utf32 characters and terminating null character. This can be calculated by gp_utf32_to_utf8_size().

Definition at line 251 of file gp_utf.h.

References gp_to_utf8().

gp_utf32_to_utf8_size()

static size_t gp_utf32_to_utf8_size ( uint32_t * chars, size_t chars_len )

inlinestatic

Calculates a size for an utf8 string to hold utf32 characters.

Parameters

chars	An array of utf32 characters.
chars_len	The lenth of the utf32 array.

Returns

A size of the buffer or zero in a case of a size_t overflow. The returned size includes space for a terminating null character.

Definition at line 224 of file gp_utf.h.

References gp_utf8_bytes().

gp_utf8_bytes()

static unsigned int gp_utf8_bytes ( uint32_t unicode )

inlinestatic

Returns a number of bytes needed to store unicode character into UTF-8.

Parameters

unicode

A unicode character.

Returns

Number of utf8 bytes required to store a unicode character.

Definition at line 118 of file gp_utf.h.

Referenced by gp_utf16_to_utf8_size(), gp_utf32_to_utf8_size(), and gp_vec_ins_utf8().

gp_utf8_next()

static uint32_t gp_utf8_next ( const char ** str )

inlinestatic

Parses next unicode character in UTF-8 string.

Parameters

str	A pointer to the C string.

Returns

A unicode character or 0 on error or end of the string.

Definition at line 35 of file gp_utf.h.

References GP_UTF8_IS_2BYTE, GP_UTF8_IS_3BYTE, GP_UTF8_IS_4BYTE, GP_UTF8_IS_ASCII, and GP_UTF8_IS_NBYTE.

Referenced by gp_utf8_pos_next(), and gp_utf8_pos_prev().

gp_utf8_next_chsz()

int8_t gp_utf8_next_chsz	(	const char *	str,
		size_t	off )

Returns number of bytes next character is occupying in an UTF-8 string.

Parameters

str	A pointer to a string.
off	An offset into the string, must point to a valid multibyte boundary.

Returns

Number of bytes next character occupies, zero on string end and -1 on failure.

Referenced by gp_utf8_pos_last(), gp_utf8_pos_move(), and gp_utf8_pos_next().

gp_utf8_prev_chsz()

int8_t gp_utf8_prev_chsz	(	const char *	str,
		size_t	off )

Returns number of bytes previous character is occupying in an UTF-8 string.

Parameters

str	A pointer to a string.
off	An offset into the string, must point to a valid multibyte boundary.

Returns

Number of bytes previous character occupies, and -1 on failure.

Referenced by gp_utf8_pos_move(), and gp_utf8_pos_prev().

gp_utf8_strlen()

size_t gp_utf8_strlen

(

const char *

str

)

Returns a number of characters in UTF-8 string.

Returns number of characters in an UTF-8 string, which may be less or equal to what strlen() reports.

Parameters

str	An UTF-8 string.

Returns

Number of characters in the string.

gp_utf_fallback()

uint32_t gp_utf_fallback

(

uint32_t

ch

)

Attempts to strip diacritics from an unicode character.

Attempts to strip diacritics and replace symbols with a similar meaning which produces text that can be stil readable even with ASCII only font.

Parameters

ch	An UTF character.

Returns

A replacemement for a character with the same meaning or original character if mapping was not found.