ICU-461.12.tar.gz

[apple/icu.git] / icuSources / i18n / unicode / coll.h

diff --git a/icuSources/i18n/unicode/coll.h b/icuSources/i18n/unicode/coll.h
index 5733f5856e9d5a0430781bd036f0fddf415f3430..357af13d9b8f0d9aed71b321edd3294b70141e0b 100644 (file)
--- a/icuSources/i18n/unicode/coll.h
+++ b/icuSources/i18n/unicode/coll.h
@@ -1,6 +1,6 @@
 /*
 ******************************************************************************
-*   Copyright (C) 1996-2008, International Business Machines                 *
+*   Copyright (C) 1996-2010, International Business Machines                 *
 *   Corporation and others.  All Rights Reserved.                            *
 ******************************************************************************
 */
@@ -59,6 +59,8 @@
 #include "unicode/locid.h"
 #include "unicode/uniset.h"
 #include "unicode/umisc.h"
+#include "unicode/uiter.h"
+#include "unicode/stringpiece.h"
 
 U_NAMESPACE_BEGIN
 
@@ -437,6 +439,38 @@ public:
                                       const UChar* target, int32_t targetLength,
                                       UErrorCode &status) const = 0;
 
+    /**
+     * Compares two strings using the Collator.
+     * Returns whether the first one compares less than/equal to/greater than
+     * the second one.
+     * This version takes UCharIterator input.
+     * @param sIter the first ("source") string iterator
+     * @param tIter the second ("target") string iterator
+     * @param status ICU status
+     * @return UCOL_LESS, UCOL_EQUAL or UCOL_GREATER
+     * @stable ICU 4.2
+     */
+    virtual UCollationResult compare(UCharIterator &sIter,
+                                     UCharIterator &tIter,
+                                     UErrorCode &status) const;
+
+    /**
+     * Compares two UTF-8 strings using the Collator.
+     * Returns whether the first one compares less than/equal to/greater than
+     * the second one.
+     * This version takes UTF-8 input.
+     * Note that a StringPiece can be implicitly constructed
+     * from a std::string or a NUL-terminated const char * string.
+     * @param source the first UTF-8 string
+     * @param target the second UTF-8 string
+     * @param status ICU status
+     * @return UCOL_LESS, UCOL_EQUAL or UCOL_GREATER
+     * @stable ICU 4.2
+     */
+    virtual UCollationResult compareUTF8(const StringPiece &source,
+                                         const StringPiece &target,
+                                         UErrorCode &status) const;
+
     /**
      * Transforms the string into a series of characters that can be compared
      * with CollationKey::compareTo. It is not possible to restore the original
@@ -563,6 +597,30 @@ public:
      */
     virtual void setStrength(ECollationStrength newStrength) = 0;
 
+    /**
+     * Get the current reordering of scripts (if one has been set).
+     * @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).
+     * @param pErrorCode Must be a valid pointer to an error code value, which must not indicate a failure before the function call.
+     * @return The length of the array of the script ordering.
+     * @see ucol_getReorderCodes
+     * @internal 
+     */
+    virtual int32_t getReorderCodes(int32_t *dest,
+                                    int32_t destCapacity,
+                                    UErrorCode& status) const;
+
+    /**
+     * Set the ordering of scripts for this collator.
+     * @param reorderCodes An array of reorder codes in the new order.
+     * @param reorderCodesLength The length of reorderCodes.
+     * @see ucol_setReorderCodes
+     * @internal 
+     */
+    virtual void setReorderCodes(const int32_t* reorderCodes,
+                                int32_t reorderCodesLength,
+                                UErrorCode& status) ;
+
     /**
      * Get name of the object for the desired Locale, in the desired langauge
      * @param objectLocale must be from getAvailableLocales
@@ -634,6 +692,25 @@ public:
      */
     static StringEnumeration* U_EXPORT2 getKeywordValues(const char *keyword, UErrorCode& status);
 
+    /**
+     * Given a key and a locale, returns an array of string values in a preferred
+     * order that would make a difference. These are all and only those values where
+     * the open (creation) of the service with the locale formed from the input locale
+     * plus input keyword and that value has different behavior than creation with the
+     * input locale alone.
+     * @param keyword        one of the keys supported by this service.  For now, only
+     *                      "collation" is supported.
+     * @param locale        the locale
+     * @param commonlyUsed  if set to true it will return only commonly used values
+     *                      with the given locale in preferred order.  Otherwise,
+     *                      it will return all the available values for the locale.
+     * @param status ICU status
+     * @return a string enumeration over keyword values for the given key and the locale.
+     * @stable ICU 4.2
+     */
+    static StringEnumeration* U_EXPORT2 getKeywordValuesForLocale(const char* keyword, const Locale& locale,
+                                                                    UBool commonlyUsed, UErrorCode& status);
+
     /**
      * Return the functionally equivalent locale for the given
      * requested locale, with respect to given keyword, for the
@@ -916,8 +993,9 @@ protected:
 
    /**
     * Used internally by registraton to define the requested and valid locales.
-    * @param requestedLocale the requsted locale
+    * @param requestedLocale the requested locale
     * @param validLocale the valid locale
+    * @param actualLocale the actual locale
     * @internal
     */
     virtual void setLocales(const Locale& requestedLocale, const Locale& validLocale, const Locale& actualLocale);