jpayne@69: // © 2016 and later: Unicode, Inc. and others.
jpayne@69: // License & terms of use: http://www.unicode.org/copyright.html
jpayne@69: /*
jpayne@69:  **********************************************************************
jpayne@69:  *   Copyright (C) 1997-2016, International Business Machines
jpayne@69:  *   Corporation and others.  All Rights Reserved.
jpayne@69:  **********************************************************************
jpayne@69:  *
jpayne@69:  * File USCRIPT.H
jpayne@69:  *
jpayne@69:  * Modification History:
jpayne@69:  *
jpayne@69:  *   Date        Name        Description
jpayne@69:  *   07/06/2001    Ram         Creation.
jpayne@69:  ******************************************************************************
jpayne@69:  */
jpayne@69: 
jpayne@69: #ifndef USCRIPT_H
jpayne@69: #define USCRIPT_H
jpayne@69: #include "unicode/utypes.h"
jpayne@69: 
jpayne@69: /**
jpayne@69:  * \file
jpayne@69:  * \brief C API: Unicode Script Information
jpayne@69:  */
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Constants for ISO 15924 script codes.
jpayne@69:  *
jpayne@69:  * The current set of script code constants supports at least all scripts
jpayne@69:  * that are encoded in the version of Unicode which ICU currently supports.
jpayne@69:  * The names of the constants are usually derived from the
jpayne@69:  * Unicode script property value aliases.
jpayne@69:  * See UAX #24 Unicode Script Property (http://www.unicode.org/reports/tr24/)
jpayne@69:  * and http://www.unicode.org/Public/UCD/latest/ucd/PropertyValueAliases.txt .
jpayne@69:  *
jpayne@69:  * In addition, constants for many ISO 15924 script codes
jpayne@69:  * are included, for use with language tags, CLDR data, and similar.
jpayne@69:  * Some of those codes are not used in the Unicode Character Database (UCD).
jpayne@69:  * For example, there are no characters that have a UCD script property value of
jpayne@69:  * Hans or Hant. All Han ideographs have the Hani script property value in Unicode.
jpayne@69:  *
jpayne@69:  * Private-use codes Qaaa..Qabx are not included, except as used in the UCD or in CLDR.
jpayne@69:  *
jpayne@69:  * Starting with ICU 55, script codes are only added when their scripts
jpayne@69:  * have been or will certainly be encoded in Unicode,
jpayne@69:  * and have been assigned Unicode script property value aliases,
jpayne@69:  * to ensure that their script names are stable and match the names of the constants.
jpayne@69:  * Script codes like Latf and Aran that are not subject to separate encoding
jpayne@69:  * may be added at any time.
jpayne@69:  *
jpayne@69:  * @stable ICU 2.2
jpayne@69:  */
jpayne@69: typedef enum UScriptCode {
jpayne@69:     /*
jpayne@69:      * Note: UScriptCode constants and their ISO script code comments
jpayne@69:      * are parsed by preparseucd.py.
jpayne@69:      * It matches lines like
jpayne@69:      *     USCRIPT_<Unicode Script value name> = <integer>,  / * <ISO script code> * /
jpayne@69:      */
jpayne@69: 
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_INVALID_CODE = -1,
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_COMMON       =  0,  /* Zyyy */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_INHERITED    =  1,  /* Zinh */ /* "Code for inherited script", for non-spacing combining marks; also Qaai */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_ARABIC       =  2,  /* Arab */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_ARMENIAN     =  3,  /* Armn */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_BENGALI      =  4,  /* Beng */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_BOPOMOFO     =  5,  /* Bopo */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_CHEROKEE     =  6,  /* Cher */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_COPTIC       =  7,  /* Copt */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_CYRILLIC     =  8,  /* Cyrl */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_DESERET      =  9,  /* Dsrt */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_DEVANAGARI   = 10,  /* Deva */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_ETHIOPIC     = 11,  /* Ethi */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_GEORGIAN     = 12,  /* Geor */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_GOTHIC       = 13,  /* Goth */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_GREEK        = 14,  /* Grek */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_GUJARATI     = 15,  /* Gujr */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_GURMUKHI     = 16,  /* Guru */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_HAN          = 17,  /* Hani */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_HANGUL       = 18,  /* Hang */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_HEBREW       = 19,  /* Hebr */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_HIRAGANA     = 20,  /* Hira */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_KANNADA      = 21,  /* Knda */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_KATAKANA     = 22,  /* Kana */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_KHMER        = 23,  /* Khmr */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_LAO          = 24,  /* Laoo */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_LATIN        = 25,  /* Latn */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_MALAYALAM    = 26,  /* Mlym */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_MONGOLIAN    = 27,  /* Mong */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_MYANMAR      = 28,  /* Mymr */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_OGHAM        = 29,  /* Ogam */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_OLD_ITALIC   = 30,  /* Ital */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_ORIYA        = 31,  /* Orya */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_RUNIC        = 32,  /* Runr */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_SINHALA      = 33,  /* Sinh */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_SYRIAC       = 34,  /* Syrc */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_TAMIL        = 35,  /* Taml */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_TELUGU       = 36,  /* Telu */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_THAANA       = 37,  /* Thaa */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_THAI         = 38,  /* Thai */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_TIBETAN      = 39,  /* Tibt */
jpayne@69:       /** Canadian_Aboriginal script. @stable ICU 2.6 */
jpayne@69:       USCRIPT_CANADIAN_ABORIGINAL = 40,  /* Cans */
jpayne@69:       /** Canadian_Aboriginal script (alias). @stable ICU 2.2 */
jpayne@69:       USCRIPT_UCAS         = USCRIPT_CANADIAN_ABORIGINAL,
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_YI           = 41,  /* Yiii */
jpayne@69:       /* New scripts in Unicode 3.2 */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_TAGALOG      = 42,  /* Tglg */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_HANUNOO      = 43,  /* Hano */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_BUHID        = 44,  /* Buhd */
jpayne@69:       /** @stable ICU 2.2 */
jpayne@69:       USCRIPT_TAGBANWA     = 45,  /* Tagb */
jpayne@69: 
jpayne@69:       /* New scripts in Unicode 4 */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_BRAILLE      = 46,  /* Brai */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_CYPRIOT      = 47,  /* Cprt */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_LIMBU        = 48,  /* Limb */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_LINEAR_B     = 49,  /* Linb */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_OSMANYA      = 50,  /* Osma */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_SHAVIAN      = 51,  /* Shaw */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_TAI_LE       = 52,  /* Tale */
jpayne@69:       /** @stable ICU 2.6 */
jpayne@69:       USCRIPT_UGARITIC     = 53,  /* Ugar */
jpayne@69: 
jpayne@69:       /** New script code in Unicode 4.0.1 @stable ICU 3.0 */
jpayne@69:       USCRIPT_KATAKANA_OR_HIRAGANA = 54,/*Hrkt */
jpayne@69: 
jpayne@69:       /* New scripts in Unicode 4.1 */
jpayne@69:       /** @stable ICU 3.4 */
jpayne@69:       USCRIPT_BUGINESE      = 55, /* Bugi */
jpayne@69:       /** @stable ICU 3.4 */
jpayne@69:       USCRIPT_GLAGOLITIC    = 56, /* Glag */
jpayne@69:       /** @stable ICU 3.4 */
jpayne@69:       USCRIPT_KHAROSHTHI    = 57, /* Khar */
jpayne@69:       /** @stable ICU 3.4 */
jpayne@69:       USCRIPT_SYLOTI_NAGRI  = 58, /* Sylo */
jpayne@69:       /** @stable ICU 3.4 */
jpayne@69:       USCRIPT_NEW_TAI_LUE   = 59, /* Talu */
jpayne@69:       /** @stable ICU 3.4 */
jpayne@69:       USCRIPT_TIFINAGH      = 60, /* Tfng */
jpayne@69:       /** @stable ICU 3.4 */
jpayne@69:       USCRIPT_OLD_PERSIAN   = 61, /* Xpeo */
jpayne@69: 
jpayne@69:       /* New script codes from Unicode and ISO 15924 */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_BALINESE                      = 62, /* Bali */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_BATAK                         = 63, /* Batk */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_BLISSYMBOLS                   = 64, /* Blis */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_BRAHMI                        = 65, /* Brah */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_CHAM                          = 66, /* Cham */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_CIRTH                         = 67, /* Cirt */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_OLD_CHURCH_SLAVONIC_CYRILLIC  = 68, /* Cyrs */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_DEMOTIC_EGYPTIAN              = 69, /* Egyd */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_HIERATIC_EGYPTIAN             = 70, /* Egyh */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_EGYPTIAN_HIEROGLYPHS          = 71, /* Egyp */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_KHUTSURI                      = 72, /* Geok */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_SIMPLIFIED_HAN                = 73, /* Hans */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_TRADITIONAL_HAN               = 74, /* Hant */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_PAHAWH_HMONG                  = 75, /* Hmng */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_OLD_HUNGARIAN                 = 76, /* Hung */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_HARAPPAN_INDUS                = 77, /* Inds */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_JAVANESE                      = 78, /* Java */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_KAYAH_LI                      = 79, /* Kali */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_LATIN_FRAKTUR                 = 80, /* Latf */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_LATIN_GAELIC                  = 81, /* Latg */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_LEPCHA                        = 82, /* Lepc */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_LINEAR_A                      = 83, /* Lina */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_MANDAIC                       = 84, /* Mand */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_MANDAEAN                      = USCRIPT_MANDAIC,
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_MAYAN_HIEROGLYPHS             = 85, /* Maya */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_MEROITIC_HIEROGLYPHS          = 86, /* Mero */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_MEROITIC                      = USCRIPT_MEROITIC_HIEROGLYPHS,
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_NKO                           = 87, /* Nkoo */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_ORKHON                        = 88, /* Orkh */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_OLD_PERMIC                    = 89, /* Perm */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_PHAGS_PA                      = 90, /* Phag */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_PHOENICIAN                    = 91, /* Phnx */
jpayne@69:       /** @stable ICU 52 */
jpayne@69:       USCRIPT_MIAO                          = 92, /* Plrd */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_PHONETIC_POLLARD              = USCRIPT_MIAO,
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_RONGORONGO                    = 93, /* Roro */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_SARATI                        = 94, /* Sara */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_ESTRANGELO_SYRIAC             = 95, /* Syre */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_WESTERN_SYRIAC                = 96, /* Syrj */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_EASTERN_SYRIAC                = 97, /* Syrn */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_TENGWAR                       = 98, /* Teng */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_VAI                           = 99, /* Vaii */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_VISIBLE_SPEECH                = 100,/* Visp */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_CUNEIFORM                     = 101,/* Xsux */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_UNWRITTEN_LANGUAGES           = 102,/* Zxxx */
jpayne@69:       /** @stable ICU 3.6 */
jpayne@69:       USCRIPT_UNKNOWN                       = 103,/* Zzzz */ /* Unknown="Code for uncoded script", for unassigned code points */
jpayne@69: 
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_CARIAN                        = 104,/* Cari */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_JAPANESE                      = 105,/* Jpan */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_LANNA                         = 106,/* Lana */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_LYCIAN                        = 107,/* Lyci */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_LYDIAN                        = 108,/* Lydi */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_OL_CHIKI                      = 109,/* Olck */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_REJANG                        = 110,/* Rjng */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_SAURASHTRA                    = 111,/* Saur */
jpayne@69:       /** Sutton SignWriting @stable ICU 3.8 */
jpayne@69:       USCRIPT_SIGN_WRITING                  = 112,/* Sgnw */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_SUNDANESE                     = 113,/* Sund */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_MOON                          = 114,/* Moon */
jpayne@69:       /** @stable ICU 3.8 */
jpayne@69:       USCRIPT_MEITEI_MAYEK                  = 115,/* Mtei */
jpayne@69: 
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_IMPERIAL_ARAMAIC              = 116,/* Armi */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_AVESTAN                       = 117,/* Avst */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_CHAKMA                        = 118,/* Cakm */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_KOREAN                        = 119,/* Kore */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_KAITHI                        = 120,/* Kthi */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_MANICHAEAN                    = 121,/* Mani */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_INSCRIPTIONAL_PAHLAVI         = 122,/* Phli */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_PSALTER_PAHLAVI               = 123,/* Phlp */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_BOOK_PAHLAVI                  = 124,/* Phlv */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_INSCRIPTIONAL_PARTHIAN        = 125,/* Prti */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_SAMARITAN                     = 126,/* Samr */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_TAI_VIET                      = 127,/* Tavt */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_MATHEMATICAL_NOTATION         = 128,/* Zmth */
jpayne@69:       /** @stable ICU 4.0 */
jpayne@69:       USCRIPT_SYMBOLS                       = 129,/* Zsym */
jpayne@69: 
jpayne@69:       /** @stable ICU 4.4 */
jpayne@69:       USCRIPT_BAMUM                         = 130,/* Bamu */
jpayne@69:       /** @stable ICU 4.4 */
jpayne@69:       USCRIPT_LISU                          = 131,/* Lisu */
jpayne@69:       /** @stable ICU 4.4 */
jpayne@69:       USCRIPT_NAKHI_GEBA                    = 132,/* Nkgb */
jpayne@69:       /** @stable ICU 4.4 */
jpayne@69:       USCRIPT_OLD_SOUTH_ARABIAN             = 133,/* Sarb */
jpayne@69: 
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_BASSA_VAH                     = 134,/* Bass */
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_DUPLOYAN                      = 135,/* Dupl */
jpayne@69: #ifndef U_HIDE_DEPRECATED_API
jpayne@69:       /** @deprecated ICU 54 Typo, use USCRIPT_DUPLOYAN */
jpayne@69:       USCRIPT_DUPLOYAN_SHORTAND             = USCRIPT_DUPLOYAN,
jpayne@69: #endif  /* U_HIDE_DEPRECATED_API */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_ELBASAN                       = 136,/* Elba */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_GRANTHA                       = 137,/* Gran */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_KPELLE                        = 138,/* Kpel */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_LOMA                          = 139,/* Loma */
jpayne@69:       /** Mende Kikakui @stable ICU 4.6 */
jpayne@69:       USCRIPT_MENDE                         = 140,/* Mend */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_MEROITIC_CURSIVE              = 141,/* Merc */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_OLD_NORTH_ARABIAN             = 142,/* Narb */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_NABATAEAN                     = 143,/* Nbat */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_PALMYRENE                     = 144,/* Palm */
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_KHUDAWADI                     = 145,/* Sind */
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_SINDHI                        = USCRIPT_KHUDAWADI,
jpayne@69:       /** @stable ICU 4.6 */
jpayne@69:       USCRIPT_WARANG_CITI                   = 146,/* Wara */
jpayne@69: 
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_AFAKA                         = 147,/* Afak */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_JURCHEN                       = 148,/* Jurc */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_MRO                           = 149,/* Mroo */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_NUSHU                         = 150,/* Nshu */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_SHARADA                       = 151,/* Shrd */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_SORA_SOMPENG                  = 152,/* Sora */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_TAKRI                         = 153,/* Takr */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_TANGUT                        = 154,/* Tang */
jpayne@69:       /** @stable ICU 4.8 */
jpayne@69:       USCRIPT_WOLEAI                        = 155,/* Wole */
jpayne@69: 
jpayne@69:       /** @stable ICU 49 */
jpayne@69:       USCRIPT_ANATOLIAN_HIEROGLYPHS         = 156,/* Hluw */
jpayne@69:       /** @stable ICU 49 */
jpayne@69:       USCRIPT_KHOJKI                        = 157,/* Khoj */
jpayne@69:       /** @stable ICU 49 */
jpayne@69:       USCRIPT_TIRHUTA                       = 158,/* Tirh */
jpayne@69: 
jpayne@69:       /** @stable ICU 52 */
jpayne@69:       USCRIPT_CAUCASIAN_ALBANIAN            = 159,/* Aghb */
jpayne@69:       /** @stable ICU 52 */
jpayne@69:       USCRIPT_MAHAJANI                      = 160,/* Mahj */
jpayne@69: 
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_AHOM                          = 161,/* Ahom */
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_HATRAN                        = 162,/* Hatr */
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_MODI                          = 163,/* Modi */
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_MULTANI                       = 164,/* Mult */
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_PAU_CIN_HAU                   = 165,/* Pauc */
jpayne@69:       /** @stable ICU 54 */
jpayne@69:       USCRIPT_SIDDHAM                       = 166,/* Sidd */
jpayne@69: 
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_ADLAM                         = 167,/* Adlm */
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_BHAIKSUKI                     = 168,/* Bhks */
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_MARCHEN                       = 169,/* Marc */
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_NEWA                          = 170,/* Newa */
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_OSAGE                         = 171,/* Osge */
jpayne@69: 
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_HAN_WITH_BOPOMOFO             = 172,/* Hanb */
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_JAMO                          = 173,/* Jamo */
jpayne@69:       /** @stable ICU 58 */
jpayne@69:       USCRIPT_SYMBOLS_EMOJI                 = 174,/* Zsye */
jpayne@69: 
jpayne@69:       /** @stable ICU 60 */
jpayne@69:       USCRIPT_MASARAM_GONDI                 = 175,/* Gonm */
jpayne@69:       /** @stable ICU 60 */
jpayne@69:       USCRIPT_SOYOMBO                       = 176,/* Soyo */
jpayne@69:       /** @stable ICU 60 */
jpayne@69:       USCRIPT_ZANABAZAR_SQUARE              = 177,/* Zanb */
jpayne@69: 
jpayne@69:       /** @stable ICU 62 */
jpayne@69:       USCRIPT_DOGRA                         = 178,/* Dogr */
jpayne@69:       /** @stable ICU 62 */
jpayne@69:       USCRIPT_GUNJALA_GONDI                 = 179,/* Gong */
jpayne@69:       /** @stable ICU 62 */
jpayne@69:       USCRIPT_MAKASAR                       = 180,/* Maka */
jpayne@69:       /** @stable ICU 62 */
jpayne@69:       USCRIPT_MEDEFAIDRIN                   = 181,/* Medf */
jpayne@69:       /** @stable ICU 62 */
jpayne@69:       USCRIPT_HANIFI_ROHINGYA               = 182,/* Rohg */
jpayne@69:       /** @stable ICU 62 */
jpayne@69:       USCRIPT_SOGDIAN                       = 183,/* Sogd */
jpayne@69:       /** @stable ICU 62 */
jpayne@69:       USCRIPT_OLD_SOGDIAN                   = 184,/* Sogo */
jpayne@69: 
jpayne@69:       /** @stable ICU 64 */
jpayne@69:       USCRIPT_ELYMAIC                       = 185,/* Elym */
jpayne@69:       /** @stable ICU 64 */
jpayne@69:       USCRIPT_NYIAKENG_PUACHUE_HMONG        = 186,/* Hmnp */
jpayne@69:       /** @stable ICU 64 */
jpayne@69:       USCRIPT_NANDINAGARI                   = 187,/* Nand */
jpayne@69:       /** @stable ICU 64 */
jpayne@69:       USCRIPT_WANCHO                        = 188,/* Wcho */
jpayne@69: 
jpayne@69:       /** @stable ICU 66 */
jpayne@69:       USCRIPT_CHORASMIAN                    = 189,/* Chrs */
jpayne@69:       /** @stable ICU 66 */
jpayne@69:       USCRIPT_DIVES_AKURU                   = 190,/* Diak */
jpayne@69:       /** @stable ICU 66 */
jpayne@69:       USCRIPT_KHITAN_SMALL_SCRIPT           = 191,/* Kits */
jpayne@69:       /** @stable ICU 66 */
jpayne@69:       USCRIPT_YEZIDI                        = 192,/* Yezi */
jpayne@69: 
jpayne@69: #ifndef U_HIDE_DEPRECATED_API
jpayne@69:     /**
jpayne@69:      * One more than the highest normal UScriptCode value.
jpayne@69:      * The highest value is available via u_getIntPropertyMaxValue(UCHAR_SCRIPT).
jpayne@69:      *
jpayne@69:      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
jpayne@69:      */
jpayne@69:     USCRIPT_CODE_LIMIT    = 193
jpayne@69: #endif  // U_HIDE_DEPRECATED_API
jpayne@69: } UScriptCode;
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Gets the script codes associated with the given locale or ISO 15924 abbreviation or name.
jpayne@69:  * Fills in USCRIPT_MALAYALAM given "Malayam" OR "Mlym".
jpayne@69:  * Fills in USCRIPT_LATIN given "en" OR "en_US"
jpayne@69:  * If the required capacity is greater than the capacity of the destination buffer,
jpayne@69:  * then the error code is set to U_BUFFER_OVERFLOW_ERROR and the required capacity is returned.
jpayne@69:  *
jpayne@69:  * <p>Note: To search by short or long script alias only, use
jpayne@69:  * u_getPropertyValueEnum(UCHAR_SCRIPT, alias) instead.  That does
jpayne@69:  * a fast lookup with no access of the locale data.
jpayne@69:  *
jpayne@69:  * @param nameOrAbbrOrLocale name of the script, as given in
jpayne@69:  * PropertyValueAliases.txt, or ISO 15924 code or locale
jpayne@69:  * @param fillIn the UScriptCode buffer to fill in the script code
jpayne@69:  * @param capacity the capacity (size) of UScriptCode buffer passed in.
jpayne@69:  * @param err the error status code.
jpayne@69:  * @return The number of script codes filled in the buffer passed in
jpayne@69:  * @stable ICU 2.4
jpayne@69:  */
jpayne@69: U_STABLE int32_t  U_EXPORT2
jpayne@69: uscript_getCode(const char* nameOrAbbrOrLocale,UScriptCode* fillIn,int32_t capacity,UErrorCode *err);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns the long Unicode script name, if there is one.
jpayne@69:  * Otherwise returns the 4-letter ISO 15924 script code.
jpayne@69:  * Returns "Malayam" given USCRIPT_MALAYALAM.
jpayne@69:  *
jpayne@69:  * @param scriptCode UScriptCode enum
jpayne@69:  * @return long script name as given in PropertyValueAliases.txt, or the 4-letter code,
jpayne@69:  * or NULL if scriptCode is invalid
jpayne@69:  * @stable ICU 2.4
jpayne@69:  */
jpayne@69: U_STABLE const char*  U_EXPORT2
jpayne@69: uscript_getName(UScriptCode scriptCode);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns the 4-letter ISO 15924 script code,
jpayne@69:  * which is the same as the short Unicode script name if Unicode has names for the script.
jpayne@69:  * Returns "Mlym" given USCRIPT_MALAYALAM.
jpayne@69:  *
jpayne@69:  * @param scriptCode UScriptCode enum
jpayne@69:  * @return short script name (4-letter code), or NULL if scriptCode is invalid
jpayne@69:  * @stable ICU 2.4
jpayne@69:  */
jpayne@69: U_STABLE const char*  U_EXPORT2
jpayne@69: uscript_getShortName(UScriptCode scriptCode);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Gets the script code associated with the given codepoint.
jpayne@69:  * Returns USCRIPT_MALAYALAM given 0x0D02
jpayne@69:  * @param codepoint UChar32 codepoint
jpayne@69:  * @param err the error status code.
jpayne@69:  * @return The UScriptCode, or 0 if codepoint is invalid
jpayne@69:  * @stable ICU 2.4
jpayne@69:  */
jpayne@69: U_STABLE UScriptCode  U_EXPORT2
jpayne@69: uscript_getScript(UChar32 codepoint, UErrorCode *err);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Do the Script_Extensions of code point c contain script sc?
jpayne@69:  * If c does not have explicit Script_Extensions, then this tests whether
jpayne@69:  * c has the Script property value sc.
jpayne@69:  *
jpayne@69:  * Some characters are commonly used in multiple scripts.
jpayne@69:  * For more information, see UAX #24: http://www.unicode.org/reports/tr24/.
jpayne@69:  * @param c code point
jpayne@69:  * @param sc script code
jpayne@69:  * @return TRUE if sc is in Script_Extensions(c)
jpayne@69:  * @stable ICU 49
jpayne@69:  */
jpayne@69: U_STABLE UBool U_EXPORT2
jpayne@69: uscript_hasScript(UChar32 c, UScriptCode sc);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Writes code point c's Script_Extensions as a list of UScriptCode values
jpayne@69:  * to the output scripts array and returns the number of script codes.
jpayne@69:  * - If c does have Script_Extensions, then the Script property value
jpayne@69:  *   (normally Common or Inherited) is not included.
jpayne@69:  * - If c does not have Script_Extensions, then the one Script code is written to the output array.
jpayne@69:  * - If c is not a valid code point, then the one USCRIPT_UNKNOWN code is written.
jpayne@69:  * In other words, if the return value is 1,
jpayne@69:  * then the output array contains exactly c's single Script code.
jpayne@69:  * If the return value is n>=2, then the output array contains c's n Script_Extensions script codes.
jpayne@69:  *
jpayne@69:  * Some characters are commonly used in multiple scripts.
jpayne@69:  * For more information, see UAX #24: http://www.unicode.org/reports/tr24/.
jpayne@69:  *
jpayne@69:  * If there are more than capacity script codes to be written, then
jpayne@69:  * U_BUFFER_OVERFLOW_ERROR is set and the number of Script_Extensions is returned.
jpayne@69:  * (Usual ICU buffer handling behavior.)
jpayne@69:  *
jpayne@69:  * @param c code point
jpayne@69:  * @param scripts output script code array
jpayne@69:  * @param capacity capacity of the scripts array
jpayne@69:  * @param errorCode Standard ICU error code. Its input value must
jpayne@69:  *                  pass the U_SUCCESS() test, or else the function returns
jpayne@69:  *                  immediately. Check for U_FAILURE() on output or use with
jpayne@69:  *                  function chaining. (See User Guide for details.)
jpayne@69:  * @return number of script codes in c's Script_Extensions, or 1 for the single Script value,
jpayne@69:  *         written to scripts unless U_BUFFER_OVERFLOW_ERROR indicates insufficient capacity
jpayne@69:  * @stable ICU 49
jpayne@69:  */
jpayne@69: U_STABLE int32_t U_EXPORT2
jpayne@69: uscript_getScriptExtensions(UChar32 c,
jpayne@69:                             UScriptCode *scripts, int32_t capacity,
jpayne@69:                             UErrorCode *errorCode);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Script usage constants.
jpayne@69:  * See UAX #31 Unicode Identifier and Pattern Syntax.
jpayne@69:  * http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Exclusion_from_Identifiers
jpayne@69:  *
jpayne@69:  * @stable ICU 51
jpayne@69:  */
jpayne@69: typedef enum UScriptUsage {
jpayne@69:     /** Not encoded in Unicode. @stable ICU 51 */
jpayne@69:     USCRIPT_USAGE_NOT_ENCODED,
jpayne@69:     /** Unknown script usage. @stable ICU 51 */
jpayne@69:     USCRIPT_USAGE_UNKNOWN,
jpayne@69:     /** Candidate for Exclusion from Identifiers. @stable ICU 51 */
jpayne@69:     USCRIPT_USAGE_EXCLUDED,
jpayne@69:     /** Limited Use script. @stable ICU 51 */
jpayne@69:     USCRIPT_USAGE_LIMITED_USE,
jpayne@69:     /** Aspirational Use script. @stable ICU 51 */
jpayne@69:     USCRIPT_USAGE_ASPIRATIONAL,
jpayne@69:     /** Recommended script. @stable ICU 51 */
jpayne@69:     USCRIPT_USAGE_RECOMMENDED
jpayne@69: } UScriptUsage;
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Writes the script sample character string.
jpayne@69:  * This string normally consists of one code point but might be longer.
jpayne@69:  * The string is empty if the script is not encoded.
jpayne@69:  *
jpayne@69:  * @param script script code
jpayne@69:  * @param dest output string array
jpayne@69:  * @param capacity number of UChars in the dest array
jpayne@69:  * @param pErrorCode standard ICU in/out error code, must pass U_SUCCESS() on input
jpayne@69:  * @return the string length, even if U_BUFFER_OVERFLOW_ERROR
jpayne@69:  * @stable ICU 51
jpayne@69:  */
jpayne@69: U_STABLE int32_t U_EXPORT2
jpayne@69: uscript_getSampleString(UScriptCode script, UChar *dest, int32_t capacity, UErrorCode *pErrorCode);
jpayne@69: 
jpayne@69: #if U_SHOW_CPLUSPLUS_API
jpayne@69: 
jpayne@69: U_NAMESPACE_BEGIN
jpayne@69: class UnicodeString;
jpayne@69: U_NAMESPACE_END
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns the script sample character string.
jpayne@69:  * This string normally consists of one code point but might be longer.
jpayne@69:  * The string is empty if the script is not encoded.
jpayne@69:  *
jpayne@69:  * @param script script code
jpayne@69:  * @return the sample character string
jpayne@69:  * @stable ICU 51
jpayne@69:  */
jpayne@69: U_COMMON_API icu::UnicodeString U_EXPORT2
jpayne@69: uscript_getSampleUnicodeString(UScriptCode script);
jpayne@69: 
jpayne@69: #endif
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns the script usage according to UAX #31 Unicode Identifier and Pattern Syntax.
jpayne@69:  * Returns USCRIPT_USAGE_NOT_ENCODED if the script is not encoded in Unicode.
jpayne@69:  *
jpayne@69:  * @param script script code
jpayne@69:  * @return script usage
jpayne@69:  * @see UScriptUsage
jpayne@69:  * @stable ICU 51
jpayne@69:  */
jpayne@69: U_STABLE UScriptUsage U_EXPORT2
jpayne@69: uscript_getUsage(UScriptCode script);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns TRUE if the script is written right-to-left.
jpayne@69:  * For example, Arab and Hebr.
jpayne@69:  *
jpayne@69:  * @param script script code
jpayne@69:  * @return TRUE if the script is right-to-left
jpayne@69:  * @stable ICU 51
jpayne@69:  */
jpayne@69: U_STABLE UBool U_EXPORT2
jpayne@69: uscript_isRightToLeft(UScriptCode script);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns TRUE if the script allows line breaks between letters (excluding hyphenation).
jpayne@69:  * Such a script typically requires dictionary-based line breaking.
jpayne@69:  * For example, Hani and Thai.
jpayne@69:  *
jpayne@69:  * @param script script code
jpayne@69:  * @return TRUE if the script allows line breaks between letters
jpayne@69:  * @stable ICU 51
jpayne@69:  */
jpayne@69: U_STABLE UBool U_EXPORT2
jpayne@69: uscript_breaksBetweenLetters(UScriptCode script);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns TRUE if in modern (or most recent) usage of the script case distinctions are customary.
jpayne@69:  * For example, Latn and Cyrl.
jpayne@69:  *
jpayne@69:  * @param script script code
jpayne@69:  * @return TRUE if the script is cased
jpayne@69:  * @stable ICU 51
jpayne@69:  */
jpayne@69: U_STABLE UBool U_EXPORT2
jpayne@69: uscript_isCased(UScriptCode script);
jpayne@69: 
jpayne@69: #endif