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