glib/gunicode.h

   1 /* gunicode.h - Unicode manipulation functions
   2  *
   3  *  Copyright (C) 1999, 2000 Tom Tromey
   4  *  Copyright 2000, 2005 Red Hat, Inc.
   5  *
   6  * The Gnome Library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * The Gnome 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 the Gnome Library; see the file COPYING.LIB.  If not,
  18  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  *   Boston, MA 02111-1307, USA.
  20  */
  21
  22 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  23 #error "Only <glib.h> can be included directly."
  24 #endif
  25
  26 #ifndef __G_UNICODE_H__
  27 #define __G_UNICODE_H__
  28
  29 #include <glib/gerror.h>
  30 #include <glib/gtypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /**
  35  * gunichar:
  36  *
  37  * A type which can hold any UTF-32 or UCS-4 character code,
  38  * also known as a Unicode code point.
  39  *
  40  * If you want to produce the UTF-8 representation of a #gunichar,
  41  * use g_ucs4_to_utf8(). See also g_utf8_to_ucs4() for the reverse
  42  * process.
  43  *
  44  * To print/scan values of this type as integer, use
  45  * %G_GINT32_MODIFIER and/or %G_GUINT32_FORMAT.
  46  *
  47  * The notation to express a Unicode code point in running text is
  48  * as a hexadecimal number with four to six digits and uppercase
  49  * letters, prefixed by the string "U+". Leading zeros are omitted,
  50  * unless the code point would have fewer than four hexadecimal digits.
  51  * For example, "U+0041 LATIN CAPITAL LETTER A". To print a code point
  52  * in the U+-notation, use the format string "U+%04"G_GINT32_FORMAT"X".
  53  * To scan, use the format string "U+%06"G_GINT32_FORMAT"X".
  54  *
  55  * |[
  56  * gunichar c;
  57  * sscanf ("U+0041", "U+%06"G_GINT32_FORMAT"X", &amp;c)
  58  * g_print ("Read U+%04"G_GINT32_FORMAT"X", c);
  59  * ]|
  60  */
  61 typedef guint32 gunichar;
  62
  63 /**
  64  * gunichar2:
  65  *
  66  * A type which can hold any UTF-16 code
  67  * point<footnote id="utf16_surrogate_pairs">UTF-16 also has so called
  68  * <firstterm>surrogate pairs</firstterm> to encode characters beyond
  69  * the BMP as pairs of 16bit numbers. Surrogate pairs cannot be stored
  70  * in a single gunichar2 field, but all GLib functions accepting gunichar2
  71  * arrays will correctly interpret surrogate pairs.</footnote>.
  72  *
  73  * To print/scan values of this type to/from text you need to convert
  74  * to/from UTF-8, using g_utf16_to_utf8()/g_utf8_to_utf16().
  75  *
  76  * To print/scan values of this type as integer, use
  77  * %G_GINT16_MODIFIER and/or %G_GUINT16_FORMAT.
  78  */
  79 typedef guint16 gunichar2;
  80
  81 /**
  82  * GUnicodeType:
  83  * @G_UNICODE_CONTROL: General category "Other, Control" (Cc)
  84  * @G_UNICODE_FORMAT: General category "Other, Format" (Cf)
  85  * @G_UNICODE_UNASSIGNED: General category "Other, Not Assigned" (Cn)
  86  * @G_UNICODE_PRIVATE_USE: General category "Other, Private Use" (Co)
  87  * @G_UNICODE_SURROGATE: General category "Other, Surrogate" (Cs)
  88  * @G_UNICODE_LOWERCASE_LETTER: General category "Letter, Lowercase" (Ll)
  89  * @G_UNICODE_MODIFIER_LETTER: General category "Letter, Modifier" (Lm)
  90  * @G_UNICODE_OTHER_LETTER: General category "Letter, Other" (Lo)
  91  * @G_UNICODE_TITLECASE_LETTER: General category "Letter, Titlecase" (Lt)
  92  * @G_UNICODE_UPPERCASE_LETTER: General category "Letter, Uppercase" (Lu)
  93  * @G_UNICODE_COMBINING_MARK: General category "Mark, Spacing Combining" (Mc)
  94  * @G_UNICODE_ENCLOSING_MARK: General category "Mark, Enclosing" (Me)
  95  * @G_UNICODE_NON_SPACING_MARK: General category "Mark, Nonspacing" (Mn)
  96  * @G_UNICODE_DECIMAL_NUMBER: General category "Number, Decimal Digit" (Nd)
  97  * @G_UNICODE_LETTER_NUMBER: General category "Number, Letter" (Nl)
  98  * @G_UNICODE_OTHER_NUMBER: General category "Number, Other" (No)
  99  * @G_UNICODE_CONNECT_PUNCTUATION: General category "Punctuation, Connector" (Pc)
 100  * @G_UNICODE_DASH_PUNCTUATION: General category "Punctuation, Dash" (Pd)
 101  * @G_UNICODE_CLOSE_PUNCTUATION: General category "Punctuation, Close" (Pe)
 102  * @G_UNICODE_FINAL_PUNCTUATION: General category "Punctuation, Final quote" (Pf)
 103  * @G_UNICODE_INITIAL_PUNCTUATION: General category "Punctuation, Initial quote" (Pi)
 104  * @G_UNICODE_OTHER_PUNCTUATION: General category "Punctuation, Other" (Po)
 105  * @G_UNICODE_OPEN_PUNCTUATION: General category "Punctuation, Open" (Ps)
 106  * @G_UNICODE_CURRENCY_SYMBOL: General category "Symbol, Currency" (Sc)
 107  * @G_UNICODE_MODIFIER_SYMBOL: General category "Symbol, Modifier" (Sk)
 108  * @G_UNICODE_MATH_SYMBOL: General category "Symbol, Math" (Sm)
 109  * @G_UNICODE_OTHER_SYMBOL: General category "Symbol, Other" (So)
 110  * @G_UNICODE_LINE_SEPARATOR: General category "Separator, Line" (Zl)
 111  * @G_UNICODE_PARAGRAPH_SEPARATOR: General category "Separator, Paragraph" (Zp)
 112  * @G_UNICODE_SPACE_SEPARATOR: General category "Separator, Space" (Zs)
 113  *
 114  * These are the possible character classifications from the
 115  * Unicode specification.
 116  * See <ulink url="http://www.unicode.org/Public/UNIDATA/UnicodeData.html">http://www.unicode.org/Public/UNIDATA/UnicodeData.html</ulink>.
 117  */
 118 typedef enum
 119 {
 120   G_UNICODE_CONTROL,
 121   G_UNICODE_FORMAT,
 122   G_UNICODE_UNASSIGNED,
 123   G_UNICODE_PRIVATE_USE,
 124   G_UNICODE_SURROGATE,
 125   G_UNICODE_LOWERCASE_LETTER,
 126   G_UNICODE_MODIFIER_LETTER,
 127   G_UNICODE_OTHER_LETTER,
 128   G_UNICODE_TITLECASE_LETTER,
 129   G_UNICODE_UPPERCASE_LETTER,
 130   G_UNICODE_COMBINING_MARK,
 131   G_UNICODE_ENCLOSING_MARK,
 132   G_UNICODE_NON_SPACING_MARK,
 133   G_UNICODE_DECIMAL_NUMBER,
 134   G_UNICODE_LETTER_NUMBER,
 135   G_UNICODE_OTHER_NUMBER,
 136   G_UNICODE_CONNECT_PUNCTUATION,
 137   G_UNICODE_DASH_PUNCTUATION,
 138   G_UNICODE_CLOSE_PUNCTUATION,
 139   G_UNICODE_FINAL_PUNCTUATION,
 140   G_UNICODE_INITIAL_PUNCTUATION,
 141   G_UNICODE_OTHER_PUNCTUATION,
 142   G_UNICODE_OPEN_PUNCTUATION,
 143   G_UNICODE_CURRENCY_SYMBOL,
 144   G_UNICODE_MODIFIER_SYMBOL,
 145   G_UNICODE_MATH_SYMBOL,
 146   G_UNICODE_OTHER_SYMBOL,
 147   G_UNICODE_LINE_SEPARATOR,
 148   G_UNICODE_PARAGRAPH_SEPARATOR,
 149   G_UNICODE_SPACE_SEPARATOR
 150 } GUnicodeType;
 151
 152 /**
 153  * GUnicodeBreakType:
 154  * @G_UNICODE_BREAK_MANDATORY: Mandatory Break (BK)
 155  * @G_UNICODE_BREAK_CARRIAGE_RETURN: Carriage Return (CR)
 156  * @G_UNICODE_BREAK_LINE_FEED: Line Feed (LF)
 157  * @G_UNICODE_BREAK_COMBINING_MARK: Attached Characters and Combining Marks (CM)
 158  * @G_UNICODE_BREAK_SURROGATE: Surrogates (SG)
 159  * @G_UNICODE_BREAK_ZERO_WIDTH_SPACE: Zero Width Space (ZW)
 160  * @G_UNICODE_BREAK_INSEPARABLE: Inseparable (IN)
 161  * @G_UNICODE_BREAK_NON_BREAKING_GLUE: Non-breaking ("Glue") (GL)
 162  * @G_UNICODE_BREAK_CONTINGENT: Contingent Break Opportunity (CB)
 163  * @G_UNICODE_BREAK_SPACE: Space (SP)
 164  * @G_UNICODE_BREAK_AFTER: Break Opportunity After (BA)
 165  * @G_UNICODE_BREAK_BEFORE: Break Opportunity Before (BB)
 166  * @G_UNICODE_BREAK_BEFORE_AND_AFTER: Break Opportunity Before and After (B2)
 167  * @G_UNICODE_BREAK_HYPHEN: Hyphen (HY)
 168  * @G_UNICODE_BREAK_NON_STARTER: Nonstarter (NS)
 169  * @G_UNICODE_BREAK_OPEN_PUNCTUATION: Opening Punctuation (OP)
 170  * @G_UNICODE_BREAK_CLOSE_PUNCTUATION: Closing Punctuation (CL)
 171  * @G_UNICODE_BREAK_QUOTATION: Ambiguous Quotation (QU)
 172  * @G_UNICODE_BREAK_EXCLAMATION: Exclamation/Interrogation (EX)
 173  * @G_UNICODE_BREAK_IDEOGRAPHIC: Ideographic (ID)
 174  * @G_UNICODE_BREAK_NUMERIC: Numeric (NU)
 175  * @G_UNICODE_BREAK_INFIX_SEPARATOR: Infix Separator (Numeric) (IS)
 176  * @G_UNICODE_BREAK_SYMBOL: Symbols Allowing Break After (SY)
 177  * @G_UNICODE_BREAK_ALPHABETIC: Ordinary Alphabetic and Symbol Characters (AL)
 178  * @G_UNICODE_BREAK_PREFIX: Prefix (Numeric) (PR)
 179  * @G_UNICODE_BREAK_POSTFIX: Postfix (Numeric) (PO)
 180  * @G_UNICODE_BREAK_COMPLEX_CONTEXT: Complex Content Dependent (South East Asian) (SA)
 181  * @G_UNICODE_BREAK_AMBIGUOUS: Ambiguous (Alphabetic or Ideographic) (AI)
 182  * @G_UNICODE_BREAK_UNKNOWN: Unknown (XX)
 183  * @G_UNICODE_BREAK_NEXT_LINE: Next Line (NL)
 184  * @G_UNICODE_BREAK_WORD_JOINER: Word Joiner (WJ)
 185  * @G_UNICODE_BREAK_HANGUL_L_JAMO: Hangul L Jamo (JL)
 186  * @G_UNICODE_BREAK_HANGUL_V_JAMO: Hangul V Jamo (JV)
 187  * @G_UNICODE_BREAK_HANGUL_T_JAMO: Hangul T Jamo (JT)
 188  * @G_UNICODE_BREAK_HANGUL_LV_SYLLABLE: Hangul LV Syllable (H2)
 189  * @G_UNICODE_BREAK_HANGUL_LVT_SYLLABLE: Hangul LVT Syllable (H3)
 190  * @G_UNICODE_BREAK_CLOSE_PARANTHESIS: Closing Parenthesis (CP). Since 2.28
 191  *
 192  * These are the possible line break classifications.
 193  *
 194  * The five Hangul types were added in Unicode 4.1, so, has been
 195  * introduced in GLib 2.10. Note that new types may be added in the future.
 196  * Applications should be ready to handle unknown values.
 197  * They may be regarded as %G_UNICODE_BREAK_UNKNOWN.
 198  *
 199  * See <ulink url="http://www.unicode.org/unicode/reports/tr14/">http://www.unicode.org/unicode/reports/tr14/</ulink>.
 200  */
 201 typedef enum
 202 {
 203   G_UNICODE_BREAK_MANDATORY,
 204   G_UNICODE_BREAK_CARRIAGE_RETURN,
 205   G_UNICODE_BREAK_LINE_FEED,
 206   G_UNICODE_BREAK_COMBINING_MARK,
 207   G_UNICODE_BREAK_SURROGATE,
 208   G_UNICODE_BREAK_ZERO_WIDTH_SPACE,
 209   G_UNICODE_BREAK_INSEPARABLE,
 210   G_UNICODE_BREAK_NON_BREAKING_GLUE,
 211   G_UNICODE_BREAK_CONTINGENT,
 212   G_UNICODE_BREAK_SPACE,
 213   G_UNICODE_BREAK_AFTER,
 214   G_UNICODE_BREAK_BEFORE,
 215   G_UNICODE_BREAK_BEFORE_AND_AFTER,
 216   G_UNICODE_BREAK_HYPHEN,
 217   G_UNICODE_BREAK_NON_STARTER,
 218   G_UNICODE_BREAK_OPEN_PUNCTUATION,
 219   G_UNICODE_BREAK_CLOSE_PUNCTUATION,
 220   G_UNICODE_BREAK_QUOTATION,
 221   G_UNICODE_BREAK_EXCLAMATION,
 222   G_UNICODE_BREAK_IDEOGRAPHIC,
 223   G_UNICODE_BREAK_NUMERIC,
 224   G_UNICODE_BREAK_INFIX_SEPARATOR,
 225   G_UNICODE_BREAK_SYMBOL,
 226   G_UNICODE_BREAK_ALPHABETIC,
 227   G_UNICODE_BREAK_PREFIX,
 228   G_UNICODE_BREAK_POSTFIX,
 229   G_UNICODE_BREAK_COMPLEX_CONTEXT,
 230   G_UNICODE_BREAK_AMBIGUOUS,
 231   G_UNICODE_BREAK_UNKNOWN,
 232   G_UNICODE_BREAK_NEXT_LINE,
 233   G_UNICODE_BREAK_WORD_JOINER,
 234   G_UNICODE_BREAK_HANGUL_L_JAMO,
 235   G_UNICODE_BREAK_HANGUL_V_JAMO,
 236   G_UNICODE_BREAK_HANGUL_T_JAMO,
 237   G_UNICODE_BREAK_HANGUL_LV_SYLLABLE,
 238   G_UNICODE_BREAK_HANGUL_LVT_SYLLABLE,
 239   G_UNICODE_BREAK_CLOSE_PARANTHESIS
 240 } GUnicodeBreakType;
 241
 242 /**
 243  * GUnicodeScript:
 244  * @G_UNICODE_SCRIPT_INVALID_CODE:
 245  *                               a value never returned from g_unichar_get_script()
 246  * @G_UNICODE_SCRIPT_COMMON:     a character used by multiple different scripts
 247  * @G_UNICODE_SCRIPT_INHERITED:  a mark glyph that takes its script from the
 248  * i                             base glyph to which it is attached
 249  * @G_UNICODE_SCRIPT_ARABIC:     Arabic
 250  * @G_UNICODE_SCRIPT_ARMENIAN:   Armenian
 251  * @G_UNICODE_SCRIPT_BENGALI:    Bengali
 252  * @G_UNICODE_SCRIPT_BOPOMOFO:   Bopomofo
 253  * @G_UNICODE_SCRIPT_CHEROKEE:   Cherokee
 254  * @G_UNICODE_SCRIPT_COPTIC:     Coptic
 255  * @G_UNICODE_SCRIPT_CYRILLIC:   Cyrillic
 256  * @G_UNICODE_SCRIPT_DESERET:    Deseret
 257  * @G_UNICODE_SCRIPT_DEVANAGARI: Devanagari
 258  * @G_UNICODE_SCRIPT_ETHIOPIC:   Ethiopic
 259  * @G_UNICODE_SCRIPT_GEORGIAN:   Georgian
 260  * @G_UNICODE_SCRIPT_GOTHIC:     Gothic
 261  * @G_UNICODE_SCRIPT_GREEK:      Greek
 262  * @G_UNICODE_SCRIPT_GUJARATI:   Gujarati
 263  * @G_UNICODE_SCRIPT_GURMUKHI:   Gurmukhi
 264  * @G_UNICODE_SCRIPT_HAN:        Han
 265  * @G_UNICODE_SCRIPT_HANGUL:     Hangul
 266  * @G_UNICODE_SCRIPT_HEBREW:     Hebrew
 267  * @G_UNICODE_SCRIPT_HIRAGANA:   Hiragana
 268  * @G_UNICODE_SCRIPT_KANNADA:    Kannada
 269  * @G_UNICODE_SCRIPT_KATAKANA:   Katakana
 270  * @G_UNICODE_SCRIPT_KHMER:      Khmer
 271  * @G_UNICODE_SCRIPT_LAO:        Lao
 272  * @G_UNICODE_SCRIPT_LATIN:      Latin
 273  * @G_UNICODE_SCRIPT_MALAYALAM:  Malayalam
 274  * @G_UNICODE_SCRIPT_MONGOLIAN:  Mongolian
 275  * @G_UNICODE_SCRIPT_MYANMAR:    Myanmar
 276  * @G_UNICODE_SCRIPT_OGHAM:      Ogham
 277  * @G_UNICODE_SCRIPT_OLD_ITALIC: Old Italic
 278  * @G_UNICODE_SCRIPT_ORIYA:      Oriya
 279  * @G_UNICODE_SCRIPT_RUNIC:      Runic
 280  * @G_UNICODE_SCRIPT_SINHALA:    Sinhala
 281  * @G_UNICODE_SCRIPT_SYRIAC:     Syriac
 282  * @G_UNICODE_SCRIPT_TAMIL:      Tamil
 283  * @G_UNICODE_SCRIPT_TELUGU:     Telugu
 284  * @G_UNICODE_SCRIPT_THAANA:     Thaana
 285  * @G_UNICODE_SCRIPT_THAI:       Thai
 286  * @G_UNICODE_SCRIPT_TIBETAN:    Tibetan
 287  * @G_UNICODE_SCRIPT_CANADIAN_ABORIGINAL:
 288  *                               Canadian Aboriginal
 289  * @G_UNICODE_SCRIPT_YI:         Yi
 290  * @G_UNICODE_SCRIPT_TAGALOG:    Tagalog
 291  * @G_UNICODE_SCRIPT_HANUNOO:    Hanunoo
 292  * @G_UNICODE_SCRIPT_BUHID:      Buhid
 293  * @G_UNICODE_SCRIPT_TAGBANWA:   Tagbanwa
 294  * @G_UNICODE_SCRIPT_BRAILLE:    Braille
 295  * @G_UNICODE_SCRIPT_CYPRIOT:    Cypriot
 296  * @G_UNICODE_SCRIPT_LIMBU:      Limbu
 297  * @G_UNICODE_SCRIPT_OSMANYA:    Osmanya
 298  * @G_UNICODE_SCRIPT_SHAVIAN:    Shavian
 299  * @G_UNICODE_SCRIPT_LINEAR_B:   Linear B
 300  * @G_UNICODE_SCRIPT_TAI_LE:     Tai Le
 301  * @G_UNICODE_SCRIPT_UGARITIC:   Ugaritic
 302  * @G_UNICODE_SCRIPT_NEW_TAI_LUE:
 303  *                               New Tai Lue
 304  * @G_UNICODE_SCRIPT_BUGINESE:   Buginese
 305  * @G_UNICODE_SCRIPT_GLAGOLITIC: Glagolitic
 306  * @G_UNICODE_SCRIPT_TIFINAGH:   Tifinagh
 307  * @G_UNICODE_SCRIPT_SYLOTI_NAGRI:
 308  *                               Syloti Nagri
 309  * @G_UNICODE_SCRIPT_OLD_PERSIAN:
 310  *                               Old Persian
 311  * @G_UNICODE_SCRIPT_KHAROSHTHI: Kharoshthi
 312  * @G_UNICODE_SCRIPT_UNKNOWN:    an unassigned code point
 313  * @G_UNICODE_SCRIPT_BALINESE:   Balinese
 314  * @G_UNICODE_SCRIPT_CUNEIFORM:  Cuneiform
 315  * @G_UNICODE_SCRIPT_PHOENICIAN: Phoenician
 316  * @G_UNICODE_SCRIPT_PHAGS_PA:   Phags-pa
 317  * @G_UNICODE_SCRIPT_NKO:        N'Ko
 318  * @G_UNICODE_SCRIPT_KAYAH_LI:   Kayah Li. Since 2.16.3
 319  * @G_UNICODE_SCRIPT_LEPCHA:     Lepcha. Since 2.16.3
 320  * @G_UNICODE_SCRIPT_REJANG:     Rejang. Since 2.16.3
 321  * @G_UNICODE_SCRIPT_SUNDANESE:  Sundanese. Since 2.16.3
 322  * @G_UNICODE_SCRIPT_SAURASHTRA: Saurashtra. Since 2.16.3
 323  * @G_UNICODE_SCRIPT_CHAM:       Cham. Since 2.16.3
 324  * @G_UNICODE_SCRIPT_OL_CHIKI:   Ol Chiki. Since 2.16.3
 325  * @G_UNICODE_SCRIPT_VAI:        Vai. Since 2.16.3
 326  * @G_UNICODE_SCRIPT_CARIAN:     Carian. Since 2.16.3
 327  * @G_UNICODE_SCRIPT_LYCIAN:     Lycian. Since 2.16.3
 328  * @G_UNICODE_SCRIPT_LYDIAN:     Lydian. Since 2.16.3
 329  * @G_UNICODE_SCRIPT_AVESTAN:    Avestan. Since 2.26
 330  * @G_UNICODE_SCRIPT_BAMUM:      Bamum. Since 2.26
 331  * @G_UNICODE_SCRIPT_EGYPTIAN_HIEROGLYPHS:
 332  *                               Egyptian Hieroglpyhs. Since 2.26
 333  * @G_UNICODE_SCRIPT_IMPERIAL_ARAMAIC:
 334  *                               Imperial Aramaic. Since 2.26
 335  * @G_UNICODE_SCRIPT_INSCRIPTIONAL_PAHLAVI:
 336  *                               Inscriptional Pahlavi. Since 2.26
 337  * @G_UNICODE_SCRIPT_INSCRIPTIONAL_PARTHIAN:
 338  *                               Inscriptional Parthian. Since 2.26
 339  * @G_UNICODE_SCRIPT_JAVANESE:   Javanese. Since 2.26
 340  * @G_UNICODE_SCRIPT_KAITHI:     Kaithi. Since 2.26
 341  * @G_UNICODE_SCRIPT_LISU:       Lisu. Since 2.26
 342  * @G_UNICODE_SCRIPT_MEETEI_MAYEK:
 343  *                               Meetei Mayek. Since 2.26
 344  * @G_UNICODE_SCRIPT_OLD_SOUTH_ARABIAN:
 345  *                               Old South Arabian. Since 2.26
 346  * @G_UNICODE_SCRIPT_OLD_TURKIC: Old Turkic. Since 2.28
 347  * @G_UNICODE_SCRIPT_SAMARITAN:  Samaritan. Since 2.26
 348  * @G_UNICODE_SCRIPT_TAI_THAM:   Tai Tham. Since 2.26
 349  * @G_UNICODE_SCRIPT_TAI_VIET:   Tai Viet. Since 2.26
 350  * @G_UNICODE_SCRIPT_BATAK:      Batak. Since 2.28
 351  * @G_UNICODE_SCRIPT_BRAHMI:     Brahmi. Since 2.28
 352  * @G_UNICODE_SCRIPT_MANDAIC:    Mandaic. Since 2.28
 353  *
 354  * The #GUnicodeScript enumeration identifies different writing
 355  * systems. The values correspond to the names as defined in the
 356  * Unicode standard. The enumeration has been added in GLib 2.14,
 357  * and is interchangeable with #PangoScript.
 358  *
 359  * Note that new types may be added in the future. Applications
 360  * should be ready to handle unknown values.
 361  * See <ulink
 362  * url="http://www.unicode.org/reports/tr24/">Unicode Standard Annex
 363  * #24: Script names</ulink>.
 364  */
 365 typedef enum
 366 {                         /* ISO 15924 code */
 367   G_UNICODE_SCRIPT_INVALID_CODE = -1,
 368   G_UNICODE_SCRIPT_COMMON       = 0,   /* Zyyy */
 369   G_UNICODE_SCRIPT_INHERITED,          /* Qaai */
 370   G_UNICODE_SCRIPT_ARABIC,             /* Arab */
 371   G_UNICODE_SCRIPT_ARMENIAN,           /* Armn */
 372   G_UNICODE_SCRIPT_BENGALI,            /* Beng */
 373   G_UNICODE_SCRIPT_BOPOMOFO,           /* Bopo */
 374   G_UNICODE_SCRIPT_CHEROKEE,           /* Cher */
 375   G_UNICODE_SCRIPT_COPTIC,             /* Qaac */
 376   G_UNICODE_SCRIPT_CYRILLIC,           /* Cyrl (Cyrs) */
 377   G_UNICODE_SCRIPT_DESERET,            /* Dsrt */
 378   G_UNICODE_SCRIPT_DEVANAGARI,         /* Deva */
 379   G_UNICODE_SCRIPT_ETHIOPIC,           /* Ethi */
 380   G_UNICODE_SCRIPT_GEORGIAN,           /* Geor (Geon, Geoa) */
 381   G_UNICODE_SCRIPT_GOTHIC,             /* Goth */
 382   G_UNICODE_SCRIPT_GREEK,              /* Grek */
 383   G_UNICODE_SCRIPT_GUJARATI,           /* Gujr */
 384   G_UNICODE_SCRIPT_GURMUKHI,           /* Guru */
 385   G_UNICODE_SCRIPT_HAN,                /* Hani */
 386   G_UNICODE_SCRIPT_HANGUL,             /* Hang */
 387   G_UNICODE_SCRIPT_HEBREW,             /* Hebr */
 388   G_UNICODE_SCRIPT_HIRAGANA,           /* Hira */
 389   G_UNICODE_SCRIPT_KANNADA,            /* Knda */
 390   G_UNICODE_SCRIPT_KATAKANA,           /* Kana */
 391   G_UNICODE_SCRIPT_KHMER,              /* Khmr */
 392   G_UNICODE_SCRIPT_LAO,                /* Laoo */
 393   G_UNICODE_SCRIPT_LATIN,              /* Latn (Latf, Latg) */
 394   G_UNICODE_SCRIPT_MALAYALAM,          /* Mlym */
 395   G_UNICODE_SCRIPT_MONGOLIAN,          /* Mong */
 396   G_UNICODE_SCRIPT_MYANMAR,            /* Mymr */
 397   G_UNICODE_SCRIPT_OGHAM,              /* Ogam */
 398   G_UNICODE_SCRIPT_OLD_ITALIC,         /* Ital */
 399   G_UNICODE_SCRIPT_ORIYA,              /* Orya */
 400   G_UNICODE_SCRIPT_RUNIC,              /* Runr */
 401   G_UNICODE_SCRIPT_SINHALA,            /* Sinh */
 402   G_UNICODE_SCRIPT_SYRIAC,             /* Syrc (Syrj, Syrn, Syre) */
 403   G_UNICODE_SCRIPT_TAMIL,              /* Taml */
 404   G_UNICODE_SCRIPT_TELUGU,             /* Telu */
 405   G_UNICODE_SCRIPT_THAANA,             /* Thaa */
 406   G_UNICODE_SCRIPT_THAI,               /* Thai */
 407   G_UNICODE_SCRIPT_TIBETAN,            /* Tibt */
 408   G_UNICODE_SCRIPT_CANADIAN_ABORIGINAL, /* Cans */
 409   G_UNICODE_SCRIPT_YI,                 /* Yiii */
 410   G_UNICODE_SCRIPT_TAGALOG,            /* Tglg */
 411   G_UNICODE_SCRIPT_HANUNOO,            /* Hano */
 412   G_UNICODE_SCRIPT_BUHID,              /* Buhd */
 413   G_UNICODE_SCRIPT_TAGBANWA,           /* Tagb */
 414
 415   /* Unicode-4.0 additions */
 416   G_UNICODE_SCRIPT_BRAILLE,            /* Brai */
 417   G_UNICODE_SCRIPT_CYPRIOT,            /* Cprt */
 418   G_UNICODE_SCRIPT_LIMBU,              /* Limb */
 419   G_UNICODE_SCRIPT_OSMANYA,            /* Osma */
 420   G_UNICODE_SCRIPT_SHAVIAN,            /* Shaw */
 421   G_UNICODE_SCRIPT_LINEAR_B,           /* Linb */
 422   G_UNICODE_SCRIPT_TAI_LE,             /* Tale */
 423   G_UNICODE_SCRIPT_UGARITIC,           /* Ugar */
 424
 425   /* Unicode-4.1 additions */
 426   G_UNICODE_SCRIPT_NEW_TAI_LUE,        /* Talu */
 427   G_UNICODE_SCRIPT_BUGINESE,           /* Bugi */
 428   G_UNICODE_SCRIPT_GLAGOLITIC,         /* Glag */
 429   G_UNICODE_SCRIPT_TIFINAGH,           /* Tfng */
 430   G_UNICODE_SCRIPT_SYLOTI_NAGRI,       /* Sylo */
 431   G_UNICODE_SCRIPT_OLD_PERSIAN,        /* Xpeo */
 432   G_UNICODE_SCRIPT_KHAROSHTHI,         /* Khar */
 433
 434   /* Unicode-5.0 additions */
 435   G_UNICODE_SCRIPT_UNKNOWN,            /* Zzzz */
 436   G_UNICODE_SCRIPT_BALINESE,           /* Bali */
 437   G_UNICODE_SCRIPT_CUNEIFORM,          /* Xsux */
 438   G_UNICODE_SCRIPT_PHOENICIAN,         /* Phnx */
 439   G_UNICODE_SCRIPT_PHAGS_PA,           /* Phag */
 440   G_UNICODE_SCRIPT_NKO,                /* Nkoo */
 441
 442   /* Unicode-5.1 additions */
 443   G_UNICODE_SCRIPT_KAYAH_LI,           /* Kali */
 444   G_UNICODE_SCRIPT_LEPCHA,             /* Lepc */
 445   G_UNICODE_SCRIPT_REJANG,             /* Rjng */
 446   G_UNICODE_SCRIPT_SUNDANESE,          /* Sund */
 447   G_UNICODE_SCRIPT_SAURASHTRA,         /* Saur */
 448   G_UNICODE_SCRIPT_CHAM,               /* Cham */
 449   G_UNICODE_SCRIPT_OL_CHIKI,           /* Olck */
 450   G_UNICODE_SCRIPT_VAI,                /* Vaii */
 451   G_UNICODE_SCRIPT_CARIAN,             /* Cari */
 452   G_UNICODE_SCRIPT_LYCIAN,             /* Lyci */
 453   G_UNICODE_SCRIPT_LYDIAN,             /* Lydi */
 454
 455   /* Unicode-5.2 additions */
 456   G_UNICODE_SCRIPT_AVESTAN,                /* Avst */
 457   G_UNICODE_SCRIPT_BAMUM,                  /* Bamu */
 458   G_UNICODE_SCRIPT_EGYPTIAN_HIEROGLYPHS,   /* Egyp */
 459   G_UNICODE_SCRIPT_IMPERIAL_ARAMAIC,       /* Armi */
 460   G_UNICODE_SCRIPT_INSCRIPTIONAL_PAHLAVI,  /* Phli */
 461   G_UNICODE_SCRIPT_INSCRIPTIONAL_PARTHIAN, /* Prti */
 462   G_UNICODE_SCRIPT_JAVANESE,               /* Java */
 463   G_UNICODE_SCRIPT_KAITHI,                 /* Kthi */
 464   G_UNICODE_SCRIPT_LISU,                   /* Lisu */
 465   G_UNICODE_SCRIPT_MEETEI_MAYEK,           /* Mtei */
 466   G_UNICODE_SCRIPT_OLD_SOUTH_ARABIAN,      /* Sarb */
 467   G_UNICODE_SCRIPT_OLD_TURKIC,             /* Orkh */
 468   G_UNICODE_SCRIPT_SAMARITAN,              /* Samr */
 469   G_UNICODE_SCRIPT_TAI_THAM,               /* Lana */
 470   G_UNICODE_SCRIPT_TAI_VIET,               /* Tavt */
 471
 472   /* Unicode-6.0 additions */
 473   G_UNICODE_SCRIPT_BATAK,                  /* Batk */
 474   G_UNICODE_SCRIPT_BRAHMI,                 /* Brah */
 475   G_UNICODE_SCRIPT_MANDAIC                 /* Mand */
 476 } GUnicodeScript;
 477
 478 guint32 g_unicode_script_to_iso15924 (GUnicodeScript script);
 479
 480 /* Returns TRUE if current locale uses UTF-8 charset.  If CHARSET is
 481  * not null, sets *CHARSET to the name of the current locale's
 482  * charset.  This value is statically allocated, and should be copied
 483  * in case the locale's charset will be changed later using setlocale()
 484  * or in some other way.
 485  */
 486 gboolean g_get_charset (const char **charset);
 487
 488 /* These are all analogs of the <ctype.h> functions.
 489  */
 490 gboolean g_unichar_isalnum   (gunichar c) G_GNUC_CONST;
 491 gboolean g_unichar_isalpha   (gunichar c) G_GNUC_CONST;
 492 gboolean g_unichar_iscntrl   (gunichar c) G_GNUC_CONST;
 493 gboolean g_unichar_isdigit   (gunichar c) G_GNUC_CONST;
 494 gboolean g_unichar_isgraph   (gunichar c) G_GNUC_CONST;
 495 gboolean g_unichar_islower   (gunichar c) G_GNUC_CONST;
 496 gboolean g_unichar_isprint   (gunichar c) G_GNUC_CONST;
 497 gboolean g_unichar_ispunct   (gunichar c) G_GNUC_CONST;
 498 gboolean g_unichar_isspace   (gunichar c) G_GNUC_CONST;
 499 gboolean g_unichar_isupper   (gunichar c) G_GNUC_CONST;
 500 gboolean g_unichar_isxdigit  (gunichar c) G_GNUC_CONST;
 501 gboolean g_unichar_istitle   (gunichar c) G_GNUC_CONST;
 502 gboolean g_unichar_isdefined (gunichar c) G_GNUC_CONST;
 503 gboolean g_unichar_iswide    (gunichar c) G_GNUC_CONST;
 504 gboolean g_unichar_iswide_cjk(gunichar c) G_GNUC_CONST;
 505 gboolean g_unichar_iszerowidth(gunichar c) G_GNUC_CONST;
 506 gboolean g_unichar_ismark    (gunichar c) G_GNUC_CONST;
 507
 508 /* More <ctype.h> functions.  These convert between the three cases.
 509  * See the Unicode book to understand title case.  */
 510 gunichar g_unichar_toupper (gunichar c) G_GNUC_CONST;
 511 gunichar g_unichar_tolower (gunichar c) G_GNUC_CONST;
 512 gunichar g_unichar_totitle (gunichar c) G_GNUC_CONST;
 513
 514 /* If C is a digit (according to `g_unichar_isdigit'), then return its
 515    numeric value.  Otherwise return -1.  */
 516 gint g_unichar_digit_value (gunichar c) G_GNUC_CONST;
 517
 518 gint g_unichar_xdigit_value (gunichar c) G_GNUC_CONST;
 519
 520 /* Return the Unicode character type of a given character.  */
 521 GUnicodeType g_unichar_type (gunichar c) G_GNUC_CONST;
 522
 523 /* Return the line break property for a given character */
 524 GUnicodeBreakType g_unichar_break_type (gunichar c) G_GNUC_CONST;
 525
 526 /* Returns the combining class for a given character */
 527 gint g_unichar_combining_class (gunichar uc) G_GNUC_CONST;
 528
 529 gboolean g_unichar_get_mirror_char (gunichar ch,
 530                                     gunichar *mirrored_ch);
 531
 532 GUnicodeScript g_unichar_get_script (gunichar ch) G_GNUC_CONST;
 533
 534 /* Validate a Unicode character */
 535 gboolean g_unichar_validate (gunichar ch) G_GNUC_CONST;
 536
 537 /* Pairwise canonical compose/decompose */
 538 gboolean g_unichar_compose (gunichar  a,
 539                             gunichar  b,
 540                             gunichar *ch);
 541 gboolean g_unichar_decompose (gunichar  ch,
 542                               gunichar *a,
 543                               gunichar *b);
 544
 545 gsize g_unichar_fully_decompose (gunichar  ch,
 546                                  gboolean  compat,
 547                                  gunichar *result,
 548                                  gsize     result_len);
 549
 550 /* Compute canonical ordering of a string in-place.  This rearranges
 551    decomposed characters in the string according to their combining
 552    classes.  See the Unicode manual for more information.  */
 553 void g_unicode_canonical_ordering (gunichar *string,
 554                                    gsize     len);
 555
 556
 557 #ifndef G_DISABLE_DEPRECATED
 558 /* Deprecated.  Use g_unichar_fully_decompose() */
 559 gunichar *g_unicode_canonical_decomposition (gunichar  ch,
 560                                              gsize    *result_len) G_GNUC_MALLOC;
 561 #endif
 562
 563 /* Array of skip-bytes-per-initial character.
 564  */
 565 GLIB_VAR const gchar * const g_utf8_skip;
 566
 567 /**
 568  * g_utf8_next_char:
 569  * @p: Pointer to the start of a valid UTF-8 character
 570  *
 571  * Skips to the next character in a UTF-8 string. The string must be
 572  * valid; this macro is as fast as possible, and has no error-checking.
 573  * You would use this macro to iterate over a string character by
 574  * character. The macro returns the start of the next UTF-8 character.
 575  * Before using this macro, use g_utf8_validate() to validate strings
 576  * that may contain invalid UTF-8.
 577  */
 578 #define g_utf8_next_char(p) (char *)((p) + g_utf8_skip[*(const guchar *)(p)])
 579
 580 gunichar g_utf8_get_char           (const gchar  *p) G_GNUC_PURE;
 581 gunichar g_utf8_get_char_validated (const  gchar *p,
 582                                     gssize        max_len) G_GNUC_PURE;
 583
 584 gchar*   g_utf8_offset_to_pointer (const gchar *str,
 585                                    glong        offset) G_GNUC_PURE;
 586 glong    g_utf8_pointer_to_offset (const gchar *str,
 587                                    const gchar *pos) G_GNUC_PURE;
 588 gchar*   g_utf8_prev_char         (const gchar *p) G_GNUC_PURE;
 589 gchar*   g_utf8_find_next_char    (const gchar *p,
 590                                    const gchar *end) G_GNUC_PURE;
 591 gchar*   g_utf8_find_prev_char    (const gchar *str,
 592                                    const gchar *p) G_GNUC_PURE;
 593
 594 glong    g_utf8_strlen            (const gchar *p,
 595                                    gssize       max) G_GNUC_PURE;
 596
 597 gchar   *g_utf8_substring         (const gchar *p,
 598                                    glong        start_pos,
 599                                    glong        end_pos) G_GNUC_MALLOC;
 600
 601 gchar   *g_utf8_strncpy           (gchar       *dest,
 602                                    const gchar *src,
 603                                    gsize        n);
 604
 605 /* Find the UTF-8 character corresponding to ch, in string p. These
 606    functions are equivalants to strchr and strrchr */
 607 gchar* g_utf8_strchr  (const gchar *p,
 608                        gssize       len,
 609                        gunichar     c);
 610 gchar* g_utf8_strrchr (const gchar *p,
 611                        gssize       len,
 612                        gunichar     c);
 613 gchar* g_utf8_strreverse (const gchar *str,
 614                           gssize len);
 615
 616 gunichar2 *g_utf8_to_utf16     (const gchar      *str,
 617                                 glong             len,
 618                                 glong            *items_read,
 619                                 glong            *items_written,
 620                                 GError          **error) G_GNUC_MALLOC;
 621 gunichar * g_utf8_to_ucs4      (const gchar      *str,
 622                                 glong             len,
 623                                 glong            *items_read,
 624                                 glong            *items_written,
 625                                 GError          **error) G_GNUC_MALLOC;
 626 gunichar * g_utf8_to_ucs4_fast (const gchar      *str,
 627                                 glong             len,
 628                                 glong            *items_written) G_GNUC_MALLOC;
 629 gunichar * g_utf16_to_ucs4     (const gunichar2  *str,
 630                                 glong             len,
 631                                 glong            *items_read,
 632                                 glong            *items_written,
 633                                 GError          **error) G_GNUC_MALLOC;
 634 gchar*     g_utf16_to_utf8     (const gunichar2  *str,
 635                                 glong             len,
 636                                 glong            *items_read,
 637                                 glong            *items_written,
 638                                 GError          **error) G_GNUC_MALLOC;
 639 gunichar2 *g_ucs4_to_utf16     (const gunichar   *str,
 640                                 glong             len,
 641                                 glong            *items_read,
 642                                 glong            *items_written,
 643                                 GError          **error) G_GNUC_MALLOC;
 644 gchar*     g_ucs4_to_utf8      (const gunichar   *str,
 645                                 glong             len,
 646                                 glong            *items_read,
 647                                 glong            *items_written,
 648                                 GError          **error) G_GNUC_MALLOC;
 649
 650 gint      g_unichar_to_utf8 (gunichar    c,
 651                              gchar      *outbuf);
 652
 653 gboolean g_utf8_validate (const gchar  *str,
 654                           gssize        max_len,
 655                           const gchar **end);
 656
 657 gchar *g_utf8_strup   (const gchar *str,
 658                        gssize       len) G_GNUC_MALLOC;
 659 gchar *g_utf8_strdown (const gchar *str,
 660                        gssize       len) G_GNUC_MALLOC;
 661 gchar *g_utf8_casefold (const gchar *str,
 662                         gssize       len) G_GNUC_MALLOC;
 663
 664 /**
 665  * GNormalizeMode:
 666  * @G_NORMALIZE_DEFAULT: standardize differences that do not affect the
 667  *     text content, such as the above-mentioned accent representation
 668  * @G_NORMALIZE_NFD: another name for %G_NORMALIZE_DEFAULT
 669  * @G_NORMALIZE_DEFAULT_COMPOSE: like %G_NORMALIZE_DEFAULT, but with
 670  *     composed forms rather than a maximally decomposed form
 671  * @G_NORMALIZE_NFC: another name for %G_NORMALIZE_DEFAULT_COMPOSE
 672  * @G_NORMALIZE_ALL: beyond %G_NORMALIZE_DEFAULT also standardize the
 673  *     "compatibility" characters in Unicode, such as SUPERSCRIPT THREE
 674  *     to the standard forms (in this case DIGIT THREE). Formatting
 675  *     information may be lost but for most text operations such
 676  *     characters should be considered the same
 677  * @G_NORMALIZE_NFKD: another name for %G_NORMALIZE_ALL
 678  * @G_NORMALIZE_ALL_COMPOSE: like %G_NORMALIZE_ALL, but with composed
 679  *     forms rather than a maximally decomposed form
 680  * @G_NORMALIZE_NFKC: another name for %G_NORMALIZE_ALL_COMPOSE
 681  *
 682  * Defines how a Unicode string is transformed in a canonical
 683  * form, standardizing such issues as whether a character with
 684  * an accent is represented as a base character and combining
 685  * accent or as a single precomposed character. Unicode strings
 686  * should generally be normalized before comparing them.
 687  */
 688 typedef enum {
 689   G_NORMALIZE_DEFAULT,
 690   G_NORMALIZE_NFD = G_NORMALIZE_DEFAULT,
 691   G_NORMALIZE_DEFAULT_COMPOSE,
 692   G_NORMALIZE_NFC = G_NORMALIZE_DEFAULT_COMPOSE,
 693   G_NORMALIZE_ALL,
 694   G_NORMALIZE_NFKD = G_NORMALIZE_ALL,
 695   G_NORMALIZE_ALL_COMPOSE,
 696   G_NORMALIZE_NFKC = G_NORMALIZE_ALL_COMPOSE
 697 } GNormalizeMode;
 698
 699 gchar *g_utf8_normalize (const gchar   *str,
 700                          gssize         len,
 701                          GNormalizeMode mode) G_GNUC_MALLOC;
 702
 703 gint   g_utf8_collate     (const gchar *str1,
 704                            const gchar *str2) G_GNUC_PURE;
 705 gchar *g_utf8_collate_key (const gchar *str,
 706                            gssize       len) G_GNUC_MALLOC;
 707 gchar *g_utf8_collate_key_for_filename (const gchar *str,
 708                                         gssize       len) G_GNUC_MALLOC;
 709
 710
 711 /* private */
 712
 713 gchar *_g_utf8_make_valid (const gchar *name);
 714
 715 G_END_DECLS
 716
 717 #endif /* __G_UNICODE_H__ */