1 /* gutf8.c - Operations on UTF-8 strings.
3 * Copyright (C) 1999 Tom Tromey
4 * Copyright (C) 2000 Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
33 #ifdef G_PLATFORM_WIN32
40 #include "libcharset/libcharset.h"
44 #define UTF8_COMPUTE(Char, Mask, Len) \
50 else if ((Char & 0xe0) == 0xc0) \
55 else if ((Char & 0xf0) == 0xe0) \
60 else if ((Char & 0xf8) == 0xf0) \
65 else if ((Char & 0xfc) == 0xf8) \
70 else if ((Char & 0xfe) == 0xfc) \
78 #define UTF8_LENGTH(Char) \
79 ((Char) < 0x80 ? 1 : \
80 ((Char) < 0x800 ? 2 : \
81 ((Char) < 0x10000 ? 3 : \
82 ((Char) < 0x200000 ? 4 : \
83 ((Char) < 0x4000000 ? 5 : 6)))))
86 #define UTF8_GET(Result, Chars, Count, Mask, Len) \
87 (Result) = (Chars)[0] & (Mask); \
88 for ((Count) = 1; (Count) < (Len); ++(Count)) \
90 if (((Chars)[(Count)] & 0xc0) != 0x80) \
96 (Result) |= ((Chars)[(Count)] & 0x3f); \
99 #define UNICODE_VALID(Char) \
100 ((Char) < 0x110000 && \
101 (((Char) & 0xFFFFF800) != 0xD800) && \
102 ((Char) < 0xFDD0 || (Char) > 0xFDEF) && \
103 ((Char) & 0xFFFE) != 0xFFFE)
106 static const gchar utf8_skip_data[256] = {
107 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
108 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
109 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
110 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
111 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
112 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
113 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
114 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,4,4,4,4,4,4,4,4,5,5,5,5,6,6,1,1
117 const gchar * const g_utf8_skip = utf8_skip_data;
120 * g_utf8_find_prev_char:
121 * @str: pointer to the beginning of a UTF-8 encoded string
122 * @p: pointer to some position within @str
124 * Given a position @p with a UTF-8 encoded string @str, find the start
125 * of the previous UTF-8 character starting before @p. Returns %NULL if no
126 * UTF-8 characters are present in @p before @str.
128 * @p does not have to be at the beginning of a UTF-8 character. No check
129 * is made to see if the character found is actually valid other than
130 * it starts with an appropriate byte.
132 * Return value: a pointer to the found character or %NULL.
135 g_utf8_find_prev_char (const char *str,
138 for (--p; p >= str; --p)
140 if ((*p & 0xc0) != 0x80)
147 * g_utf8_find_next_char:
148 * @p: a pointer to a position within a UTF-8 encoded string
149 * @end: a pointer to the end of the string, or %NULL to indicate
150 * that the string is nul-terminated, in which case
151 * the returned value will be
153 * Finds the start of the next UTF-8 character in the string after @p.
155 * @p does not have to be at the beginning of a UTF-8 character. No check
156 * is made to see if the character found is actually valid other than
157 * it starts with an appropriate byte.
159 * Return value: a pointer to the found character or %NULL
162 g_utf8_find_next_char (const gchar *p,
168 for (++p; p < end && (*p & 0xc0) == 0x80; ++p)
171 for (++p; (*p & 0xc0) == 0x80; ++p)
174 return (p == end) ? NULL : (gchar *)p;
179 * @p: a pointer to a position within a UTF-8 encoded string
181 * Finds the previous UTF-8 character in the string before @p.
183 * @p does not have to be at the beginning of a UTF-8 character. No check
184 * is made to see if the character found is actually valid other than
185 * it starts with an appropriate byte. If @p might be the first
186 * character of the string, you must use g_utf8_find_prev_char() instead.
188 * Return value: a pointer to the found character.
191 g_utf8_prev_char (const gchar *p)
196 if ((*p & 0xc0) != 0x80)
203 * @p: pointer to the start of a UTF-8 encoded string.
204 * @max: the maximum number of bytes to examine. If @max
205 * is less than 0, then the string is assumed to be
206 * nul-terminated. If @max is 0, @p will not be examined and
209 * Returns the length of the string in characters.
211 * Return value: the length of the string in characters
214 g_utf8_strlen (const gchar *p,
218 const gchar *start = p;
219 g_return_val_if_fail (p != NULL || max == 0, 0);
225 p = g_utf8_next_char (p);
234 p = g_utf8_next_char (p);
236 while (p - start < max && *p)
239 p = g_utf8_next_char (p);
242 /* only do the last len increment if we got a complete
243 * char (don't count partial chars)
245 if (p - start == max)
254 * @p: a pointer to Unicode character encoded as UTF-8
256 * Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
257 * If @p does not point to a valid UTF-8 encoded character, results are
258 * undefined. If you are not sure that the bytes are complete
259 * valid Unicode characters, you should use g_utf8_get_char_validated()
262 * Return value: the resulting character
265 g_utf8_get_char (const gchar *p)
267 int i, mask = 0, len;
269 unsigned char c = (unsigned char) *p;
271 UTF8_COMPUTE (c, mask, len);
274 UTF8_GET (result, p, i, mask, len);
280 * g_utf8_offset_to_pointer:
281 * @str: a UTF-8 encoded string
282 * @offset: a character offset within @str
284 * Converts from an integer character offset to a pointer to a position
287 * Return value: the resulting pointer
290 g_utf8_offset_to_pointer (const gchar *str,
293 const gchar *s = str;
295 s = g_utf8_next_char (s);
301 * g_utf8_pointer_to_offset:
302 * @str: a UTF-8 encoded string
303 * @pos: a pointer to a position within @str
305 * Converts from a pointer to position within a string to a integer
308 * Return value: the resulting character offset
311 g_utf8_pointer_to_offset (const gchar *str,
314 const gchar *s = str;
319 s = g_utf8_next_char (s);
329 * @dest: buffer to fill with characters from @src
330 * @src: UTF-8 encoded string
331 * @n: character count
333 * Like the standard C strncpy() function, but
334 * copies a given number of characters instead of a given number of
335 * bytes. The @src string must be valid UTF-8 encoded text.
336 * (Use g_utf8_validate() on all text before trying to use UTF-8
337 * utility functions with it.)
339 * Return value: @dest
342 g_utf8_strncpy (gchar *dest,
346 const gchar *s = src;
349 s = g_utf8_next_char(s);
352 strncpy(dest, src, s - src);
357 G_LOCK_DEFINE_STATIC (aliases);
360 get_alias_hash (void)
362 static GHashTable *alias_hash = NULL;
369 alias_hash = g_hash_table_new (g_str_hash, g_str_equal);
371 aliases = _g_locale_get_charset_aliases ();
372 while (*aliases != '\0')
374 const char *canonical;
376 const char **alias_array;
380 aliases += strlen (aliases) + 1;
382 aliases += strlen (aliases) + 1;
384 alias_array = g_hash_table_lookup (alias_hash, canonical);
387 while (alias_array[count])
391 alias_array = g_renew (const char *, alias_array, count + 2);
392 alias_array[count] = alias;
393 alias_array[count + 1] = NULL;
395 g_hash_table_insert (alias_hash, (char *)canonical, alias_array);
404 /* As an abuse of the alias table, the following routines gets
405 * the charsets that are aliases for the canonical name.
408 _g_charset_get_aliases (const char *canonical_name)
410 GHashTable *alias_hash = get_alias_hash ();
412 return g_hash_table_lookup (alias_hash, canonical_name);
416 g_utf8_get_charset_internal (const char *raw_data,
419 const char *charset = getenv("CHARSET");
421 if (charset && *charset)
425 if (charset && strstr (charset, "UTF-8"))
431 /* The libcharset code tries to be thread-safe without
432 * a lock, but has a memory leak and a missing memory
433 * barrier, so we lock for it
436 charset = _g_locale_charset_unalias (raw_data);
439 if (charset && *charset)
443 if (charset && strstr (charset, "UTF-8"))
449 /* Assume this for compatibility at present. */
455 typedef struct _GCharsetCache GCharsetCache;
457 struct _GCharsetCache {
464 charset_cache_free (gpointer data)
466 GCharsetCache *cache = data;
468 g_free (cache->charset);
474 * @charset: return location for character set name
476 * Obtains the character set for the current locale; you might use
477 * this character set as an argument to g_convert(), to convert from
478 * the current locale's encoding to some other encoding. (Frequently
479 * g_locale_to_utf8() and g_locale_from_utf8() are nice shortcuts,
482 * The return value is %TRUE if the locale's encoding is UTF-8, in that
483 * case you can perhaps avoid calling g_convert().
485 * The string returned in @charset is not allocated, and should not be
488 * Return value: %TRUE if the returned charset is UTF-8
491 g_get_charset (G_CONST_RETURN char **charset)
493 static GStaticPrivate cache_private = G_STATIC_PRIVATE_INIT;
494 GCharsetCache *cache = g_static_private_get (&cache_private);
499 cache = g_new0 (GCharsetCache, 1);
500 g_static_private_set (&cache_private, cache, charset_cache_free);
503 raw = _g_locale_charset_raw ();
505 if (!(cache->raw && strcmp (cache->raw, raw) == 0))
507 const gchar *new_charset;
510 g_free (cache->charset);
511 cache->raw = g_strdup (raw);
512 cache->is_utf8 = g_utf8_get_charset_internal (raw, &new_charset);
513 cache->charset = g_strdup (new_charset);
517 *charset = cache->charset;
519 return cache->is_utf8;
526 * @c: a ISO10646 character code
527 * @outbuf: output buffer, must have at least 6 bytes of space.
528 * If %NULL, the length will be computed and returned
529 * and nothing will be written to @outbuf.
531 * Converts a single character to UTF-8.
533 * Return value: number of bytes written
536 g_unichar_to_utf8 (gunichar c,
539 /* If this gets modified, also update the copy in g_string_insert_unichar() */
554 else if (c < 0x10000)
559 else if (c < 0x200000)
564 else if (c < 0x4000000)
577 for (i = len - 1; i > 0; --i)
579 outbuf[i] = (c & 0x3f) | 0x80;
582 outbuf[0] = c | first;
590 * @p: a nul-terminated UTF-8 encoded string
591 * @len: the maximum length of @p
592 * @c: a ISO10646 character
594 * Finds the leftmost occurrence of the given ISO10646 character
595 * in a UTF-8 encoded string, while limiting the search to @len bytes.
596 * If @len is -1, allow unbounded search.
598 * Return value: %NULL if the string does not contain the character,
599 * otherwise, a pointer to the start of the leftmost occurrence of
600 * the character in the string.
603 g_utf8_strchr (const char *p,
609 gint charlen = g_unichar_to_utf8 (c, ch);
612 return g_strstr_len (p, len, ch);
618 * @p: a nul-terminated UTF-8 encoded string
619 * @len: the maximum length of @p
620 * @c: a ISO10646 character
622 * Find the rightmost occurrence of the given ISO10646 character
623 * in a UTF-8 encoded string, while limiting the search to @len bytes.
624 * If @len is -1, allow unbounded search.
626 * Return value: %NULL if the string does not contain the character,
627 * otherwise, a pointer to the start of the rightmost occurrence of the
628 * character in the string.
631 g_utf8_strrchr (const char *p,
637 gint charlen = g_unichar_to_utf8 (c, ch);
640 return g_strrstr_len (p, len, ch);
644 /* Like g_utf8_get_char, but take a maximum length
645 * and return (gunichar)-2 on incomplete trailing character
647 static inline gunichar
648 g_utf8_get_char_extended (const gchar *p,
652 gunichar wc = (guchar) *p;
692 if (max_len >= 0 && len > max_len)
694 for (i = 1; i < max_len; i++)
696 if ((((guchar *)p)[i] & 0xc0) != 0x80)
702 for (i = 1; i < len; ++i)
704 gunichar ch = ((guchar *)p)[i];
706 if ((ch & 0xc0) != 0x80)
718 if (UTF8_LENGTH(wc) != len)
725 * g_utf8_get_char_validated:
726 * @p: a pointer to Unicode character encoded as UTF-8
727 * @max_len: the maximum number of bytes to read, or -1, for no maximum.
729 * Convert a sequence of bytes encoded as UTF-8 to a Unicode character.
730 * This function checks for incomplete characters, for invalid characters
731 * such as characters that are out of the range of Unicode, and for
732 * overlong encodings of valid characters.
734 * Return value: the resulting character. If @p points to a partial
735 * sequence at the end of a string that could begin a valid
736 * character, returns (gunichar)-2; otherwise, if @p does not point
737 * to a valid UTF-8 encoded Unicode character, returns (gunichar)-1.
740 g_utf8_get_char_validated (const gchar *p,
743 gunichar result = g_utf8_get_char_extended (p, max_len);
745 if (result & 0x80000000)
747 else if (!UNICODE_VALID (result))
754 * g_utf8_to_ucs4_fast:
755 * @str: a UTF-8 encoded string
756 * @len: the maximum length of @str to use. If @len < 0, then
757 * the string is nul-terminated.
758 * @items_written: location to store the number of characters in the
761 * Convert a string from UTF-8 to a 32-bit fixed width
762 * representation as UCS-4, assuming valid UTF-8 input.
763 * This function is roughly twice as fast as g_utf8_to_ucs4()
764 * but does no error checking on the input.
766 * Return value: a pointer to a newly allocated UCS-4 string.
767 * This value must be freed with g_free().
770 g_utf8_to_ucs4_fast (const gchar *str,
772 glong *items_written)
779 g_return_val_if_fail (str != NULL, NULL);
787 p = g_utf8_next_char (p);
793 while (p < str + len && *p)
795 p = g_utf8_next_char (p);
800 result = g_new (gunichar, n_chars + 1);
803 for (i=0; i < n_chars; i++)
805 gunichar wc = ((unsigned char *)p)[0];
840 for (j = 1; j < charlen; j++)
843 wc |= ((unsigned char *)p)[j] & 0x3f;
860 * @str: a UTF-8 encoded string
861 * @len: the maximum length of @str to use. If @len < 0, then
862 * the string is nul-terminated.
863 * @items_read: location to store number of bytes read, or %NULL.
864 * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
865 * returned in case @str contains a trailing partial
866 * character. If an error occurs then the index of the
867 * invalid input is stored here.
868 * @items_written: location to store number of characters written or %NULL.
869 * The value here stored does not include the trailing 0
871 * @error: location to store the error occuring, or %NULL to ignore
872 * errors. Any of the errors in #GConvertError other than
873 * %G_CONVERT_ERROR_NO_CONVERSION may occur.
875 * Convert a string from UTF-8 to a 32-bit fixed width
876 * representation as UCS-4. A trailing 0 will be added to the
877 * string after the converted text.
879 * Return value: a pointer to a newly allocated UCS-4 string.
880 * This value must be freed with g_free(). If an
881 * error occurs, %NULL will be returned and
885 g_utf8_to_ucs4 (const gchar *str,
888 glong *items_written,
891 gunichar *result = NULL;
897 while ((len < 0 || str + len - in > 0) && *in)
899 gunichar wc = g_utf8_get_char_extended (in, str + len - in);
902 if (wc == (gunichar)-2)
907 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
908 _("Partial character sequence at end of input"));
911 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
912 _("Invalid byte sequence in conversion input"));
919 in = g_utf8_next_char (in);
922 result = g_new (gunichar, n_chars + 1);
925 for (i=0; i < n_chars; i++)
927 result[i] = g_utf8_get_char (in);
928 in = g_utf8_next_char (in);
933 *items_written = n_chars;
937 *items_read = in - str;
944 * @str: a UCS-4 encoded string
945 * @len: the maximum length of @str to use. If @len < 0, then
946 * the string is terminated with a 0 character.
947 * @items_read: location to store number of characters read read, or %NULL.
948 * @items_written: location to store number of bytes written or %NULL.
949 * The value here stored does not include the trailing 0
951 * @error: location to store the error occuring, or %NULL to ignore
952 * errors. Any of the errors in #GConvertError other than
953 * %G_CONVERT_ERROR_NO_CONVERSION may occur.
955 * Convert a string from a 32-bit fixed width representation as UCS-4.
956 * to UTF-8. The result will be terminated with a 0 byte.
958 * Return value: a pointer to a newly allocated UTF-8 string.
959 * This value must be freed with g_free(). If an
960 * error occurs, %NULL will be returned and
964 g_ucs4_to_utf8 (const gunichar *str,
967 glong *items_written,
971 gchar *result = NULL;
976 for (i = 0; len < 0 || i < len ; i++)
981 if (str[i] >= 0x80000000)
986 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
987 _("Character out of range for UTF-8"));
991 result_length += UTF8_LENGTH (str[i]);
994 result = g_malloc (result_length + 1);
998 while (p < result + result_length)
999 p += g_unichar_to_utf8 (str[i++], p);
1004 *items_written = p - result;
1013 #define SURROGATE_VALUE(h,l) (((h) - 0xd800) * 0x400 + (l) - 0xdc00 + 0x10000)
1017 * @str: a UTF-16 encoded string
1018 * @len: the maximum length of @str to use. If @len < 0, then
1019 * the string is terminated with a 0 character.
1020 * @items_read: location to store number of words read, or %NULL.
1021 * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
1022 * returned in case @str contains a trailing partial
1023 * character. If an error occurs then the index of the
1024 * invalid input is stored here.
1025 * @items_written: location to store number of bytes written, or %NULL.
1026 * The value stored here does not include the trailing
1028 * @error: location to store the error occuring, or %NULL to ignore
1029 * errors. Any of the errors in #GConvertError other than
1030 * %G_CONVERT_ERROR_NO_CONVERSION may occur.
1032 * Convert a string from UTF-16 to UTF-8. The result will be
1033 * terminated with a 0 byte.
1035 * Note that the input is expected to be already in native endianness,
1036 * an initial byte-order-mark character is not handled specially.
1037 * g_convert() can be used to convert a byte buffer of UTF-16 data of
1038 * ambiguous endianess.
1040 * Return value: a pointer to a newly allocated UTF-8 string.
1041 * This value must be freed with g_free(). If an
1042 * error occurs, %NULL will be returned and
1046 g_utf16_to_utf8 (const gunichar2 *str,
1049 glong *items_written,
1052 /* This function and g_utf16_to_ucs4 are almost exactly identical - The lines that differ
1055 const gunichar2 *in;
1057 gchar *result = NULL;
1059 gunichar high_surrogate;
1061 g_return_val_if_fail (str != 0, NULL);
1066 while ((len < 0 || in - str < len) && *in)
1071 if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1075 wc = SURROGATE_VALUE (high_surrogate, c);
1080 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1081 _("Invalid sequence in conversion input"));
1089 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1090 _("Invalid sequence in conversion input"));
1094 if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1103 /********** DIFFERENT for UTF8/UCS4 **********/
1104 n_bytes += UTF8_LENGTH (wc);
1110 if (high_surrogate && !items_read)
1112 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1113 _("Partial character sequence at end of input"));
1117 /* At this point, everything is valid, and we just need to convert
1119 /********** DIFFERENT for UTF8/UCS4 **********/
1120 result = g_malloc (n_bytes + 1);
1125 while (out < result + n_bytes)
1130 if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1132 wc = SURROGATE_VALUE (high_surrogate, c);
1135 else if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1143 /********** DIFFERENT for UTF8/UCS4 **********/
1144 out += g_unichar_to_utf8 (wc, out);
1150 /********** DIFFERENT for UTF8/UCS4 **********/
1154 /********** DIFFERENT for UTF8/UCS4 **********/
1155 *items_written = out - result;
1159 *items_read = in - str;
1166 * @str: a UTF-16 encoded string
1167 * @len: the maximum length of @str to use. If @len < 0, then
1168 * the string is terminated with a 0 character.
1169 * @items_read: location to store number of words read, or %NULL.
1170 * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
1171 * returned in case @str contains a trailing partial
1172 * character. If an error occurs then the index of the
1173 * invalid input is stored here.
1174 * @items_written: location to store number of characters written, or %NULL.
1175 * The value stored here does not include the trailing
1177 * @error: location to store the error occuring, or %NULL to ignore
1178 * errors. Any of the errors in #GConvertError other than
1179 * %G_CONVERT_ERROR_NO_CONVERSION may occur.
1181 * Convert a string from UTF-16 to UCS-4. The result will be
1182 * terminated with a 0 character.
1184 * Return value: a pointer to a newly allocated UCS-4 string.
1185 * This value must be freed with g_free(). If an
1186 * error occurs, %NULL will be returned and
1190 g_utf16_to_ucs4 (const gunichar2 *str,
1193 glong *items_written,
1196 const gunichar2 *in;
1198 gchar *result = NULL;
1200 gunichar high_surrogate;
1202 g_return_val_if_fail (str != 0, NULL);
1207 while ((len < 0 || in - str < len) && *in)
1212 if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1216 wc = SURROGATE_VALUE (high_surrogate, c);
1221 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1222 _("Invalid sequence in conversion input"));
1230 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1231 _("Invalid sequence in conversion input"));
1235 if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1244 /********** DIFFERENT for UTF8/UCS4 **********/
1245 n_bytes += sizeof (gunichar);
1251 if (high_surrogate && !items_read)
1253 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1254 _("Partial character sequence at end of input"));
1258 /* At this point, everything is valid, and we just need to convert
1260 /********** DIFFERENT for UTF8/UCS4 **********/
1261 result = g_malloc (n_bytes + 4);
1266 while (out < result + n_bytes)
1271 if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1273 wc = SURROGATE_VALUE (high_surrogate, c);
1276 else if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1284 /********** DIFFERENT for UTF8/UCS4 **********/
1285 *(gunichar *)out = wc;
1286 out += sizeof (gunichar);
1292 /********** DIFFERENT for UTF8/UCS4 **********/
1293 *(gunichar *)out = 0;
1296 /********** DIFFERENT for UTF8/UCS4 **********/
1297 *items_written = (out - result) / sizeof (gunichar);
1301 *items_read = in - str;
1303 return (gunichar *)result;
1308 * @str: a UTF-8 encoded string
1309 * @len: the maximum length of @str to use. If @len < 0, then
1310 * the string is nul-terminated.
1311 * @items_read: location to store number of bytes read, or %NULL.
1312 * If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
1313 * returned in case @str contains a trailing partial
1314 * character. If an error occurs then the index of the
1315 * invalid input is stored here.
1316 * @items_written: location to store number of words written, or %NULL.
1317 * The value stored here does not include the trailing
1319 * @error: location to store the error occuring, or %NULL to ignore
1320 * errors. Any of the errors in #GConvertError other than
1321 * %G_CONVERT_ERROR_NO_CONVERSION may occur.
1323 * Convert a string from UTF-8 to UTF-16. A 0 word will be
1324 * added to the result after the converted text.
1326 * Return value: a pointer to a newly allocated UTF-16 string.
1327 * This value must be freed with g_free(). If an
1328 * error occurs, %NULL will be returned and
1332 g_utf8_to_utf16 (const gchar *str,
1335 glong *items_written,
1338 gunichar2 *result = NULL;
1343 g_return_val_if_fail (str != NULL, NULL);
1347 while ((len < 0 || str + len - in > 0) && *in)
1349 gunichar wc = g_utf8_get_char_extended (in, str + len - in);
1350 if (wc & 0x80000000)
1352 if (wc == (gunichar)-2)
1357 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1358 _("Partial character sequence at end of input"));
1361 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1362 _("Invalid byte sequence in conversion input"));
1369 else if (wc < 0xe000)
1371 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1372 _("Invalid sequence in conversion input"));
1376 else if (wc < 0x10000)
1378 else if (wc < 0x110000)
1382 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1383 _("Character out of range for UTF-16"));
1388 in = g_utf8_next_char (in);
1391 result = g_new (gunichar2, n16 + 1);
1394 for (i = 0; i < n16;)
1396 gunichar wc = g_utf8_get_char (in);
1404 result[i++] = (wc - 0x10000) / 0x400 + 0xd800;
1405 result[i++] = (wc - 0x10000) % 0x400 + 0xdc00;
1408 in = g_utf8_next_char (in);
1414 *items_written = n16;
1418 *items_read = in - str;
1425 * @str: a UCS-4 encoded string
1426 * @len: the maximum length of @str to use. If @len < 0, then
1427 * the string is terminated with a 0 character.
1428 * @items_read: location to store number of bytes read, or %NULL.
1429 * If an error occurs then the index of the invalid input
1431 * @items_written: location to store number of words written, or %NULL.
1432 * The value stored here does not include the trailing
1434 * @error: location to store the error occuring, or %NULL to ignore
1435 * errors. Any of the errors in #GConvertError other than
1436 * %G_CONVERT_ERROR_NO_CONVERSION may occur.
1438 * Convert a string from UCS-4 to UTF-16. A 0 word will be
1439 * added to the result after the converted text.
1441 * Return value: a pointer to a newly allocated UTF-16 string.
1442 * This value must be freed with g_free(). If an
1443 * error occurs, %NULL will be returned and
1447 g_ucs4_to_utf16 (const gunichar *str,
1450 glong *items_written,
1453 gunichar2 *result = NULL;
1459 while ((len < 0 || i < len) && str[i])
1461 gunichar wc = str[i];
1465 else if (wc < 0xe000)
1467 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1468 _("Invalid sequence in conversion input"));
1472 else if (wc < 0x10000)
1474 else if (wc < 0x110000)
1478 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1479 _("Character out of range for UTF-16"));
1487 result = g_new (gunichar2, n16 + 1);
1489 for (i = 0, j = 0; j < n16; i++)
1491 gunichar wc = str[i];
1499 result[j++] = (wc - 0x10000) / 0x400 + 0xd800;
1500 result[j++] = (wc - 0x10000) % 0x400 + 0xdc00;
1506 *items_written = n16;
1515 #define CONTINUATION_CHAR \
1517 if ((*(guchar *)p & 0xc0) != 0x80) /* 10xxxxxx */ \
1520 val |= (*(guchar *)p) & 0x3f; \
1523 static const gchar *
1524 fast_validate (const char *str)
1531 for (p = str; *p; p++)
1533 if (*(guchar *)p < 128)
1540 if ((*(guchar *)p & 0xe0) == 0xc0) /* 110xxxxx */
1542 if (G_UNLIKELY ((*(guchar *)p & 0x1e) == 0))
1545 if (G_UNLIKELY ((*(guchar *)p & 0xc0) != 0x80)) /* 10xxxxxx */
1550 if ((*(guchar *)p & 0xf0) == 0xe0) /* 1110xxxx */
1553 val = *(guchar *)p & 0x0f;
1556 else if ((*(guchar *)p & 0xf8) == 0xf0) /* 11110xxx */
1559 val = *(guchar *)p & 0x07;
1572 if (G_UNLIKELY (val < min))
1575 if (G_UNLIKELY (!UNICODE_VALID(val)))
1589 static const gchar *
1590 fast_validate_len (const char *str,
1598 for (p = str; (max_len < 0 || (p - str) < max_len) && *p; p++)
1600 if (*(guchar *)p < 128)
1607 if ((*(guchar *)p & 0xe0) == 0xc0) /* 110xxxxx */
1609 if (G_UNLIKELY (max_len >= 0 && max_len - (p - str) < 2))
1612 if (G_UNLIKELY ((*(guchar *)p & 0x1e) == 0))
1615 if (G_UNLIKELY ((*(guchar *)p & 0xc0) != 0x80)) /* 10xxxxxx */
1620 if ((*(guchar *)p & 0xf0) == 0xe0) /* 1110xxxx */
1622 if (G_UNLIKELY (max_len >= 0 && max_len - (p - str) < 3))
1626 val = *(guchar *)p & 0x0f;
1629 else if ((*(guchar *)p & 0xf8) == 0xf0) /* 11110xxx */
1631 if (G_UNLIKELY (max_len >= 0 && max_len - (p - str) < 4))
1635 val = *(guchar *)p & 0x07;
1648 if (G_UNLIKELY (val < min))
1650 if (G_UNLIKELY (!UNICODE_VALID(val)))
1666 * @str: a pointer to character data
1667 * @max_len: max bytes to validate, or -1 to go until NUL
1668 * @end: return location for end of valid data
1670 * Validates UTF-8 encoded text. @str is the text to validate;
1671 * if @str is nul-terminated, then @max_len can be -1, otherwise
1672 * @max_len should be the number of bytes to validate.
1673 * If @end is non-%NULL, then the end of the valid range
1674 * will be stored there (i.e. the start of the first invalid
1675 * character if some bytes were invalid, or the end of the text
1676 * being validated otherwise).
1678 * Note that g_utf8_validate() returns %FALSE if @max_len is
1679 * positive and NUL is met before @max_len bytes have been read.
1681 * Returns %TRUE if all of @str was valid. Many GLib and GTK+
1682 * routines <emphasis>require</emphasis> valid UTF-8 as input;
1683 * so data read from a file or the network should be checked
1684 * with g_utf8_validate() before doing anything else with it.
1686 * Return value: %TRUE if the text was valid UTF-8
1689 g_utf8_validate (const char *str,
1697 p = fast_validate (str);
1699 p = fast_validate_len (str, max_len);
1704 if ((max_len >= 0 && p != str + max_len) ||
1705 (max_len < 0 && *p != '\0'))
1713 * g_unichar_validate:
1714 * @ch: a Unicode character
1716 * Checks whether @ch is a valid Unicode character. Some possible
1717 * integer values of @ch will not be valid. 0 is considered a valid
1718 * character, though it's normally a string terminator.
1720 * Return value: %TRUE if @ch is a valid Unicode character
1723 g_unichar_validate (gunichar ch)
1725 return UNICODE_VALID (ch);
1729 * g_utf8_strreverse:
1730 * @str: a UTF-8 encoded string
1731 * @len: the maximum length of @str to use. If @len < 0, then
1732 * the string is nul-terminated.
1734 * Reverses a UTF-8 string. @str must be valid UTF-8 encoded text.
1735 * (Use g_utf8_validate() on all text before trying to use UTF-8
1736 * utility functions with it.)
1738 * Note that unlike g_strreverse(), this function returns
1739 * newly-allocated memory, which should be freed with g_free() when
1742 * Returns: a newly-allocated string which is the reverse of @str.
1747 g_utf8_strreverse (const gchar *str,
1757 result = g_new (gchar, len + 1);
1762 skip = g_utf8_skip[*(guchar*)p];
1764 for (m = r; skip; skip--)
1772 #define __G_UTF8_C__
1773 #include "galiasdef.c"