Update ICU to 54.1 step 1

source/i18n/unicode/rbnf.h

 /*
 *******************************************************************************
-* Copyright (C) 1997-2013, International Business Machines Corporation and others.
+* Copyright (C) 1997-2014, International Business Machines Corporation and others.
 * All Rights Reserved.
 *******************************************************************************
 */
 
 #ifndef RBNF_H
 #define RBNF_H
 
 #include "unicode/utypes.h"
 
 /**
  * \file
  * \brief C++ API: Rule Based Number Format
  */
 
 /**
  * \def U_HAVE_RBNF
  * This will be 0 if RBNF support is not included in ICU
  * and 1 if it is.
  *
  * @stable ICU 2.4
  */
 #if UCONFIG_NO_FORMATTING
 #define U_HAVE_RBNF 0
 #else
 #define U_HAVE_RBNF 1
 
-#include "unicode/coll.h"
 #include "unicode/dcfmtsym.h"
 #include "unicode/fmtable.h"
 #include "unicode/locid.h"
 #include "unicode/numfmt.h"
 #include "unicode/unistr.h"
 #include "unicode/strenum.h"
+#include "unicode/brkiter.h"
+#include "unicode/upluralrules.h"
 
 U_NAMESPACE_BEGIN
 
 class NFRuleSet;
 class LocalizationInfo;
+class PluralFormat;
+class RuleBasedCollator;
 
 /**
  * Tags for the predefined rulesets.
  *
  * @stable ICU 2.2
  */
 enum URBNFRuleSetTag {
     URBNF_SPELLOUT,
     URBNF_ORDINAL,
     URBNF_DURATION,
     URBNF_NUMBERING_SYSTEM,
     URBNF_COUNT
 };
 
