Update ICU to 54.1 step 1

source/common/unicode/uscript.h

 /*
  **********************************************************************
- *   Copyright (C) 1997-2013, International Business Machines
+ *   Copyright (C) 1997-2014, International Business Machines
  *   Corporation and others.  All Rights Reserved.
  **********************************************************************
  *
  * File USCRIPT.H
  *
  * Modification History:
  *
  *   Date        Name        Description
  *   07/06/2001    Ram         Creation.
  ******************************************************************************
@@ skipping 165 matching lines @@
       USCRIPT_KHAROSHTHI    = 57, /* Khar */
       /** @stable ICU 3.4 */
       USCRIPT_SYLOTI_NAGRI  = 58, /* Sylo */
       /** @stable ICU 3.4 */
       USCRIPT_NEW_TAI_LUE   = 59, /* Talu */
       /** @stable ICU 3.4 */
       USCRIPT_TIFINAGH      = 60, /* Tfng */
       /** @stable ICU 3.4 */
       USCRIPT_OLD_PERSIAN   = 61, /* Xpeo */
 
-      /* New script codes from ISO 15924 */
+      /* New script codes from Unicode and ISO 15924 */
       /** @stable ICU 3.6 */
       USCRIPT_BALINESE                      = 62, /* Bali */
       /** @stable ICU 3.6 */
       USCRIPT_BATAK                         = 63, /* Batk */
       /** @stable ICU 3.6 */
       USCRIPT_BLISSYMBOLS                   = 64, /* Blis */
       /** @stable ICU 3.6 */
       USCRIPT_BRAHMI                        = 65, /* Brah */
       /** @stable ICU 3.6 */
       USCRIPT_CHAM                          = 66, /* Cham */
@@ skipping 71 matching lines @@
       USCRIPT_VAI                           = 99, /* Vaii */
       /** @stable ICU 3.6 */
       USCRIPT_VISIBLE_SPEECH                = 100,/* Visp */
       /** @stable ICU 3.6 */
       USCRIPT_CUNEIFORM                     = 101,/* Xsux */
       /** @stable ICU 3.6 */
       USCRIPT_UNWRITTEN_LANGUAGES           = 102,/* Zxxx */
       /** @stable ICU 3.6 */
       USCRIPT_UNKNOWN                       = 103,/* Zzzz */ /* Unknown="Code for uncoded script", for unassigned code points */
 
-      /* New script codes from ISO 15924 */
       /** @stable ICU 3.8 */
       USCRIPT_CARIAN                        = 104,/* Cari */
       /** @stable ICU 3.8 */
       USCRIPT_JAPANESE                      = 105,/* Jpan */
       /** @stable ICU 3.8 */
       USCRIPT_LANNA                         = 106,/* Lana */
       /** @stable ICU 3.8 */
       USCRIPT_LYCIAN                        = 107,/* Lyci */
       /** @stable ICU 3.8 */
       USCRIPT_LYDIAN                        = 108,/* Lydi */
       /** @stable ICU 3.8 */
       USCRIPT_OL_CHIKI                      = 109,/* Olck */
       /** @stable ICU 3.8 */
       USCRIPT_REJANG                        = 110,/* Rjng */
       /** @stable ICU 3.8 */
       USCRIPT_SAURASHTRA                    = 111,/* Saur */
       /** @stable ICU 3.8 */
       USCRIPT_SIGN_WRITING                  = 112,/* Sgnw */
       /** @stable ICU 3.8 */
       USCRIPT_SUNDANESE                     = 113,/* Sund */
       /** @stable ICU 3.8 */
       USCRIPT_MOON                          = 114,/* Moon */
       /** @stable ICU 3.8 */
       USCRIPT_MEITEI_MAYEK                  = 115,/* Mtei */
 
