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