keymile: Make distinct kmtegr1, kmvect1, suvd3 configs
[oweals/u-boot.git] / include / charset.h
index cf41eb5e5fb290eb3d50520ac4e037a820524751..4f7ae8fafdf7843f36871f10b9480ae841e989a5 100644 (file)
 
 #define MAX_UTF8_PER_UTF16 3
 
+/**
+ * console_read_unicode() - read Unicode code point from console
+ *
+ * @code:      pointer to store Unicode code point
+ * Return:     0 = success
+ */
+int console_read_unicode(s32 *code);
+
 /**
  * utf8_get() - get next UTF-8 code point from buffer
  *
@@ -38,9 +46,9 @@ int utf8_put(s32 code, char **dst);
  *
  * @src:               utf-8 string
  * @count:             maximum number of code points to convert
- * Return:             length in bytes after conversion to utf-16 without the
+ * Return:             length in u16 after conversion to utf-16 without the
  *                     trailing \0. If an invalid UTF-8 sequence is hit one
- *                     word will be reserved for a replacement character.
+ *                     u16 will be reserved for a replacement character.
  */
 size_t utf8_utf16_strnlen(const char *src, size_t count);
 
@@ -48,8 +56,9 @@ size_t utf8_utf16_strnlen(const char *src, size_t count);
  * utf8_utf16_strlen() - length of a utf-8 string after conversion to utf-16
  *
  * @src:               utf-8 string
- * Return:             length in bytes after conversion to utf-16 without the
- *                     trailing \0. -1 if the utf-8 string is not valid.
+ * Return:             length in u16 after conversion to utf-16 without the
+ *                     trailing \0. If an invalid UTF-8 sequence is hit one
+ *                     u16 will be reserved for a replacement character.
  */
 #define utf8_utf16_strlen(a) utf8_utf16_strnlen((a), SIZE_MAX)
 
@@ -119,7 +128,8 @@ size_t utf16_utf8_strnlen(const u16 *src, size_t count);
  *
  * @src:               utf-16 string
  * Return:             length in bytes after conversion to utf-8 without the
- *                     trailing \0. -1 if the utf-16 string is not valid.
+ *                     trailing \0. If an invalid UTF-16 sequence is hit one
+ *                     byte will be reserved for a replacement character.
  */
 #define utf16_utf8_strlen(a) utf16_utf8_strnlen((a), SIZE_MAX)
 
@@ -142,6 +152,22 @@ int utf16_utf8_strncpy(char **dst, const u16 *src, size_t count);
  */
 #define utf16_utf8_strcpy(d, s) utf16_utf8_strncpy((d), (s), SIZE_MAX)
 
+/**
+ * utf_to_lower() - convert a Unicode letter to lower case
+ *
+ * @code:              letter to convert
+ * Return:             lower case letter or unchanged letter
+ */
+s32 utf_to_lower(const s32 code);
+
+/**
+ * utf_to_upper() - convert a Unicode letter to upper case
+ *
+ * @code:              letter to convert
+ * Return:             upper case letter or unchanged letter
+ */
+s32 utf_to_upper(const s32 code);
+
 /**
  * u16_strlen - count non-zero words
  *
@@ -168,14 +194,27 @@ size_t u16_strlen(const u16 *in);
 size_t u16_strnlen(const u16 *in, size_t count);
 
 /**
- * utf16_strcpy() - UTF16 equivalent of strcpy()
+ * u16_strcpy() - copy u16 string
+ *
+ * Copy u16 string pointed to by src, including terminating null word, to
+ * the buffer pointed to by dest.
+ *
+ * @dest:              destination buffer
+ * @src:               source buffer (null terminated)
+ * Return:             'dest' address
  */
-uint16_t *utf16_strcpy(uint16_t *dest, const uint16_t *src);
+u16 *u16_strcpy(u16 *dest, const u16 *src);
 
 /**
- * utf16_strdup() - UTF16 equivalent of strdup()
+ * u16_strdup() - duplicate u16 string
+ *
+ * Copy u16 string pointed to by src, including terminating null word, to a
+ * newly allocated buffer.
+ *
+ * @src:               source buffer (null terminated)
+ * Return:             allocated new buffer on success, NULL on failure
  */
-uint16_t *utf16_strdup(const uint16_t *s);
+u16 *u16_strdup(const u16 *src);
 
 /**
  * utf16_to_utf8() - Convert an utf16 string to utf8
@@ -193,17 +232,4 @@ uint16_t *utf16_strdup(const uint16_t *s);
  */
 uint8_t *utf16_to_utf8(uint8_t *dest, const uint16_t *src, size_t size);
 
-/**
- * utf8_to_utf16() - Convert an utf8 string to utf16
- *
- * Converts up to 'size' characters of the utf16 string 'src' to utf8
- * written to the 'dest' buffer. Stops at 0x00.
- *
- * @dest   the destination buffer to write the utf8 characters
- * @src    the source utf16 string
- * @size   maximum number of utf16 characters to convert
- * @return the pointer to the first unwritten byte in 'dest'
- */
-uint16_t *utf8_to_utf16(uint16_t *dest, const uint8_t *src, size_t size);
-
 #endif /* __CHARSET_H_ */