ICU 57.1: uscript.h Source File

00001 /*
00002  **********************************************************************
00003  *   Copyright (C) 1997-2015, International Business Machines
00004  *   Corporation and others.  All Rights Reserved.
00005  **********************************************************************
00006  *
00007  * File USCRIPT.H
00008  *
00009  * Modification History:
00010  *
00011  *   Date        Name        Description
00012  *   07/06/2001    Ram         Creation.
00013  ******************************************************************************
00014  */
00015 
00016 #ifndef USCRIPT_H
00017 #define USCRIPT_H
00018 #include "unicode/utypes.h"
00019 
00052 typedef enum UScriptCode {
00053     /*
00054      * Note: UScriptCode constants and their ISO script code comments
00055      * are parsed by preparseucd.py.
00056      * It matches lines like
00057      *     USCRIPT_<Unicode Script value name> = <integer>,  / * <ISO script code> * /
00058      */
00059 
00061       USCRIPT_INVALID_CODE = -1,
00063       USCRIPT_COMMON       =  0,  /* Zyyy */
00065       USCRIPT_INHERITED    =  1,  /* Zinh */ /* "Code for inherited script", for non-spacing combining marks; also Qaai */
00067       USCRIPT_ARABIC       =  2,  /* Arab */
00069       USCRIPT_ARMENIAN     =  3,  /* Armn */
00071       USCRIPT_BENGALI      =  4,  /* Beng */
00073       USCRIPT_BOPOMOFO     =  5,  /* Bopo */
00075       USCRIPT_CHEROKEE     =  6,  /* Cher */
00077       USCRIPT_COPTIC       =  7,  /* Copt */
00079       USCRIPT_CYRILLIC     =  8,  /* Cyrl */
00081       USCRIPT_DESERET      =  9,  /* Dsrt */
00083       USCRIPT_DEVANAGARI   = 10,  /* Deva */
00085       USCRIPT_ETHIOPIC     = 11,  /* Ethi */
00087       USCRIPT_GEORGIAN     = 12,  /* Geor */
00089       USCRIPT_GOTHIC       = 13,  /* Goth */
00091       USCRIPT_GREEK        = 14,  /* Grek */
00093       USCRIPT_GUJARATI     = 15,  /* Gujr */
00095       USCRIPT_GURMUKHI     = 16,  /* Guru */
00097       USCRIPT_HAN          = 17,  /* Hani */
00099       USCRIPT_HANGUL       = 18,  /* Hang */
00101       USCRIPT_HEBREW       = 19,  /* Hebr */
00103       USCRIPT_HIRAGANA     = 20,  /* Hira */
00105       USCRIPT_KANNADA      = 21,  /* Knda */
00107       USCRIPT_KATAKANA     = 22,  /* Kana */
00109       USCRIPT_KHMER        = 23,  /* Khmr */
00111       USCRIPT_LAO          = 24,  /* Laoo */
00113       USCRIPT_LATIN        = 25,  /* Latn */
00115       USCRIPT_MALAYALAM    = 26,  /* Mlym */
00117       USCRIPT_MONGOLIAN    = 27,  /* Mong */
00119       USCRIPT_MYANMAR      = 28,  /* Mymr */
00121       USCRIPT_OGHAM        = 29,  /* Ogam */
00123       USCRIPT_OLD_ITALIC   = 30,  /* Ital */
00125       USCRIPT_ORIYA        = 31,  /* Orya */
00127       USCRIPT_RUNIC        = 32,  /* Runr */
00129       USCRIPT_SINHALA      = 33,  /* Sinh */
00131       USCRIPT_SYRIAC       = 34,  /* Syrc */
00133       USCRIPT_TAMIL        = 35,  /* Taml */
00135       USCRIPT_TELUGU       = 36,  /* Telu */
00137       USCRIPT_THAANA       = 37,  /* Thaa */
00139       USCRIPT_THAI         = 38,  /* Thai */
00141       USCRIPT_TIBETAN      = 39,  /* Tibt */
00143       USCRIPT_CANADIAN_ABORIGINAL = 40,  /* Cans */
00145       USCRIPT_UCAS         = USCRIPT_CANADIAN_ABORIGINAL,
00147       USCRIPT_YI           = 41,  /* Yiii */
00148       /* New scripts in Unicode 3.2 */
00150       USCRIPT_TAGALOG      = 42,  /* Tglg */
00152       USCRIPT_HANUNOO      = 43,  /* Hano */
00154       USCRIPT_BUHID        = 44,  /* Buhd */
00156       USCRIPT_TAGBANWA     = 45,  /* Tagb */
00157 
00158       /* New scripts in Unicode 4 */
00160       USCRIPT_BRAILLE      = 46,  /* Brai */
00162       USCRIPT_CYPRIOT      = 47,  /* Cprt */
00164       USCRIPT_LIMBU        = 48,  /* Limb */
00166       USCRIPT_LINEAR_B     = 49,  /* Linb */
00168       USCRIPT_OSMANYA      = 50,  /* Osma */
00170       USCRIPT_SHAVIAN      = 51,  /* Shaw */
00172       USCRIPT_TAI_LE       = 52,  /* Tale */
00174       USCRIPT_UGARITIC     = 53,  /* Ugar */
00175 
00177       USCRIPT_KATAKANA_OR_HIRAGANA = 54,/*Hrkt */
00178 
00179       /* New scripts in Unicode 4.1 */
00181       USCRIPT_BUGINESE      = 55, /* Bugi */
00183       USCRIPT_GLAGOLITIC    = 56, /* Glag */
00185       USCRIPT_KHAROSHTHI    = 57, /* Khar */
00187       USCRIPT_SYLOTI_NAGRI  = 58, /* Sylo */
00189       USCRIPT_NEW_TAI_LUE   = 59, /* Talu */
00191       USCRIPT_TIFINAGH      = 60, /* Tfng */
00193       USCRIPT_OLD_PERSIAN   = 61, /* Xpeo */
00194 
00195       /* New script codes from Unicode and ISO 15924 */
00197       USCRIPT_BALINESE                      = 62, /* Bali */
00199       USCRIPT_BATAK                         = 63, /* Batk */
00201       USCRIPT_BLISSYMBOLS                   = 64, /* Blis */
00203       USCRIPT_BRAHMI                        = 65, /* Brah */
00205       USCRIPT_CHAM                          = 66, /* Cham */
00207       USCRIPT_CIRTH                         = 67, /* Cirt */
00209       USCRIPT_OLD_CHURCH_SLAVONIC_CYRILLIC  = 68, /* Cyrs */
00211       USCRIPT_DEMOTIC_EGYPTIAN              = 69, /* Egyd */
00213       USCRIPT_HIERATIC_EGYPTIAN             = 70, /* Egyh */
00215       USCRIPT_EGYPTIAN_HIEROGLYPHS          = 71, /* Egyp */
00217       USCRIPT_KHUTSURI                      = 72, /* Geok */
00219       USCRIPT_SIMPLIFIED_HAN                = 73, /* Hans */
00221       USCRIPT_TRADITIONAL_HAN               = 74, /* Hant */
00223       USCRIPT_PAHAWH_HMONG                  = 75, /* Hmng */
00225       USCRIPT_OLD_HUNGARIAN                 = 76, /* Hung */
00227       USCRIPT_HARAPPAN_INDUS                = 77, /* Inds */
00229       USCRIPT_JAVANESE                      = 78, /* Java */
00231       USCRIPT_KAYAH_LI                      = 79, /* Kali */
00233       USCRIPT_LATIN_FRAKTUR                 = 80, /* Latf */
00235       USCRIPT_LATIN_GAELIC                  = 81, /* Latg */
00237       USCRIPT_LEPCHA                        = 82, /* Lepc */
00239       USCRIPT_LINEAR_A                      = 83, /* Lina */
00241       USCRIPT_MANDAIC                       = 84, /* Mand */
00243       USCRIPT_MANDAEAN                      = USCRIPT_MANDAIC,
00245       USCRIPT_MAYAN_HIEROGLYPHS             = 85, /* Maya */
00247       USCRIPT_MEROITIC_HIEROGLYPHS          = 86, /* Mero */
00249       USCRIPT_MEROITIC                      = USCRIPT_MEROITIC_HIEROGLYPHS,
00251       USCRIPT_NKO                           = 87, /* Nkoo */
00253       USCRIPT_ORKHON                        = 88, /* Orkh */
00255       USCRIPT_OLD_PERMIC                    = 89, /* Perm */
00257       USCRIPT_PHAGS_PA                      = 90, /* Phag */
00259       USCRIPT_PHOENICIAN                    = 91, /* Phnx */
00261       USCRIPT_MIAO                          = 92, /* Plrd */
00263       USCRIPT_PHONETIC_POLLARD              = USCRIPT_MIAO,
00265       USCRIPT_RONGORONGO                    = 93, /* Roro */
00267       USCRIPT_SARATI                        = 94, /* Sara */
00269       USCRIPT_ESTRANGELO_SYRIAC             = 95, /* Syre */
00271       USCRIPT_WESTERN_SYRIAC                = 96, /* Syrj */
00273       USCRIPT_EASTERN_SYRIAC                = 97, /* Syrn */
00275       USCRIPT_TENGWAR                       = 98, /* Teng */
00277       USCRIPT_VAI                           = 99, /* Vaii */
00279       USCRIPT_VISIBLE_SPEECH                = 100,/* Visp */
00281       USCRIPT_CUNEIFORM                     = 101,/* Xsux */
00283       USCRIPT_UNWRITTEN_LANGUAGES           = 102,/* Zxxx */
00285       USCRIPT_UNKNOWN                       = 103,/* Zzzz */ /* Unknown="Code for uncoded script", for unassigned code points */
00286 
00288       USCRIPT_CARIAN                        = 104,/* Cari */
00290       USCRIPT_JAPANESE                      = 105,/* Jpan */
00292       USCRIPT_LANNA                         = 106,/* Lana */
00294       USCRIPT_LYCIAN                        = 107,/* Lyci */
00296       USCRIPT_LYDIAN                        = 108,/* Lydi */
00298       USCRIPT_OL_CHIKI                      = 109,/* Olck */
00300       USCRIPT_REJANG                        = 110,/* Rjng */
00302       USCRIPT_SAURASHTRA                    = 111,/* Saur */
00304       USCRIPT_SIGN_WRITING                  = 112,/* Sgnw */
00306       USCRIPT_SUNDANESE                     = 113,/* Sund */
00308       USCRIPT_MOON                          = 114,/* Moon */
00310       USCRIPT_MEITEI_MAYEK                  = 115,/* Mtei */
00311 
00313       USCRIPT_IMPERIAL_ARAMAIC              = 116,/* Armi */
00315       USCRIPT_AVESTAN                       = 117,/* Avst */
00317       USCRIPT_CHAKMA                        = 118,/* Cakm */
00319       USCRIPT_KOREAN                        = 119,/* Kore */
00321       USCRIPT_KAITHI                        = 120,/* Kthi */
00323       USCRIPT_MANICHAEAN                    = 121,/* Mani */
00325       USCRIPT_INSCRIPTIONAL_PAHLAVI         = 122,/* Phli */
00327       USCRIPT_PSALTER_PAHLAVI               = 123,/* Phlp */
00329       USCRIPT_BOOK_PAHLAVI                  = 124,/* Phlv */
00331       USCRIPT_INSCRIPTIONAL_PARTHIAN        = 125,/* Prti */
00333       USCRIPT_SAMARITAN                     = 126,/* Samr */
00335       USCRIPT_TAI_VIET                      = 127,/* Tavt */
00337       USCRIPT_MATHEMATICAL_NOTATION         = 128,/* Zmth */
00339       USCRIPT_SYMBOLS                       = 129,/* Zsym */
00340 
00342       USCRIPT_BAMUM                         = 130,/* Bamu */
00344       USCRIPT_LISU                          = 131,/* Lisu */
00346       USCRIPT_NAKHI_GEBA                    = 132,/* Nkgb */
00348       USCRIPT_OLD_SOUTH_ARABIAN             = 133,/* Sarb */
00349 
00351       USCRIPT_BASSA_VAH                     = 134,/* Bass */
00353       USCRIPT_DUPLOYAN                      = 135,/* Dupl */
00354 #ifndef U_HIDE_DEPRECATED_API
00355 
00356       USCRIPT_DUPLOYAN_SHORTAND             = USCRIPT_DUPLOYAN,
00357 #endif  /* U_HIDE_DEPRECATED_API */
00358 
00359       USCRIPT_ELBASAN                       = 136,/* Elba */
00361       USCRIPT_GRANTHA                       = 137,/* Gran */
00363       USCRIPT_KPELLE                        = 138,/* Kpel */
00365       USCRIPT_LOMA                          = 139,/* Loma */
00367       USCRIPT_MENDE                         = 140,/* Mend */
00369       USCRIPT_MEROITIC_CURSIVE              = 141,/* Merc */
00371       USCRIPT_OLD_NORTH_ARABIAN             = 142,/* Narb */
00373       USCRIPT_NABATAEAN                     = 143,/* Nbat */
00375       USCRIPT_PALMYRENE                     = 144,/* Palm */
00377       USCRIPT_KHUDAWADI                     = 145,/* Sind */
00379       USCRIPT_SINDHI                        = USCRIPT_KHUDAWADI,
00381       USCRIPT_WARANG_CITI                   = 146,/* Wara */
00382 
00384       USCRIPT_AFAKA                         = 147,/* Afak */
00386       USCRIPT_JURCHEN                       = 148,/* Jurc */
00388       USCRIPT_MRO                           = 149,/* Mroo */
00390       USCRIPT_NUSHU                         = 150,/* Nshu */
00392       USCRIPT_SHARADA                       = 151,/* Shrd */
00394       USCRIPT_SORA_SOMPENG                  = 152,/* Sora */
00396       USCRIPT_TAKRI                         = 153,/* Takr */
00398       USCRIPT_TANGUT                        = 154,/* Tang */
00400       USCRIPT_WOLEAI                        = 155,/* Wole */
00401 
00403       USCRIPT_ANATOLIAN_HIEROGLYPHS         = 156,/* Hluw */
00405       USCRIPT_KHOJKI                        = 157,/* Khoj */
00407       USCRIPT_TIRHUTA                       = 158,/* Tirh */
00408 
00410       USCRIPT_CAUCASIAN_ALBANIAN            = 159,/* Aghb */
00412       USCRIPT_MAHAJANI                      = 160,/* Mahj */
00413 
00415       USCRIPT_AHOM                          = 161,/* Ahom */
00417       USCRIPT_HATRAN                        = 162,/* Hatr */
00419       USCRIPT_MODI                          = 163,/* Modi */
00421       USCRIPT_MULTANI                       = 164,/* Mult */
00423       USCRIPT_PAU_CIN_HAU                   = 165,/* Pauc */
00425       USCRIPT_SIDDHAM                       = 166,/* Sidd */
00426 
00438       USCRIPT_CODE_LIMIT    = 167
00439 } UScriptCode;
00440 
00460 U_STABLE int32_t  U_EXPORT2 
00461 uscript_getCode(const char* nameOrAbbrOrLocale,UScriptCode* fillIn,int32_t capacity,UErrorCode *err);
00462 
00473 U_STABLE const char*  U_EXPORT2 
00474 uscript_getName(UScriptCode scriptCode);
00475 
00485 U_STABLE const char*  U_EXPORT2 
00486 uscript_getShortName(UScriptCode scriptCode);
00487 
00496 U_STABLE UScriptCode  U_EXPORT2 
00497 uscript_getScript(UChar32 codepoint, UErrorCode *err);
00498 
00514 U_STABLE UBool U_EXPORT2
00515 uscript_hasScript(UChar32 c, UScriptCode sc);
00516 
00548 U_STABLE int32_t U_EXPORT2
00549 uscript_getScriptExtensions(UChar32 c,
00550                             UScriptCode *scripts, int32_t capacity,
00551                             UErrorCode *errorCode);
00552 
00560 typedef enum UScriptUsage {
00562     USCRIPT_USAGE_NOT_ENCODED,
00564     USCRIPT_USAGE_UNKNOWN,
00566     USCRIPT_USAGE_EXCLUDED,
00568     USCRIPT_USAGE_LIMITED_USE,
00570     USCRIPT_USAGE_ASPIRATIONAL,
00572     USCRIPT_USAGE_RECOMMENDED
00573 } UScriptUsage;
00574 
00587 U_STABLE int32_t U_EXPORT2
00588 uscript_getSampleString(UScriptCode script, UChar *dest, int32_t capacity, UErrorCode *pErrorCode);
00589 
00590 #if U_SHOW_CPLUSPLUS_API
00591 
00592 U_NAMESPACE_BEGIN
00593 class UnicodeString;
00594 U_NAMESPACE_END
00595 
00605 U_COMMON_API icu::UnicodeString U_EXPORT2
00606 uscript_getSampleUnicodeString(UScriptCode script);
00607 
00608 #endif
00609 
00619 U_STABLE UScriptUsage U_EXPORT2
00620 uscript_getUsage(UScriptCode script);
00621 
00630 U_STABLE UBool U_EXPORT2
00631 uscript_isRightToLeft(UScriptCode script);
00632 
00642 U_STABLE UBool U_EXPORT2
00643 uscript_breaksBetweenLetters(UScriptCode script);
00644 
00653 U_STABLE UBool U_EXPORT2
00654 uscript_isCased(UScriptCode script);
00655 
00656 #endif