glib/gutf8.c

   1 /* gutf8.c - Operations on UTF-8 strings.
   2  *
   3  * Copyright (C) 1999 Tom Tromey
   4  * Copyright (C) 2000 Red Hat, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 #include "config.h"
  23
  24 #include <stdlib.h>
  25 #ifdef HAVE_CODESET
  26 #include <langinfo.h>
  27 #endif
  28 #include <string.h>
  29
  30 #include "glib.h"
  31
  32 #ifdef G_PLATFORM_WIN32
  33 #include <stdio.h>
  34 #define STRICT
  35 #include <windows.h>
  36 #undef STRICT
  37 #endif
  38
  39 #include "libcharset/libcharset.h"
  40
  41 #include "glibintl.h"
  42 #include "galias.h"
  43
  44 #define UTF8_COMPUTE(Char, Mask, Len)                                         \
  45   if (Char < 128)                                                             \
  46     {                                                                         \
  47       Len = 1;                                                                \
  48       Mask = 0x7f;                                                            \
  49     }                                                                         \
  50   else if ((Char & 0xe0) == 0xc0)                                             \
  51     {                                                                         \
  52       Len = 2;                                                                \
  53       Mask = 0x1f;                                                            \
  54     }                                                                         \
  55   else if ((Char & 0xf0) == 0xe0)                                             \
  56     {                                                                         \
  57       Len = 3;                                                                \
  58       Mask = 0x0f;                                                            \
  59     }                                                                         \
  60   else if ((Char & 0xf8) == 0xf0)                                             \
  61     {                                                                         \
  62       Len = 4;                                                                \
  63       Mask = 0x07;                                                            \
  64     }                                                                         \
  65   else if ((Char & 0xfc) == 0xf8)                                             \
  66     {                                                                         \
  67       Len = 5;                                                                \
  68       Mask = 0x03;                                                            \
  69     }                                                                         \
  70   else if ((Char & 0xfe) == 0xfc)                                             \
  71     {                                                                         \
  72       Len = 6;                                                                \
  73       Mask = 0x01;                                                            \
  74     }                                                                         \
  75   else                                                                        \
  76     Len = -1;
  77
  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)))))
  84
  85
  86 #define UTF8_GET(Result, Chars, Count, Mask, Len)                             \
  87   (Result) = (Chars)[0] & (Mask);                                             \
  88   for ((Count) = 1; (Count) < (Len); ++(Count))                               \
  89     {                                                                         \
  90       if (((Chars)[(Count)] & 0xc0) != 0x80)                                  \
  91         {                                                                     \
  92           (Result) = -1;                                                      \
  93           break;                                                              \
  94         }                                                                     \
  95       (Result) <<= 6;                                                         \
  96       (Result) |= ((Chars)[(Count)] & 0x3f);                                  \
  97     }
  98
  99 /**
 100  * Check whether a Unicode (5.2) char is in a valid range.
 101  *
 102  * The first check comes from the Unicode guarantee to never encode
 103  * a point above 0x0010ffff, since UTF-16 couldn't represent it.
 104  *
 105  * The second check covers surrogate pairs (category Cs).
 106  *
 107  * The last two checks cover "Noncharacter": defined as:
 108  *   "A code point that is permanently reserved for
 109  *    internal use, and that should never be interchanged. In
 110  *    Unicode 3.1, these consist of the values U+nFFFE and U+nFFFF
 111  *    (where n is from 0 to 10_16) and the values U+FDD0..U+FDEF."
 112  *
 113  * @param Char the character
 114  */
 115 #define UNICODE_VALID(Char)                   \
 116     ((Char) < 0x110000 &&                     \
 117      (((Char) & 0xFFFFF800) != 0xD800) &&     \
 118      ((Char) < 0xFDD0 || (Char) > 0xFDEF) &&  \
 119      ((Char) & 0xFFFE) != 0xFFFE)
 120
 121
 122 static const gchar utf8_skip_data[256] = {
 123   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,
 124   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,
 125   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,
 126   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,
 127   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,
 128   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,
 129   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,
 130   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
 131 };
 132
 133 const gchar * const g_utf8_skip = utf8_skip_data;
 134
 135 /**
 136  * g_utf8_find_prev_char:
 137  * @str: pointer to the beginning of a UTF-8 encoded string
 138  * @p: pointer to some position within @str
 139  *
 140  * Given a position @p with a UTF-8 encoded string @str, find the start
 141  * of the previous UTF-8 character starting before @p. Returns %NULL if no
 142  * UTF-8 characters are present in @str before @p.
 143  *
 144  * @p does not have to be at the beginning of a UTF-8 character. No check
 145  * is made to see if the character found is actually valid other than
 146  * it starts with an appropriate byte.
 147  *
 148  * Return value: a pointer to the found character or %NULL.
 149  **/
 150 gchar *
 151 g_utf8_find_prev_char (const char *str,
 152                        const char *p)
 153 {
 154   for (--p; p >= str; --p)
 155     {
 156       if ((*p & 0xc0) != 0x80)
 157         return (gchar *)p;
 158     }
 159   return NULL;
 160 }
 161
 162 /**
 163  * g_utf8_find_next_char:
 164  * @p: a pointer to a position within a UTF-8 encoded string
 165  * @end: a pointer to the byte following the end of the string,
 166  * or %NULL to indicate that the string is nul-terminated.
 167  *
 168  * Finds the start of the next UTF-8 character in the string after @p.
 169  *
 170  * @p does not have to be at the beginning of a UTF-8 character. No check
 171  * is made to see if the character found is actually valid other than
 172  * it starts with an appropriate byte.
 173  *
 174  * Return value: a pointer to the found character or %NULL
 175  **/
 176 gchar *
 177 g_utf8_find_next_char (const gchar *p,
 178                        const gchar *end)
 179 {
 180   if (*p)
 181     {
 182       if (end)
 183         for (++p; p < end && (*p & 0xc0) == 0x80; ++p)
 184           ;
 185       else
 186         for (++p; (*p & 0xc0) == 0x80; ++p)
 187           ;
 188     }
 189   return (p == end) ? NULL : (gchar *)p;
 190 }
 191
 192 /**
 193  * g_utf8_prev_char:
 194  * @p: a pointer to a position within a UTF-8 encoded string
 195  *
 196  * Finds the previous UTF-8 character in the string before @p.
 197  *
 198  * @p does not have to be at the beginning of a UTF-8 character. No check
 199  * is made to see if the character found is actually valid other than
 200  * it starts with an appropriate byte. If @p might be the first
 201  * character of the string, you must use g_utf8_find_prev_char() instead.
 202  *
 203  * Return value: a pointer to the found character.
 204  **/
 205 gchar *
 206 g_utf8_prev_char (const gchar *p)
 207 {
 208   while (TRUE)
 209     {
 210       p--;
 211       if ((*p & 0xc0) != 0x80)
 212         return (gchar *)p;
 213     }
 214 }
 215
 216 /**
 217  * g_utf8_strlen:
 218  * @p: pointer to the start of a UTF-8 encoded string.
 219  * @max: the maximum number of bytes to examine. If @max
 220  *       is less than 0, then the string is assumed to be
 221  *       nul-terminated. If @max is 0, @p will not be examined and
 222  *       may be %NULL.
 223  *
 224  * Returns the length of the string in characters.
 225  *
 226  * Return value: the length of the string in characters
 227  **/
 228 glong
 229 g_utf8_strlen (const gchar *p,
 230                gssize       max)
 231 {
 232   glong len = 0;
 233   const gchar *start = p;
 234   g_return_val_if_fail (p != NULL || max == 0, 0);
 235
 236   if (max < 0)
 237     {
 238       while (*p)
 239         {
 240           p = g_utf8_next_char (p);
 241           ++len;
 242         }
 243     }
 244   else
 245     {
 246       if (max == 0 || !*p)
 247         return 0;
 248
 249       p = g_utf8_next_char (p);
 250
 251       while (p - start < max && *p)
 252         {
 253           ++len;
 254           p = g_utf8_next_char (p);
 255         }
 256
 257       /* only do the last len increment if we got a complete
 258        * char (don't count partial chars)
 259        */
 260       if (p - start <= max)
 261         ++len;
 262     }
 263
 264   return len;
 265 }
 266
 267 /**
 268  * g_utf8_get_char:
 269  * @p: a pointer to Unicode character encoded as UTF-8
 270  *
 271  * Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
 272  * If @p does not point to a valid UTF-8 encoded character, results are
 273  * undefined. If you are not sure that the bytes are complete
 274  * valid Unicode characters, you should use g_utf8_get_char_validated()
 275  * instead.
 276  *
 277  * Return value: the resulting character
 278  **/
 279 gunichar
 280 g_utf8_get_char (const gchar *p)
 281 {
 282   int i, mask = 0, len;
 283   gunichar result;
 284   unsigned char c = (unsigned char) *p;
 285
 286   UTF8_COMPUTE (c, mask, len);
 287   if (len == -1)
 288     return (gunichar)-1;
 289   UTF8_GET (result, p, i, mask, len);
 290
 291   return result;
 292 }
 293
 294 /**
 295  * g_utf8_offset_to_pointer:
 296  * @str: a UTF-8 encoded string
 297  * @offset: a character offset within @str
 298  *
 299  * Converts from an integer character offset to a pointer to a position
 300  * within the string.
 301  *
 302  * Since 2.10, this function allows to pass a negative @offset to
 303  * step backwards. It is usually worth stepping backwards from the end
 304  * instead of forwards if @offset is in the last fourth of the string,
 305  * since moving forward is about 3 times faster than moving backward.
 306  *
 307  * <note><para>
 308  * This function doesn't abort when reaching the end of @str. Therefore
 309  * you should be sure that @offset is within string boundaries before
 310  * calling that function. Call g_utf8_strlen() when unsure.
 311  *
 312  * This limitation exists as this function is called frequently during
 313  * text rendering and therefore has to be as fast as possible.
 314  * </para></note>
 315  *
 316  * Return value: the resulting pointer
 317  **/
 318 gchar *
 319 g_utf8_offset_to_pointer  (const gchar *str,
 320                            glong        offset)
 321 {
 322   const gchar *s = str;
 323
 324   if (offset > 0)
 325     while (offset--)
 326       s = g_utf8_next_char (s);
 327   else
 328     {
 329       const char *s1;
 330
 331       /* This nice technique for fast backwards stepping
 332        * through a UTF-8 string was dubbed "stutter stepping"
 333        * by its inventor, Larry Ewing.
 334        */
 335       while (offset)
 336         {
 337           s1 = s;
 338           s += offset;
 339           while ((*s & 0xc0) == 0x80)
 340             s--;
 341
 342           offset += g_utf8_pointer_to_offset (s, s1);
 343         }
 344     }
 345
 346   return (gchar *)s;
 347 }
 348
 349 /**
 350  * g_utf8_pointer_to_offset:
 351  * @str: a UTF-8 encoded string
 352  * @pos: a pointer to a position within @str
 353  *
 354  * Converts from a pointer to position within a string to a integer
 355  * character offset.
 356  *
 357  * Since 2.10, this function allows @pos to be before @str, and returns
 358  * a negative offset in this case.
 359  *
 360  * Return value: the resulting character offset
 361  **/
 362 glong
 363 g_utf8_pointer_to_offset (const gchar *str,
 364                           const gchar *pos)
 365 {
 366   const gchar *s = str;
 367   glong offset = 0;
 368
 369   if (pos < str)
 370     offset = - g_utf8_pointer_to_offset (pos, str);
 371   else
 372     while (s < pos)
 373       {
 374         s = g_utf8_next_char (s);
 375         offset++;
 376       }
 377
 378   return offset;
 379 }
 380
 381
 382 /**
 383  * g_utf8_strncpy:
 384  * @dest: buffer to fill with characters from @src
 385  * @src: UTF-8 encoded string
 386  * @n: character count
 387  *
 388  * Like the standard C strncpy() function, but
 389  * copies a given number of characters instead of a given number of
 390  * bytes. The @src string must be valid UTF-8 encoded text.
 391  * (Use g_utf8_validate() on all text before trying to use UTF-8
 392  * utility functions with it.)
 393  *
 394  * Return value: @dest
 395  **/
 396 gchar *
 397 g_utf8_strncpy (gchar       *dest,
 398                 const gchar *src,
 399                 gsize        n)
 400 {
 401   const gchar *s = src;
 402   while (n && *s)
 403     {
 404       s = g_utf8_next_char(s);
 405       n--;
 406     }
 407   strncpy(dest, src, s - src);
 408   dest[s - src] = 0;
 409   return dest;
 410 }
 411
 412 G_LOCK_DEFINE_STATIC (aliases);
 413
 414 static GHashTable *
 415 get_alias_hash (void)
 416 {
 417   static GHashTable *alias_hash = NULL;
 418   const char *aliases;
 419
 420   G_LOCK (aliases);
 421
 422   if (!alias_hash)
 423     {
 424       alias_hash = g_hash_table_new (g_str_hash, g_str_equal);
 425
 426       aliases = _g_locale_get_charset_aliases ();
 427       while (*aliases != '\0')
 428         {
 429           const char *canonical;
 430           const char *alias;
 431           const char **alias_array;
 432           int count = 0;
 433
 434           alias = aliases;
 435           aliases += strlen (aliases) + 1;
 436           canonical = aliases;
 437           aliases += strlen (aliases) + 1;
 438
 439           alias_array = g_hash_table_lookup (alias_hash, canonical);
 440           if (alias_array)
 441             {
 442               while (alias_array[count])
 443                 count++;
 444             }
 445
 446           alias_array = g_renew (const char *, alias_array, count + 2);
 447           alias_array[count] = alias;
 448           alias_array[count + 1] = NULL;
 449
 450           g_hash_table_insert (alias_hash, (char *)canonical, alias_array);
 451         }
 452     }
 453
 454   G_UNLOCK (aliases);
 455
 456   return alias_hash;
 457 }
 458
 459 /* As an abuse of the alias table, the following routines gets
 460  * the charsets that are aliases for the canonical name.
 461  */
 462 G_GNUC_INTERNAL const char **
 463 _g_charset_get_aliases (const char *canonical_name)
 464 {
 465   GHashTable *alias_hash = get_alias_hash ();
 466
 467   return g_hash_table_lookup (alias_hash, canonical_name);
 468 }
 469
 470 static gboolean
 471 g_utf8_get_charset_internal (const char  *raw_data,
 472                              const char **a)
 473 {
 474   const char *charset = getenv("CHARSET");
 475
 476   if (charset && *charset)
 477     {
 478       *a = charset;
 479
 480       if (charset && strstr (charset, "UTF-8"))
 481         return TRUE;
 482       else
 483         return FALSE;
 484     }
 485
 486   /* The libcharset code tries to be thread-safe without
 487    * a lock, but has a memory leak and a missing memory
 488    * barrier, so we lock for it
 489    */
 490   G_LOCK (aliases);
 491   charset = _g_locale_charset_unalias (raw_data);
 492   G_UNLOCK (aliases);
 493
 494   if (charset && *charset)
 495     {
 496       *a = charset;
 497
 498       if (charset && strstr (charset, "UTF-8"))
 499         return TRUE;
 500       else
 501         return FALSE;
 502     }
 503
 504   /* Assume this for compatibility at present.  */
 505   *a = "US-ASCII";
 506
 507   return FALSE;
 508 }
 509
 510 typedef struct _GCharsetCache GCharsetCache;
 511
 512 struct _GCharsetCache {
 513   gboolean is_utf8;
 514   gchar *raw;
 515   gchar *charset;
 516 };
 517
 518 static void
 519 charset_cache_free (gpointer data)
 520 {
 521   GCharsetCache *cache = data;
 522   g_free (cache->raw);
 523   g_free (cache->charset);
 524   g_free (cache);
 525 }
 526
 527 /**
 528  * g_get_charset:
 529  * @charset: return location for character set name
 530  *
 531  * Obtains the character set for the <link linkend="setlocale">current
 532  * locale</link>; you might use this character set as an argument to
 533  * g_convert(), to convert from the current locale's encoding to some
 534  * other encoding. (Frequently g_locale_to_utf8() and g_locale_from_utf8()
 535  * are nice shortcuts, though.)
 536  *
 537  * On Windows the character set returned by this function is the
 538  * so-called system default ANSI code-page. That is the character set
 539  * used by the "narrow" versions of C library and Win32 functions that
 540  * handle file names. It might be different from the character set
 541  * used by the C library's current locale.
 542  *
 543  * The return value is %TRUE if the locale's encoding is UTF-8, in that
 544  * case you can perhaps avoid calling g_convert().
 545  *
 546  * The string returned in @charset is not allocated, and should not be
 547  * freed.
 548  *
 549  * Return value: %TRUE if the returned charset is UTF-8
 550  **/
 551 gboolean
 552 g_get_charset (G_CONST_RETURN char **charset)
 553 {
 554   static GStaticPrivate cache_private = G_STATIC_PRIVATE_INIT;
 555   GCharsetCache *cache = g_static_private_get (&cache_private);
 556   const gchar *raw;
 557
 558   if (!cache)
 559     {
 560       cache = g_new0 (GCharsetCache, 1);
 561       g_static_private_set (&cache_private, cache, charset_cache_free);
 562     }
 563
 564   raw = _g_locale_charset_raw ();
 565
 566   if (!(cache->raw && strcmp (cache->raw, raw) == 0))
 567     {
 568       const gchar *new_charset;
 569
 570       g_free (cache->raw);
 571       g_free (cache->charset);
 572       cache->raw = g_strdup (raw);
 573       cache->is_utf8 = g_utf8_get_charset_internal (raw, &new_charset);
 574       cache->charset = g_strdup (new_charset);
 575     }
 576
 577   if (charset)
 578     *charset = cache->charset;
 579
 580   return cache->is_utf8;
 581 }
 582
 583 /* unicode_strchr */
 584
 585 /**
 586  * g_unichar_to_utf8:
 587  * @c: a Unicode character code
 588  * @outbuf: output buffer, must have at least 6 bytes of space.
 589  *       If %NULL, the length will be computed and returned
 590  *       and nothing will be written to @outbuf.
 591  *
 592  * Converts a single character to UTF-8.
 593  *
 594  * Return value: number of bytes written
 595  **/
 596 int
 597 g_unichar_to_utf8 (gunichar c,
 598                    gchar   *outbuf)
 599 {
 600   /* If this gets modified, also update the copy in g_string_insert_unichar() */
 601   guint len = 0;
 602   int first;
 603   int i;
 604
 605   if (c < 0x80)
 606     {
 607       first = 0;
 608       len = 1;
 609     }
 610   else if (c < 0x800)
 611     {
 612       first = 0xc0;
 613       len = 2;
 614     }
 615   else if (c < 0x10000)
 616     {
 617       first = 0xe0;
 618       len = 3;
 619     }
 620    else if (c < 0x200000)
 621     {
 622       first = 0xf0;
 623       len = 4;
 624     }
 625   else if (c < 0x4000000)
 626     {
 627       first = 0xf8;
 628       len = 5;
 629     }
 630   else
 631     {
 632       first = 0xfc;
 633       len = 6;
 634     }
 635
 636   if (outbuf)
 637     {
 638       for (i = len - 1; i > 0; --i)
 639         {
 640           outbuf[i] = (c & 0x3f) | 0x80;
 641           c >>= 6;
 642         }
 643       outbuf[0] = c | first;
 644     }
 645
 646   return len;
 647 }
 648
 649 /**
 650  * g_utf8_strchr:
 651  * @p: a nul-terminated UTF-8 encoded string
 652  * @len: the maximum length of @p
 653  * @c: a Unicode character
 654  *
 655  * Finds the leftmost occurrence of the given Unicode character
 656  * in a UTF-8 encoded string, while limiting the search to @len bytes.
 657  * If @len is -1, allow unbounded search.
 658  *
 659  * Return value: %NULL if the string does not contain the character,
 660  *   otherwise, a pointer to the start of the leftmost occurrence of
 661  *   the character in the string.
 662  **/
 663 gchar *
 664 g_utf8_strchr (const char *p,
 665                gssize      len,
 666                gunichar    c)
 667 {
 668   gchar ch[10];
 669
 670   gint charlen = g_unichar_to_utf8 (c, ch);
 671   ch[charlen] = '\0';
 672
 673   return g_strstr_len (p, len, ch);
 674 }
 675
 676
 677 /**
 678  * g_utf8_strrchr:
 679  * @p: a nul-terminated UTF-8 encoded string
 680  * @len: the maximum length of @p
 681  * @c: a Unicode character
 682  *
 683  * Find the rightmost occurrence of the given Unicode character
 684  * in a UTF-8 encoded string, while limiting the search to @len bytes.
 685  * If @len is -1, allow unbounded search.
 686  *
 687  * Return value: %NULL if the string does not contain the character,
 688  *   otherwise, a pointer to the start of the rightmost occurrence of the
 689  *   character in the string.
 690  **/
 691 gchar *
 692 g_utf8_strrchr (const char *p,
 693                 gssize      len,
 694                 gunichar    c)
 695 {
 696   gchar ch[10];
 697
 698   gint charlen = g_unichar_to_utf8 (c, ch);
 699   ch[charlen] = '\0';
 700
 701   return g_strrstr_len (p, len, ch);
 702 }
 703
 704
 705 /* Like g_utf8_get_char, but take a maximum length
 706  * and return (gunichar)-2 on incomplete trailing character
 707  */
 708 static inline gunichar
 709 g_utf8_get_char_extended (const  gchar *p,
 710                           gssize max_len)
 711 {
 712   guint i, len;
 713   gunichar wc = (guchar) *p;
 714
 715   if (wc < 0x80)
 716     {
 717       return wc;
 718     }
 719   else if (wc < 0xc0)
 720     {
 721       return (gunichar)-1;
 722     }
 723   else if (wc < 0xe0)
 724     {
 725       len = 2;
 726       wc &= 0x1f;
 727     }
 728   else if (wc < 0xf0)
 729     {
 730       len = 3;
 731       wc &= 0x0f;
 732     }
 733   else if (wc < 0xf8)
 734     {
 735       len = 4;
 736       wc &= 0x07;
 737     }
 738   else if (wc < 0xfc)
 739     {
 740       len = 5;
 741       wc &= 0x03;
 742     }
 743   else if (wc < 0xfe)
 744     {
 745       len = 6;
 746       wc &= 0x01;
 747     }
 748   else
 749     {
 750       return (gunichar)-1;
 751     }
 752
 753   if (max_len >= 0 && len > max_len)
 754     {
 755       for (i = 1; i < max_len; i++)
 756         {
 757           if ((((guchar *)p)[i] & 0xc0) != 0x80)
 758             return (gunichar)-1;
 759         }
 760       return (gunichar)-2;
 761     }
 762
 763   for (i = 1; i < len; ++i)
 764     {
 765       gunichar ch = ((guchar *)p)[i];
 766
 767       if ((ch & 0xc0) != 0x80)
 768         {
 769           if (ch)
 770             return (gunichar)-1;
 771           else
 772             return (gunichar)-2;
 773         }
 774
 775       wc <<= 6;
 776       wc |= (ch & 0x3f);
 777     }
 778
 779   if (UTF8_LENGTH(wc) != len)
 780     return (gunichar)-1;
 781
 782   return wc;
 783 }
 784
 785 /**
 786  * g_utf8_get_char_validated:
 787  * @p: a pointer to Unicode character encoded as UTF-8
 788  * @max_len: the maximum number of bytes to read, or -1, for no maximum or
 789  *           if @p is nul-terminated
 790  *
 791  * Convert a sequence of bytes encoded as UTF-8 to a Unicode character.
 792  * This function checks for incomplete characters, for invalid characters
 793  * such as characters that are out of the range of Unicode, and for
 794  * overlong encodings of valid characters.
 795  *
 796  * Return value: the resulting character. If @p points to a partial
 797  *    sequence at the end of a string that could begin a valid
 798  *    character (or if @max_len is zero), returns (gunichar)-2;
 799  *    otherwise, if @p does not point to a valid UTF-8 encoded
 800  *    Unicode character, returns (gunichar)-1.
 801  **/
 802 gunichar
 803 g_utf8_get_char_validated (const  gchar *p,
 804                            gssize max_len)
 805 {
 806   gunichar result;
 807
 808   if (max_len == 0)
 809     return (gunichar)-2;
 810
 811   result = g_utf8_get_char_extended (p, max_len);
 812
 813   if (result & 0x80000000)
 814     return result;
 815   else if (!UNICODE_VALID (result))
 816     return (gunichar)-1;
 817   else
 818     return result;
 819 }
 820
 821 /**
 822  * g_utf8_to_ucs4_fast:
 823  * @str: a UTF-8 encoded string
 824  * @len: the maximum length of @str to use, in bytes. If @len < 0,
 825  *       then the string is nul-terminated.
 826  * @items_written: location to store the number of characters in the
 827  *                 result, or %NULL.
 828  *
 829  * Convert a string from UTF-8 to a 32-bit fixed width
 830  * representation as UCS-4, assuming valid UTF-8 input.
 831  * This function is roughly twice as fast as g_utf8_to_ucs4()
 832  * but does no error checking on the input.
 833  *
 834  * Return value: a pointer to a newly allocated UCS-4 string.
 835  *               This value must be freed with g_free().
 836  **/
 837 gunichar *
 838 g_utf8_to_ucs4_fast (const gchar *str,
 839                      glong        len,
 840                      glong       *items_written)
 841 {
 842   gint j, charlen;
 843   gunichar *result;
 844   gint n_chars, i;
 845   const gchar *p;
 846
 847   g_return_val_if_fail (str != NULL, NULL);
 848
 849   p = str;
 850   n_chars = 0;
 851   if (len < 0)
 852     {
 853       while (*p)
 854         {
 855           p = g_utf8_next_char (p);
 856           ++n_chars;
 857         }
 858     }
 859   else
 860     {
 861       while (p < str + len && *p)
 862         {
 863           p = g_utf8_next_char (p);
 864           ++n_chars;
 865         }
 866     }
 867
 868   result = g_new (gunichar, n_chars + 1);
 869
 870   p = str;
 871   for (i=0; i < n_chars; i++)
 872     {
 873       gunichar wc = ((unsigned char *)p)[0];
 874
 875       if (wc < 0x80)
 876         {
 877           result[i] = wc;
 878           p++;
 879         }
 880       else
 881         {
 882           if (wc < 0xe0)
 883             {
 884               charlen = 2;
 885               wc &= 0x1f;
 886             }
 887           else if (wc < 0xf0)
 888             {
 889               charlen = 3;
 890               wc &= 0x0f;
 891             }
 892           else if (wc < 0xf8)
 893             {
 894               charlen = 4;
 895               wc &= 0x07;
 896             }
 897           else if (wc < 0xfc)
 898             {
 899               charlen = 5;
 900               wc &= 0x03;
 901             }
 902           else
 903             {
 904               charlen = 6;
 905               wc &= 0x01;
 906             }
 907
 908           for (j = 1; j < charlen; j++)
 909             {
 910               wc <<= 6;
 911               wc |= ((unsigned char *)p)[j] & 0x3f;
 912             }
 913
 914           result[i] = wc;
 915           p += charlen;
 916         }
 917     }
 918   result[i] = 0;
 919
 920   if (items_written)
 921     *items_written = i;
 922
 923   return result;
 924 }
 925
 926 /**
 927  * g_utf8_to_ucs4:
 928  * @str: a UTF-8 encoded string
 929  * @len: the maximum length of @str to use, in bytes. If @len < 0,
 930  *       then the string is nul-terminated.
 931  * @items_read: location to store number of bytes read, or %NULL.
 932  *              If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
 933  *              returned in case @str contains a trailing partial
 934  *              character. If an error occurs then the index of the
 935  *              invalid input is stored here.
 936  * @items_written: location to store number of characters written or %NULL.
 937  *                 The value here stored does not include the trailing 0
 938  *                 character.
 939  * @error: location to store the error occuring, or %NULL to ignore
 940  *         errors. Any of the errors in #GConvertError other than
 941  *         %G_CONVERT_ERROR_NO_CONVERSION may occur.
 942  *
 943  * Convert a string from UTF-8 to a 32-bit fixed width
 944  * representation as UCS-4. A trailing 0 will be added to the
 945  * string after the converted text.
 946  *
 947  * Return value: a pointer to a newly allocated UCS-4 string.
 948  *               This value must be freed with g_free(). If an
 949  *               error occurs, %NULL will be returned and
 950  *               @error set.
 951  **/
 952 gunichar *
 953 g_utf8_to_ucs4 (const gchar *str,
 954                 glong        len,
 955                 glong       *items_read,
 956                 glong       *items_written,
 957                 GError     **error)
 958 {
 959   gunichar *result = NULL;
 960   gint n_chars, i;
 961   const gchar *in;
 962
 963   in = str;
 964   n_chars = 0;
 965   while ((len < 0 || str + len - in > 0) && *in)
 966     {
 967       gunichar wc = g_utf8_get_char_extended (in, len < 0 ? 6 : str + len - in);
 968       if (wc & 0x80000000)
 969         {
 970           if (wc == (gunichar)-2)
 971             {
 972               if (items_read)
 973                 break;
 974               else
 975                 g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
 976                                      _("Partial character sequence at end of input"));
 977             }
 978           else
 979             g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
 980                                  _("Invalid byte sequence in conversion input"));
 981
 982           goto err_out;
 983         }
 984
 985       n_chars++;
 986
 987       in = g_utf8_next_char (in);
 988     }
 989
 990   result = g_new (gunichar, n_chars + 1);
 991
 992   in = str;
 993   for (i=0; i < n_chars; i++)
 994     {
 995       result[i] = g_utf8_get_char (in);
 996       in = g_utf8_next_char (in);
 997     }
 998   result[i] = 0;
 999
