ICU 56 update step 1

source/common/unicode/uscript.h

 /*
  **********************************************************************
- *   Copyright (C) 1997-2014, International Business Machines
+ *   Copyright (C) 1997-2015, International Business Machines
  *   Corporation and others.  All Rights Reserved.
  **********************************************************************
  *
  * File USCRIPT.H
  *
  * Modification History:
  *
  *   Date        Name        Description
  *   07/06/2001    Ram         Creation.
  ******************************************************************************
  */
 
 #ifndef USCRIPT_H
 #define USCRIPT_H
 #include "unicode/utypes.h"
 
 /**
  * \file
  * \brief C API: Unicode Script Information
  */
- 
+
 /**
  * Constants for ISO 15924 script codes.
  *
- * Many of these script codes - those from Unicode's ScriptNames.txt -
- * are character property values for Unicode's Script property.
- * See UAX #24 Script Names (http://www.unicode.org/reports/tr24/).
+ * The current set of script code constants supports at least all scripts
+ * that are encoded in the version of Unicode which ICU currently supports.
+ * The names of the constants are usually derived from the
+ * Unicode script property value aliases.
+ * See UAX #24 Unicode Script Property (http://www.unicode.org/reports/tr24/)
+ * and http://www.unicode.org/Public/UCD/latest/ucd/PropertyValueAliases.txt .
  *
  * Starting with ICU 3.6, constants for most ISO 15924 script codes
- * are included (currently excluding private-use codes Qaaa..Qabx).
- * For scripts for which there are codes in ISO 15924 but which are not
- * used in the Unicode Character Database (UCD), there are no Unicode characters
- * associated with those scripts.
+ * are included, for use with language tags, CLDR data, and similar.
+ * Some of those codes are not used in the Unicode Character Database (UCD).
+ * For example, there are no characters that have a UCD script property value of
+ * Hans or Hant. All Han ideographs have the Hani script property value in Unicode.
  *
- * For example, there are no characters that have a UCD script code of
- * Hans or Hant. All Han ideographs have the Hani script code.
- * The Hans and Hant script codes are used with CLDR data.
+ * Private-use codes Qaaa..Qabx are not included.
  *
- * ISO 15924 script codes are included for use with CLDR and similar.
+ * Starting with ICU 55, script codes are only added when their scripts
+ * have been or will certainly be encoded in Unicode,
+ * and have been assigned Unicode script property value aliases,
+ * to ensure that their script names are stable and match the names of the constants.
+ * Script codes like Latf and Aran that are not subject to separate encoding
+ * may be added at any time.
  *
  * @stable ICU 2.2
  */
 typedef enum UScriptCode {
     /*
      * Note: UScriptCode constants and their ISO script code comments
      * are parsed by preparseucd.py.
      * It matches lines like
      *     USCRIPT_<Unicode Script value name> = <integer>,  / * <ISO script code> * /
      */
@@ skipping 234 matching lines @@
       /** @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 */
+      /** Sutton SignWriting @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 */
 
       /** @stable ICU 4.0 */
       USCRIPT_IMPERIAL_ARAMAIC              = 116,/* Armi */
@@ skipping 103 matching lines @@
       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 */
+      /**
+       * One higher than the last script code constant.
+       * This value increases as constants for script codes are added.
+       *
+       * There are constants for Unicode 7 script property values.
+       * There are constants for ISO 15924 script codes assigned on or before 2013-10-12.
+       * There are no constants for private use codes from Qaaa - Qabx
+       * except as used in the UCD.
+       *
+       * @stable ICU 2.2
+       */
       USCRIPT_CODE_LIMIT    = 167
 } UScriptCode;
 
 /**
  * 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 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.
  *
@@ skipping 199 matching lines @@
  * For example, Latn and Cyrl.
  *
  * @param script script code
  * @return TRUE if the script is cased
  * @stable ICU 51
  */
 U_STABLE UBool U_EXPORT2
 uscript_isCased(UScriptCode script);
 
 #endif