-#if UCONFIG_NO_COLLATION
-class Collator;
-#endif
-
 /**
  * The RuleBasedNumberFormat class formats numbers according to a set of rules. This number formatter is
  * typically used for spelling out numeric values in words (e.g., 25,3476 as
  * "twenty-five thousand three hundred seventy-six" or "vingt-cinq mille trois
  * cents soixante-seize" or
  * "fünfundzwanzigtausenddreihundertsechsundsiebzig"), but can also be used for
  * other complicated formatting tasks, such as formatting a number of seconds as hours,
  * minutes and seconds (e.g., 3,730 as "1:02:10").
  *
  * <p>The resources contain three predefined formatters for each locale: spellout, which
@@ skipping 354 matching lines @@
  *   <tr>
  *     <td></td>
  *     <td>in proper-fraction rule</td>
  *     <td>Not allowed.</td>
  *   </tr>
  *   <tr>
  *     <td></td>
  *     <td>in rule in fraction rule set</td>
  *     <td>Omit the optional text if multiplying the number by the rule's base value yields 1.</td>
  *   </tr>
+ *   <tr>
+ *     <td width="37">$(cardinal,<i>plural syntax</i>)$</td>
+ *     <td width="23"></td>
+ *     <td width="165" valign="top">in all rule sets</td>
+ *     <td>This provides the ability to choose a word based on the number divided by the radix to the power of the
+ *     exponent of the base value for the specified locale, which is normally equivalent to the &lt;&lt; value.
+ *     This uses the cardinal plural rules from PluralFormat. All strings used in the plural format are treated
+ *     as the same base value for parsing.</td>
+ *   </tr>
+ *   <tr>
+ *     <td width="37">$(ordinal,<i>plural syntax</i>)$</td>
+ *     <td width="23"></td>
+ *     <td width="165" valign="top">in all rule sets</td>
+ *     <td>This provides the ability to choose a word based on the number divided by the radix to the power of the
+ *     exponent of the base value for the specified locale, which is normally equivalent to the &lt;&lt; value.
+ *     This uses the ordinal plural rules from PluralFormat. All strings used in the plural format are treated
+ *     as the same base value for parsing.</td>
+ *   </tr>
  * </table>
  *
  * <p>The substitution descriptor (i.e., the text between the token characters) may take one
  * of three forms:</p>
  *
  * <table border="0" width="100%">
  *   <tr>
  *     <td>a rule set name</td>
  *     <td>Perform the mathematical operation on the number, and format the result using the
  *     named rule set.</td>
@@ skipping 47 matching lines @@
  * to separate elements of an array.  Whitespace is ignored, unless quoted.</p>
  * <p>For example:<pre>
  * < < %foo, %bar, %baz >,
  *   < en, Foo, Bar, Baz >,
  *   < fr, 'le Foo', 'le Bar', 'le Baz' >
  *   < zh, \\u7532, \\u4e59, \\u4e19 > >
  * </pre></p>
  * @author Richard Gillam
  * @see NumberFormat
  * @see DecimalFormat
+ * @see PluralFormat
+ * @see PluralRules
  * @stable ICU 2.0
  */
 class U_I18N_API RuleBasedNumberFormat : public NumberFormat {
 public:
 
   //-----------------------------------------------------------------------
   // constructors
   //-----------------------------------------------------------------------
 
     /**
@@ skipping 376 matching lines @@
   virtual void setDefaultRuleSet(const UnicodeString& ruleSetName, UErrorCode& status);
 
   /**
    * Return the name of the current default rule set.  If the current rule set is
    * not public, returns a bogus (and empty) UnicodeString.
    * @return the name of the current default rule set
    * @stable ICU 3.0
    */
   virtual UnicodeString getDefaultRuleSetName() const;
 
+  /* Cannot use #ifndef U_HIDE_DRAFT_API for the following draft method since it is virtual */
+  /**
+   * Set a particular UDisplayContext value in the formatter, such as
+   * UDISPCTX_CAPITALIZATION_FOR_STANDALONE. Note: For getContext, see
+   * NumberFormat.
+   * @param value The UDisplayContext value to set.
+   * @param status Input/output status. If at entry this indicates a failure
+   *               status, the function will do nothing; otherwise this will be
+   *               updated with any new status from the function. 
+   * @draft ICU 53
+   */
+  virtual void setContext(UDisplayContext value, UErrorCode& status);
+
 public:
     /**
      * ICU "poor man's RTTI", returns a UClassID for this class.
      *
      * @stable ICU 2.8
      */
     static UClassID U_EXPORT2 getStaticClassID(void);
 
     /**
      * ICU "poor man's RTTI", returns a UClassID for the actual class.
@@ skipping 25 matching lines @@
 
 private:
     RuleBasedNumberFormat(); // default constructor not implemented
 
     // this will ref the localizations if they are not NULL
     // caller must deref to get adoption
     RuleBasedNumberFormat(const UnicodeString& description, LocalizationInfo* localizations,
               const Locale& locale, UParseError& perror, UErrorCode& status);
 
     void init(const UnicodeString& rules, LocalizationInfo* localizations, UParseError& perror, UErrorCode& status);
+    void initCapitalizationContextInfo(const Locale& thelocale);
     void dispose();
     void stripWhitespace(UnicodeString& src);
     void initDefaultRuleSet();
     void format(double number, NFRuleSet& ruleSet);
     NFRuleSet* findRuleSet(const UnicodeString& name, UErrorCode& status) const;
 
     /* friend access */
     friend class NFSubstitution;
     friend class NFRule;
     friend class FractionalPartSubstitution;
 
     inline NFRuleSet * getDefaultRuleSet() const;
-    Collator * getCollator() const;
+    const RuleBasedCollator * getCollator() const;
     DecimalFormatSymbols * getDecimalFormatSymbols() const;
+    PluralFormat *createPluralFormat(UPluralType pluralType, const UnicodeString &pattern, UErrorCode& status) const;
+    UnicodeString& adjustForCapitalizationContext(int32_t startPos, UnicodeString& currentResult) const;
 
 private:
     NFRuleSet **ruleSets;
     UnicodeString* ruleSetDescriptions;
     int32_t numRuleSets;
     NFRuleSet *defaultRuleSet;
     Locale locale;
-    Collator* collator;
+    RuleBasedCollator* collator;
     DecimalFormatSymbols* decimalFormatSymbols;
     UBool lenient;
     UnicodeString* lenientParseRules;
     LocalizationInfo* localizations;
+    UnicodeString originalDescription;
+    UBool capitalizationInfoSet;
+    UBool capitalizationForUIListMenu;
+    UBool capitalizationForStandAlone;
+    BreakIterator* capitalizationBrkIter;
 };
 
 // ---------------
 
 #if !UCONFIG_NO_COLLATION
 
 inline UBool
 RuleBasedNumberFormat::isLenient(void) const {
     return lenient;
 }
 
 #endif
 
 inline NFRuleSet*
 RuleBasedNumberFormat::getDefaultRuleSet() const {
     return defaultRuleSet;
 }
 
 U_NAMESPACE_END
 
 /* U_HAVE_RBNF */
 #endif
 
 /* RBNF_H */
 #endif