-      /* New script codes from ISO 15924 */
       /** @stable ICU 4.0 */
       USCRIPT_IMPERIAL_ARAMAIC              = 116,/* Armi */
       /** @stable ICU 4.0 */
       USCRIPT_AVESTAN                       = 117,/* Avst */
       /** @stable ICU 4.0 */
       USCRIPT_CHAKMA                        = 118,/* Cakm */
       /** @stable ICU 4.0 */
       USCRIPT_KOREAN                        = 119,/* Kore */
       /** @stable ICU 4.0 */
       USCRIPT_KAITHI                        = 120,/* Kthi */
       /** @stable ICU 4.0 */
       USCRIPT_MANICHAEAN                    = 121,/* Mani */
       /** @stable ICU 4.0 */
       USCRIPT_INSCRIPTIONAL_PAHLAVI         = 122,/* Phli */
       /** @stable ICU 4.0 */
       USCRIPT_PSALTER_PAHLAVI               = 123,/* Phlp */
       /** @stable ICU 4.0 */
       USCRIPT_BOOK_PAHLAVI                  = 124,/* Phlv */
       /** @stable ICU 4.0 */
       USCRIPT_INSCRIPTIONAL_PARTHIAN        = 125,/* Prti */
       /** @stable ICU 4.0 */
       USCRIPT_SAMARITAN                     = 126,/* Samr */
       /** @stable ICU 4.0 */
       USCRIPT_TAI_VIET                      = 127,/* Tavt */
       /** @stable ICU 4.0 */
       USCRIPT_MATHEMATICAL_NOTATION         = 128,/* Zmth */
       /** @stable ICU 4.0 */
       USCRIPT_SYMBOLS                       = 129,/* Zsym */
 
-      /* New script codes from ISO 15924 */
       /** @stable ICU 4.4 */
       USCRIPT_BAMUM                         = 130,/* Bamu */
       /** @stable ICU 4.4 */
       USCRIPT_LISU                          = 131,/* Lisu */
       /** @stable ICU 4.4 */
       USCRIPT_NAKHI_GEBA                    = 132,/* Nkgb */
       /** @stable ICU 4.4 */
       USCRIPT_OLD_SOUTH_ARABIAN             = 133,/* Sarb */
 
-      /* New script codes from ISO 15924 */
       /** @stable ICU 4.6 */
       USCRIPT_BASSA_VAH                     = 134,/* Bass */
-      /** @stable ICU 4.6 */
-      USCRIPT_DUPLOYAN_SHORTAND             = 135,/* Dupl */
+      /** @stable ICU 54 */
+      USCRIPT_DUPLOYAN                      = 135,/* Dupl */
+#ifndef U_HIDE_DEPRECATED_API
+      /** @deprecated ICU 54 Typo, use USCRIPT_DUPLOYAN */
+      USCRIPT_DUPLOYAN_SHORTAND             = USCRIPT_DUPLOYAN,
+#endif  /* U_HIDE_DEPRECATED_API */
       /** @stable ICU 4.6 */
       USCRIPT_ELBASAN                       = 136,/* Elba */
       /** @stable ICU 4.6 */
       USCRIPT_GRANTHA                       = 137,/* Gran */
       /** @stable ICU 4.6 */
       USCRIPT_KPELLE                        = 138,/* Kpel */
       /** @stable ICU 4.6 */
       USCRIPT_LOMA                          = 139,/* Loma */
-      /** @stable ICU 4.6 */
+      /** Mende Kikakui @stable ICU 4.6 */
       USCRIPT_MENDE                         = 140,/* Mend */
       /** @stable ICU 4.6 */
       USCRIPT_MEROITIC_CURSIVE              = 141,/* Merc */
       /** @stable ICU 4.6 */
       USCRIPT_OLD_NORTH_ARABIAN             = 142,/* Narb */
       /** @stable ICU 4.6 */
       USCRIPT_NABATAEAN                     = 143,/* Nbat */
       /** @stable ICU 4.6 */
       USCRIPT_PALMYRENE                     = 144,/* Palm */
+      /** @stable ICU 54 */
+      USCRIPT_KHUDAWADI                     = 145,/* Sind */
       /** @stable ICU 4.6 */
-      USCRIPT_SINDHI                        = 145,/* Sind */
+      USCRIPT_SINDHI                        = USCRIPT_KHUDAWADI,
       /** @stable ICU 4.6 */
       USCRIPT_WARANG_CITI                   = 146,/* Wara */
 
       /** @stable ICU 4.8 */
       USCRIPT_AFAKA                         = 147,/* Afak */
       /** @stable ICU 4.8 */
       USCRIPT_JURCHEN                       = 148,/* Jurc */
       /** @stable ICU 4.8 */
       USCRIPT_MRO                           = 149,/* Mroo */
       /** @stable ICU 4.8 */
@@ skipping 14 matching lines @@
       /** @stable ICU 49 */
       USCRIPT_KHOJKI                        = 157,/* Khoj */
       /** @stable ICU 49 */
       USCRIPT_TIRHUTA                       = 158,/* Tirh */
 
       /** @stable ICU 52 */
       USCRIPT_CAUCASIAN_ALBANIAN            = 159,/* Aghb */
       /** @stable ICU 52 */
       USCRIPT_MAHAJANI                      = 160,/* Mahj */
 
