ICU-64260.0.1.tar.gz

[apple/icu.git] / icuSources / common / unicode / brkiter.h

diff --git a/icuSources/common/unicode/brkiter.h b/icuSources/common/unicode/brkiter.h
index 6fc9fefa5b9a97cc7021c841214bf1cee3bed977..42a0fbfa1da3ee002409bee2bfb37d34b2a45896 100644 (file)
--- a/icuSources/common/unicode/brkiter.h
+++ b/icuSources/common/unicode/brkiter.h
@@ -1,6 +1,8 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html

 /*
 ********************************************************************************
 /*
 ********************************************************************************

-*   Copyright (C) 1997-2014, International Business Machines
+*   Copyright (C) 1997-2016, International Business Machines

 *   Corporation and others.  All Rights Reserved.
 ********************************************************************************
 *
 *   Corporation and others.  All Rights Reserved.
 ********************************************************************************
 *


@@ -29,6 +31,7 @@
 
 #if UCONFIG_NO_BREAK_ITERATION
 
 
 #if UCONFIG_NO_BREAK_ITERATION
 

+#if U_SHOW_CPLUSPLUS_API

 U_NAMESPACE_BEGIN
 
 /*
 U_NAMESPACE_BEGIN
 
 /*


@@ -38,6 +41,7 @@ U_NAMESPACE_BEGIN
 class BreakIterator;
 
 U_NAMESPACE_END
 class BreakIterator;
 
 U_NAMESPACE_END

+#endif // U_SHOW_CPLUSPLUS_API

 
 #else
 
 
 #else
 


@@ -50,6 +54,7 @@ U_NAMESPACE_END
 #include "unicode/utext.h"
 #include "unicode/umisc.h"
 
 #include "unicode/utext.h"
 #include "unicode/umisc.h"
 

+#if U_SHOW_CPLUSPLUS_API

 U_NAMESPACE_BEGIN
 
 /**
 U_NAMESPACE_BEGIN
 
 /**


@@ -168,6 +173,11 @@ public:
     /**
      * Change the text over which this operates. The text boundary is
      * reset to the start.
     /**
      * Change the text over which this operates. The text boundary is
      * reset to the start.

+     *
+     * The BreakIterator will retain a reference to the supplied string.
+     * The caller must not modify or delete the text while the BreakIterator
+     * retains the reference.
+     *

      * @param text The UnicodeString used to change the text.
      * @stable ICU 2.0
      */
      * @param text The UnicodeString used to change the text.
      * @stable ICU 2.0
      */


@@ -213,8 +223,8 @@ public:
     };
 
     /**
     };
 
     /**

-     * 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;
      * @stable ICU 2.0
      */
     virtual int32_t first(void) = 0;


@@ -243,7 +253,7 @@ public:
     virtual int32_t next(void) = 0;
 
     /**
     virtual int32_t next(void) = 0;
 
     /**

-     * Return character index of the current interator position within the text.
+     * Return character index of the current iterator position within the text.

      * @return The boundary most recently returned.
      * @stable ICU 2.0
      */
      * @return The boundary most recently returned.
      * @stable ICU 2.0
      */


