glib/guniprop.c

   1 /* guniprop.c - Unicode character properties.
   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 "glib.h"
  23 #include "gunichartables.h"
  24
  25 #include <config.h>
  26
  27 #include <stddef.h>
  28 #include <string.h>
  29 #include <locale.h>
  30
  31 #define ATTTABLE(Page, Char) \
  32   ((attr_table[Page] == 0) ? 0 : (attr_table[Page][Char]))
  33
  34 /* We cheat a bit and cast type values to (char *).  We detect these
  35    using the &0xff trick.  */
  36 #define TTYPE(Page, Char) \
  37   (((GPOINTER_TO_INT(type_table[Page]) & 0xff) == GPOINTER_TO_INT(type_table[Page])) \
  38    ? GPOINTER_TO_INT(type_table[Page]) \
  39    : (type_table[Page][Char]))
  40
  41 #define TYPE(Char) (((Char) > (G_UNICODE_LAST_CHAR)) ? G_UNICODE_UNASSIGNED : TTYPE ((Char) >> 8, (Char) & 0xff))
  42
  43 #define ISDIGIT(Type) ((Type) == G_UNICODE_DECIMAL_NUMBER       \
  44                        || (Type) == G_UNICODE_LETTER_NUMBER     \
  45                        || (Type) == G_UNICODE_OTHER_NUMBER)
  46
  47 #define ISALPHA(Type) ((Type) == G_UNICODE_LOWERCASE_LETTER     \
  48                        || (Type) == G_UNICODE_UPPERCASE_LETTER  \
  49                        || (Type) == G_UNICODE_TITLECASE_LETTER  \
  50                        || (Type) == G_UNICODE_MODIFIER_LETTER   \
  51                        || (Type) == G_UNICODE_OTHER_LETTER)
  52
  53 #define ISMARK(Type) ((Type) == G_UNICODE_NON_SPACING_MARK ||   \
  54                       (Type) == G_UNICODE_COMBINING_MARK ||     \
  55                       (Type) == G_UNICODE_ENCLOSING_MARK)
  56
  57
  58 /**
  59  * g_unichar_isalnum:
  60  * @c: a Unicode character
  61  *
  62  * Determines whether a character is alphanumeric.
  63  * Given some UTF-8 text, obtain a character value
  64  * with g_utf8_get_char().
  65  *
  66  * Return value: %TRUE if @c is an alphanumeric character
  67  **/
  68 gboolean
  69 g_unichar_isalnum (gunichar c)
  70 {
  71   int t = TYPE (c);
  72   return ISDIGIT (t) || ISALPHA (t);
  73 }
  74
  75 /**
  76  * g_unichar_isalpha:
  77  * @c: a Unicode character
  78  *
  79  * Determines whether a character is alphabetic (i.e. a letter).
  80  * Given some UTF-8 text, obtain a character value with
  81  * g_utf8_get_char().
  82  *
  83  * Return value: %TRUE if @c is an alphabetic character
  84  **/
  85 gboolean
  86 g_unichar_isalpha (gunichar c)
  87 {
  88   int t = TYPE (c);
  89   return ISALPHA (t);
  90 }
  91
  92
  93 /**
  94  * g_unichar_iscntrl:
  95  * @c: a Unicode character
  96  *
  97  * Determines whether a character is a control character.
  98  * Given some UTF-8 text, obtain a character value with
  99  * g_utf8_get_char().
 100  *
 101  * Return value: %TRUE if @c is a control character
 102  **/
 103 gboolean
 104 g_unichar_iscntrl (gunichar c)
 105 {
 106   return TYPE (c) == G_UNICODE_CONTROL;
 107 }
 108
 109 /**
 110  * g_unichar_isdigit:
 111  * @c: a Unicode character
 112  *
 113  * Determines whether a character is numeric (i.e. a digit).  This
 114  * covers ASCII 0-9 and also digits in other languages/scripts.  Given
 115  * some UTF-8 text, obtain a character value with g_utf8_get_char().
 116  *
 117  * Return value: %TRUE if @c is a digit
 118  **/
 119 gboolean
 120 g_unichar_isdigit (gunichar c)
 121 {
 122   return TYPE (c) == G_UNICODE_DECIMAL_NUMBER;
 123 }
 124
 125
 126 /**
 127  * g_unichar_isgraph:
 128  * @c: a Unicode character
 129  *
 130  * Determines whether a character is printable and not a space
 131  * (returns %FALSE for control characters, format characters, and
 132  * spaces). g_unichar_isprint() is similar, but returns %TRUE for
 133  * spaces. Given some UTF-8 text, obtain a character value with
 134  * g_utf8_get_char().
 135  *
 136  * Return value: %TRUE if @c is printable unless it's a space
 137  **/
 138 gboolean
 139 g_unichar_isgraph (gunichar c)
 140 {
 141   int t = TYPE (c);
 142   return (t != G_UNICODE_CONTROL
 143           && t != G_UNICODE_FORMAT
 144           && t != G_UNICODE_UNASSIGNED
 145           && t != G_UNICODE_PRIVATE_USE
 146           && t != G_UNICODE_SURROGATE
 147           && t != G_UNICODE_SPACE_SEPARATOR);
 148 }
 149
 150 /**
 151  * g_unichar_islower:
 152  * @c: a Unicode character
 153  *
 154  * Determines whether a character is a lowercase letter.
 155  * Given some UTF-8 text, obtain a character value with
 156  * g_utf8_get_char().
 157  *
 158  * Return value: %TRUE if @c is a lowercase letter
 159  **/
 160 gboolean
 161 g_unichar_islower (gunichar c)
 162 {
 163   return TYPE (c) == G_UNICODE_LOWERCASE_LETTER;
 164 }
 165
 166
 167 /**
 168  * g_unichar_isprint:
 169  * @c: a Unicode character
 170  *
 171  * Determines whether a character is printable.
 172  * Unlike g_unichar_isgraph(), returns %TRUE for spaces.
 173  * Given some UTF-8 text, obtain a character value with
 174  * g_utf8_get_char().
 175  *
 176  * Return value: %TRUE if @c is printable
 177  **/
 178 gboolean
 179 g_unichar_isprint (gunichar c)
 180 {
 181   int t = TYPE (c);
 182   return (t != G_UNICODE_CONTROL
 183           && t != G_UNICODE_FORMAT
 184           && t != G_UNICODE_UNASSIGNED
 185           && t != G_UNICODE_PRIVATE_USE
 186           && t != G_UNICODE_SURROGATE);
 187 }
 188
 189 /**
 190  * g_unichar_ispunct:
 191  * @c: a Unicode character
 192  *
 193  * Determines whether a character is punctuation or a symbol.
 194  * Given some UTF-8 text, obtain a character value with
 195  * g_utf8_get_char().
 196  *
 197  * Return value: %TRUE if @c is a punctuation or symbol character
 198  **/
 199 gboolean
 200 g_unichar_ispunct (gunichar c)
 201 {
 202   int t = TYPE (c);
 203   return (t == G_UNICODE_CONNECT_PUNCTUATION || t == G_UNICODE_DASH_PUNCTUATION
 204           || t == G_UNICODE_CLOSE_PUNCTUATION || t == G_UNICODE_FINAL_PUNCTUATION
 205           || t == G_UNICODE_INITIAL_PUNCTUATION || t == G_UNICODE_OTHER_PUNCTUATION
 206           || t == G_UNICODE_OPEN_PUNCTUATION || t == G_UNICODE_CURRENCY_SYMBOL
 207           || t == G_UNICODE_MODIFIER_SYMBOL || t == G_UNICODE_MATH_SYMBOL
 208           || t == G_UNICODE_OTHER_SYMBOL);
 209 }
 210
 211 /**
 212  * g_unichar_isspace:
 213  * @c: a Unicode character
 214  *
 215  * Determines whether a character is a space, tab, or line separator
 216  * (newline, carriage return, etc.).  Given some UTF-8 text, obtain a
 217  * character value with g_utf8_get_char().
 218  *
 219  * (Note: don't use this to do word breaking; you have to use
 220  * Pango or equivalent to get word breaking right, the algorithm
 221  * is fairly complex.)
 222  *
 223  * Return value: %TRUE if @c is a punctuation character
 224  **/
 225 gboolean
 226 g_unichar_isspace (gunichar c)
 227 {
 228   switch (c)
 229     {
 230       /* special-case these since Unicode thinks they are not spaces */
 231     case '\t':
 232     case '\n':
 233     case '\r':
 234     case '\f':
 235       return TRUE;
 236       break;
 237
 238     default:
 239       {
 240         int t = TYPE (c);
 241         return (t == G_UNICODE_SPACE_SEPARATOR || t == G_UNICODE_LINE_SEPARATOR
 242                 || t == G_UNICODE_PARAGRAPH_SEPARATOR);
 243       }
 244       break;
 245     }
 246 }
 247
 248 /**
 249  * g_unichar_isupper:
 250  * @c: a Unicode character
 251  *
 252  * Determines if a character is uppercase.
 253  *
 254  * Return value: %TRUE if @c is an uppercase character
 255  **/
 256 gboolean
 257 g_unichar_isupper (gunichar c)
 258 {
 259   return TYPE (c) == G_UNICODE_UPPERCASE_LETTER;
 260 }
 261
 262 /**
 263  * g_unichar_istitle:
 264  * @c: a Unicode character
 265  *
 266  * Determines if a character is titlecase. Some characters in
 267  * Unicode which are composites, such as the DZ digraph
 268  * have three case variants instead of just two. The titlecase
 269  * form is used at the beginning of a word where only the
 270  * first letter is capitalized. The titlecase form of the DZ
 271  * digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z.
 272  *
 273  * Return value: %TRUE if the character is titlecase
 274  **/
 275 gboolean
 276 g_unichar_istitle (gunichar c)
 277 {
 278   unsigned int i;
 279   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 280     if (title_table[i][0] == c)
 281       return 1;
 282   return 0;
 283 }
 284
 285 /**
 286  * g_unichar_isxdigit:
 287  * @c: a Unicode character.
 288  *
 289  * Determines if a character is a hexidecimal digit.
 290  *
 291  * Return value: %TRUE if the character is a hexadecimal digit
 292  **/
 293 gboolean
 294 g_unichar_isxdigit (gunichar c)
 295 {
 296   int t = TYPE (c);
 297   return ((c >= 'a' && c <= 'f')
 298           || (c >= 'A' && c <= 'F')
 299           || ISDIGIT (t));
 300 }
 301
 302 /**
 303  * g_unichar_isdefined:
 304  * @c: a Unicode character
 305  *
 306  * Determines if a given character is assigned in the Unicode
 307  * standard.
 308  *
 309  * Return value: %TRUE if the character has an assigned value
 310  **/
 311 gboolean
 312 g_unichar_isdefined (gunichar c)
 313 {
 314   int t = TYPE (c);
 315   return t != G_UNICODE_UNASSIGNED;
 316 }
 317
 318 /**
 319  * g_unichar_iswide:
 320  * @c: a Unicode character
 321  *
 322  * Determines if a character is typically rendered in a double-width
 323  * cell.
 324  *
 325  * Return value: %TRUE if the character is wide
 326  **/
 327 /* This function stolen from Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk>.  */
 328 gboolean
 329 g_unichar_iswide (gunichar c)
 330 {
 331   if (c < 0x1100)
 332     return 0;
 333
 334   return ((c >= 0x1100 && c <= 0x115f)     /* Hangul Jamo */
 335           || (c >= 0x2e80 && c <= 0xa4cf && (c & ~0x0011) != 0x300a &&
 336               c != 0x303f)                 /* CJK ... Yi */
 337           || (c >= 0xac00 && c <= 0xd7a3)  /* Hangul Syllables */
 338           || (c >= 0xf900 && c <= 0xfaff)  /* CJK Compatibility Ideographs */
 339           || (c >= 0xfe30 && c <= 0xfe6f)  /* CJK Compatibility Forms */
 340           || (c >= 0xff00 && c <= 0xff5f)  /* Fullwidth Forms */
 341           || (c >= 0xffe0 && c <= 0xffe6));
 342 }
 343
 344 /**
 345  * g_unichar_toupper:
 346  * @c: a Unicode character
 347  *
 348  * Converts a character to uppercase.
 349  *
 350  * Return value: the result of converting @c to uppercase.
 351  *               If @c is not an lowercase or titlecase character,
 352  *               @c is returned unchanged.
 353  **/
 354 gunichar
 355 g_unichar_toupper (gunichar c)
 356 {
 357   int t = TYPE (c);
 358   if (t == G_UNICODE_LOWERCASE_LETTER)
 359     {
 360       gunichar val = ATTTABLE (c >> 8, c & 0xff);
 361       if (val >= 0xd800 && val < 0xdc00)
 362         {
 363           const guchar *p = special_case_table[val - 0xd800];
 364           return p[0] * 256 + p[1];
 365         }
 366       else
 367         return val;
 368     }
 369   else if (t == G_UNICODE_TITLECASE_LETTER)
 370     {
 371       unsigned int i;
 372       for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 373         {
 374           if (title_table[i][0] == c)
 375             return title_table[i][1];
 376         }
 377     }
 378   return c;
 379 }
 380
 381 /**
 382  * g_unichar_tolower:
 383  * @c: a Unicode character.
 384  *
 385  * Converts a character to lower case.
 386  *
 387  * Return value: the result of converting @c to lower case.
 388  *               If @c is not an upperlower or titlecase character,
 389  *               @c is returned unchanged.
 390  **/
 391 gunichar
 392 g_unichar_tolower (gunichar c)
 393 {
 394   int t = TYPE (c);
 395   if (t == G_UNICODE_UPPERCASE_LETTER)
 396     {
 397       gunichar val = ATTTABLE (c >> 8, c & 0xff);
 398       if (val >= 0xd800 && val < 0xdc00)
 399         {
 400           const guchar *p = special_case_table[val - 0xd800];
 401           return p[0] * 256 + p[1];
 402         }
 403       else
 404         return val;
 405     }
 406   else if (t == G_UNICODE_TITLECASE_LETTER)
 407     {
 408       unsigned int i;
 409       for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 410         {
 411           if (title_table[i][0] == c)
 412             return title_table[i][2];
 413         }
 414     }
 415   return c;
 416 }
 417
 418 /**
 419  * g_unichar_totitle:
 420  * @c: a Unicode character
 421  *
 422  * Converts a character to the titlecase.
 423  *
 424  * Return value: the result of converting @c to titlecase.
 425  *               If @c is not an uppercase or lowercase character,
 426  *               @c is returned unchanged.
 427  **/
 428 gunichar
 429 g_unichar_totitle (gunichar c)
 430 {
 431   unsigned int i;
 432   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 433     {
 434       if (title_table[i][0] == c || title_table[i][1] == c
 435           || title_table[i][2] == c)
 436         return title_table[i][0];
 437     }
 438   return (TYPE (c) == G_UNICODE_LOWERCASE_LETTER
 439           ? ATTTABLE (c >> 8, c & 0xff)
 440           : c);
 441 }
 442
 443 /**
 444  * g_unichar_digit_value:
 445  * @c: a Unicode character
 446  *
 447  * Determines the numeric value of a character as a decimal
 448  * digit.
 449  *
 450  * Return value: If @c is a decimal digit (according to
 451  * g_unichar_isdigit()), its numeric value. Otherwise, -1.
 452  **/
 453 int
 454 g_unichar_digit_value (gunichar c)
 455 {
 456   if (TYPE (c) == G_UNICODE_DECIMAL_NUMBER)
 457     return ATTTABLE (c >> 8, c & 0xff);
 458   return -1;
 459 }
 460
 461 /**
 462  * g_unichar_xdigit_value:
 463  * @c: a Unicode character
 464  *
 465  * Determines the numeric value of a character as a hexidecimal
 466  * digit.
 467  *
 468  * Return value: If @c is a hex digit (according to
 469  * g_unichar_isxdigit()), its numeric value. Otherwise, -1.
 470  **/
 471 int
 472 g_unichar_xdigit_value (gunichar c)
 473 {
 474   if (c >= 'A' && c <= 'F')
 475     return c - 'A' + 10;
 476   if (c >= 'a' && c <= 'f')
 477     return c - 'a' + 10;
 478   if (TYPE (c) == G_UNICODE_DECIMAL_NUMBER)
 479     return ATTTABLE (c >> 8, c & 0xff);
 480   return -1;
 481 }
 482
 483 /**
 484  * g_unichar_type:
 485  * @c: a Unicode character
 486  *
 487  * Classifies a Unicode character by type.
 488  *
 489  * Return value: the type of the character.
 490  **/
 491 GUnicodeType
 492 g_unichar_type (gunichar c)
 493 {
 494   return TYPE (c);
 495 }
 496
 497 /*
 498  * Case mapping functions
 499  */
 500
 501 typedef enum {
 502   LOCALE_NORMAL,
 503   LOCALE_TURKIC,
 504   LOCALE_LITHUANIAN
 505 } LocaleType;
 506
 507 static LocaleType
 508 get_locale_type (void)
 509 {
 510   const char *locale = setlocale (LC_CTYPE, NULL);
 511
 512   switch (locale[0])
 513     {
 514    case 'a':
 515       if (locale[1] == 'z')
 516         return LOCALE_TURKIC;
 517       break;
 518     case 'l':
 519       if (locale[1] == 't')
 520         return LOCALE_LITHUANIAN;
 521       break;
 522     case 't':
 523       if (locale[1] == 'r')
 524         return LOCALE_TURKIC;
 525       break;
 526     }
 527
 528   return LOCALE_NORMAL;
 529 }
 530
 531 static int
 532 output_marks (const char **p_inout,
 533               char        *out_buffer,
 534               int          len,
 535               gboolean     remove_dot)
 536 {
 537   const char *p = *p_inout;
 538
 539   while (*p)
 540     {
 541       gunichar c = g_utf8_get_char (p);
 542       int t = TYPE(c);
 543
 544       if (ISMARK(t))
 545         {
 546           if (!remove_dot || c != 0x307 /* COMBINING DOT ABOVE */)
 547             len += g_unichar_to_utf8 (c, out_buffer ? out_buffer + len : NULL);
 548           p = g_utf8_next_char (p);
 549         }
 550       else
 551         break;
 552     }
 553
 554   *p_inout = p;
 555   return len;
 556 }
 557
 558 static gsize
 559 output_special_case (gchar *out_buffer,
 560                      gsize  len,
 561                      int    index,
 562                      int    type,
 563                      int    which)
 564 {
 565   const guchar *p = special_case_table[index];
 566
 567   if (type != G_UNICODE_TITLECASE_LETTER)
 568     p += 2; /* +2 to skip over "best single match" */
 569
 570   if (which == 1)
 571     {
 572       while (p[0] && p[1])
 573         p += 2;
 574       p += 2;
 575     }
 576
 577   while (TRUE)
 578     {
 579       gunichar ch = p[0] * 256 + p[1];
 580       if (!ch)
 581         break;
 582
 583       len += g_unichar_to_utf8 (ch, out_buffer ? out_buffer + len : NULL);
 584       p += 2;
 585     }
 586
 587   return len;
 588 }
 589
 590 static gsize
 591 real_toupper (const gchar *str,
 592               gssize       max_len,
 593               gchar       *out_buffer,
 594               LocaleType   locale_type)
 595 {
 596   const gchar *p = str;
 597   const char *last = NULL;
 598   gsize len = 0;
 599   gboolean last_was_i = FALSE;
 600
 601   while ((max_len < 0 || p < str + max_len) && *p)
 602     {
 603       gunichar c = g_utf8_get_char (p);
 604       int t = TYPE (c);
 605       gunichar val;
 606
 607       last = p;
 608       p = g_utf8_next_char (p);
 609
 610       if (locale_type == LOCALE_LITHUANIAN)
 611         {
 612           if (c == 'i')
 613             last_was_i = TRUE;
 614           else
 615             {
 616               if (last_was_i)
 617                 {
 618                   /* Nasty, need to remove any dot above. Though
 619                    * I think only E WITH DOT ABOVE occurs in practice
 620                    * which could simplify this considerably.
 621                    */
 622                   gsize decomp_len, i;
 623                   gunichar *decomp;
 624
 625                   decomp = g_unicode_canonical_decomposition (c, &decomp_len);
 626                   for (i=0; i < decomp_len; i++)
 627                     {
 628                       if (decomp[i] != 0x307 /* COMBINING DOT ABOVE */)
 629                         len += g_unichar_to_utf8 (g_unichar_toupper (decomp[i]), out_buffer ? out_buffer + len : NULL);
 630                     }
 631                   g_free (decomp);
 632
 633                   len = output_marks (&p, out_buffer, len, TRUE);
 634
 635                   continue;
 636                 }
 637
 638               if (!ISMARK(t))
 639                 last_was_i = FALSE;
 640             }
 641         }
 642
 643       if (locale_type == LOCALE_TURKIC && c == 'i')
 644         {
 645           /* i => LATIN CAPITAL LETTER I WITH DOT ABOVE */
 646           len += g_unichar_to_utf8 (0x130, out_buffer ? out_buffer + len : NULL);
 647         }
 648       else if (c == 0x0345)     /* COMBINING GREEK YPOGEGRAMMENI */
 649         {
 650           /* Nasty, need to move it after other combining marks .. this would go away if
 651            * we normalized first.
 652            */
 653           len = output_marks (&p, out_buffer, len, FALSE);
 654
 655           /* And output as GREEK CAPITAL LETTER IOTA */
 656           len += g_unichar_to_utf8 (0x399, out_buffer ? out_buffer + len : NULL);
 657         }
 658       else if (t == G_UNICODE_LOWERCASE_LETTER || t == G_UNICODE_TITLECASE_LETTER)
 659         {
 660           val = ATTTABLE (c >> 8, c & 0xff);
 661
 662           if (val >= 0xd800 && val < 0xdc00)
 663             {
 664               len += output_special_case (out_buffer, len, val - 0xd800, t,
 665                                           t == G_UNICODE_LOWERCASE_LETTER ? 0 : 1);
 666             }
 667           else
 668             {
 669               if (t == G_UNICODE_TITLECASE_LETTER)
 670                 {
 671                   unsigned int i;
 672                   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 673                     {
 674                       if (title_table[i][0] == c)
 675                         val = title_table[i][1];
 676                     }
 677                 }
 678
 679               len += g_unichar_to_utf8 (val, out_buffer ? out_buffer + len : NULL);
 680             }
 681         }
 682       else
 683         {
 684           gsize char_len = g_utf8_skip[*(guchar *)last];
 685
 686           if (out_buffer)
 687             memcpy (out_buffer + len, last, char_len);
 688
 689           len += char_len;
 690         }
 691
 692     }
 693
 694   return len;
 695 }
 696
 697 /**
 698  * g_utf8_strup:
 699  * @str: a UTF-8 encoded string
 700  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
 701  *
 702  * Converts all Unicode characters in the string that have a case
 703  * to uppercase. The exact manner that this is done depends
 704  * on the current locale, and may result in the number of
 705  * characters in the string increasing. (For instance, the
 706  * German ess-zet will be changed to SS.)
 707  *
 708  * Return value: a newly allocated string, with all characters
 709  *    converted to uppercase.
 710  **/
 711 gchar *
 712 g_utf8_strup (const gchar *str,
 713               gssize       len)
 714 {
 715   gsize result_len;
 716   LocaleType locale_type;
 717   gchar *result;
 718
 719   g_return_val_if_fail (str != NULL, NULL);
 720
 721   locale_type = get_locale_type ();
 722
 723   /*
 724    * We use a two pass approach to keep memory management simple
 725    */
 726   result_len = real_toupper (str, len, NULL, locale_type);
 727   result = g_malloc (result_len + 1);
 728   real_toupper (str, len, result, locale_type);
 729   result[result_len] = '\0';
 730
 731   return result;
 732 }
 733
 734 static gsize
 735 real_tolower (const gchar *str,
 736               gssize       max_len,
 737               gchar       *out_buffer,
 738               LocaleType   locale_type)
 739 {
 740   const gchar *p = str;
 741   const char *last = NULL;
 742   gsize len = 0;
 743
 744   while ((max_len < 0 || p < str + max_len) && *p)
 745     {
 746       gunichar c = g_utf8_get_char (p);
 747       int t = TYPE (c);
 748       gunichar val;
 749
 750       last = p;
 751       p = g_utf8_next_char (p);
 752
 753       if (locale_type == LOCALE_TURKIC && c == 'I')
 754         {
 755           /* I => LATIN SMALL LETTER DOTLESS I */
 756           len += g_unichar_to_utf8 (0x131, out_buffer ? out_buffer + len : NULL);
 757         }
 758       else if (c == 0x03A3)     /* GREEK CAPITAL LETTER SIGMA */
 759         {
 760           gunichar next_c = g_utf8_get_char (p);
 761           int next_t = TYPE(next_c);
 762
 763           /* SIGMA mapps differently depending on whether it is
 764            * final or not. The following simplified test would
 765            * fail in the case of combining marks following the
 766            * sigma, but I don't think that occurs in real text.
 767            * The test here matches that in ICU.
 768            */
 769           if (ISALPHA(next_t)) /* Lu,Ll,Lt,Lm,Lo */
 770             val = 0x3c3;        /* GREEK SMALL SIGMA */
 771           else
 772             val = 0x3c2;        /* GREEK SMALL FINAL SIGMA */
 773
 774           len += g_unichar_to_utf8 (val, out_buffer ? out_buffer + len : NULL);
 775         }
 776       else if (t == G_UNICODE_UPPERCASE_LETTER || t == G_UNICODE_TITLECASE_LETTER)
 777         {
 778           val = ATTTABLE (c >> 8, c & 0xff);
 779
 780           if (val >= 0xd800 && val < 0xdc00)
 781             {
 782               len += output_special_case (out_buffer, len, val - 0xd800, t, 0);
 783             }
 784           else
 785             {
 786               if (t == G_UNICODE_TITLECASE_LETTER)
 787                 {
 788                   unsigned int i;
 789                   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 790                     {
 791                       if (title_table[i][0] == c)
 792                         val = title_table[i][2];
 793                     }
 794                 }
 795
 796               len += g_unichar_to_utf8 (val, out_buffer ? out_buffer + len : NULL);
 797             }
 798         }
 799       else
 800         {
 801           gsize char_len = g_utf8_skip[*(guchar *)last];
 802
 803           if (out_buffer)
 804             memcpy (out_buffer + len, last, char_len);
 805
 806           len += char_len;
 807         }
 808
 809     }
 810
 811   return len;
 812 }
 813
 814 /**
 815  * g_utf8_strdown:
 816  * @str: a UTF-8 encoded string
 817  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
 818  *
 819  * Converts all Unicode characters in the string that have a case
 820  * to lowercase. The exact manner that this is done depends
 821  * on the current locale, and may result in the number of
 822  * characters in the string changing.
 823  *
 824  * Return value: a newly allocated string, with all characters
 825  *    converted to lowercase.
 826  **/
 827 gchar *
 828 g_utf8_strdown (const gchar *str,
 829                 gssize       len)
 830 {
 831   gsize result_len;
 832   LocaleType locale_type;
 833   gchar *result;
 834
 835   g_return_val_if_fail (str != NULL, NULL);
 836
 837   locale_type = get_locale_type ();
 838
 839   /*
 840    * We use a two pass approach to keep memory management simple
 841    */
 842   result_len = real_tolower (str, len, NULL, locale_type);
 843   result = g_malloc (result_len + 1);
 844   real_tolower (str, len, result, locale_type);
 845   result[result_len] = '\0';
 846
 847   return result;
 848 }
 849
 850 /**
 851  * g_utf8_casefold:
 852  * @str: a UTF-8 encoded string
 853  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
 854  *
 855  * Converts a string into a form that is independent of case. The
 856  * result will not correspond to any particular case, but can be
 857  * compared for equality or ordered with the results of calling
 858  * g_utf8_casefold() on other strings.
 859  *
 860  * Note that calling g_utf8_casefold() followed by g_utf8_collate() is
 861  * only an approximation to the correct linguistic case insensitive
 862  * ordering, though it is a fairly good one. Getting this exactly
 863  * right would require a more sophisticated collation function that
 864  * takes case sensitivity into account. GLib does not currently
 865  * provide such a function.
 866  *
 867  * Return value: a newly allocated string, that is a
 868  *   case independent form of @str.
 869  **/
 870 gchar *
 871 g_utf8_casefold (const gchar *str,
 872                  gssize       len)
 873 {
 874   GString *result = g_string_new (NULL);
 875   const char *p;
 876
 877   p = str;
 878   while ((len < 0 || p < str + len) && *p)
 879     {
 880       gunichar ch = g_utf8_get_char (p);
 881
 882       int start = 0;
 883       int end = G_N_ELEMENTS (casefold_table);
 884
 885       if (ch >= casefold_table[start].ch &&
 886           ch <= casefold_table[end - 1].ch)
 887         {
 888           while (TRUE)
 889             {
 890               int half = (start + end) / 2;
 891               if (ch == casefold_table[half].ch)
 892                 {
 893                   g_string_append (result, casefold_table[half].data);
 894                   goto next;
 895                 }
 896               else if (half == start)
 897                 break;
 898               else if (ch > casefold_table[half].ch)
 899                 start = half;
 900               else
 901                 end = half;
 902             }
 903         }
 904
 905       g_string_append_unichar (result, g_unichar_tolower (ch));
 906
 907     next:
 908       p = g_utf8_next_char (p);
 909     }
 910
 911   return g_string_free (result, FALSE);
 912 }