1000   if (items_written)
1001     *items_written = n_chars;
1002
1003  err_out:
1004   if (items_read)
1005     *items_read = in - str;
1006
1007   return result;
1008 }
1009
1010 /**
1011  * g_ucs4_to_utf8:
1012  * @str: a UCS-4 encoded string
1013  * @len: the maximum length (number of characters) of @str to use.
1014  *       If @len < 0, then the string is nul-terminated.
1015  * @items_read: location to store number of characters read, or %NULL.
1016  * @items_written: location to store number of bytes written or %NULL.
1017  *                 The value here stored does not include the trailing 0
1018  *                 byte.
1019  * @error: location to store the error occuring, or %NULL to ignore
1020  *         errors. Any of the errors in #GConvertError other than
1021  *         %G_CONVERT_ERROR_NO_CONVERSION may occur.
1022  *
1023  * Convert a string from a 32-bit fixed width representation as UCS-4.
1024  * to UTF-8. The result will be terminated with a 0 byte.
1025  *
1026  * Return value: a pointer to a newly allocated UTF-8 string.
1027  *               This value must be freed with g_free(). If an
1028  *               error occurs, %NULL will be returned and
1029  *               @error set. In that case, @items_read will be
1030  *               set to the position of the first invalid input
1031  *               character.
1032  **/
1033 gchar *
1034 g_ucs4_to_utf8 (const gunichar *str,
1035                 glong           len,
1036                 glong          *items_read,
1037                 glong          *items_written,
1038                 GError        **error)
1039 {
1040   gint result_length;
1041   gchar *result = NULL;
1042   gchar *p;
1043   gint i;
1044
1045   result_length = 0;
1046   for (i = 0; len < 0 || i < len ; i++)
1047     {
1048       if (!str[i])
1049         break;
1050
1051       if (str[i] >= 0x80000000)
1052         {
1053           g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1054                                _("Character out of range for UTF-8"));
1055           goto err_out;
1056         }
1057
1058       result_length += UTF8_LENGTH (str[i]);
1059     }
1060
1061   result = g_malloc (result_length + 1);
1062   p = result;
1063
1064   i = 0;
1065   while (p < result + result_length)
1066     p += g_unichar_to_utf8 (str[i++], p);
1067
1068   *p = '\0';
1069
1070   if (items_written)
1071     *items_written = p - result;
1072
1073  err_out:
1074   if (items_read)
1075     *items_read = i;
1076
1077   return result;
1078 }
1079
1080 #define SURROGATE_VALUE(h,l) (((h) - 0xd800) * 0x400 + (l) - 0xdc00 + 0x10000)
1081
1082 /**
1083  * g_utf16_to_utf8:
1084  * @str: a UTF-16 encoded string
1085  * @len: the maximum length (number of <type>gunichar2</type>) of @str to use.
1086  *       If @len < 0, then the string is nul-terminated.
1087  * @items_read: location to store number of words read, or %NULL.
1088  *              If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
1089  *              returned in case @str contains a trailing partial
1090  *              character. If an error occurs then the index of the
1091  *              invalid input is stored here.
1092  * @items_written: location to store number of bytes written, or %NULL.
1093  *                 The value stored here does not include the trailing
1094  *                 0 byte.
1095  * @error: location to store the error occuring, or %NULL to ignore
1096  *         errors. Any of the errors in #GConvertError other than
1097  *         %G_CONVERT_ERROR_NO_CONVERSION may occur.
1098  *
1099  * Convert a string from UTF-16 to UTF-8. The result will be
1100  * terminated with a 0 byte.
1101  *
1102  * Note that the input is expected to be already in native endianness,
1103  * an initial byte-order-mark character is not handled specially.
1104  * g_convert() can be used to convert a byte buffer of UTF-16 data of
1105  * ambiguous endianess.
1106  *
1107  * Further note that this function does not validate the result
1108  * string; it may e.g. include embedded NUL characters. The only
1109  * validation done by this function is to ensure that the input can
1110  * be correctly interpreted as UTF-16, i.e. it doesn't contain
1111  * things unpaired surrogates.
1112  *
1113  * Return value: a pointer to a newly allocated UTF-8 string.
1114  *               This value must be freed with g_free(). If an
1115  *               error occurs, %NULL will be returned and
1116  *               @error set.
1117  **/
1118 gchar *
1119 g_utf16_to_utf8 (const gunichar2  *str,
1120                  glong             len,
1121                  glong            *items_read,
1122                  glong            *items_written,
1123                  GError          **error)
1124 {
1125   /* This function and g_utf16_to_ucs4 are almost exactly identical - The lines that differ
1126    * are marked.
1127    */
1128   const gunichar2 *in;
1129   gchar *out;
1130   gchar *result = NULL;
1131   gint n_bytes;
1132   gunichar high_surrogate;
1133
1134   g_return_val_if_fail (str != NULL, NULL);
1135
1136   n_bytes = 0;
1137   in = str;
1138   high_surrogate = 0;
1139   while ((len < 0 || in - str < len) && *in)
1140     {
1141       gunichar2 c = *in;
1142       gunichar wc;
1143
1144       if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1145         {
1146           if (high_surrogate)
1147             {
1148               wc = SURROGATE_VALUE (high_surrogate, c);
1149               high_surrogate = 0;
1150             }
1151           else
1152             {
1153               g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1154                                    _("Invalid sequence in conversion input"));
1155               goto err_out;
1156             }
1157         }
1158       else
1159         {
1160           if (high_surrogate)
1161             {
1162               g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1163                                    _("Invalid sequence in conversion input"));
1164               goto err_out;
1165             }
1166
1167           if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1168             {
1169               high_surrogate = c;
1170               goto next1;
1171             }
1172           else
1173             wc = c;
1174         }
1175
1176       /********** DIFFERENT for UTF8/UCS4 **********/
1177       n_bytes += UTF8_LENGTH (wc);
1178
1179     next1:
1180       in++;
1181     }
1182
1183   if (high_surrogate && !items_read)
1184     {
1185       g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1186                            _("Partial character sequence at end of input"));
1187       goto err_out;
1188     }
1189
1190   /* At this point, everything is valid, and we just need to convert
1191    */
1192   /********** DIFFERENT for UTF8/UCS4 **********/
1193   result = g_malloc (n_bytes + 1);
1194
1195   high_surrogate = 0;
1196   out = result;
1197   in = str;
1198   while (out < result + n_bytes)
1199     {
1200       gunichar2 c = *in;
1201       gunichar wc;
1202
1203       if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1204         {
1205           wc = SURROGATE_VALUE (high_surrogate, c);
1206           high_surrogate = 0;
1207         }
1208       else if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1209         {
1210           high_surrogate = c;
1211           goto next2;
1212         }
1213       else
1214         wc = c;
1215
1216       /********** DIFFERENT for UTF8/UCS4 **********/
1217       out += g_unichar_to_utf8 (wc, out);
1218
1219     next2:
1220       in++;
1221     }
1222
1223   /********** DIFFERENT for UTF8/UCS4 **********/
1224   *out = '\0';
1225
1226   if (items_written)
1227     /********** DIFFERENT for UTF8/UCS4 **********/
1228     *items_written = out - result;
1229
1230  err_out:
1231   if (items_read)
1232     *items_read = in - str;
1233
1234   return result;
1235 }
1236
1237 /**
1238  * g_utf16_to_ucs4:
1239  * @str: a UTF-16 encoded string
1240  * @len: the maximum length (number of <type>gunichar2</type>) of @str to use.
1241  *       If @len < 0, then the string is nul-terminated.
1242  * @items_read: location to store number of words read, or %NULL.
1243  *              If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
1244  *              returned in case @str contains a trailing partial
1245  *              character. If an error occurs then the index of the
1246  *              invalid input is stored here.
1247  * @items_written: location to store number of characters written, or %NULL.
1248  *                 The value stored here does not include the trailing
1249  *                 0 character.
1250  * @error: location to store the error occuring, or %NULL to ignore
1251  *         errors. Any of the errors in #GConvertError other than
1252  *         %G_CONVERT_ERROR_NO_CONVERSION may occur.
1253  *
1254  * Convert a string from UTF-16 to UCS-4. The result will be
1255  * nul-terminated.
1256  *
1257  * Return value: a pointer to a newly allocated UCS-4 string.
1258  *               This value must be freed with g_free(). If an
1259  *               error occurs, %NULL will be returned and
1260  *               @error set.
1261  **/
1262 gunichar *
1263 g_utf16_to_ucs4 (const gunichar2  *str,
1264                  glong             len,
1265                  glong            *items_read,
1266                  glong            *items_written,
1267                  GError          **error)
1268 {
1269   const gunichar2 *in;
1270   gchar *out;
1271   gchar *result = NULL;
1272   gint n_bytes;
1273   gunichar high_surrogate;
1274
1275   g_return_val_if_fail (str != NULL, NULL);
1276
1277   n_bytes = 0;
1278   in = str;
1279   high_surrogate = 0;
1280   while ((len < 0 || in - str < len) && *in)
1281     {
1282       gunichar2 c = *in;
1283       gunichar wc;
1284
1285       if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1286         {
1287           if (high_surrogate)
1288             {
1289               wc = SURROGATE_VALUE (high_surrogate, c);
1290               high_surrogate = 0;
1291             }
1292           else
1293             {
1294               g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1295                                    _("Invalid sequence in conversion input"));
1296               goto err_out;
1297             }
1298         }
1299       else
1300         {
1301           if (high_surrogate)
1302             {
1303               g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1304                                    _("Invalid sequence in conversion input"));
1305               goto err_out;
1306             }
1307
1308           if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1309             {
1310               high_surrogate = c;
1311               goto next1;
1312             }
1313           else
1314             wc = c;
1315         }
1316
1317       /********** DIFFERENT for UTF8/UCS4 **********/
1318       n_bytes += sizeof (gunichar);
1319
1320     next1:
1321       in++;
1322     }
1323
1324   if (high_surrogate && !items_read)
1325     {
1326       g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1327                            _("Partial character sequence at end of input"));
1328       goto err_out;
1329     }
1330
1331   /* At this point, everything is valid, and we just need to convert
1332    */
1333   /********** DIFFERENT for UTF8/UCS4 **********/
1334   result = g_malloc (n_bytes + 4);
1335
1336   high_surrogate = 0;
1337   out = result;
1338   in = str;
1339   while (out < result + n_bytes)
1340     {
1341       gunichar2 c = *in;
1342       gunichar wc;
1343
1344       if (c >= 0xdc00 && c < 0xe000) /* low surrogate */
1345         {
1346           wc = SURROGATE_VALUE (high_surrogate, c);
1347           high_surrogate = 0;
1348         }
1349       else if (c >= 0xd800 && c < 0xdc00) /* high surrogate */
1350         {
1351           high_surrogate = c;
1352           goto next2;
1353         }
1354       else
1355         wc = c;
1356
1357       /********** DIFFERENT for UTF8/UCS4 **********/
1358       *(gunichar *)out = wc;
1359       out += sizeof (gunichar);
1360
1361     next2:
1362       in++;
1363     }
1364
1365   /********** DIFFERENT for UTF8/UCS4 **********/
1366   *(gunichar *)out = 0;
1367
1368   if (items_written)
1369     /********** DIFFERENT for UTF8/UCS4 **********/
1370     *items_written = (out - result) / sizeof (gunichar);
1371
1372  err_out:
1373   if (items_read)
1374     *items_read = in - str;
1375
1376   return (gunichar *)result;
1377 }
1378
1379 /**
1380  * g_utf8_to_utf16:
1381  * @str: a UTF-8 encoded string
1382  * @len: the maximum length (number of bytes) of @str to use.
1383  *       If @len < 0, then the string is nul-terminated.
1384  * @items_read: location to store number of bytes read, or %NULL.
1385  *              If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
1386  *              returned in case @str contains a trailing partial
1387  *              character. If an error occurs then the index of the
1388  *              invalid input is stored here.
1389  * @items_written: location to store number of <type>gunichar2</type> written,
1390  *                 or %NULL.
1391  *                 The value stored here does not include the trailing 0.
1392  * @error: location to store the error occuring, or %NULL to ignore
1393  *         errors. Any of the errors in #GConvertError other than
1394  *         %G_CONVERT_ERROR_NO_CONVERSION may occur.
1395  *
1396  * Convert a string from UTF-8 to UTF-16. A 0 character will be
1397  * added to the result after the converted text.
1398  *
1399  * Return value: a pointer to a newly allocated UTF-16 string.
1400  *               This value must be freed with g_free(). If an
1401  *               error occurs, %NULL will be returned and
1402  *               @error set.
1403  **/
1404 gunichar2 *
1405 g_utf8_to_utf16 (const gchar *str,
1406                  glong        len,
1407                  glong       *items_read,
1408                  glong       *items_written,
1409                  GError     **error)
1410 {
1411   gunichar2 *result = NULL;
1412   gint n16;
1413   const gchar *in;
1414   gint i;
1415
1416   g_return_val_if_fail (str != NULL, NULL);
1417
1418   in = str;
1419   n16 = 0;
1420   while ((len < 0 || str + len - in > 0) && *in)
1421     {
1422       gunichar wc = g_utf8_get_char_extended (in, len < 0 ? 6 : str + len - in);
1423       if (wc & 0x80000000)
1424         {
1425           if (wc == (gunichar)-2)
1426             {
1427               if (items_read)
1428                 break;
1429               else
1430                 g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1431                                      _("Partial character sequence at end of input"));
1432             }
1433           else
1434             g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1435                                  _("Invalid byte sequence in conversion input"));
1436
1437           goto err_out;
1438         }
1439
1440       if (wc < 0xd800)
1441         n16 += 1;
1442       else if (wc < 0xe000)
1443         {
1444           g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1445                                _("Invalid sequence in conversion input"));
1446
1447           goto err_out;
1448         }
1449       else if (wc < 0x10000)
1450         n16 += 1;
1451       else if (wc < 0x110000)
1452         n16 += 2;
1453       else
1454         {
1455           g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1456                                _("Character out of range for UTF-16"));
1457
1458           goto err_out;
1459         }
1460
1461       in = g_utf8_next_char (in);
1462     }
1463
1464   result = g_new (gunichar2, n16 + 1);
1465
1466   in = str;
1467   for (i = 0; i < n16;)
1468     {
1469       gunichar wc = g_utf8_get_char (in);
1470
1471       if (wc < 0x10000)
1472         {
1473           result[i++] = wc;
1474         }
1475       else
1476         {
1477           result[i++] = (wc - 0x10000) / 0x400 + 0xd800;
1478           result[i++] = (wc - 0x10000) % 0x400 + 0xdc00;
1479         }
1480
1481       in = g_utf8_next_char (in);
1482     }
1483
1484   result[i] = 0;
1485
1486   if (items_written)
1487     *items_written = n16;
1488
1489  err_out:
1490   if (items_read)
1491     *items_read = in - str;
1492
1493   return result;
1494 }
1495
1496 /**
1497  * g_ucs4_to_utf16:
1498  * @str: a UCS-4 encoded string
1499  * @len: the maximum length (number of characters) of @str to use.
1500  *       If @len < 0, then the string is nul-terminated.
1501  * @items_read: location to store number of bytes read, or %NULL.
1502  *              If an error occurs then the index of the invalid input
1503  *              is stored here.
1504  * @items_written: location to store number of <type>gunichar2</type>
1505  *                 written, or %NULL. The value stored here does not
1506  *                 include the trailing 0.
1507  * @error: location to store the error occuring, or %NULL to ignore
1508  *         errors. Any of the errors in #GConvertError other than
1509  *         %G_CONVERT_ERROR_NO_CONVERSION may occur.
1510  *
1511  * Convert a string from UCS-4 to UTF-16. A 0 character will be
1512  * added to the result after the converted text.
1513  *
1514  * Return value: a pointer to a newly allocated UTF-16 string.
1515  *               This value must be freed with g_free(). If an
1516  *               error occurs, %NULL will be returned and
1517  *               @error set.
1518  **/
1519 gunichar2 *
1520 g_ucs4_to_utf16 (const gunichar  *str,
1521                  glong            len,
1522                  glong           *items_read,
1523                  glong           *items_written,
1524                  GError         **error)
1525 {
1526   gunichar2 *result = NULL;
1527   gint n16;
1528   gint i, j;
1529
1530   n16 = 0;
1531   i = 0;
1532   while ((len < 0 || i < len) && str[i])
1533     {
1534       gunichar wc = str[i];
1535
1536       if (wc < 0xd800)
1537         n16 += 1;
1538       else if (wc < 0xe000)
1539         {
1540           g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1541                                _("Invalid sequence in conversion input"));
1542
1543           goto err_out;
1544         }
1545       else if (wc < 0x10000)
1546         n16 += 1;
1547       else if (wc < 0x110000)
1548         n16 += 2;
1549       else
1550         {
1551           g_set_error_literal (error, G_CONVERT_ERROR, G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1552                                _("Character out of range for UTF-16"));
1553
1554           goto err_out;
1555         }
1556
1557       i++;
1558     }
1559
1560   result = g_new (gunichar2, n16 + 1);
1561
1562   for (i = 0, j = 0; j < n16; i++)
1563     {
1564       gunichar wc = str[i];
1565
1566       if (wc < 0x10000)
1567         {
1568           result[j++] = wc;
1569         }
1570       else
1571         {
1572           result[j++] = (wc - 0x10000) / 0x400 + 0xd800;
1573           result[j++] = (wc - 0x10000) % 0x400 + 0xdc00;
1574         }
1575     }
1576   result[j] = 0;
1577
1578   if (items_written)
1579     *items_written = n16;
1580
1581  err_out:
1582   if (items_read)
1583     *items_read = i;
1584
1585   return result;
1586 }
1587
1588 #define CONTINUATION_CHAR                           \
1589  G_STMT_START {                                     \
1590   if ((*(guchar *)p & 0xc0) != 0x80) /* 10xxxxxx */ \
1591     goto error;                                     \
1592   val <<= 6;                                        \
1593   val |= (*(guchar *)p) & 0x3f;                     \
1594  } G_STMT_END
1595
1596 static const gchar *
1597 fast_validate (const char *str)
1598
1599 {
1600   gunichar val = 0;
1601   gunichar min = 0;
1602   const gchar *p;
1603
1604   for (p = str; *p; p++)
1605     {
1606       if (*(guchar *)p < 128)
1607         /* done */;
1608       else
1609         {
1610           const gchar *last;
1611
1612           last = p;
1613           if ((*(guchar *)p & 0xe0) == 0xc0) /* 110xxxxx */
1614             {
1615               if (G_UNLIKELY ((*(guchar *)p & 0x1e) == 0))
1616                 goto error;
1617               p++;
1618               if (G_UNLIKELY ((*(guchar *)p & 0xc0) != 0x80)) /* 10xxxxxx */
1619                 goto error;
1620             }
1621           else
1622             {
1623               if ((*(guchar *)p & 0xf0) == 0xe0) /* 1110xxxx */
1624                 {
1625                   min = (1 << 11);
1626                   val = *(guchar *)p & 0x0f;
1627                   goto TWO_REMAINING;
1628                 }
1629               else if ((*(guchar *)p & 0xf8) == 0xf0) /* 11110xxx */
1630                 {
1631                   min = (1 << 16);
1632                   val = *(guchar *)p & 0x07;
1633                 }
1634               else
1635                 goto error;
1636
1637               p++;
1638               CONTINUATION_CHAR;
1639             TWO_REMAINING:
1640               p++;
1641               CONTINUATION_CHAR;
1642               p++;
1643               CONTINUATION_CHAR;
1644
1645               if (G_UNLIKELY (val < min))
1646                 goto error;
1647
1648               if (G_UNLIKELY (!UNICODE_VALID(val)))
1649                 goto error;
1650             }
1651
1652           continue;
1653
1654         error:
1655           return last;
1656         }
1657     }
1658
1659   return p;
1660 }
1661
1662 static const gchar *
1663 fast_validate_len (const char *str,
1664                    gssize      max_len)
1665
1666 {
1667   gunichar val = 0;
1668   gunichar min = 0;
1669   const gchar *p;
1670
1671   g_assert (max_len >= 0);
1672
1673   for (p = str; ((p - str) < max_len) && *p; p++)
1674     {
1675       if (*(guchar *)p < 128)
1676         /* done */;
1677       else
1678         {
1679           const gchar *last;
1680
1681           last = p;
1682           if ((*(guchar *)p & 0xe0) == 0xc0) /* 110xxxxx */
1683             {
1684               if (G_UNLIKELY (max_len - (p - str) < 2))
1685                 goto error;
1686
1687               if (G_UNLIKELY ((*(guchar *)p & 0x1e) == 0))
1688                 goto error;
1689               p++;
1690               if (G_UNLIKELY ((*(guchar *)p & 0xc0) != 0x80)) /* 10xxxxxx */
1691                 goto error;
1692             }
1693           else
1694             {
1695               if ((*(guchar *)p & 0xf0) == 0xe0) /* 1110xxxx */
1696                 {
1697                   if (G_UNLIKELY (max_len - (p - str) < 3))
1698                     goto error;
1699
1700                   min = (1 << 11);
1701                   val = *(guchar *)p & 0x0f;
1702                   goto TWO_REMAINING;
1703                 }
1704               else if ((*(guchar *)p & 0xf8) == 0xf0) /* 11110xxx */
1705                 {
1706                   if (G_UNLIKELY (max_len - (p - str) < 4))
1707                     goto error;
1708
1709                   min = (1 << 16);
1710                   val = *(guchar *)p & 0x07;
1711                 }
1712               else
1713                 goto error;
1714
1715               p++;
1716               CONTINUATION_CHAR;
1717             TWO_REMAINING:
1718               p++;
1719               CONTINUATION_CHAR;
1720               p++;
1721               CONTINUATION_CHAR;
1722
1723               if (G_UNLIKELY (val < min))
1724                 goto error;
1725               if (G_UNLIKELY (!UNICODE_VALID(val)))
1726                 goto error;
1727             }
1728
1729           continue;
1730
1731         error:
1732           return last;
1733         }
1734     }
1735
1736   return p;
1737 }
1738
1739 /**
1740  * g_utf8_validate:
1741  * @str: a pointer to character data
1742  * @max_len: max bytes to validate, or -1 to go until NUL
1743  * @end: return location for end of valid data
1744  *
1745  * Validates UTF-8 encoded text. @str is the text to validate;
1746  * if @str is nul-terminated, then @max_len can be -1, otherwise
1747  * @max_len should be the number of bytes to validate.
1748  * If @end is non-%NULL, then the end of the valid range
1749  * will be stored there (i.e. the start of the first invalid
1750  * character if some bytes were invalid, or the end of the text
1751  * being validated otherwise).
1752  *
1753  * Note that g_utf8_validate() returns %FALSE if @max_len is
1754  * positive and NUL is met before @max_len bytes have been read.
1755  *
1756  * Returns %TRUE if all of @str was valid. Many GLib and GTK+
1757  * routines <emphasis>require</emphasis> valid UTF-8 as input;
1758  * so data read from a file or the network should be checked
1759  * with g_utf8_validate() before doing anything else with it.
1760  *
1761  * Return value: %TRUE if the text was valid UTF-8
1762  **/
1763 gboolean
1764 g_utf8_validate (const char   *str,
1765                  gssize        max_len,
1766                  const gchar **end)
1767
1768 {
1769   const gchar *p;
1770
1771   if (max_len < 0)
1772     p = fast_validate (str);
1773   else
1774     p = fast_validate_len (str, max_len);
1775
1776   if (end)
1777     *end = p;
1778
1779   if ((max_len >= 0 && p != str + max_len) ||
1780       (max_len < 0 && *p != '\0'))
1781     return FALSE;
1782   else
1783     return TRUE;
1784 }
1785
1786 /**
1787  * g_unichar_validate:
1788  * @ch: a Unicode character
1789  *
1790  * Checks whether @ch is a valid Unicode character. Some possible
1791  * integer values of @ch will not be valid. 0 is considered a valid
1792  * character, though it's normally a string terminator.
1793  *
1794  * Return value: %TRUE if @ch is a valid Unicode character
1795  **/
1796 gboolean
1797 g_unichar_validate (gunichar ch)
1798 {
1799   return UNICODE_VALID (ch);
1800 }
1801
1802 /**
1803  * g_utf8_strreverse:
1804  * @str: a UTF-8 encoded string
1805  * @len: the maximum length of @str to use, in bytes. If @len < 0,
1806  *       then the string is nul-terminated.
1807  *
1808  * Reverses a UTF-8 string. @str must be valid UTF-8 encoded text.
1809  * (Use g_utf8_validate() on all text before trying to use UTF-8
1810  * utility functions with it.)
1811  *
1812  * This function is intended for programmatic uses of reversed strings.
1813  * It pays no attention to decomposed characters, combining marks, byte
1814  * order marks, directional indicators (LRM, LRO, etc) and similar
1815  * characters which might need special handling when reversing a string
1816  * for display purposes.
1817  *
1818  * Note that unlike g_strreverse(), this function returns
1819  * newly-allocated memory, which should be freed with g_free() when
1820  * no longer needed.
1821  *
1822  * Returns: a newly-allocated string which is the reverse of @str.
1823  *
1824  * Since: 2.2
1825  */
1826 gchar *
1827 g_utf8_strreverse (const gchar *str,
1828                    gssize       len)
1829 {
1830   gchar *r, *result;
1831   const gchar *p;
1832
1833   if (len < 0)
1834     len = strlen (str);
1835
1836   result = g_new (gchar, len + 1);
1837   r = result + len;
1838   p = str;
1839   while (r > result)
1840     {
1841       gchar *m, skip = g_utf8_skip[*(guchar*) p];
1842       r -= skip;
1843       for (m = r; skip; skip--)
1844         *m++ = *p++;
1845     }
1846   result[len] = 0;
1847
1848   return result;
1849 }
1850
1851
1852 gchar *
1853 _g_utf8_make_valid (const gchar *name)
1854 {
1855   GString *string;
1856   const gchar *remainder, *invalid;
1857   gint remaining_bytes, valid_bytes;
1858
1859   g_return_val_if_fail (name != NULL, NULL);
1860
1861   string = NULL;
1862   remainder = name;
1863   remaining_bytes = strlen (name);
1864
1865   while (remaining_bytes != 0)
1866     {
1867       if (g_utf8_validate (remainder, remaining_bytes, &invalid))
1868         break;
1869       valid_bytes = invalid - remainder;
1870
1871       if (string == NULL)
1872         string = g_string_sized_new (remaining_bytes);
1873
1874       g_string_append_len (string, remainder, valid_bytes);
1875       /* append U+FFFD REPLACEMENT CHARACTER */
1876       g_string_append (string, "\357\277\275");
1877
1878       remaining_bytes -= valid_bytes + 1;
1879       remainder = invalid + 1;
1880     }
1881
1882   if (string == NULL)
1883     return g_strdup (name);
1884
1885   g_string_append (string, remainder);
1886
1887   g_assert (g_utf8_validate (string->str, -1, NULL));
1888
1889   return g_string_free (string, FALSE);
1890 }
1891
1892
1893 #define __G_UTF8_C__
1894 #include "galiasdef.c"