@@ -270,7 +280,7 @@ public:
     virtual int32_t preceding(int32_t offset) = 0;
 
     /**
     virtual int32_t preceding(int32_t offset) = 0;
 
     /**

-     * Return true if the specfied position is a boundary position.
+     * Return true if the specified position is a boundary position.

      * As a side effect, the current position of the iterator is set
      * to the first boundary position at or following the specified offset.
      * @param offset the offset to check.
      * As a side effect, the current position of the iterator is set
      * to the first boundary position at or following the specified offset.
      * @param offset the offset to check.


@@ -285,30 +295,29 @@ public:
      * does nothing.  Negative values move to previous boundaries
      * and positive values move to later boundaries.
      * @return The new iterator position, or
      * does nothing.  Negative values move to previous boundaries
      * and positive values move to later boundaries.
      * @return The new iterator position, or

-     * DONE if there are fewer than |n| boundaries in the specfied direction.
+     * DONE if there are fewer than |n| boundaries in the specified direction.

      * @stable ICU 2.0
      */
     virtual int32_t next(int32_t n) = 0;
 
    /**
      * @stable ICU 2.0
      */
     virtual int32_t next(int32_t n) = 0;
 
    /**

-     * For RuleBasedBreakIterators, return the status tag from the 
-     * break rule that determined the most recently
-     * returned break position.
+     * For RuleBasedBreakIterators, return the status tag from the break rule
+     * that determined the boundary at the current iteration position.

      * <p>
      * For break iterator types that do not support a rule status,
      * a default value of 0 is returned.
      * <p>
      * <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.
+     * @return the status from the break rule that determined the boundary at
+     *         the current iteration position.

      * @see RuleBaseBreakIterator::getRuleStatus()
      * @see UWordBreak
      * @see RuleBaseBreakIterator::getRuleStatus()
      * @see UWordBreak

-     * @draft ICU 52
+     * @stable ICU 52

      */
     virtual int32_t getRuleStatus() const;
 
    /**
      */
     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.
+    * For RuleBasedBreakIterators, get the status (tag) values from the break rule(s)
+    * that determined the boundary at the current iteration position.

     * <p>
     * For break iterator types that do not support rule status,
     * no values are returned.
     * <p>
     * For break iterator types that do not support rule status,
     * no values are returned.


@@ -324,15 +333,15 @@ public:
     * @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
     * @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.
+    *                  normal way, without attempting to store any values.

     * @param status    receives error codes.
     * @return          The number of rule status values from rules that determined
     * @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.
+    *                  the boundary at the current iteration position.

     *                  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
     *                  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);
 
     */
     virtual int32_t getRuleStatusVec(int32_t *fillInVec, int32_t capacity, UErrorCode &status);
 


@@ -425,12 +434,13 @@ public:
     static BreakIterator* U_EXPORT2
     createSentenceInstance(const Locale& where, UErrorCode& status);
 
     static BreakIterator* U_EXPORT2
     createSentenceInstance(const Locale& where, UErrorCode& status);
 

+#ifndef U_HIDE_DEPRECATED_API

     /**
      * Create BreakIterator for title-casing breaks using the specified locale
      * Returns an instance of a BreakIterator implementing title breaks.
      * The iterator returned locates title boundaries as described for
      * Unicode 3.2 only. For Unicode 4.0 and above title boundary iteration,
     /**
      * Create BreakIterator for title-casing breaks using the specified locale
      * Returns an instance of a BreakIterator implementing title breaks.
      * The iterator returned locates title boundaries as described for
      * Unicode 3.2 only. For Unicode 4.0 and above title boundary iteration,

-     * please use Word Boundary iterator.{@link #createWordInstance }
+     * please use a word boundary iterator. See {@link #createWordInstance }.

      *
      * @param where the locale.
      * @param status The error code.
      *
      * @param where the locale.
      * @param status The error code.


@@ -445,10 +455,11 @@ public:
      * used; neither the requested locale nor any of its fall back locales
      * could be found.
      * The caller owns the returned object and is responsible for deleting it.
      * used; neither the requested locale nor any of its fall back locales
      * could be found.
      * The caller owns the returned object and is responsible for deleting it.

-     * @stable ICU 2.1
+     * @deprecated ICU 64 Use createWordInstance instead.

      */
     static BreakIterator* U_EXPORT2
     createTitleInstance(const Locale& where, UErrorCode& status);
      */
     static BreakIterator* U_EXPORT2
     createTitleInstance(const Locale& where, UErrorCode& status);