+      /** @stable ICU 54 */
+      USCRIPT_AHOM                          = 161,/* Ahom */
+      /** @stable ICU 54 */
+      USCRIPT_HATRAN                        = 162,/* Hatr */
+      /** @stable ICU 54 */
+      USCRIPT_MODI                          = 163,/* Modi */
+      /** @stable ICU 54 */
+      USCRIPT_MULTANI                       = 164,/* Mult */
+      /** @stable ICU 54 */
+      USCRIPT_PAU_CIN_HAU                   = 165,/* Pauc */
+      /** @stable ICU 54 */
+      USCRIPT_SIDDHAM                       = 166,/* Sidd */
+
       /* Private use codes from Qaaa - Qabx are not supported */
 
       /** @stable ICU 2.2 */
-      USCRIPT_CODE_LIMIT    = 161
+      USCRIPT_CODE_LIMIT    = 167
 } UScriptCode;
 
 /**
- * Gets script codes associated with the given locale or ISO 15924 abbreviation or name. 
+ * Gets the script codes associated with the given locale or ISO 15924 abbreviation or name. 
  * Fills in USCRIPT_MALAYALAM given "Malayam" OR "Mlym".
  * Fills in USCRIPT_LATIN given "en" OR "en_US" 
- * If required capacity is greater than capacity of the destination buffer then the error code
- * is set to U_BUFFER_OVERFLOW_ERROR and the required capacity is returned
+ * If the required capacity is greater than the capacity of the destination buffer,
+ * then the error code is set to U_BUFFER_OVERFLOW_ERROR and the required capacity is returned.
  *
  * <p>Note: To search by short or long script alias only, use
- * u_getPropertyValueEnum(UCHAR_SCRIPT, alias) instead.  This does
+ * u_getPropertyValueEnum(UCHAR_SCRIPT, alias) instead.  That does
  * a fast lookup with no access of the locale data.
+ *
  * @param nameOrAbbrOrLocale name of the script, as given in
  * PropertyValueAliases.txt, or ISO 15924 code or locale
  * @param fillIn the UScriptCode buffer to fill in the script code
  * @param capacity the capacity (size) fo UScriptCode buffer passed in.
  * @param err the error status code.
  * @return The number of script codes filled in the buffer passed in 
  * @stable ICU 2.4
  */
 U_STABLE int32_t  U_EXPORT2 
 uscript_getCode(const char* nameOrAbbrOrLocale,UScriptCode* fillIn,int32_t capacity,UErrorCode *err);
 
 /**
- * Gets a script name associated with the given script code. 
- * Returns  "Malayam" given USCRIPT_MALAYALAM
+ * Returns the long Unicode script name, if there is one.
+ * Otherwise returns the 4-letter ISO 15924 script code.
+ * Returns "Malayam" given USCRIPT_MALAYALAM.
+ *
  * @param scriptCode UScriptCode enum
- * @return script long name as given in
- * PropertyValueAliases.txt, or NULL if scriptCode is invalid
+ * @return long script name as given in PropertyValueAliases.txt, or the 4-letter code,
+ * or NULL if scriptCode is invalid
  * @stable ICU 2.4
  */
 U_STABLE const char*  U_EXPORT2 
 uscript_getName(UScriptCode scriptCode);
 
 /**
- * Gets a script name associated with the given script code. 
- * Returns  "Mlym" given USCRIPT_MALAYALAM
+ * Returns the 4-letter ISO 15924 script code,
+ * which is the same as the short Unicode script name if Unicode has names for the script.
+ * Returns "Mlym" given USCRIPT_MALAYALAM.
+ *
  * @param scriptCode UScriptCode enum
- * @return script abbreviated name as given in
- * PropertyValueAliases.txt, or NULL if scriptCode is invalid
+ * @return short script name (4-letter code), or NULL if scriptCode is invalid
  * @stable ICU 2.4
  */
 U_STABLE const char*  U_EXPORT2 
 uscript_getShortName(UScriptCode scriptCode);
 
 /**
  * Gets the script code associated with the given codepoint.
  * Returns USCRIPT_MALAYALAM given 0x0D02 
  * @param codepoint UChar32 codepoint
  * @param err the error status code.
@@ skipping 50 matching lines @@
  *                  function chaining. (See User Guide for details.)
  * @return number of script codes in c's Script_Extensions, or 1 for the single Script value,
  *         written to scripts unless U_BUFFER_OVERFLOW_ERROR indicates insufficient capacity
  * @stable ICU 49
  */
 U_STABLE int32_t U_EXPORT2
 uscript_getScriptExtensions(UChar32 c,
                             UScriptCode *scripts, int32_t capacity,
                             UErrorCode *errorCode);
 
