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