Update ICU to 54.1 step 1

source/common/unicode/brkiter.h

 /*
 ********************************************************************************
-*   Copyright (C) 1997-2013, International Business Machines
+*   Copyright (C) 1997-2014, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 ********************************************************************************
 *
 * File brkiter.h
 *
 * Modification History:
 *
 *   Date        Name        Description
 *   02/18/97    aliu        Added typedef for TextCount.  Made DONE const.
 *   05/07/97    aliu        Fixed DLL declaration.
@@ skipping 192 matching lines @@
     enum {
         /**
          * DONE is returned by previous() and next() after all valid
          * boundaries have been returned.
          * @stable ICU 2.0
          */
         DONE = (int32_t)-1
     };
 
     /**
-     * Set the iterator position to the index of the first character in the text being scanned.
-     * @return The index of the first character in the text being scanned.
+     * Sets the current iteration position to the beginning of the text, position zero.
+     * @return The offset of the beginning of the text, zero.
      * @stable ICU 2.0
      */
     virtual int32_t first(void) = 0;
 
     /**
      * Set the iterator position to the index immediately BEYOND the last character in the text being scanned.
      * @return The index immediately BEYOND the last character in the text being scanned.
      * @stable ICU 2.0
      */
     virtual int32_t last(void) = 0;
@@ skipping 67 matching lines @@
      * break rule that determined the most recently
      * returned break position.
      * <p>
      * For break iterator types that do not support a rule status,
      * a default value of 0 is returned.
      * <p>
      * @return the status from the break rule that determined the most recently
      *         returned break position.
      * @see RuleBaseBreakIterator::getRuleStatus()
      * @see UWordBreak
-     * @draft ICU 52
+     * @stable ICU 52
      */
     virtual int32_t getRuleStatus() const;
 
    /**
     * For RuleBasedBreakIterators, get the status (tag) values from the break rule(s) 
     * that determined the most recently returned break position.
     * <p>
     * For break iterator types that do not support rule status,
     * no values are returned.
     * <p>
     * The returned status value(s) are stored into an array provided by the caller.
     * The values are stored in sorted (ascending) order.
     * If the capacity of the output array is insufficient to hold the data,
     *  the output will be truncated to the available length, and a
     *  U_BUFFER_OVERFLOW_ERROR will be signaled.
     * <p>
     * @see RuleBaseBreakIterator::getRuleStatusVec
     *
     * @param fillInVec an array to be filled in with the status values.
     * @param capacity  the length of the supplied vector.  A length of zero causes
     *                  the function to return the number of status values, in the
     *                  normal way, without attemtping to store any values.
     * @param status    receives error codes.
     * @return          The number of rule status values from rules that determined
     *                  the most recent boundary returned by the break iterator.
     *                  In the event of a U_BUFFER_OVERFLOW_ERROR, the return value
     *                  is the total number of status values that were available,
     *                  not the reduced number that were actually returned.
     * @see getRuleStatus
-    * @draft ICU 52
+    * @stable ICU 52
     */
     virtual int32_t getRuleStatusVec(int32_t *fillInVec, int32_t capacity, UErrorCode &status);
 
     /**
      * Create BreakIterator for word-breaks using the given locale.
      * Returns an instance of a BreakIterator implementing word breaks.
      * WordBreak is useful for word selection (ex. double click)
      * @param where the locale.
      * @param status the error code
      * @return A BreakIterator for word-breaks.  The UErrorCode& status
@@ skipping 173 matching lines @@
     inline UBool isBufferClone(void);
 
 #endif /* U_HIDE_DEPRECATED_API */
 
 #if !UCONFIG_NO_SERVICE
     /**
      * Register a new break iterator of the indicated kind, to use in the given locale.
      * The break iterator will be adopted.  Clones of the iterator will be returned
      * if a request for a break iterator of the given kind matches or falls back to
      * this locale.
+     * Because ICU may choose to cache BreakIterators internally, this must
+     * be called at application startup, prior to any calls to
+     * BreakIterator::createXXXInstance to avoid undefined behavior.
      * @param toAdopt the BreakIterator instance to be adopted
      * @param locale the Locale for which this instance is to be registered
      * @param kind the type of iterator for which this instance is to be registered
      * @param status the in/out status code, no special meanings are assigned
      * @return a registry key that can be used to unregister this instance
      * @stable ICU 2.4
      */
     static URegistryKey U_EXPORT2 registerInstance(BreakIterator* toAdopt,
                                         const Locale& locale,
                                         UBreakIteratorType kind,
                                         UErrorCode& status);
 
     /**
      * Unregister a previously-registered BreakIterator using the key returned from the
      * register call.  Key becomes invalid after a successful call and should not be used again.
      * The BreakIterator corresponding to the key will be deleted.
+     * Because ICU may choose to cache BreakIterators internally, this should
+     * be called during application shutdown, after all calls to
+     * BreakIterator::createXXXInstance to avoid undefined behavior.
      * @param key the registry key returned by a previous call to registerInstance
      * @param status the in/out status code, no special meanings are assigned
      * @return TRUE if the iterator for the key was successfully unregistered
      * @stable ICU 2.4
      */
     static UBool U_EXPORT2 unregister(URegistryKey key, UErrorCode& status);
 
     /**
      * Return a StringEnumeration over the locales available at the time of the call,
      * including registered locales.
@@ skipping 55 matching lines @@
     friend class ICUBreakIteratorFactory;
     friend class ICUBreakIteratorService;
 
 protected:
     // Do not enclose protected default/copy constructors with #ifndef U_HIDE_INTERNAL_API
     // or else the compiler will create a public ones.
     /** @internal */
     BreakIterator();
     /** @internal */
     BreakIterator (const BreakIterator &other) : UObject(other) {}
-
+    /** @internal */
+    BreakIterator (const Locale& valid, const Locale& actual);
 private:
 
     /** @internal */
     char actualLocale[ULOC_FULLNAME_CAPACITY];
     char validLocale[ULOC_FULLNAME_CAPACITY];
 
     /**
      * The assignment operator has no real implementation.
      * It's provided to make the compiler happy. Do not call.
      */
     BreakIterator& operator=(const BreakIterator&);
 };
 
 #ifndef U_HIDE_DEPRECATED_API
 
 inline UBool BreakIterator::isBufferClone()
 {
     return FALSE;
 }
 
 #endif /* U_HIDE_DEPRECATED_API */
 
 U_NAMESPACE_END
 
 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */
 
 #endif // _BRKITER
 //eof