-#ifndef U_HIDE_DRAFT_API
-
 /**
  * Script usage constants.
  * See UAX #31 Unicode Identifier and Pattern Syntax.
  * http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Exclusion_from_Identifiers
  *
- * @draft ICU 51
+ * @stable ICU 51
  */
 typedef enum UScriptUsage {
-    /** Not encoded in Unicode. @draft ICU 51 */
+    /** Not encoded in Unicode. @stable ICU 51 */
     USCRIPT_USAGE_NOT_ENCODED,
-    /** Unknown script usage. @draft ICU 51 */
+    /** Unknown script usage. @stable ICU 51 */
     USCRIPT_USAGE_UNKNOWN,
-    /** Candidate for Exclusion from Identifiers. @draft ICU 51 */
+    /** Candidate for Exclusion from Identifiers. @stable ICU 51 */
     USCRIPT_USAGE_EXCLUDED,
-    /** Limited Use script. @draft ICU 51 */
+    /** Limited Use script. @stable ICU 51 */
     USCRIPT_USAGE_LIMITED_USE,
-    /** Aspirational Use script. @draft ICU 51 */
+    /** Aspirational Use script. @stable ICU 51 */
     USCRIPT_USAGE_ASPIRATIONAL,
-    /** Recommended script. @draft ICU 51 */
+    /** Recommended script. @stable ICU 51 */
     USCRIPT_USAGE_RECOMMENDED
 } UScriptUsage;
 
 /**
  * Writes the script sample character string.
  * This string normally consists of one code point but might be longer.
  * The string is empty if the script is not encoded.
  *
  * @param script script code
  * @param dest output string array
  * @param capacity number of UChars in the dest array
  * @param pErrorCode standard ICU in/out error code, must pass U_SUCCESS() on input
  * @return the string length, even if U_BUFFER_OVERFLOW_ERROR
- * @draft ICU 51
+ * @stable ICU 51
  */
-U_DRAFT int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
 uscript_getSampleString(UScriptCode script, UChar *dest, int32_t capacity, UErrorCode *pErrorCode);
 
 #if U_SHOW_CPLUSPLUS_API
 
 U_NAMESPACE_BEGIN
 class UnicodeString;
 U_NAMESPACE_END
 
 /**
  * Returns the script sample character string.
  * This string normally consists of one code point but might be longer.
  * The string is empty if the script is not encoded.
  *
  * @param script script code
  * @return the sample character string
- * @draft ICU 51
+ * @stable ICU 51
  */
 U_COMMON_API icu::UnicodeString U_EXPORT2
 uscript_getSampleUnicodeString(UScriptCode script);
 
 #endif
 
 /**
  * Returns the script usage according to UAX #31 Unicode Identifier and Pattern Syntax.
  * Returns USCRIPT_USAGE_NOT_ENCODED if the script is not encoded in Unicode.
  *
  * @param script script code
  * @return script usage
  * @see UScriptUsage
- * @draft ICU 51
+ * @stable ICU 51
  */
-U_DRAFT UScriptUsage U_EXPORT2
+U_STABLE UScriptUsage U_EXPORT2
 uscript_getUsage(UScriptCode script);
 
 /**
  * Returns TRUE if the script is written right-to-left.
  * For example, Arab and Hebr.
  *
  * @param script script code
  * @return TRUE if the script is right-to-left
- * @draft ICU 51
+ * @stable ICU 51
  */
-U_DRAFT UBool U_EXPORT2
+U_STABLE UBool U_EXPORT2
 uscript_isRightToLeft(UScriptCode script);
 
 /**
  * Returns TRUE if the script allows line breaks between letters (excluding hyphenation).
  * Such a script typically requires dictionary-based line breaking.
  * For example, Hani and Thai.
  *
  * @param script script code
  * @return TRUE if the script allows line breaks between letters
- * @draft ICU 51
+ * @stable ICU 51
  */
-U_DRAFT UBool U_EXPORT2
+U_STABLE UBool U_EXPORT2
 uscript_breaksBetweenLetters(UScriptCode script);
 
 /**
  * Returns TRUE if in modern (or most recent) usage of the script case distinctions are customary.
  * For example, Latn and Cyrl.
  *
  * @param script script code
  * @return TRUE if the script is cased
- * @draft ICU 51
+ * @stable ICU 51
  */
-U_DRAFT UBool U_EXPORT2
+U_STABLE UBool U_EXPORT2
 uscript_isCased(UScriptCode script);
 
-#endif  /* U_HIDE_DRAFT_API */
-
 #endif