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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include "config.h"
  21
  22 #include <stdlib.h>
  23 #include <stddef.h>
  24 #include <string.h>
  25 #include <locale.h>
  26
  27 #include "gmem.h"
  28 #include "gstring.h"
  29 #include "gtestutils.h"
  30 #include "gtypes.h"
  31 #include "gunicode.h"
  32 #include "gunichartables.h"
  33 #include "gmirroringtable.h"
  34 #include "gscripttable.h"
  35 #include "gunicodeprivate.h"
  36 #ifdef G_OS_WIN32
  37 #include "gwin32.h"
  38 #endif
  39
  40 #define ATTR_TABLE(Page) (((Page) <= G_UNICODE_LAST_PAGE_PART1) \
  41                           ? attr_table_part1[Page] \
  42                           : attr_table_part2[(Page) - 0xe00])
  43
  44 #define ATTTABLE(Page, Char) \
  45   ((ATTR_TABLE(Page) == G_UNICODE_MAX_TABLE_INDEX) ? 0 : (attr_data[ATTR_TABLE(Page)][Char]))
  46
  47 #define TTYPE_PART1(Page, Char) \
  48   ((type_table_part1[Page] >= G_UNICODE_MAX_TABLE_INDEX) \
  49    ? (type_table_part1[Page] - G_UNICODE_MAX_TABLE_INDEX) \
  50    : (type_data[type_table_part1[Page]][Char]))
  51
  52 #define TTYPE_PART2(Page, Char) \
  53   ((type_table_part2[Page] >= G_UNICODE_MAX_TABLE_INDEX) \
  54    ? (type_table_part2[Page] - G_UNICODE_MAX_TABLE_INDEX) \
  55    : (type_data[type_table_part2[Page]][Char]))
  56
  57 #define TYPE(Char) \
  58   (((Char) <= G_UNICODE_LAST_CHAR_PART1) \
  59    ? TTYPE_PART1 ((Char) >> 8, (Char) & 0xff) \
  60    : (((Char) >= 0xe0000 && (Char) <= G_UNICODE_LAST_CHAR) \
  61       ? TTYPE_PART2 (((Char) - 0xe0000) >> 8, (Char) & 0xff) \
  62       : G_UNICODE_UNASSIGNED))
  63
  64
  65 #define IS(Type, Class) (((guint)1 << (Type)) & (Class))
  66 #define OR(Type, Rest)  (((guint)1 << (Type)) | (Rest))
  67
  68
  69
  70 #define ISALPHA(Type)   IS ((Type),                             \
  71                             OR (G_UNICODE_LOWERCASE_LETTER,     \
  72                             OR (G_UNICODE_UPPERCASE_LETTER,     \
  73                             OR (G_UNICODE_TITLECASE_LETTER,     \
  74                             OR (G_UNICODE_MODIFIER_LETTER,      \
  75                             OR (G_UNICODE_OTHER_LETTER,         0))))))
  76
  77 #define ISALDIGIT(Type) IS ((Type),                             \
  78                             OR (G_UNICODE_DECIMAL_NUMBER,       \
  79                             OR (G_UNICODE_LETTER_NUMBER,        \
  80                             OR (G_UNICODE_OTHER_NUMBER,         \
  81                             OR (G_UNICODE_LOWERCASE_LETTER,     \
  82                             OR (G_UNICODE_UPPERCASE_LETTER,     \
  83                             OR (G_UNICODE_TITLECASE_LETTER,     \
  84                             OR (G_UNICODE_MODIFIER_LETTER,      \
  85                             OR (G_UNICODE_OTHER_LETTER,         0)))))))))
  86
  87 #define ISMARK(Type)    IS ((Type),                             \
  88                             OR (G_UNICODE_NON_SPACING_MARK,     \
  89                             OR (G_UNICODE_SPACING_MARK, \
  90                             OR (G_UNICODE_ENCLOSING_MARK,       0))))
  91
  92 #define ISZEROWIDTHTYPE(Type)   IS ((Type),                     \
  93                             OR (G_UNICODE_NON_SPACING_MARK,     \
  94                             OR (G_UNICODE_ENCLOSING_MARK,       \
  95                             OR (G_UNICODE_FORMAT,               0))))
  96
  97 /**
  98  * g_unichar_isalnum:
  99  * @c: a Unicode character
 100  *
 101  * Determines whether a character is alphanumeric.
 102  * Given some UTF-8 text, obtain a character value
 103  * with g_utf8_get_char().
 104  *
 105  * Returns: %TRUE if @c is an alphanumeric character
 106  **/
 107 gboolean
 108 g_unichar_isalnum (gunichar c)
 109 {
 110   return ISALDIGIT (TYPE (c)) ? TRUE : FALSE;
 111 }
 112
 113 /**
 114  * g_unichar_isalpha:
 115  * @c: a Unicode character
 116  *
 117  * Determines whether a character is alphabetic (i.e. a letter).
 118  * Given some UTF-8 text, obtain a character value with
 119  * g_utf8_get_char().
 120  *
 121  * Returns: %TRUE if @c is an alphabetic character
 122  **/
 123 gboolean
 124 g_unichar_isalpha (gunichar c)
 125 {
 126   return ISALPHA (TYPE (c)) ? TRUE : FALSE;
 127 }
 128
 129
 130 /**
 131  * g_unichar_iscntrl:
 132  * @c: a Unicode character
 133  *
 134  * Determines whether a character is a control character.
 135  * Given some UTF-8 text, obtain a character value with
 136  * g_utf8_get_char().
 137  *
 138  * Returns: %TRUE if @c is a control character
 139  **/
 140 gboolean
 141 g_unichar_iscntrl (gunichar c)
 142 {
 143   return TYPE (c) == G_UNICODE_CONTROL;
 144 }
 145
 146 /**
 147  * g_unichar_isdigit:
 148  * @c: a Unicode character
 149  *
 150  * Determines whether a character is numeric (i.e. a digit).  This
 151  * covers ASCII 0-9 and also digits in other languages/scripts.  Given
 152  * some UTF-8 text, obtain a character value with g_utf8_get_char().
 153  *
 154  * Returns: %TRUE if @c is a digit
 155  **/
 156 gboolean
 157 g_unichar_isdigit (gunichar c)
 158 {
 159   return TYPE (c) == G_UNICODE_DECIMAL_NUMBER;
 160 }
 161
 162
 163 /**
 164  * g_unichar_isgraph:
 165  * @c: a Unicode character
 166  *
 167  * Determines whether a character is printable and not a space
 168  * (returns %FALSE for control characters, format characters, and
 169  * spaces). g_unichar_isprint() is similar, but returns %TRUE for
 170  * spaces. Given some UTF-8 text, obtain a character value with
 171  * g_utf8_get_char().
 172  *
 173  * Returns: %TRUE if @c is printable unless it's a space
 174  **/
 175 gboolean
 176 g_unichar_isgraph (gunichar c)
 177 {
 178   return !IS (TYPE(c),
 179               OR (G_UNICODE_CONTROL,
 180               OR (G_UNICODE_FORMAT,
 181               OR (G_UNICODE_UNASSIGNED,
 182               OR (G_UNICODE_SURROGATE,
 183               OR (G_UNICODE_SPACE_SEPARATOR,
 184              0))))));
 185 }
 186
 187 /**
 188  * g_unichar_islower:
 189  * @c: a Unicode character
 190  *
 191  * Determines whether a character is a lowercase letter.
 192  * Given some UTF-8 text, obtain a character value with
 193  * g_utf8_get_char().
 194  *
 195  * Returns: %TRUE if @c is a lowercase letter
 196  **/
 197 gboolean
 198 g_unichar_islower (gunichar c)
 199 {
 200   return TYPE (c) == G_UNICODE_LOWERCASE_LETTER;
 201 }
 202
 203
 204 /**
 205  * g_unichar_isprint:
 206  * @c: a Unicode character
 207  *
 208  * Determines whether a character is printable.
 209  * Unlike g_unichar_isgraph(), returns %TRUE for spaces.
 210  * Given some UTF-8 text, obtain a character value with
 211  * g_utf8_get_char().
 212  *
 213  * Returns: %TRUE if @c is printable
 214  **/
 215 gboolean
 216 g_unichar_isprint (gunichar c)
 217 {
 218   return !IS (TYPE(c),
 219               OR (G_UNICODE_CONTROL,
 220               OR (G_UNICODE_FORMAT,
 221               OR (G_UNICODE_UNASSIGNED,
 222               OR (G_UNICODE_SURROGATE,
 223              0)))));
 224 }
 225
 226 /**
 227  * g_unichar_ispunct:
 228  * @c: a Unicode character
 229  *
 230  * Determines whether a character is punctuation or a symbol.
 231  * Given some UTF-8 text, obtain a character value with
 232  * g_utf8_get_char().
 233  *
 234  * Returns: %TRUE if @c is a punctuation or symbol character
 235  **/
 236 gboolean
 237 g_unichar_ispunct (gunichar c)
 238 {
 239   return IS (TYPE(c),
 240              OR (G_UNICODE_CONNECT_PUNCTUATION,
 241              OR (G_UNICODE_DASH_PUNCTUATION,
 242              OR (G_UNICODE_CLOSE_PUNCTUATION,
 243              OR (G_UNICODE_FINAL_PUNCTUATION,
 244              OR (G_UNICODE_INITIAL_PUNCTUATION,
 245              OR (G_UNICODE_OTHER_PUNCTUATION,
 246              OR (G_UNICODE_OPEN_PUNCTUATION,
 247              OR (G_UNICODE_CURRENCY_SYMBOL,
 248              OR (G_UNICODE_MODIFIER_SYMBOL,
 249              OR (G_UNICODE_MATH_SYMBOL,
 250              OR (G_UNICODE_OTHER_SYMBOL,
 251             0)))))))))))) ? TRUE : FALSE;
 252 }
 253
 254 /**
 255  * g_unichar_isspace:
 256  * @c: a Unicode character
 257  *
 258  * Determines whether a character is a space, tab, or line separator
 259  * (newline, carriage return, etc.).  Given some UTF-8 text, obtain a
 260  * character value with g_utf8_get_char().
 261  *
 262  * (Note: don't use this to do word breaking; you have to use
 263  * Pango or equivalent to get word breaking right, the algorithm
 264  * is fairly complex.)
 265  *
 266  * Returns: %TRUE if @c is a space character
 267  **/
 268 gboolean
 269 g_unichar_isspace (gunichar c)
 270 {
 271   switch (c)
 272     {
 273       /* special-case these since Unicode thinks they are not spaces */
 274     case '\t':
 275     case '\n':
 276     case '\r':
 277     case '\f':
 278       return TRUE;
 279       break;
 280
 281     default:
 282       {
 283         return IS (TYPE(c),
 284                    OR (G_UNICODE_SPACE_SEPARATOR,
 285                    OR (G_UNICODE_LINE_SEPARATOR,
 286                    OR (G_UNICODE_PARAGRAPH_SEPARATOR,
 287                   0)))) ? TRUE : FALSE;
 288       }
 289       break;
 290     }
 291 }
 292
 293 /**
 294  * g_unichar_ismark:
 295  * @c: a Unicode character
 296  *
 297  * Determines whether a character is a mark (non-spacing mark,
 298  * combining mark, or enclosing mark in Unicode speak).
 299  * Given some UTF-8 text, obtain a character value
 300  * with g_utf8_get_char().
 301  *
 302  * Note: in most cases where isalpha characters are allowed,
 303  * ismark characters should be allowed to as they are essential
 304  * for writing most European languages as well as many non-Latin
 305  * scripts.
 306  *
 307  * Returns: %TRUE if @c is a mark character
 308  *
 309  * Since: 2.14
 310  **/
 311 gboolean
 312 g_unichar_ismark (gunichar c)
 313 {
 314   return ISMARK (TYPE (c));
 315 }
 316
 317 /**
 318  * g_unichar_isupper:
 319  * @c: a Unicode character
 320  *
 321  * Determines if a character is uppercase.
 322  *
 323  * Returns: %TRUE if @c is an uppercase character
 324  **/
 325 gboolean
 326 g_unichar_isupper (gunichar c)
 327 {
 328   return TYPE (c) == G_UNICODE_UPPERCASE_LETTER;
 329 }
 330
 331 /**
 332  * g_unichar_istitle:
 333  * @c: a Unicode character
 334  *
 335  * Determines if a character is titlecase. Some characters in
 336  * Unicode which are composites, such as the DZ digraph
 337  * have three case variants instead of just two. The titlecase
 338  * form is used at the beginning of a word where only the
 339  * first letter is capitalized. The titlecase form of the DZ
 340  * digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z.
 341  *
 342  * Returns: %TRUE if the character is titlecase
 343  **/
 344 gboolean
 345 g_unichar_istitle (gunichar c)
 346 {
 347   unsigned int i;
 348   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 349     if (title_table[i][0] == c)
 350       return TRUE;
 351   return FALSE;
 352 }
 353
 354 /**
 355  * g_unichar_isxdigit:
 356  * @c: a Unicode character.
 357  *
 358  * Determines if a character is a hexidecimal digit.
 359  *
 360  * Returns: %TRUE if the character is a hexadecimal digit
 361  **/
 362 gboolean
 363 g_unichar_isxdigit (gunichar c)
 364 {
 365   return ((c >= 'a' && c <= 'f')
 366           || (c >= 'A' && c <= 'F')
 367           || (TYPE (c) == G_UNICODE_DECIMAL_NUMBER));
 368 }
 369
 370 /**
 371  * g_unichar_isdefined:
 372  * @c: a Unicode character
 373  *
 374  * Determines if a given character is assigned in the Unicode
 375  * standard.
 376  *
 377  * Returns: %TRUE if the character has an assigned value
 378  **/
 379 gboolean
 380 g_unichar_isdefined (gunichar c)
 381 {
 382   return !IS (TYPE(c),
 383               OR (G_UNICODE_UNASSIGNED,
 384               OR (G_UNICODE_SURROGATE,
 385              0)));
 386 }
 387
 388 /**
 389  * g_unichar_iszerowidth:
 390  * @c: a Unicode character
 391  *
 392  * Determines if a given character typically takes zero width when rendered.
 393  * The return value is %TRUE for all non-spacing and enclosing marks
 394  * (e.g., combining accents), format characters, zero-width
 395  * space, but not U+00AD SOFT HYPHEN.
 396  *
 397  * A typical use of this function is with one of g_unichar_iswide() or
 398  * g_unichar_iswide_cjk() to determine the number of cells a string occupies
 399  * when displayed on a grid display (terminals).  However, note that not all
 400  * terminals support zero-width rendering of zero-width marks.
 401  *
 402  * Returns: %TRUE if the character has zero width
 403  *
 404  * Since: 2.14
 405  **/
 406 gboolean
 407 g_unichar_iszerowidth (gunichar c)
 408 {
 409   if (G_UNLIKELY (c == 0x00AD))
 410     return FALSE;
 411
 412   if (G_UNLIKELY (ISZEROWIDTHTYPE (TYPE (c))))
 413     return TRUE;
 414
 415   if (G_UNLIKELY ((c >= 0x1160 && c < 0x1200) ||
 416                   c == 0x200B))
 417     return TRUE;
 418
 419   return FALSE;
 420 }
 421
 422 static int
 423 interval_compare (const void *key, const void *elt)
 424 {
 425   gunichar c = GPOINTER_TO_UINT (key);
 426   struct Interval *interval = (struct Interval *)elt;
 427
 428   if (c < interval->start)
 429     return -1;
 430   if (c > interval->end)
 431     return +1;
 432
 433   return 0;
 434 }
 435
 436 /**
 437  * g_unichar_iswide:
 438  * @c: a Unicode character
 439  *
 440  * Determines if a character is typically rendered in a double-width
 441  * cell.
 442  *
 443  * Returns: %TRUE if the character is wide
 444  **/
 445 gboolean
 446 g_unichar_iswide (gunichar c)
 447 {
 448   if (bsearch (GUINT_TO_POINTER (c),
 449                g_unicode_width_table_wide,
 450                G_N_ELEMENTS (g_unicode_width_table_wide),
 451                sizeof g_unicode_width_table_wide[0],
 452                interval_compare))
 453     return TRUE;
 454
 455   return FALSE;
 456 }
 457
 458
 459 /**
 460  * g_unichar_iswide_cjk:
 461  * @c: a Unicode character
 462  *
 463  * Determines if a character is typically rendered in a double-width
 464  * cell under legacy East Asian locales.  If a character is wide according to
 465  * g_unichar_iswide(), then it is also reported wide with this function, but
 466  * the converse is not necessarily true. See the
 467  * [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
 468  * for details.
 469  *
 470  * If a character passes the g_unichar_iswide() test then it will also pass
 471  * this test, but not the other way around.  Note that some characters may
 472  * pass both this test and g_unichar_iszerowidth().
 473  *
 474  * Returns: %TRUE if the character is wide in legacy East Asian locales
 475  *
 476  * Since: 2.12
 477  */
 478 gboolean
 479 g_unichar_iswide_cjk (gunichar c)
 480 {
 481   if (g_unichar_iswide (c))
 482     return TRUE;
 483
 484   if (bsearch (GUINT_TO_POINTER (c),
 485                g_unicode_width_table_ambiguous,
 486                G_N_ELEMENTS (g_unicode_width_table_ambiguous),
 487                sizeof g_unicode_width_table_ambiguous[0],
 488                interval_compare))
 489     return TRUE;
 490
 491   return FALSE;
 492 }
 493
 494
 495 /**
 496  * g_unichar_toupper:
 497  * @c: a Unicode character
 498  *
 499  * Converts a character to uppercase.
 500  *
 501  * Returns: the result of converting @c to uppercase.
 502  *               If @c is not an lowercase or titlecase character,
 503  *               or has no upper case equivalent @c is returned unchanged.
 504  **/
 505 gunichar
 506 g_unichar_toupper (gunichar c)
 507 {
 508   int t = TYPE (c);
 509   if (t == G_UNICODE_LOWERCASE_LETTER)
 510     {
 511       gunichar val = ATTTABLE (c >> 8, c & 0xff);
 512       if (val >= 0x1000000)
 513         {
 514           const gchar *p = special_case_table + val - 0x1000000;
 515           val = g_utf8_get_char (p);
 516         }
 517       /* Some lowercase letters, e.g., U+000AA, FEMININE ORDINAL INDICATOR,
 518        * do not have an uppercase equivalent, in which case val will be
 519        * zero.
 520        */
 521       return val ? val : c;
 522     }
 523   else if (t == G_UNICODE_TITLECASE_LETTER)
 524     {
 525       unsigned int i;
 526       for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 527         {
 528           if (title_table[i][0] == c)
 529             return title_table[i][1] ? title_table[i][1] : c;
 530         }
 531     }
 532   return c;
 533 }
 534
 535 /**
 536  * g_unichar_tolower:
 537  * @c: a Unicode character.
 538  *
 539  * Converts a character to lower case.
 540  *
 541  * Returns: the result of converting @c to lower case.
 542  *               If @c is not an upperlower or titlecase character,
 543  *               or has no lowercase equivalent @c is returned unchanged.
 544  **/
 545 gunichar
 546 g_unichar_tolower (gunichar c)
 547 {
 548   int t = TYPE (c);
 549   if (t == G_UNICODE_UPPERCASE_LETTER)
 550     {
 551       gunichar val = ATTTABLE (c >> 8, c & 0xff);
 552       if (val >= 0x1000000)
 553         {
 554           const gchar *p = special_case_table + val - 0x1000000;
 555           return g_utf8_get_char (p);
 556         }
 557       else
 558         {
 559           /* Not all uppercase letters are guaranteed to have a lowercase
 560            * equivalent.  If this is the case, val will be zero. */
 561           return val ? val : c;
 562         }
 563     }
 564   else if (t == G_UNICODE_TITLECASE_LETTER)
 565     {
 566       unsigned int i;
 567       for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 568         {
 569           if (title_table[i][0] == c)
 570             return title_table[i][2];
 571         }
 572     }
 573   return c;
 574 }
 575
 576 /**
 577  * g_unichar_totitle:
 578  * @c: a Unicode character
 579  *
 580  * Converts a character to the titlecase.
 581  *
 582  * Returns: the result of converting @c to titlecase.
 583  *               If @c is not an uppercase or lowercase character,
 584  *               @c is returned unchanged.
 585  **/
 586 gunichar
 587 g_unichar_totitle (gunichar c)
 588 {
 589   unsigned int i;
 590   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 591     {
 592       if (title_table[i][0] == c || title_table[i][1] == c
 593           || title_table[i][2] == c)
 594         return title_table[i][0];
 595     }
 596
 597   if (TYPE (c) == G_UNICODE_LOWERCASE_LETTER)
 598     return g_unichar_toupper (c);
 599
 600   return c;
 601 }
 602
 603 /**
 604  * g_unichar_digit_value:
 605  * @c: a Unicode character
 606  *
 607  * Determines the numeric value of a character as a decimal
 608  * digit.
 609  *
 610  * Returns: If @c is a decimal digit (according to
 611  * g_unichar_isdigit()), its numeric value. Otherwise, -1.
 612  **/
 613 int
 614 g_unichar_digit_value (gunichar c)
 615 {
 616   if (TYPE (c) == G_UNICODE_DECIMAL_NUMBER)
 617     return ATTTABLE (c >> 8, c & 0xff);
 618   return -1;
 619 }
 620
 621 /**
 622  * g_unichar_xdigit_value:
 623  * @c: a Unicode character
 624  *
 625  * Determines the numeric value of a character as a hexidecimal
 626  * digit.
 627  *
 628  * Returns: If @c is a hex digit (according to
 629  * g_unichar_isxdigit()), its numeric value. Otherwise, -1.
 630  **/
 631 int
 632 g_unichar_xdigit_value (gunichar c)
 633 {
 634   if (c >= 'A' && c <= 'F')
 635     return c - 'A' + 10;
 636   if (c >= 'a' && c <= 'f')
 637     return c - 'a' + 10;
 638   if (TYPE (c) == G_UNICODE_DECIMAL_NUMBER)
 639     return ATTTABLE (c >> 8, c & 0xff);
 640   return -1;
 641 }
 642
 643 /**
 644  * g_unichar_type:
 645  * @c: a Unicode character
 646  *
 647  * Classifies a Unicode character by type.
 648  *
 649  * Returns: the type of the character.
 650  **/
 651 GUnicodeType
 652 g_unichar_type (gunichar c)
 653 {
 654   return TYPE (c);
 655 }
 656
 657 /*
 658  * Case mapping functions
 659  */
 660
 661 typedef enum {
 662   LOCALE_NORMAL,
 663   LOCALE_TURKIC,
 664   LOCALE_LITHUANIAN
 665 } LocaleType;
 666
 667 static LocaleType
 668 get_locale_type (void)
 669 {
 670 #ifdef G_OS_WIN32
 671   char *tem = g_win32_getlocale ();
 672   char locale[2];
 673
 674   locale[0] = tem[0];
 675   locale[1] = tem[1];
 676   g_free (tem);
 677 #else
 678   const char *locale = setlocale (LC_CTYPE, NULL);
 679
 680   if (locale == NULL)
 681     return LOCALE_NORMAL;
 682 #endif
 683
 684   switch (locale[0])
 685     {
 686    case 'a':
 687       if (locale[1] == 'z')
 688         return LOCALE_TURKIC;
 689       break;
 690     case 'l':
 691       if (locale[1] == 't')
 692         return LOCALE_LITHUANIAN;
 693       break;
 694     case 't':
 695       if (locale[1] == 'r')
 696         return LOCALE_TURKIC;
 697       break;
 698     }
 699
 700   return LOCALE_NORMAL;
 701 }
 702
 703 static gint
 704 output_marks (const char **p_inout,
 705               char        *out_buffer,
 706               gboolean     remove_dot)
 707 {
 708   const char *p = *p_inout;
 709   gint len = 0;
 710
 711   while (*p)
 712     {
 713       gunichar c = g_utf8_get_char (p);
 714
 715       if (ISMARK (TYPE (c)))
 716         {
 717           if (!remove_dot || c != 0x307 /* COMBINING DOT ABOVE */)
 718             len += g_unichar_to_utf8 (c, out_buffer ? out_buffer + len : NULL);
 719           p = g_utf8_next_char (p);
 720         }
 721       else
 722         break;
 723     }
 724
 725   *p_inout = p;
 726   return len;
 727 }
 728
 729 static gint
 730 output_special_case (gchar *out_buffer,
 731                      int    offset,
 732                      int    type,
 733                      int    which)
 734 {
 735   const gchar *p = special_case_table + offset;
 736   gint len;
 737
 738   if (type != G_UNICODE_TITLECASE_LETTER)
 739     p = g_utf8_next_char (p);
 740
 741   if (which == 1)
 742     p += strlen (p) + 1;
 743
 744   len = strlen (p);
 745   if (out_buffer)
 746     memcpy (out_buffer, p, len);
 747
 748   return len;
 749 }
 750
 751 static gsize
 752 real_toupper (const gchar *str,
 753               gssize       max_len,
 754               gchar       *out_buffer,
 755               LocaleType   locale_type)
 756 {
 757   const gchar *p = str;
 758   const char *last = NULL;
 759   gsize len = 0;
 760   gboolean last_was_i = FALSE;
 761
 762   while ((max_len < 0 || p < str + max_len) && *p)
 763     {
 764       gunichar c = g_utf8_get_char (p);
 765       int t = TYPE (c);
 766       gunichar val;
 767
 768       last = p;
 769       p = g_utf8_next_char (p);
 770
 771       if (locale_type == LOCALE_LITHUANIAN)
 772         {
 773           if (c == 'i')
 774             last_was_i = TRUE;
 775           else
 776             {
 777               if (last_was_i)
 778                 {
 779                   /* Nasty, need to remove any dot above. Though
 780                    * I think only E WITH DOT ABOVE occurs in practice
 781                    * which could simplify this considerably.
 782                    */
 783                   gsize decomp_len, i;
 784                   gunichar decomp[G_UNICHAR_MAX_DECOMPOSITION_LENGTH];
 785
 786                   decomp_len = g_unichar_fully_decompose (c, FALSE, decomp, G_N_ELEMENTS (decomp));
 787                   for (i=0; i < decomp_len; i++)
 788                     {
 789                       if (decomp[i] != 0x307 /* COMBINING DOT ABOVE */)
 790                         len += g_unichar_to_utf8 (g_unichar_toupper (decomp[i]), out_buffer ? out_buffer + len : NULL);
 791                     }
 792
 793                   len += output_marks (&p, out_buffer ? out_buffer + len : NULL, TRUE);
 794
 795                   continue;
 796                 }
 797
 798               if (!ISMARK (t))
 799                 last_was_i = FALSE;
 800             }
 801         }
 802
 803       if (locale_type == LOCALE_TURKIC && c == 'i')
 804         {
 805           /* i => LATIN CAPITAL LETTER I WITH DOT ABOVE */
 806           len += g_unichar_to_utf8 (0x130, out_buffer ? out_buffer + len : NULL);
 807         }
 808       else if (c == 0x0345)     /* COMBINING GREEK YPOGEGRAMMENI */
 809         {
 810           /* Nasty, need to move it after other combining marks .. this would go away if
 811            * we normalized first.
 812            */
 813           len += output_marks (&p, out_buffer ? out_buffer + len : NULL, FALSE);
 814
 815           /* And output as GREEK CAPITAL LETTER IOTA */
 816           len += g_unichar_to_utf8 (0x399, out_buffer ? out_buffer + len : NULL);
 817         }
 818       else if (IS (t,
 819                    OR (G_UNICODE_LOWERCASE_LETTER,
 820                    OR (G_UNICODE_TITLECASE_LETTER,
 821                   0))))
 822         {
 823           val = ATTTABLE (c >> 8, c & 0xff);
 824
 825           if (val >= 0x1000000)
 826             {
 827               len += output_special_case (out_buffer ? out_buffer + len : NULL, val - 0x1000000, t,
 828                                           t == G_UNICODE_LOWERCASE_LETTER ? 0 : 1);
 829             }
 830           else
 831             {
 832               if (t == G_UNICODE_TITLECASE_LETTER)
 833                 {
 834                   unsigned int i;
 835                   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 836                     {
 837                       if (title_table[i][0] == c)
 838                         {
 839                           val = title_table[i][1];
 840                           break;
 841                         }
 842                     }
 843                 }
 844
 845               /* Some lowercase letters, e.g., U+000AA, FEMININE ORDINAL INDICATOR,
 846                * do not have an uppercase equivalent, in which case val will be
 847                * zero. */
 848               len += g_unichar_to_utf8 (val ? val : c, out_buffer ? out_buffer + len : NULL);
 849             }
 850         }
 851       else
 852         {
 853           gsize char_len = g_utf8_skip[*(guchar *)last];
 854
 855           if (out_buffer)
 856             memcpy (out_buffer + len, last, char_len);
 857
 858           len += char_len;
 859         }
 860
 861     }
 862
 863   return len;
 864 }
 865
 866 /**
 867  * g_utf8_strup:
 868  * @str: a UTF-8 encoded string
 869  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
 870  *
 871  * Converts all Unicode characters in the string that have a case
 872  * to uppercase. The exact manner that this is done depends
 873  * on the current locale, and may result in the number of
 874  * characters in the string increasing. (For instance, the
 875  * German ess-zet will be changed to SS.)
 876  *
 877  * Returns: a newly allocated string, with all characters
 878  *    converted to uppercase.
 879  **/
 880 gchar *
 881 g_utf8_strup (const gchar *str,
 882               gssize       len)
 883 {
 884   gsize result_len;
 885   LocaleType locale_type;
 886   gchar *result;
 887
 888   g_return_val_if_fail (str != NULL, NULL);
 889
 890   locale_type = get_locale_type ();
 891
 892   /*
 893    * We use a two pass approach to keep memory management simple
 894    */
 895   result_len = real_toupper (str, len, NULL, locale_type);
 896   result = g_malloc (result_len + 1);
 897   real_toupper (str, len, result, locale_type);
 898   result[result_len] = '\0';
 899
 900   return result;
 901 }
 902
 903 /* traverses the string checking for characters with combining class == 230
 904  * until a base character is found */
 905 static gboolean
 906 has_more_above (const gchar *str)
 907 {
 908   const gchar *p = str;
 909   gint combining_class;
 910
 911   while (*p)
 912     {
 913       combining_class = g_unichar_combining_class (g_utf8_get_char (p));
 914       if (combining_class == 230)
 915         return TRUE;
 916       else if (combining_class == 0)
 917         break;
 918
 919       p = g_utf8_next_char (p);
 920     }
 921
 922   return FALSE;
 923 }
 924
 925 static gsize
 926 real_tolower (const gchar *str,
 927               gssize       max_len,
 928               gchar       *out_buffer,
 929               LocaleType   locale_type)
 930 {
 931   const gchar *p = str;
 932   const char *last = NULL;
 933   gsize len = 0;
 934
 935   while ((max_len < 0 || p < str + max_len) && *p)
 936     {
 937       gunichar c = g_utf8_get_char (p);
 938       int t = TYPE (c);
 939       gunichar val;
 940
 941       last = p;
 942       p = g_utf8_next_char (p);
 943
 944       if (locale_type == LOCALE_TURKIC && c == 'I')
 945         {
 946           if (g_utf8_get_char (p) == 0x0307)
 947             {
 948               /* I + COMBINING DOT ABOVE => i (U+0069) */
 949               len += g_unichar_to_utf8 (0x0069, out_buffer ? out_buffer + len : NULL);
 950               p = g_utf8_next_char (p);
 951             }
 952           else
 953             {
 954               /* I => LATIN SMALL LETTER DOTLESS I */
 955               len += g_unichar_to_utf8 (0x131, out_buffer ? out_buffer + len : NULL);
 956             }
 957         }
 958       /* Introduce an explicit dot above when lowercasing capital I's and J's
 959        * whenever there are more accents above. [SpecialCasing.txt] */
 960       else if (locale_type == LOCALE_LITHUANIAN &&
 961                (c == 0x00cc || c == 0x00cd || c == 0x0128))
 962         {
 963           len += g_unichar_to_utf8 (0x0069, out_buffer ? out_buffer + len : NULL);
 964           len += g_unichar_to_utf8 (0x0307, out_buffer ? out_buffer + len : NULL);
 965
 966           switch (c)
 967             {
 968             case 0x00cc:
 969               len += g_unichar_to_utf8 (0x0300, out_buffer ? out_buffer + len : NULL);
 970               break;
 971             case 0x00cd:
 972               len += g_unichar_to_utf8 (0x0301, out_buffer ? out_buffer + len : NULL);
 973               break;
 974             case 0x0128:
 975               len += g_unichar_to_utf8 (0x0303, out_buffer ? out_buffer + len : NULL);
 976               break;
 977             }
 978         }
 979       else if (locale_type == LOCALE_LITHUANIAN &&
 980                (c == 'I' || c == 'J' || c == 0x012e) &&
 981                has_more_above (p))
 982         {
 983           len += g_unichar_to_utf8 (g_unichar_tolower (c), out_buffer ? out_buffer + len : NULL);
 984           len += g_unichar_to_utf8 (0x0307, out_buffer ? out_buffer + len : NULL);
 985         }
 986       else if (c == 0x03A3)     /* GREEK CAPITAL LETTER SIGMA */
 987         {
 988           if ((max_len < 0 || p < str + max_len) && *p)
 989             {
 990               gunichar next_c = g_utf8_get_char (p);
 991               int next_type = TYPE(next_c);
 992
 993               /* SIGMA mapps differently depending on whether it is
 994                * final or not. The following simplified test would
 995                * fail in the case of combining marks following the
 996                * sigma, but I don't think that occurs in real text.
 997                * The test here matches that in ICU.
 998                */
 999               if (ISALPHA (next_type)) /* Lu,Ll,Lt,Lm,Lo */
1000                 val = 0x3c3;    /* GREEK SMALL SIGMA */
1001               else
1002                 val = 0x3c2;    /* GREEK SMALL FINAL SIGMA */
1003             }
1004           else
1005             val = 0x3c2;        /* GREEK SMALL FINAL SIGMA */
1006
1007           len += g_unichar_to_utf8 (val, out_buffer ? out_buffer + len : NULL);
1008         }
1009       else if (IS (t,
1010                    OR (G_UNICODE_UPPERCASE_LETTER,
1011                    OR (G_UNICODE_TITLECASE_LETTER,
1012                   0))))
1013         {
1014           val = ATTTABLE (c >> 8, c & 0xff);
1015
1016           if (val >= 0x1000000)
1017             {
1018               len += output_special_case (out_buffer ? out_buffer + len : NULL, val - 0x1000000, t, 0);
1019             }
1020           else
1021             {
1022               if (t == G_UNICODE_TITLECASE_LETTER)
1023                 {
1024                   unsigned int i;
1025                   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
1026                     {
1027                       if (title_table[i][0] == c)
1028                         {
1029                           val = title_table[i][2];
1030                           break;
1031                         }
1032                     }
1033                 }
1034
1035               /* Not all uppercase letters are guaranteed to have a lowercase
1036                * equivalent.  If this is the case, val will be zero. */
1037               len += g_unichar_to_utf8 (val ? val : c, out_buffer ? out_buffer + len : NULL);
1038             }
1039         }
1040       else
1041         {
1042           gsize char_len = g_utf8_skip[*(guchar *)last];
1043
1044           if (out_buffer)
1045             memcpy (out_buffer + len, last, char_len);
1046
1047           len += char_len;
1048         }
1049
1050     }
1051
1052   return len;
1053 }
1054
1055 /**
1056  * g_utf8_strdown:
1057  * @str: a UTF-8 encoded string
1058  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
1059  *
1060  * Converts all Unicode characters in the string that have a case
1061  * to lowercase. The exact manner that this is done depends
1062  * on the current locale, and may result in the number of
1063  * characters in the string changing.
1064  *
1065  * Returns: a newly allocated string, with all characters
1066  *    converted to lowercase.
1067  **/
1068 gchar *
1069 g_utf8_strdown (const gchar *str,
1070                 gssize       len)
1071 {
1072   gsize result_len;
1073   LocaleType locale_type;
1074   gchar *result;
1075
1076   g_return_val_if_fail (str != NULL, NULL);
1077
1078   locale_type = get_locale_type ();
1079
1080   /*
1081    * We use a two pass approach to keep memory management simple
1082    */
1083   result_len = real_tolower (str, len, NULL, locale_type);
1084   result = g_malloc (result_len + 1);
1085   real_tolower (str, len, result, locale_type);
1086   result[result_len] = '\0';
1087
1088   return result;
1089 }
1090
1091 /**
1092  * g_utf8_casefold:
1093  * @str: a UTF-8 encoded string
1094  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
1095  *
1096  * Converts a string into a form that is independent of case. The
1097  * result will not correspond to any particular case, but can be
1098  * compared for equality or ordered with the results of calling
1099  * g_utf8_casefold() on other strings.
1100  *
1101  * Note that calling g_utf8_casefold() followed by g_utf8_collate() is
1102  * only an approximation to the correct linguistic case insensitive
1103  * ordering, though it is a fairly good one. Getting this exactly
1104  * right would require a more sophisticated collation function that
1105  * takes case sensitivity into account. GLib does not currently
1106  * provide such a function.
1107  *
1108  * Returns: a newly allocated string, that is a
1109  *   case independent form of @str.
1110  **/
1111 gchar *
1112 g_utf8_casefold (const gchar *str,
1113                  gssize       len)
1114 {
1115   GString *result;
1116   const char *p;
1117
1118   g_return_val_if_fail (str != NULL, NULL);
1119
1120   result = g_string_new (NULL);
1121   p = str;
1122   while ((len < 0 || p < str + len) && *p)
1123     {
1124       gunichar ch = g_utf8_get_char (p);
1125
1126       int start = 0;
1127       int end = G_N_ELEMENTS (casefold_table);
1128
1129       if (ch >= casefold_table[start].ch &&
1130           ch <= casefold_table[end - 1].ch)
1131         {
1132           while (TRUE)
1133             {
1134               int half = (start + end) / 2;
1135               if (ch == casefold_table[half].ch)
1136                 {
1137                   g_string_append (result, casefold_table[half].data);
1138                   goto next;
1139                 }
1140               else if (half == start)
1141                 break;
1142               else if (ch > casefold_table[half].ch)
1143                 start = half;
1144               else
1145                 end = half;
1146             }
1147         }
1148
1149       g_string_append_unichar (result, g_unichar_tolower (ch));
1150
1151     next:
1152       p = g_utf8_next_char (p);
1153     }
1154
1155   return g_string_free (result, FALSE);
1156 }
1157
1158 /**
1159  * g_unichar_get_mirror_char:
1160  * @ch: a Unicode character
1161  * @mirrored_ch: location to store the mirrored character
1162  *
1163  * In Unicode, some characters are "mirrored". This means that their
1164  * images are mirrored horizontally in text that is laid out from right
1165  * to left. For instance, "(" would become its mirror image, ")", in
1166  * right-to-left text.
1167  *
1168  * If @ch has the Unicode mirrored property and there is another unicode
1169  * character that typically has a glyph that is the mirror image of @ch's
1170  * glyph and @mirrored_ch is set, it puts that character in the address
1171  * pointed to by @mirrored_ch.  Otherwise the original character is put.
1172  *
1173  * Returns: %TRUE if @ch has a mirrored character, %FALSE otherwise
1174  *
1175  * Since: 2.4
1176  **/
1177 gboolean
1178 g_unichar_get_mirror_char (gunichar ch,
1179                            gunichar *mirrored_ch)
1180 {
1181   gboolean found;
1182   gunichar mirrored;
1183
1184   mirrored = GLIB_GET_MIRRORING(ch);
1185
1186   found = ch != mirrored;
1187   if (mirrored_ch)
1188     *mirrored_ch = mirrored;
1189
1190   return found;
1191
1192 }
1193
1194 #define G_SCRIPT_TABLE_MIDPOINT (G_N_ELEMENTS (g_script_table) / 2)
1195
1196 static inline GUnicodeScript
1197 g_unichar_get_script_bsearch (gunichar ch)
1198 {
1199   int lower = 0;
1200   int upper = G_N_ELEMENTS (g_script_table) - 1;
1201   static int saved_mid = G_SCRIPT_TABLE_MIDPOINT;
1202   int mid = saved_mid;
1203
1204
1205   do
1206     {
1207       if (ch < g_script_table[mid].start)
1208         upper = mid - 1;
1209       else if (ch >= g_script_table[mid].start + g_script_table[mid].chars)
1210         lower = mid + 1;
1211       else
1212         return g_script_table[saved_mid = mid].script;
1213
1214       mid = (lower + upper) / 2;
1215     }
1216   while (lower <= upper);
1217
1218   return G_UNICODE_SCRIPT_UNKNOWN;
1219 }
1220
1221 /**
1222  * g_unichar_get_script:
1223  * @ch: a Unicode character
1224  *
1225  * Looks up the #GUnicodeScript for a particular character (as defined
1226  * by Unicode Standard Annex \#24). No check is made for @ch being a
1227  * valid Unicode character; if you pass in invalid character, the
1228  * result is undefined.
1229  *
1230  * This function is equivalent to pango_script_for_unichar() and the
1231  * two are interchangeable.
1232  *
1233  * Returns: the #GUnicodeScript for the character.
1234  *
1235  * Since: 2.14
1236  */
1237 GUnicodeScript
1238 g_unichar_get_script (gunichar ch)
1239 {
1240   if (ch < G_EASY_SCRIPTS_RANGE)
1241     return g_script_easy_table[ch];
1242   else
1243     return g_unichar_get_script_bsearch (ch);
1244 }
1245
1246
1247 /* http://unicode.org/iso15924/ */
1248 static const guint32 iso15924_tags[] =
1249 {
1250 #define PACK(a,b,c,d) ((guint32)((((guint8)(a))<<24)|(((guint8)(b))<<16)|(((guint8)(c))<<8)|((guint8)(d))))
1251
1252     PACK ('Z','y','y','y'), /* G_UNICODE_SCRIPT_COMMON */
1253     PACK ('Z','i','n','h'), /* G_UNICODE_SCRIPT_INHERITED */
1254     PACK ('A','r','a','b'), /* G_UNICODE_SCRIPT_ARABIC */
1255     PACK ('A','r','m','n'), /* G_UNICODE_SCRIPT_ARMENIAN */
1256     PACK ('B','e','n','g'), /* G_UNICODE_SCRIPT_BENGALI */
1257     PACK ('B','o','p','o'), /* G_UNICODE_SCRIPT_BOPOMOFO */
1258     PACK ('C','h','e','r'), /* G_UNICODE_SCRIPT_CHEROKEE */
1259     PACK ('C','o','p','t'), /* G_UNICODE_SCRIPT_COPTIC */
1260     PACK ('C','y','r','l'), /* G_UNICODE_SCRIPT_CYRILLIC */
1261     PACK ('D','s','r','t'), /* G_UNICODE_SCRIPT_DESERET */
1262     PACK ('D','e','v','a'), /* G_UNICODE_SCRIPT_DEVANAGARI */
1263     PACK ('E','t','h','i'), /* G_UNICODE_SCRIPT_ETHIOPIC */
1264     PACK ('G','e','o','r'), /* G_UNICODE_SCRIPT_GEORGIAN */
1265     PACK ('G','o','t','h'), /* G_UNICODE_SCRIPT_GOTHIC */
1266     PACK ('G','r','e','k'), /* G_UNICODE_SCRIPT_GREEK */
1267     PACK ('G','u','j','r'), /* G_UNICODE_SCRIPT_GUJARATI */
1268     PACK ('G','u','r','u'), /* G_UNICODE_SCRIPT_GURMUKHI */
1269     PACK ('H','a','n','i'), /* G_UNICODE_SCRIPT_HAN */
1270     PACK ('H','a','n','g'), /* G_UNICODE_SCRIPT_HANGUL */
1271     PACK ('H','e','b','r'), /* G_UNICODE_SCRIPT_HEBREW */
1272     PACK ('H','i','r','a'), /* G_UNICODE_SCRIPT_HIRAGANA */
1273     PACK ('K','n','d','a'), /* G_UNICODE_SCRIPT_KANNADA */
1274     PACK ('K','a','n','a'), /* G_UNICODE_SCRIPT_KATAKANA */
1275     PACK ('K','h','m','r'), /* G_UNICODE_SCRIPT_KHMER */
1276     PACK ('L','a','o','o'), /* G_UNICODE_SCRIPT_LAO */
1277     PACK ('L','a','t','n'), /* G_UNICODE_SCRIPT_LATIN */
1278     PACK ('M','l','y','m'), /* G_UNICODE_SCRIPT_MALAYALAM */
1279     PACK ('M','o','n','g'), /* G_UNICODE_SCRIPT_MONGOLIAN */
1280     PACK ('M','y','m','r'), /* G_UNICODE_SCRIPT_MYANMAR */
1281     PACK ('O','g','a','m'), /* G_UNICODE_SCRIPT_OGHAM */
1282     PACK ('I','t','a','l'), /* G_UNICODE_SCRIPT_OLD_ITALIC */
1283     PACK ('O','r','y','a'), /* G_UNICODE_SCRIPT_ORIYA */
1284     PACK ('R','u','n','r'), /* G_UNICODE_SCRIPT_RUNIC */
1285     PACK ('S','i','n','h'), /* G_UNICODE_SCRIPT_SINHALA */
1286     PACK ('S','y','r','c'), /* G_UNICODE_SCRIPT_SYRIAC */
1287     PACK ('T','a','m','l'), /* G_UNICODE_SCRIPT_TAMIL */
1288     PACK ('T','e','l','u'), /* G_UNICODE_SCRIPT_TELUGU */
1289     PACK ('T','h','a','a'), /* G_UNICODE_SCRIPT_THAANA */
1290     PACK ('T','h','a','i'), /* G_UNICODE_SCRIPT_THAI */
1291     PACK ('T','i','b','t'), /* G_UNICODE_SCRIPT_TIBETAN */
1292     PACK ('C','a','n','s'), /* G_UNICODE_SCRIPT_CANADIAN_ABORIGINAL */
1293     PACK ('Y','i','i','i'), /* G_UNICODE_SCRIPT_YI */
1294     PACK ('T','g','l','g'), /* G_UNICODE_SCRIPT_TAGALOG */
1295     PACK ('H','a','n','o'), /* G_UNICODE_SCRIPT_HANUNOO */
1296     PACK ('B','u','h','d'), /* G_UNICODE_SCRIPT_BUHID */
1297     PACK ('T','a','g','b'), /* G_UNICODE_SCRIPT_TAGBANWA */
1298
1299   /* Unicode-4.0 additions */
1300     PACK ('B','r','a','i'), /* G_UNICODE_SCRIPT_BRAILLE */
1301     PACK ('C','p','r','t'), /* G_UNICODE_SCRIPT_CYPRIOT */
1302     PACK ('L','i','m','b'), /* G_UNICODE_SCRIPT_LIMBU */
1303     PACK ('O','s','m','a'), /* G_UNICODE_SCRIPT_OSMANYA */
1304     PACK ('S','h','a','w'), /* G_UNICODE_SCRIPT_SHAVIAN */
1305     PACK ('L','i','n','b'), /* G_UNICODE_SCRIPT_LINEAR_B */
1306     PACK ('T','a','l','e'), /* G_UNICODE_SCRIPT_TAI_LE */
1307     PACK ('U','g','a','r'), /* G_UNICODE_SCRIPT_UGARITIC */
1308
1309   /* Unicode-4.1 additions */
1310     PACK ('T','a','l','u'), /* G_UNICODE_SCRIPT_NEW_TAI_LUE */
1311     PACK ('B','u','g','i'), /* G_UNICODE_SCRIPT_BUGINESE */
1312     PACK ('G','l','a','g'), /* G_UNICODE_SCRIPT_GLAGOLITIC */
1313     PACK ('T','f','n','g'), /* G_UNICODE_SCRIPT_TIFINAGH */
1314     PACK ('S','y','l','o'), /* G_UNICODE_SCRIPT_SYLOTI_NAGRI */
1315     PACK ('X','p','e','o'), /* G_UNICODE_SCRIPT_OLD_PERSIAN */
1316     PACK ('K','h','a','r'), /* G_UNICODE_SCRIPT_KHAROSHTHI */
1317
1318   /* Unicode-5.0 additions */
1319     PACK ('Z','z','z','z'), /* G_UNICODE_SCRIPT_UNKNOWN */
1320     PACK ('B','a','l','i'), /* G_UNICODE_SCRIPT_BALINESE */
1321     PACK ('X','s','u','x'), /* G_UNICODE_SCRIPT_CUNEIFORM */
1322     PACK ('P','h','n','x'), /* G_UNICODE_SCRIPT_PHOENICIAN */
1323     PACK ('P','h','a','g'), /* G_UNICODE_SCRIPT_PHAGS_PA */
1324     PACK ('N','k','o','o'), /* G_UNICODE_SCRIPT_NKO */
1325
1326   /* Unicode-5.1 additions */
1327     PACK ('K','a','l','i'), /* G_UNICODE_SCRIPT_KAYAH_LI */
1328     PACK ('L','e','p','c'), /* G_UNICODE_SCRIPT_LEPCHA */
1329     PACK ('R','j','n','g'), /* G_UNICODE_SCRIPT_REJANG */
1330     PACK ('S','u','n','d'), /* G_UNICODE_SCRIPT_SUNDANESE */
1331     PACK ('S','a','u','r'), /* G_UNICODE_SCRIPT_SAURASHTRA */
1332     PACK ('C','h','a','m'), /* G_UNICODE_SCRIPT_CHAM */
1333     PACK ('O','l','c','k'), /* G_UNICODE_SCRIPT_OL_CHIKI */
1334     PACK ('V','a','i','i'), /* G_UNICODE_SCRIPT_VAI */
1335     PACK ('C','a','r','i'), /* G_UNICODE_SCRIPT_CARIAN */
1336     PACK ('L','y','c','i'), /* G_UNICODE_SCRIPT_LYCIAN */
1337     PACK ('L','y','d','i'), /* G_UNICODE_SCRIPT_LYDIAN */
1338
1339   /* Unicode-5.2 additions */
1340     PACK ('A','v','s','t'), /* G_UNICODE_SCRIPT_AVESTAN */
1341     PACK ('B','a','m','u'), /* G_UNICODE_SCRIPT_BAMUM */
1342     PACK ('E','g','y','p'), /* G_UNICODE_SCRIPT_EGYPTIAN_HIEROGLYPHS */
1343     PACK ('A','r','m','i'), /* G_UNICODE_SCRIPT_IMPERIAL_ARAMAIC */
1344     PACK ('P','h','l','i'), /* G_UNICODE_SCRIPT_INSCRIPTIONAL_PAHLAVI */
1345     PACK ('P','r','t','i'), /* G_UNICODE_SCRIPT_INSCRIPTIONAL_PARTHIAN */
1346     PACK ('J','a','v','a'), /* G_UNICODE_SCRIPT_JAVANESE */
1347     PACK ('K','t','h','i'), /* G_UNICODE_SCRIPT_KAITHI */
1348     PACK ('L','i','s','u'), /* G_UNICODE_SCRIPT_LISU */
1349     PACK ('M','t','e','i'), /* G_UNICODE_SCRIPT_MEETEI_MAYEK */
1350     PACK ('S','a','r','b'), /* G_UNICODE_SCRIPT_OLD_SOUTH_ARABIAN */
1351     PACK ('O','r','k','h'), /* G_UNICODE_SCRIPT_OLD_TURKIC */
1352     PACK ('S','a','m','r'), /* G_UNICODE_SCRIPT_SAMARITAN */
1353     PACK ('L','a','n','a'), /* G_UNICODE_SCRIPT_TAI_THAM */
1354     PACK ('T','a','v','t'), /* G_UNICODE_SCRIPT_TAI_VIET */
1355
1356   /* Unicode-6.0 additions */
1357     PACK ('B','a','t','k'), /* G_UNICODE_SCRIPT_BATAK */
1358     PACK ('B','r','a','h'), /* G_UNICODE_SCRIPT_BRAHMI */
1359     PACK ('M','a','n','d'), /* G_UNICODE_SCRIPT_MANDAIC */
1360
1361   /* Unicode-6.1 additions */
1362     PACK ('C','a','k','m'), /* G_UNICODE_SCRIPT_CHAKMA */
1363     PACK ('M','e','r','c'), /* G_UNICODE_SCRIPT_MEROITIC_CURSIVE */
1364     PACK ('M','e','r','o'), /* G_UNICODE_SCRIPT_MEROITIC_HIEROGLYPHS */
1365     PACK ('P','l','r','d'), /* G_UNICODE_SCRIPT_MIAO */
1366     PACK ('S','h','r','d'), /* G_UNICODE_SCRIPT_SHARADA */
1367     PACK ('S','o','r','a'), /* G_UNICODE_SCRIPT_SORA_SOMPENG */
1368     PACK ('T','a','k','r'), /* G_UNICODE_SCRIPT_TAKRI */
1369
1370   /* Unicode 7.0 additions */
1371     PACK ('B','a','s','s'), /* G_UNICODE_SCRIPT_BASSA_VAH */
1372     PACK ('A','g','h','b'), /* G_UNICODE_SCRIPT_CAUCASIAN_ALBANIAN */
1373     PACK ('D','u','p','l'), /* G_UNICODE_SCRIPT_DUPLOYAN */
1374     PACK ('E','l','b','a'), /* G_UNICODE_SCRIPT_ELBASAN */
1375     PACK ('G','r','a','n'), /* G_UNICODE_SCRIPT_GRANTHA */
1376     PACK ('K','h','o','j'), /* G_UNICODE_SCRIPT_KHOJKI*/
1377     PACK ('S','i','n','d'), /* G_UNICODE_SCRIPT_KHUDAWADI */
1378     PACK ('L','i','n','a'), /* G_UNICODE_SCRIPT_LINEAR_A */
1379     PACK ('M','a','h','j'), /* G_UNICODE_SCRIPT_MAHAJANI */
1380     PACK ('M','a','n','u'), /* G_UNICODE_SCRIPT_MANICHAEAN */
1381     PACK ('M','e','n','d'), /* G_UNICODE_SCRIPT_MENDE_KIKAKUI */
1382     PACK ('M','o','d','i'), /* G_UNICODE_SCRIPT_MODI */
1383     PACK ('M','r','o','o'), /* G_UNICODE_SCRIPT_MRO */
1384     PACK ('N','b','a','t'), /* G_UNICODE_SCRIPT_NABATAEAN */
1385     PACK ('N','a','r','b'), /* G_UNICODE_SCRIPT_OLD_NORTH_ARABIAN */
1386     PACK ('P','e','r','m'), /* G_UNICODE_SCRIPT_OLD_PERMIC */
1387     PACK ('H','m','n','g'), /* G_UNICODE_SCRIPT_PAHAWH_HMONG */
1388     PACK ('P','a','l','m'), /* G_UNICODE_SCRIPT_PALMYRENE */
1389     PACK ('P','a','u','c'), /* G_UNICODE_SCRIPT_PAU_CIN_HAU */
1390     PACK ('P','h','l','p'), /* G_UNICODE_SCRIPT_PSALTER_PAHLAVI */
1391     PACK ('S','i','d','d'), /* G_UNICODE_SCRIPT_SIDDHAM */
1392     PACK ('T','i','r','h'), /* G_UNICODE_SCRIPT_TIRHUTA */
1393     PACK ('W','a','r','a'), /* G_UNICODE_SCRIPT_WARANG_CITI */
1394
1395 #undef PACK
1396 };
1397
1398 /**
1399  * g_unicode_script_to_iso15924:
1400  * @script: a Unicode script
1401  *
1402  * Looks up the ISO 15924 code for @script.  ISO 15924 assigns four-letter
1403  * codes to scripts.  For example, the code for Arabic is 'Arab'.  The
1404  * four letter codes are encoded as a @guint32 by this function in a
1405  * big-endian fashion.  That is, the code returned for Arabic is
1406  * 0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc).
1407  *
1408  * See
1409  * [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html)
1410  * for details.
1411  *
1412  * Returns: the ISO 15924 code for @script, encoded as an integer,
1413  *   of zero if @script is %G_UNICODE_SCRIPT_INVALID_CODE or
1414  *   ISO 15924 code 'Zzzz' (script code for UNKNOWN) if @script is not understood.
1415  *
1416  * Since: 2.30
1417  */
1418 guint32
1419 g_unicode_script_to_iso15924 (GUnicodeScript script)
1420 {
1421   if (G_UNLIKELY (script == G_UNICODE_SCRIPT_INVALID_CODE))
1422     return 0;
1423
1424   if (G_UNLIKELY (script < 0 || script >= (int) G_N_ELEMENTS (iso15924_tags)))
1425     return 0x5A7A7A7A;
1426
1427   return iso15924_tags[script];
1428 }
1429
1430 /**
1431  * g_unicode_script_from_iso15924:
1432  * @iso15924: a Unicode script
1433  *
1434  * Looks up the Unicode script for @iso15924.  ISO 15924 assigns four-letter
1435  * codes to scripts.  For example, the code for Arabic is 'Arab'.
1436  * This function accepts four letter codes encoded as a @guint32 in a
1437  * big-endian fashion.  That is, the code expected for Arabic is
1438  * 0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc).
1439  *
1440  * See
1441  * [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html)
1442  * for details.
1443  *
1444  * Returns: the Unicode script for @iso15924, or
1445  *   of %G_UNICODE_SCRIPT_INVALID_CODE if @iso15924 is zero and
1446  *   %G_UNICODE_SCRIPT_UNKNOWN if @iso15924 is unknown.
1447  *
1448  * Since: 2.30
1449  */
1450 GUnicodeScript
1451 g_unicode_script_from_iso15924 (guint32 iso15924)
1452 {
1453   unsigned int i;
1454
1455    if (!iso15924)
1456      return G_UNICODE_SCRIPT_INVALID_CODE;
1457
1458   for (i = 0; i < G_N_ELEMENTS (iso15924_tags); i++)
1459     if (iso15924_tags[i] == iso15924)
1460       return (GUnicodeScript) i;
1461
1462   return G_UNICODE_SCRIPT_UNKNOWN;
1463 }