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 <stddef.h>
  25 #include <string.h>
  26 #include <locale.h>
  27
  28 #include "glib.h"
  29 #include "gunichartables.h"
  30 #include "gmirroringtable.h"
  31 #include "gunicodeprivate.h"
  32 #include "galias.h"
  33
  34 #define ATTR_TABLE(Page) (((Page) <= G_UNICODE_LAST_PAGE_PART1) \
  35                           ? attr_table_part1[Page] \
  36                           : attr_table_part2[(Page) - 0xe00])
  37
  38 #define ATTTABLE(Page, Char) \
  39   ((ATTR_TABLE(Page) == G_UNICODE_MAX_TABLE_INDEX) ? 0 : (attr_data[ATTR_TABLE(Page)][Char]))
  40
  41 #define TTYPE_PART1(Page, Char) \
  42   ((type_table_part1[Page] >= G_UNICODE_MAX_TABLE_INDEX) \
  43    ? (type_table_part1[Page] - G_UNICODE_MAX_TABLE_INDEX) \
  44    : (type_data[type_table_part1[Page]][Char]))
  45
  46 #define TTYPE_PART2(Page, Char) \
  47   ((type_table_part2[Page] >= G_UNICODE_MAX_TABLE_INDEX) \
  48    ? (type_table_part2[Page] - G_UNICODE_MAX_TABLE_INDEX) \
  49    : (type_data[type_table_part2[Page]][Char]))
  50
  51 #define TYPE(Char) \
  52   (((Char) <= G_UNICODE_LAST_CHAR_PART1) \
  53    ? TTYPE_PART1 ((Char) >> 8, (Char) & 0xff) \
  54    : (((Char) >= 0xe0000 && (Char) <= G_UNICODE_LAST_CHAR) \
  55       ? TTYPE_PART2 (((Char) - 0xe0000) >> 8, (Char) & 0xff) \
  56       : G_UNICODE_UNASSIGNED))
  57
  58
  59 #define IS(Type, Class) (((guint)1 << (Type)) & (Class))
  60 #define OR(Type, Rest)  (((guint)1 << (Type)) | (Rest))
  61
  62
  63
  64 #define ISDIGIT(Type)   IS ((Type),                             \
  65                             OR (G_UNICODE_DECIMAL_NUMBER,       \
  66                             OR (G_UNICODE_LETTER_NUMBER,        \
  67                             OR (G_UNICODE_OTHER_NUMBER,         0))))
  68
  69 #define ISALPHA(Type)   IS ((Type),                             \
  70                             OR (G_UNICODE_LOWERCASE_LETTER,     \
  71                             OR (G_UNICODE_UPPERCASE_LETTER,     \
  72                             OR (G_UNICODE_TITLECASE_LETTER,     \
  73                             OR (G_UNICODE_MODIFIER_LETTER,      \
  74                             OR (G_UNICODE_OTHER_LETTER,         0))))))
  75
  76 #define ISALDIGIT(Type) IS ((Type),                             \
  77                             OR (G_UNICODE_DECIMAL_NUMBER,       \
  78                             OR (G_UNICODE_LETTER_NUMBER,        \
  79                             OR (G_UNICODE_OTHER_NUMBER,         \
  80                             OR (G_UNICODE_LOWERCASE_LETTER,     \
  81                             OR (G_UNICODE_UPPERCASE_LETTER,     \
  82                             OR (G_UNICODE_TITLECASE_LETTER,     \
  83                             OR (G_UNICODE_MODIFIER_LETTER,      \
  84                             OR (G_UNICODE_OTHER_LETTER,         0)))))))))
  85
  86 #define ISMARK(Type)    IS ((Type),                             \
  87                             OR (G_UNICODE_NON_SPACING_MARK,     \
  88                             OR (G_UNICODE_COMBINING_MARK,       \
  89                             OR (G_UNICODE_ENCLOSING_MARK,       0))))
  90
  91 /**
  92  * g_unichar_isalnum:
  93  * @c: a Unicode character
  94  *
  95  * Determines whether a character is alphanumeric.
  96  * Given some UTF-8 text, obtain a character value
  97  * with g_utf8_get_char().
  98  *
  99  * Return value: %TRUE if @c is an alphanumeric character
 100  **/
 101 gboolean
 102 g_unichar_isalnum (gunichar c)
 103 {
 104   return ISALDIGIT (TYPE (c)) ? TRUE : FALSE;
 105 }
 106
 107 /**
 108  * g_unichar_isalpha:
 109  * @c: a Unicode character
 110  *
 111  * Determines whether a character is alphabetic (i.e. a letter).
 112  * Given some UTF-8 text, obtain a character value with
 113  * g_utf8_get_char().
 114  *
 115  * Return value: %TRUE if @c is an alphabetic character
 116  **/
 117 gboolean
 118 g_unichar_isalpha (gunichar c)
 119 {
 120   return ISALPHA (TYPE (c)) ? TRUE : FALSE;
 121 }
 122
 123
 124 /**
 125  * g_unichar_iscntrl:
 126  * @c: a Unicode character
 127  *
 128  * Determines whether a character is a control character.
 129  * Given some UTF-8 text, obtain a character value with
 130  * g_utf8_get_char().
 131  *
 132  * Return value: %TRUE if @c is a control character
 133  **/
 134 gboolean
 135 g_unichar_iscntrl (gunichar c)
 136 {
 137   return TYPE (c) == G_UNICODE_CONTROL;
 138 }
 139
 140 /**
 141  * g_unichar_isdigit:
 142  * @c: a Unicode character
 143  *
 144  * Determines whether a character is numeric (i.e. a digit).  This
 145  * covers ASCII 0-9 and also digits in other languages/scripts.  Given
 146  * some UTF-8 text, obtain a character value with g_utf8_get_char().
 147  *
 148  * Return value: %TRUE if @c is a digit
 149  **/
 150 gboolean
 151 g_unichar_isdigit (gunichar c)
 152 {
 153   return TYPE (c) == G_UNICODE_DECIMAL_NUMBER;
 154 }
 155
 156
 157 /**
 158  * g_unichar_isgraph:
 159  * @c: a Unicode character
 160  *
 161  * Determines whether a character is printable and not a space
 162  * (returns %FALSE for control characters, format characters, and
 163  * spaces). g_unichar_isprint() is similar, but returns %TRUE for
 164  * spaces. Given some UTF-8 text, obtain a character value with
 165  * g_utf8_get_char().
 166  *
 167  * Return value: %TRUE if @c is printable unless it's a space
 168  **/
 169 gboolean
 170 g_unichar_isgraph (gunichar c)
 171 {
 172   return !IS (TYPE(c),
 173               OR (G_UNICODE_CONTROL,
 174               OR (G_UNICODE_FORMAT,
 175               OR (G_UNICODE_UNASSIGNED,
 176               OR (G_UNICODE_PRIVATE_USE,
 177               OR (G_UNICODE_SURROGATE,
 178               OR (G_UNICODE_SPACE_SEPARATOR,
 179              0)))))));
 180 }
 181
 182 /**
 183  * g_unichar_islower:
 184  * @c: a Unicode character
 185  *
 186  * Determines whether a character is a lowercase letter.
 187  * Given some UTF-8 text, obtain a character value with
 188  * g_utf8_get_char().
 189  *
 190  * Return value: %TRUE if @c is a lowercase letter
 191  **/
 192 gboolean
 193 g_unichar_islower (gunichar c)
 194 {
 195   return TYPE (c) == G_UNICODE_LOWERCASE_LETTER;
 196 }
 197
 198
 199 /**
 200  * g_unichar_isprint:
 201  * @c: a Unicode character
 202  *
 203  * Determines whether a character is printable.
 204  * Unlike g_unichar_isgraph(), returns %TRUE for spaces.
 205  * Given some UTF-8 text, obtain a character value with
 206  * g_utf8_get_char().
 207  *
 208  * Return value: %TRUE if @c is printable
 209  **/
 210 gboolean
 211 g_unichar_isprint (gunichar c)
 212 {
 213   return !IS (TYPE(c),
 214               OR (G_UNICODE_CONTROL,
 215               OR (G_UNICODE_FORMAT,
 216               OR (G_UNICODE_UNASSIGNED,
 217               OR (G_UNICODE_PRIVATE_USE,
 218               OR (G_UNICODE_SURROGATE,
 219              0))))));
 220 }
 221
 222 /**
 223  * g_unichar_ispunct:
 224  * @c: a Unicode character
 225  *
 226  * Determines whether a character is punctuation or a symbol.
 227  * Given some UTF-8 text, obtain a character value with
 228  * g_utf8_get_char().
 229  *
 230  * Return value: %TRUE if @c is a punctuation or symbol character
 231  **/
 232 gboolean
 233 g_unichar_ispunct (gunichar c)
 234 {
 235   return IS (TYPE(c),
 236              OR (G_UNICODE_CONNECT_PUNCTUATION,
 237              OR (G_UNICODE_DASH_PUNCTUATION,
 238              OR (G_UNICODE_CLOSE_PUNCTUATION,
 239              OR (G_UNICODE_FINAL_PUNCTUATION,
 240              OR (G_UNICODE_INITIAL_PUNCTUATION,
 241              OR (G_UNICODE_OTHER_PUNCTUATION,
 242              OR (G_UNICODE_OPEN_PUNCTUATION,
 243              OR (G_UNICODE_CURRENCY_SYMBOL,
 244              OR (G_UNICODE_MODIFIER_SYMBOL,
 245              OR (G_UNICODE_MATH_SYMBOL,
 246              OR (G_UNICODE_OTHER_SYMBOL,
 247             0)))))))))))) ? TRUE : FALSE;
 248 }
 249
 250 /**
 251  * g_unichar_isspace:
 252  * @c: a Unicode character
 253  *
 254  * Determines whether a character is a space, tab, or line separator
 255  * (newline, carriage return, etc.).  Given some UTF-8 text, obtain a
 256  * character value with g_utf8_get_char().
 257  *
 258  * (Note: don't use this to do word breaking; you have to use
 259  * Pango or equivalent to get word breaking right, the algorithm
 260  * is fairly complex.)
 261  *
 262  * Return value: %TRUE if @c is a space character
 263  **/
 264 gboolean
 265 g_unichar_isspace (gunichar c)
 266 {
 267   switch (c)
 268     {
 269       /* special-case these since Unicode thinks they are not spaces */
 270     case '\t':
 271     case '\n':
 272     case '\r':
 273     case '\f':
 274       return TRUE;
 275       break;
 276
 277     default:
 278       {
 279         return IS (TYPE(c),
 280                    OR (G_UNICODE_SPACE_SEPARATOR,
 281                    OR (G_UNICODE_LINE_SEPARATOR,
 282                    OR (G_UNICODE_PARAGRAPH_SEPARATOR,
 283                   0)))) ? TRUE : FALSE;
 284       }
 285       break;
 286     }
 287 }
 288
 289 /**
 290  * g_unichar_isupper:
 291  * @c: a Unicode character
 292  *
 293  * Determines if a character is uppercase.
 294  *
 295  * Return value: %TRUE if @c is an uppercase character
 296  **/
 297 gboolean
 298 g_unichar_isupper (gunichar c)
 299 {
 300   return TYPE (c) == G_UNICODE_UPPERCASE_LETTER;
 301 }
 302
 303 /**
 304  * g_unichar_istitle:
 305  * @c: a Unicode character
 306  *
 307  * Determines if a character is titlecase. Some characters in
 308  * Unicode which are composites, such as the DZ digraph
 309  * have three case variants instead of just two. The titlecase
 310  * form is used at the beginning of a word where only the
 311  * first letter is capitalized. The titlecase form of the DZ
 312  * digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z.
 313  *
 314  * Return value: %TRUE if the character is titlecase
 315  **/
 316 gboolean
 317 g_unichar_istitle (gunichar c)
 318 {
 319   unsigned int i;
 320   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 321     if (title_table[i][0] == c)
 322       return 1;
 323   return 0;
 324 }
 325
 326 /**
 327  * g_unichar_isxdigit:
 328  * @c: a Unicode character.
 329  *
 330  * Determines if a character is a hexidecimal digit.
 331  *
 332  * Return value: %TRUE if the character is a hexadecimal digit
 333  **/
 334 gboolean
 335 g_unichar_isxdigit (gunichar c)
 336 {
 337   return ((c >= 'a' && c <= 'f')
 338           || (c >= 'A' && c <= 'F')
 339           || ISDIGIT (TYPE (c)));
 340 }
 341
 342 /**
 343  * g_unichar_isdefined:
 344  * @c: a Unicode character
 345  *
 346  * Determines if a given character is assigned in the Unicode
 347  * standard.
 348  *
 349  * Return value: %TRUE if the character has an assigned value
 350  **/
 351 gboolean
 352 g_unichar_isdefined (gunichar c)
 353 {
 354   return TYPE (c) != G_UNICODE_UNASSIGNED;
 355 }
 356
 357 /**
 358  * g_unichar_iswide:
 359  * @c: a Unicode character
 360  *
 361  * Determines if a character is typically rendered in a double-width
 362  * cell.
 363  *
 364  * Return value: %TRUE if the character is wide
 365  **/
 366 /* This function stolen from Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk>.  */
 367 gboolean
 368 g_unichar_iswide (gunichar c)
 369 {
 370   if (c < 0x1100)
 371     return FALSE;
 372
 373   return (c <= 0x115f  /* Hangul Jamo init. consonants */
 374           || c == 0x2329 || c == 0x232a     /* angle brackets */
 375           || (c >= 0x2e80 && c <= 0xa4cf && (c < 0x302a || c > 0x302f)
 376               && c != 0x303f && c != 0x3099 && c!= 0x309a) /* CJK ... Yi */
 377           || (c >= 0xac00 && c <= 0xd7a3)   /* Hangul Syllables */
 378           || (c >= 0xf900 && c <= 0xfaff)   /* CJK Compatibility Ideographs */
 379           || (c >= 0xfe30 && c <= 0xfe6f)   /* CJK Compatibility Forms */
 380           || (c >= 0xff00 && c <= 0xff60)   /* Fullwidth Forms */
 381           || (c >= 0xffe0 && c <= 0xffe6)   /* Fullwidth Forms */
 382           || (c >= 0x20000 && c <= 0x2fffd) /* CJK extra stuff */
 383           || (c >= 0x30000 && c <= 0x3fffd));
 384 }
 385
 386
 387 struct Interval
 388 {
 389   gunichar start, end;
 390 };
 391
 392 int
 393 interval_compare (const void *key, const void *elt)
 394 {
 395   gunichar c = GPOINTER_TO_UINT (key);
 396   struct Interval *interval = elt;
 397
 398   if (c < interval->start)
 399     return -1;
 400   if (c > interval->end)
 401     return +1;
 402
 403   return 0;
 404 }
 405
 406 /**
 407  * g_unichar_iswide_cjk:
 408  * @c: a Unicode character
 409  *
 410  * Determines if a character is typically rendered in a double-width
 411  * cell under legacy East Asian locales.  If a character is wide according to
 412  * g_unichar_iswide(), then it is also reported wide with this function, but
 413  * the converse is not necessarily true.  See the
 414  * <ulink url="http://www.unicode.org/reports/tr11/">Unicode Standard
 415  * Annex #11</ulink> for details.
 416  *
 417  * Return value: %TRUE if the character is wide in legacy East Asian locales
 418  *
 419  * Since: 2.12
 420  */
 421 /* This function stolen from Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk>.  */
 422 gboolean
 423 g_unichar_iswide_cjk (gunichar c)
 424 {
 425   /* sorted list of non-overlapping intervals of East Asian Ambiguous
 426    * characters, generated by "uniset +WIDTH-A -cat=Me -cat=Mn -cat=Cf c" */
 427   static const struct Interval ambiguous[] = {
 428     { 0x00A1, 0x00A1 }, { 0x00A4, 0x00A4 }, { 0x00A7, 0x00A8 },
 429     { 0x00AA, 0x00AA }, { 0x00AE, 0x00AE }, { 0x00B0, 0x00B4 },
 430     { 0x00B6, 0x00BA }, { 0x00BC, 0x00BF }, { 0x00C6, 0x00C6 },
 431     { 0x00D0, 0x00D0 }, { 0x00D7, 0x00D8 }, { 0x00DE, 0x00E1 },
 432     { 0x00E6, 0x00E6 }, { 0x00E8, 0x00EA }, { 0x00EC, 0x00ED },
 433     { 0x00F0, 0x00F0 }, { 0x00F2, 0x00F3 }, { 0x00F7, 0x00FA },
 434     { 0x00FC, 0x00FC }, { 0x00FE, 0x00FE }, { 0x0101, 0x0101 },
 435     { 0x0111, 0x0111 }, { 0x0113, 0x0113 }, { 0x011B, 0x011B },
 436     { 0x0126, 0x0127 }, { 0x012B, 0x012B }, { 0x0131, 0x0133 },
 437     { 0x0138, 0x0138 }, { 0x013F, 0x0142 }, { 0x0144, 0x0144 },
 438     { 0x0148, 0x014B }, { 0x014D, 0x014D }, { 0x0152, 0x0153 },
 439     { 0x0166, 0x0167 }, { 0x016B, 0x016B }, { 0x01CE, 0x01CE },
 440     { 0x01D0, 0x01D0 }, { 0x01D2, 0x01D2 }, { 0x01D4, 0x01D4 },
 441     { 0x01D6, 0x01D6 }, { 0x01D8, 0x01D8 }, { 0x01DA, 0x01DA },
 442     { 0x01DC, 0x01DC }, { 0x0251, 0x0251 }, { 0x0261, 0x0261 },
 443     { 0x02C4, 0x02C4 }, { 0x02C7, 0x02C7 }, { 0x02C9, 0x02CB },
 444     { 0x02CD, 0x02CD }, { 0x02D0, 0x02D0 }, { 0x02D8, 0x02DB },
 445     { 0x02DD, 0x02DD }, { 0x02DF, 0x02DF }, { 0x0391, 0x03A1 },
 446     { 0x03A3, 0x03A9 }, { 0x03B1, 0x03C1 }, { 0x03C3, 0x03C9 },
 447     { 0x0401, 0x0401 }, { 0x0410, 0x044F }, { 0x0451, 0x0451 },
 448     { 0x2010, 0x2010 }, { 0x2013, 0x2016 }, { 0x2018, 0x2019 },
 449     { 0x201C, 0x201D }, { 0x2020, 0x2022 }, { 0x2024, 0x2027 },
 450     { 0x2030, 0x2030 }, { 0x2032, 0x2033 }, { 0x2035, 0x2035 },
 451     { 0x203B, 0x203B }, { 0x203E, 0x203E }, { 0x2074, 0x2074 },
 452     { 0x207F, 0x207F }, { 0x2081, 0x2084 }, { 0x20AC, 0x20AC },
 453     { 0x2103, 0x2103 }, { 0x2105, 0x2105 }, { 0x2109, 0x2109 },
 454     { 0x2113, 0x2113 }, { 0x2116, 0x2116 }, { 0x2121, 0x2122 },
 455     { 0x2126, 0x2126 }, { 0x212B, 0x212B }, { 0x2153, 0x2154 },
 456     { 0x215B, 0x215E }, { 0x2160, 0x216B }, { 0x2170, 0x2179 },
 457     { 0x2190, 0x2199 }, { 0x21B8, 0x21B9 }, { 0x21D2, 0x21D2 },
 458     { 0x21D4, 0x21D4 }, { 0x21E7, 0x21E7 }, { 0x2200, 0x2200 },
 459     { 0x2202, 0x2203 }, { 0x2207, 0x2208 }, { 0x220B, 0x220B },
 460     { 0x220F, 0x220F }, { 0x2211, 0x2211 }, { 0x2215, 0x2215 },
 461     { 0x221A, 0x221A }, { 0x221D, 0x2220 }, { 0x2223, 0x2223 },
 462     { 0x2225, 0x2225 }, { 0x2227, 0x222C }, { 0x222E, 0x222E },
 463     { 0x2234, 0x2237 }, { 0x223C, 0x223D }, { 0x2248, 0x2248 },
 464     { 0x224C, 0x224C }, { 0x2252, 0x2252 }, { 0x2260, 0x2261 },
 465     { 0x2264, 0x2267 }, { 0x226A, 0x226B }, { 0x226E, 0x226F },
 466     { 0x2282, 0x2283 }, { 0x2286, 0x2287 }, { 0x2295, 0x2295 },
 467     { 0x2299, 0x2299 }, { 0x22A5, 0x22A5 }, { 0x22BF, 0x22BF },
 468     { 0x2312, 0x2312 }, { 0x2460, 0x24E9 }, { 0x24EB, 0x254B },
 469     { 0x2550, 0x2573 }, { 0x2580, 0x258F }, { 0x2592, 0x2595 },
 470     { 0x25A0, 0x25A1 }, { 0x25A3, 0x25A9 }, { 0x25B2, 0x25B3 },
 471     { 0x25B6, 0x25B7 }, { 0x25BC, 0x25BD }, { 0x25C0, 0x25C1 },
 472     { 0x25C6, 0x25C8 }, { 0x25CB, 0x25CB }, { 0x25CE, 0x25D1 },
 473     { 0x25E2, 0x25E5 }, { 0x25EF, 0x25EF }, { 0x2605, 0x2606 },
 474     { 0x2609, 0x2609 }, { 0x260E, 0x260F }, { 0x2614, 0x2615 },
 475     { 0x261C, 0x261C }, { 0x261E, 0x261E }, { 0x2640, 0x2640 },
 476     { 0x2642, 0x2642 }, { 0x2660, 0x2661 }, { 0x2663, 0x2665 },
 477     { 0x2667, 0x266A }, { 0x266C, 0x266D }, { 0x266F, 0x266F },
 478     { 0x273D, 0x273D }, { 0x2776, 0x277F }, { 0xE000, 0xF8FF },
 479     { 0xFFFD, 0xFFFD }, { 0xF0000, 0xFFFFD }, { 0x100000, 0x10FFFD }
 480   };
 481
 482   if (g_unichar_iswide (c))
 483     return TRUE;
 484
 485   if (bsearch (GUINT_TO_POINTER (c), ambiguous, G_N_ELEMENTS (ambiguous), sizeof ambiguous[0],
 486                interval_compare))
 487     return TRUE;
 488
 489   return FALSE;
 490 }
 491
 492
 493 /**
 494  * g_unichar_toupper:
 495  * @c: a Unicode character
 496  *
 497  * Converts a character to uppercase.
 498  *
 499  * Return value: the result of converting @c to uppercase.
 500  *               If @c is not an lowercase or titlecase character,
 501  *               or has no upper case equivalent @c is returned unchanged.
 502  **/
 503 gunichar
 504 g_unichar_toupper (gunichar c)
 505 {
 506   int t = TYPE (c);
 507   if (t == G_UNICODE_LOWERCASE_LETTER)
 508     {
 509       gunichar val = ATTTABLE (c >> 8, c & 0xff);
 510       if (val >= 0x1000000)
 511         {
 512           const gchar *p = special_case_table + val - 0x1000000;
 513           return g_utf8_get_char (p);
 514         }
 515       else
 516         return val ? val : c;
 517     }
 518   else if (t == G_UNICODE_TITLECASE_LETTER)
 519     {
 520       unsigned int i;
 521       for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 522         {
 523           if (title_table[i][0] == c)
 524             return title_table[i][1];
 525         }
 526     }
 527   return c;
 528 }
 529
 530 /**
 531  * g_unichar_tolower:
 532  * @c: a Unicode character.
 533  *
 534  * Converts a character to lower case.
 535  *
 536  * Return value: the result of converting @c to lower case.
 537  *               If @c is not an upperlower or titlecase character,
 538  *               or has no lowercase equivalent @c is returned unchanged.
 539  **/
 540 gunichar
 541 g_unichar_tolower (gunichar c)
 542 {
 543   int t = TYPE (c);
 544   if (t == G_UNICODE_UPPERCASE_LETTER)
 545     {
 546       gunichar val = ATTTABLE (c >> 8, c & 0xff);
 547       if (val >= 0x1000000)
 548         {
 549           const gchar *p = special_case_table + val - 0x1000000;
 550           return g_utf8_get_char (p);
 551         }
 552       else
 553         return val ? val : c;
 554     }
 555   else if (t == G_UNICODE_TITLECASE_LETTER)
 556     {
 557       unsigned int i;
 558       for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 559         {
 560           if (title_table[i][0] == c)
 561             return title_table[i][2];
 562         }
 563     }
 564   return c;
 565 }
 566
 567 /**
 568  * g_unichar_totitle:
 569  * @c: a Unicode character
 570  *
 571  * Converts a character to the titlecase.
 572  *
 573  * Return value: the result of converting @c to titlecase.
 574  *               If @c is not an uppercase or lowercase character,
 575  *               @c is returned unchanged.
 576  **/
 577 gunichar
 578 g_unichar_totitle (gunichar c)
 579 {
 580   unsigned int i;
 581   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 582     {
 583       if (title_table[i][0] == c || title_table[i][1] == c
 584           || title_table[i][2] == c)
 585         return title_table[i][0];
 586     }
 587   return (TYPE (c) == G_UNICODE_LOWERCASE_LETTER
 588           ? ATTTABLE (c >> 8, c & 0xff)
 589           : c);
 590 }
 591
 592 /**
 593  * g_unichar_digit_value:
 594  * @c: a Unicode character
 595  *
 596  * Determines the numeric value of a character as a decimal
 597  * digit.
 598  *
 599  * Return value: If @c is a decimal digit (according to
 600  * g_unichar_isdigit()), its numeric value. Otherwise, -1.
 601  **/
 602 int
 603 g_unichar_digit_value (gunichar c)
 604 {
 605   if (TYPE (c) == G_UNICODE_DECIMAL_NUMBER)
 606     return ATTTABLE (c >> 8, c & 0xff);
 607   return -1;
 608 }
 609
 610 /**
 611  * g_unichar_xdigit_value:
 612  * @c: a Unicode character
 613  *
 614  * Determines the numeric value of a character as a hexidecimal
 615  * digit.
 616  *
 617  * Return value: If @c is a hex digit (according to
 618  * g_unichar_isxdigit()), its numeric value. Otherwise, -1.
 619  **/
 620 int
 621 g_unichar_xdigit_value (gunichar c)
 622 {
 623   if (c >= 'A' && c <= 'F')
 624     return c - 'A' + 10;
 625   if (c >= 'a' && c <= 'f')
 626     return c - 'a' + 10;
 627   if (TYPE (c) == G_UNICODE_DECIMAL_NUMBER)
 628     return ATTTABLE (c >> 8, c & 0xff);
 629   return -1;
 630 }
 631
 632 /**
 633  * g_unichar_type:
 634  * @c: a Unicode character
 635  *
 636  * Classifies a Unicode character by type.
 637  *
 638  * Return value: the type of the character.
 639  **/
 640 GUnicodeType
 641 g_unichar_type (gunichar c)
 642 {
 643   return TYPE (c);
 644 }
 645
 646 /*
 647  * Case mapping functions
 648  */
 649
 650 typedef enum {
 651   LOCALE_NORMAL,
 652   LOCALE_TURKIC,
 653   LOCALE_LITHUANIAN
 654 } LocaleType;
 655
 656 static LocaleType
 657 get_locale_type (void)
 658 {
 659 #ifdef G_OS_WIN32
 660   char *tem = g_win32_getlocale ();
 661   char locale[2];
 662
 663   locale[0] = tem[0];
 664   locale[1] = tem[1];
 665   g_free (tem);
 666 #else
 667   const char *locale = setlocale (LC_CTYPE, NULL);
 668 #endif
 669
 670   switch (locale[0])
 671     {
 672    case 'a':
 673       if (locale[1] == 'z')
 674         return LOCALE_TURKIC;
 675       break;
 676     case 'l':
 677       if (locale[1] == 't')
 678         return LOCALE_LITHUANIAN;
 679       break;
 680     case 't':
 681       if (locale[1] == 'r')
 682         return LOCALE_TURKIC;
 683       break;
 684     }
 685
 686   return LOCALE_NORMAL;
 687 }
 688
 689 static gint
 690 output_marks (const char **p_inout,
 691               char        *out_buffer,
 692               gboolean     remove_dot)
 693 {
 694   const char *p = *p_inout;
 695   gint len = 0;
 696
 697   while (*p)
 698     {
 699       gunichar c = g_utf8_get_char (p);
 700
 701       if (ISMARK (TYPE (c)))
 702         {
 703           if (!remove_dot || c != 0x307 /* COMBINING DOT ABOVE */)
 704             len += g_unichar_to_utf8 (c, out_buffer ? out_buffer + len : NULL);
 705           p = g_utf8_next_char (p);
 706         }
 707       else
 708         break;
 709     }
 710
 711   *p_inout = p;
 712   return len;
 713 }
 714
 715 static gint
 716 output_special_case (gchar *out_buffer,
 717                      int    offset,
 718                      int    type,
 719                      int    which)
 720 {
 721   const gchar *p = special_case_table + offset;
 722   gint len;
 723
 724   if (type != G_UNICODE_TITLECASE_LETTER)
 725     p = g_utf8_next_char (p);
 726
 727   if (which == 1)
 728     p += strlen (p) + 1;
 729
 730   len = strlen (p);
 731   if (out_buffer)
 732     memcpy (out_buffer, p, len);
 733
 734   return len;
 735 }
 736
 737 static gsize
 738 real_toupper (const gchar *str,
 739               gssize       max_len,
 740               gchar       *out_buffer,
 741               LocaleType   locale_type)
 742 {
 743   const gchar *p = str;
 744   const char *last = NULL;
 745   gsize len = 0;
 746   gboolean last_was_i = FALSE;
 747
 748   while ((max_len < 0 || p < str + max_len) && *p)
 749     {
 750       gunichar c = g_utf8_get_char (p);
 751       int t = TYPE (c);
 752       gunichar val;
 753
 754       last = p;
 755       p = g_utf8_next_char (p);
 756
 757       if (locale_type == LOCALE_LITHUANIAN)
 758         {
 759           if (c == 'i')
 760             last_was_i = TRUE;
 761           else
 762             {
 763               if (last_was_i)
 764                 {
 765                   /* Nasty, need to remove any dot above. Though
 766                    * I think only E WITH DOT ABOVE occurs in practice
 767                    * which could simplify this considerably.
 768                    */
 769                   gsize decomp_len, i;
 770                   gunichar *decomp;
 771
 772                   decomp = g_unicode_canonical_decomposition (c, &decomp_len);
 773                   for (i=0; i < decomp_len; i++)
 774                     {
 775                       if (decomp[i] != 0x307 /* COMBINING DOT ABOVE */)
 776                         len += g_unichar_to_utf8 (g_unichar_toupper (decomp[i]), out_buffer ? out_buffer + len : NULL);
 777                     }
 778                   g_free (decomp);
 779
 780                   len += output_marks (&p, out_buffer ? out_buffer + len : NULL, TRUE);
 781
 782                   continue;
 783                 }
 784
 785               if (!ISMARK (t))
 786                 last_was_i = FALSE;
 787             }
 788         }
 789
 790       if (locale_type == LOCALE_TURKIC && c == 'i')
 791         {
 792           /* i => LATIN CAPITAL LETTER I WITH DOT ABOVE */
 793           len += g_unichar_to_utf8 (0x130, out_buffer ? out_buffer + len : NULL);
 794         }
 795       else if (c == 0x0345)     /* COMBINING GREEK YPOGEGRAMMENI */
 796         {
 797           /* Nasty, need to move it after other combining marks .. this would go away if
 798            * we normalized first.
 799            */
 800           len += output_marks (&p, out_buffer ? out_buffer + len : NULL, FALSE);
 801
 802           /* And output as GREEK CAPITAL LETTER IOTA */
 803           len += g_unichar_to_utf8 (0x399, out_buffer ? out_buffer + len : NULL);
 804         }
 805       else if (IS (t,
 806                    OR (G_UNICODE_LOWERCASE_LETTER,
 807                    OR (G_UNICODE_TITLECASE_LETTER,
 808                   0))))
 809         {
 810           val = ATTTABLE (c >> 8, c & 0xff);
 811
 812           if (val >= 0x1000000)
 813             {
 814               len += output_special_case (out_buffer ? out_buffer + len : NULL, val - 0x1000000, t,
 815                                           t == G_UNICODE_LOWERCASE_LETTER ? 0 : 1);
 816             }
 817           else
 818             {
 819               if (t == G_UNICODE_TITLECASE_LETTER)
 820                 {
 821                   unsigned int i;
 822                   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
 823                     {
 824                       if (title_table[i][0] == c)
 825                         val = title_table[i][1];
 826                     }
 827                 }
 828
 829               len += g_unichar_to_utf8 (val, out_buffer ? out_buffer + len : NULL);
 830             }
 831         }
 832       else
 833         {
 834           gsize char_len = g_utf8_skip[*(guchar *)last];
 835
 836           if (out_buffer)
 837             memcpy (out_buffer + len, last, char_len);
 838
 839           len += char_len;
 840         }
 841
 842     }
 843
 844   return len;
 845 }
 846
 847 /**
 848  * g_utf8_strup:
 849  * @str: a UTF-8 encoded string
 850  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
 851  *
 852  * Converts all Unicode characters in the string that have a case
 853  * to uppercase. The exact manner that this is done depends
 854  * on the current locale, and may result in the number of
 855  * characters in the string increasing. (For instance, the
 856  * German ess-zet will be changed to SS.)
 857  *
 858  * Return value: a newly allocated string, with all characters
 859  *    converted to uppercase.
 860  **/
 861 gchar *
 862 g_utf8_strup (const gchar *str,
 863               gssize       len)
 864 {
 865   gsize result_len;
 866   LocaleType locale_type;
 867   gchar *result;
 868
 869   g_return_val_if_fail (str != NULL, NULL);
 870
 871   locale_type = get_locale_type ();
 872
 873   /*
 874    * We use a two pass approach to keep memory management simple
 875    */
 876   result_len = real_toupper (str, len, NULL, locale_type);
 877   result = g_malloc (result_len + 1);
 878   real_toupper (str, len, result, locale_type);
 879   result[result_len] = '\0';
 880
 881   return result;
 882 }
 883
 884 /* traverses the string checking for characters with combining class == 230
 885  * until a base character is found */
 886 static gboolean
 887 has_more_above (const gchar *str)
 888 {
 889   const gchar *p = str;
 890   gint combining_class;
 891
 892   while (*p)
 893     {
 894       combining_class = _g_unichar_combining_class (g_utf8_get_char (p));
 895       if (combining_class == 230)
 896         return TRUE;
 897       else if (combining_class == 0)
 898         break;
 899
 900       p = g_utf8_next_char (p);
 901     }
 902
 903   return FALSE;
 904 }
 905
 906 static gsize
 907 real_tolower (const gchar *str,
 908               gssize       max_len,
 909               gchar       *out_buffer,
 910               LocaleType   locale_type)
 911 {
 912   const gchar *p = str;
 913   const char *last = NULL;
 914   gsize len = 0;
 915
 916   while ((max_len < 0 || p < str + max_len) && *p)
 917     {
 918       gunichar c = g_utf8_get_char (p);
 919       int t = TYPE (c);
 920       gunichar val;
 921
 922       last = p;
 923       p = g_utf8_next_char (p);
 924
 925       if (locale_type == LOCALE_TURKIC && c == 'I')
 926         {
 927           if (g_utf8_get_char (p) == 0x0307)
 928             {
 929               /* I + COMBINING DOT ABOVE => i (U+0069) */
 930               len += g_unichar_to_utf8 (0x0069, out_buffer ? out_buffer + len : NULL);
 931               p = g_utf8_next_char (p);
 932             }
 933           else
 934             {
 935               /* I => LATIN SMALL LETTER DOTLESS I */
 936               len += g_unichar_to_utf8 (0x131, out_buffer ? out_buffer + len : NULL);
 937             }
 938         }
 939       /* Introduce an explicit dot above when lowercasing capital I's and J's
 940        * whenever there are more accents above. [SpecialCasing.txt] */
 941       else if (locale_type == LOCALE_LITHUANIAN &&
 942                (c == 0x00cc || c == 0x00cd || c == 0x0128))
 943         {
 944           len += g_unichar_to_utf8 (0x0069, out_buffer ? out_buffer + len : NULL);
 945           len += g_unichar_to_utf8 (0x0307, out_buffer ? out_buffer + len : NULL);
 946
 947           switch (c)
 948             {
 949             case 0x00cc:
 950               len += g_unichar_to_utf8 (0x0300, out_buffer ? out_buffer + len : NULL);
 951               break;
 952             case 0x00cd:
 953               len += g_unichar_to_utf8 (0x0301, out_buffer ? out_buffer + len : NULL);
 954               break;
 955             case 0x0128:
 956               len += g_unichar_to_utf8 (0x0303, out_buffer ? out_buffer + len : NULL);
 957               break;
 958             }
 959         }
 960       else if (locale_type == LOCALE_LITHUANIAN &&
 961                (c == 'I' || c == 'J' || c == 0x012e) &&
 962                has_more_above (p))
 963         {
 964           len += g_unichar_to_utf8 (g_unichar_tolower (c), out_buffer ? out_buffer + len : NULL);
 965           len += g_unichar_to_utf8 (0x0307, out_buffer ? out_buffer + len : NULL);
 966         }
 967       else if (c == 0x03A3)     /* GREEK CAPITAL LETTER SIGMA */
 968         {
 969           if ((max_len < 0 || p < str + max_len) && *p)
 970             {
 971               gunichar next_c = g_utf8_get_char (p);
 972               int next_type = TYPE(next_c);
 973
 974               /* SIGMA mapps differently depending on whether it is
 975                * final or not. The following simplified test would
 976                * fail in the case of combining marks following the
 977                * sigma, but I don't think that occurs in real text.
 978                * The test here matches that in ICU.
 979                */
 980               if (ISALPHA (next_type)) /* Lu,Ll,Lt,Lm,Lo */
 981                 val = 0x3c3;    /* GREEK SMALL SIGMA */
 982               else
 983                 val = 0x3c2;    /* GREEK SMALL FINAL SIGMA */
 984             }
 985           else
 986             val = 0x3c2;        /* GREEK SMALL FINAL SIGMA */
 987
 988           len += g_unichar_to_utf8 (val, out_buffer ? out_buffer + len : NULL);
 989         }
 990       else if (IS (t,
 991                    OR (G_UNICODE_UPPERCASE_LETTER,
 992                    OR (G_UNICODE_TITLECASE_LETTER,
 993                   0))))
 994         {
 995           val = ATTTABLE (c >> 8, c & 0xff);
 996
 997           if (val >= 0x1000000)
 998             {
 999               len += output_special_case (out_buffer ? out_buffer + len : NULL, val - 0x1000000, t, 0);
1000             }
1001           else
1002             {
1003               if (t == G_UNICODE_TITLECASE_LETTER)
1004                 {
1005                   unsigned int i;
1006                   for (i = 0; i < G_N_ELEMENTS (title_table); ++i)
1007                     {
1008                       if (title_table[i][0] == c)
1009                         val = title_table[i][2];
1010                     }
1011                 }
1012
1013               len += g_unichar_to_utf8 (val, out_buffer ? out_buffer + len : NULL);
1014             }
1015         }
1016       else
1017         {
1018           gsize char_len = g_utf8_skip[*(guchar *)last];
1019
1020           if (out_buffer)
1021             memcpy (out_buffer + len, last, char_len);
1022
1023           len += char_len;
1024         }
1025
1026     }
1027
1028   return len;
1029 }
1030
1031 /**
1032  * g_utf8_strdown:
1033  * @str: a UTF-8 encoded string
1034  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
1035  *
1036  * Converts all Unicode characters in the string that have a case
1037  * to lowercase. The exact manner that this is done depends
1038  * on the current locale, and may result in the number of
1039  * characters in the string changing.
1040  *
1041  * Return value: a newly allocated string, with all characters
1042  *    converted to lowercase.
1043  **/
1044 gchar *
1045 g_utf8_strdown (const gchar *str,
1046                 gssize       len)
1047 {
1048   gsize result_len;
1049   LocaleType locale_type;
1050   gchar *result;
1051
1052   g_return_val_if_fail (str != NULL, NULL);
1053
1054   locale_type = get_locale_type ();
1055
1056   /*
1057    * We use a two pass approach to keep memory management simple
1058    */
1059   result_len = real_tolower (str, len, NULL, locale_type);
1060   result = g_malloc (result_len + 1);
1061   real_tolower (str, len, result, locale_type);
1062   result[result_len] = '\0';
1063
1064   return result;
1065 }
1066
1067 /**
1068  * g_utf8_casefold:
1069  * @str: a UTF-8 encoded string
1070  * @len: length of @str, in bytes, or -1 if @str is nul-terminated.
1071  *
1072  * Converts a string into a form that is independent of case. The
1073  * result will not correspond to any particular case, but can be
1074  * compared for equality or ordered with the results of calling
1075  * g_utf8_casefold() on other strings.
1076  *
1077  * Note that calling g_utf8_casefold() followed by g_utf8_collate() is
1078  * only an approximation to the correct linguistic case insensitive
1079  * ordering, though it is a fairly good one. Getting this exactly
1080  * right would require a more sophisticated collation function that
1081  * takes case sensitivity into account. GLib does not currently
1082  * provide such a function.
1083  *
1084  * Return value: a newly allocated string, that is a
1085  *   case independent form of @str.
1086  **/
1087 gchar *
1088 g_utf8_casefold (const gchar *str,
1089                  gssize       len)
1090 {
1091   GString *result;
1092   const char *p;
1093
1094   g_return_val_if_fail (str != NULL, NULL);
1095
1096   result = g_string_new (NULL);
1097   p = str;
1098   while ((len < 0 || p < str + len) && *p)
1099     {
1100       gunichar ch = g_utf8_get_char (p);
1101
1102       int start = 0;
1103       int end = G_N_ELEMENTS (casefold_table);
1104
1105       if (ch >= casefold_table[start].ch &&
1106           ch <= casefold_table[end - 1].ch)
1107         {
1108           while (TRUE)
1109             {
1110               int half = (start + end) / 2;
1111               if (ch == casefold_table[half].ch)
1112                 {
1113                   g_string_append (result, casefold_table[half].data);
1114                   goto next;
1115                 }
1116               else if (half == start)
1117                 break;
1118               else if (ch > casefold_table[half].ch)
1119                 start = half;
1120               else
1121                 end = half;
1122             }
1123         }
1124
1125       g_string_append_unichar (result, g_unichar_tolower (ch));
1126
1127     next:
1128       p = g_utf8_next_char (p);
1129     }
1130
1131   return g_string_free (result, FALSE);
1132 }
1133
1134 /**
1135  * g_unichar_get_mirror_char:
1136  * @ch: a Unicode character
1137  * @mirrored_ch: location to store the mirrored character
1138  *
1139  * In Unicode, some characters are <firstterm>mirrored</firstterm>. This
1140  * means that their images are mirrored horizontally in text that is laid
1141  * out from right to left. For instance, "(" would become its mirror image,
1142  * ")", in right-to-left text.
1143  *
1144  * If @ch has the Unicode mirrored property and there is another unicode
1145  * character that typically has a glyph that is the mirror image of @ch's
1146  * glyph and @mirrored_ch is set, it puts that character in the address
1147  * pointed to by @mirrored_ch.  Otherwise the original character is put.
1148  *
1149  * Return value: %TRUE if @ch has a mirrored character, %FALSE otherwise
1150  *
1151  * Since: 2.4
1152  **/
1153 gboolean
1154 g_unichar_get_mirror_char (gunichar ch,
1155                            gunichar *mirrored_ch)
1156 {
1157   gboolean found;
1158   gunichar mirrored;
1159
1160   mirrored = GLIB_GET_MIRRORING(ch);
1161
1162   found = ch != mirrored;
1163   if (mirrored_ch)
1164     *mirrored_ch = mirrored;
1165
1166   return found;
1167
1168 }
1169
1170 #define __G_UNIPROP_C__
1171 #include "galiasdef.c"