ICU 56 update step 1

source/i18n/unicode/ucol.h

 /*
 *******************************************************************************
-* Copyright (c) 1996-2014, International Business Machines Corporation and others.
+* Copyright (c) 1996-2015, International Business Machines Corporation and others.
 * All Rights Reserved.
 *******************************************************************************
 */
 
 #ifndef UCOL_H
 #define UCOL_H
 
 #include "unicode/utypes.h"
 
 #if !UCONFIG_NO_COLLATION
@@ skipping 664 matching lines @@
 U_STABLE void U_EXPORT2 
 ucol_setStrength(UCollator *coll,
                  UCollationStrength strength);
 
 /**
  * Retrieves the reordering codes for this collator.
  * These reordering codes are a combination of UScript codes and UColReorderCode entries.
  * @param coll The UCollator to query.
  * @param dest The array to fill with the script ordering.
  * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the function 
- * will only return the length of the result without writing any of the result string (pre-flighting).
+ * will only return the length of the result without writing any codes (pre-flighting).
  * @param pErrorCode Must be a valid pointer to an error code value, which must not indicate a 
  * failure before the function call.
  * @return The number of reordering codes written to the dest array.
  * @see ucol_setReorderCodes
  * @see ucol_getEquivalentReorderCodes
  * @see UScriptCode
  * @see UColReorderCode
  * @stable ICU 4.8
  */
 U_STABLE int32_t U_EXPORT2 
 ucol_getReorderCodes(const UCollator* coll,
                     int32_t* dest,
                     int32_t destCapacity,
                     UErrorCode *pErrorCode);
 /** 
  * Sets the reordering codes for this collator.
- * Collation reordering allows scripts and some other defined blocks of characters 
- * to be moved relative to each other as a block. This reordering is done on top of 
+ * Collation reordering allows scripts and some other groups of characters
+ * to be moved relative to each other. This reordering is done on top of
  * the DUCET/CLDR standard collation order. Reordering can specify groups to be placed 
  * at the start and/or the end of the collation order. These groups are specified using
  * UScript codes and UColReorderCode entries.
+ *
  * <p>By default, reordering codes specified for the start of the order are placed in the 
- * order given after a group of "special" non-script blocks. These special groups of characters 
+ * order given after several special non-script blocks. These special groups of characters
  * are space, punctuation, symbol, currency, and digit. These special groups are represented with
  * UColReorderCode entries. Script groups can be intermingled with 
- * these special non-script blocks if those special blocks are explicitly specified in the reordering.
+ * these special non-script groups if those special groups are explicitly specified in the reordering.
+ *
  * <p>The special code OTHERS stands for any script that is not explicitly 
  * mentioned in the list of reordering codes given. Anything that is after OTHERS
  * will go at the very end of the reordering in the order given.
+ *
  * <p>The special reorder code DEFAULT will reset the reordering for this collator
  * to the default for this collator. The default reordering may be the DUCET/CLDR order or may be a reordering that
  * was specified when this collator was created from resource data or from rules. The 
- * DEFAULT code <b>must</b> be the sole code supplied when it used. If not
- * that will result in a U_ILLEGAL_ARGUMENT_ERROR being set.
+ * DEFAULT code <b>must</b> be the sole code supplied when it is used.
+ * If not, then U_ILLEGAL_ARGUMENT_ERROR will be set.
+ *
  * <p>The special reorder code NONE will remove any reordering for this collator.
  * The result of setting no reordering will be to have the DUCET/CLDR ordering used. The 
- * NONE code <b>must</b> be the sole code supplied when it used.
+ * NONE code <b>must</b> be the sole code supplied when it is used.
+ *
  * @param coll The UCollator to set.
  * @param reorderCodes An array of script codes in the new order. This can be NULL if the 
  * length is also set to 0. An empty array will clear any reordering codes on the collator.
  * @param reorderCodesLength The length of reorderCodes.
  * @param pErrorCode Must be a valid pointer to an error code value, which must not indicate a
  * failure before the function call.
  * @see ucol_getReorderCodes
  * @see ucol_getEquivalentReorderCodes
  * @see UScriptCode
  * @see UColReorderCode
  * @stable ICU 4.8
  */ 
 U_STABLE void U_EXPORT2 
 ucol_setReorderCodes(UCollator* coll,
                     const int32_t* reorderCodes,
                     int32_t reorderCodesLength,
                     UErrorCode *pErrorCode);
 
 /**
  * Retrieves the reorder codes that are grouped with the given reorder code. Some reorder
  * codes will be grouped and must reorder together.
+ * Beginning with ICU 55, scripts only reorder together if they are primary-equal,
+ * for example Hiragana and Katakana.
+ *
  * @param reorderCode The reorder code to determine equivalence for.
  * @param dest The array to fill with the script ordering.
  * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the function
- * will only return the length of the result without writing any of the result string (pre-flighting).
+ * will only return the length of the result without writing any codes (pre-flighting).
  * @param pErrorCode Must be a valid pointer to an error code value, which must not indicate 
  * a failure before the function call.
  * @return The number of reordering codes written to the dest array.
  * @see ucol_setReorderCodes
  * @see ucol_getReorderCodes
  * @see UScriptCode
  * @see UColReorderCode
  * @stable ICU 4.8
  */
 U_STABLE int32_t U_EXPORT2 