+#endif /* U_HIDE_DEPRECATED_API */

 
     /**
      * Get the set of Locales for which TextBoundaries are installed.
 
     /**
      * Get the set of Locales for which TextBoundaries are installed.


@@ -462,7 +473,7 @@ public:
     static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
 
     /**
     static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
 
     /**

-     * Get name of the object for the desired Locale, in the desired langauge.
+     * Get name of the object for the desired Locale, in the desired language.

      * @param objectLocale must be from getAvailableLocales.
      * @param displayLocale specifies the desired locale for output.
      * @param name the fill-in parameter of the return value
      * @param objectLocale must be from getAvailableLocales.
      * @param displayLocale specifies the desired locale for output.
      * @param name the fill-in parameter of the return value


@@ -475,7 +486,7 @@ public:
                                          UnicodeString& name);
 
     /**
                                          UnicodeString& name);
 
     /**

-     * Get name of the object for the desired Locale, in the langauge of the
+     * Get name of the object for the desired Locale, in the language of the

      * default locale.
      * @param objectLocale must be from getMatchingLocales
      * @param name the fill-in parameter of the return value
      * default locale.
      * @param objectLocale must be from getMatchingLocales
      * @param name the fill-in parameter of the return value


@@ -608,8 +619,17 @@ public:
      */
     virtual BreakIterator &refreshInputText(UText *input, UErrorCode &status) = 0;
 
      */
     virtual BreakIterator &refreshInputText(UText *input, UErrorCode &status) = 0;
 

+#ifndef U_HIDE_INTERNAL_API
+    /**
+     * Set the ULineWordOptions for this break iterator.
+     * @param lineWordOpts The ULineWordOptions to set.
+     * @internal Apple only
+     */
+    void setLineWordOpts(ULineWordOptions lineWordOpts);
+#endif  /* U_HIDE_INTERNAL_API */
+

  private:
  private:

-    static BreakIterator* buildInstance(const Locale& loc, const char *type, int32_t kind, UErrorCode& status);
+    static BreakIterator* buildInstance(const Locale& loc, const char *type, UErrorCode& status);

     static BreakIterator* createInstance(const Locale& loc, int32_t kind, UErrorCode& status);
     static BreakIterator* makeInstance(const Locale& loc, int32_t kind, UErrorCode& status);
 
     static BreakIterator* createInstance(const Locale& loc, int32_t kind, UErrorCode& status);
     static BreakIterator* makeInstance(const Locale& loc, int32_t kind, UErrorCode& status);
 


@@ -622,22 +642,27 @@ protected:
     /** @internal */
     BreakIterator();
     /** @internal */
     /** @internal */
     BreakIterator();
     /** @internal */

-    BreakIterator (const BreakIterator &other) : UObject(other) {}
+    BreakIterator (const BreakIterator &other);
+#ifndef U_HIDE_INTERNAL_API

     /** @internal */
     /** @internal */

-    BreakIterator (const Locale& valid, const Locale& actual);
+    BreakIterator (const Locale& valid, const Locale &actual);
+    /** @internal. Assignment Operator, used by RuleBasedBreakIterator. */
+    BreakIterator &operator = (const BreakIterator &other);
+#endif  /* U_HIDE_INTERNAL_API */
+    ULineWordOptions fLineWordOpts;
+

 private:
 
 private:
 

-    /** @internal */
+    /** @internal (private) */

     char actualLocale[ULOC_FULLNAME_CAPACITY];
     char validLocale[ULOC_FULLNAME_CAPACITY];
     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&);

 };
 
 };
 

+inline void BreakIterator::setLineWordOpts(ULineWordOptions lineWordOpts)
+{
+    fLineWordOpts = lineWordOpts;
+}
+

 #ifndef U_HIDE_DEPRECATED_API
 
 inline UBool BreakIterator::isBufferClone()
 #ifndef U_HIDE_DEPRECATED_API
 
 inline UBool BreakIterator::isBufferClone()


@@ -648,8 +673,9 @@ inline UBool BreakIterator::isBufferClone()
 #endif /* U_HIDE_DEPRECATED_API */
 
 U_NAMESPACE_END
 #endif /* U_HIDE_DEPRECATED_API */
 
 U_NAMESPACE_END

+#endif // U_SHOW_CPLUSPLUS_API

 
 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */
 
 
 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */
 

-#endif // _BRKITER
+#endif // BRKITER_H

 //eof
 //eof