@@ skipping 424 matching lines @@
  * @return attribute value
  * @param status to indicate whether the operation went on smoothly or there were errors
  * @see UColAttribute
  * @see UColAttributeValue
  * @see ucol_setAttribute
  * @stable ICU 2.0
  */
 U_STABLE UColAttributeValue  U_EXPORT2 
 ucol_getAttribute(const UCollator *coll, UColAttribute attr, UErrorCode *status);
 
-#ifndef U_HIDE_DRAFT_API
-
 /**
  * Sets the variable top to the top of the specified reordering group.
  * The variable top determines the highest-sorting character
  * which is affected by UCOL_ALTERNATE_HANDLING.
  * If that attribute is set to UCOL_NON_IGNORABLE, then the variable top has no effect.
  * @param coll the collator
  * @param group one of UCOL_REORDER_CODE_SPACE, UCOL_REORDER_CODE_PUNCTUATION,
  *              UCOL_REORDER_CODE_SYMBOL, UCOL_REORDER_CODE_CURRENCY;
  *              or UCOL_REORDER_CODE_DEFAULT to restore the default max variable group
  * @param pErrorCode Standard ICU error code. Its input value must
  *                   pass the U_SUCCESS() test, or else the function returns
  *                   immediately. Check for U_FAILURE() on output or use with
  *                   function chaining. (See User Guide for details.)
  * @see ucol_getMaxVariable
- * @draft ICU 53
+ * @stable ICU 53
  */
-U_DRAFT void U_EXPORT2
+U_STABLE void U_EXPORT2
 ucol_setMaxVariable(UCollator *coll, UColReorderCode group, UErrorCode *pErrorCode);
 
 /**
  * Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING.
  * @param coll the collator
  * @return the maximum variable reordering group.
  * @see ucol_setMaxVariable
- * @draft ICU 53
+ * @stable ICU 53
  */
-U_DRAFT UColReorderCode U_EXPORT2
+U_STABLE UColReorderCode U_EXPORT2
 ucol_getMaxVariable(const UCollator *coll);
 
-#endif  /* U_HIDE_DRAFT_API */
-
 #ifndef U_HIDE_DEPRECATED_API
 /**
  * Sets the variable top to the primary weight of the specified string.
  *
  * Beginning with ICU 53, the variable top is pinned to
  * the top of one of the supported reordering groups,
  * and it must not be beyond the last of those groups.
  * See ucol_setMaxVariable().
  * @param coll the collator
  * @param varTop one or more (if contraction) UChars to which the variable top should be set
@@ skipping 20 matching lines @@
  * @param status error code (not changed by function). If error code is set, 
  *               the return value is undefined.
  * @return the variable top primary weight
  * @see ucol_getMaxVariable
  * @see ucol_setVariableTop
  * @see ucol_restoreVariableTop
  * @stable ICU 2.0
  */
 U_STABLE uint32_t U_EXPORT2 ucol_getVariableTop(const UCollator *coll, UErrorCode *status);
 
+#ifndef U_HIDE_DEPRECATED_API
 /**
  * Sets the variable top to the specified primary weight.
  *
  * Beginning with ICU 53, the variable top is pinned to
  * the top of one of the supported reordering groups,
  * and it must not be beyond the last of those groups.
  * See ucol_setMaxVariable().
  * @param varTop primary weight, as returned by ucol_setVariableTop or ucol_getVariableTop
  * @param status error code
  * @see ucol_getVariableTop
  * @see ucol_setVariableTop
  * @deprecated ICU 53 Call ucol_setMaxVariable() instead.
  */
 U_DEPRECATED void U_EXPORT2 
 ucol_restoreVariableTop(UCollator *coll, const uint32_t varTop, UErrorCode *status);
+#endif  /* U_HIDE_DEPRECATED_API */
 
 /**
  * Thread safe cloning operation. The result is a clone of a given collator.
  * @param coll collator to be cloned
  * @param stackBuffer <em>Deprecated functionality as of ICU 52, use NULL.</em><br>
  * user allocated space for the new clone. 
  * If NULL new memory will be allocated. 
  *  If buffer is not large enough, new memory will be allocated.
  *  Clients can use the U_COL_SAFECLONE_BUFFERSIZE.
  * @param pBufferSize <em>Deprecated functionality as of ICU 52, use NULL or 1.</em><br>
@@ skipping 172 matching lines @@
  */
 U_STABLE UCollator* U_EXPORT2
 ucol_openBinary(const uint8_t *bin, int32_t length, 
                 const UCollator *base, 
                 UErrorCode *status);
 
 
 #endif /* #if !UCONFIG_NO_COLLATION */
 
 #endif