/src/mozilla-central/intl/icu/source/i18n/unicode/plurrule.h

Source (jump to first uncovered line)
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2008-2015, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*
*
* File PLURRULE.H
*
* Modification History:*
*   Date        Name        Description
*
********************************************************************************
*/

#ifndef PLURRULE
#define PLURRULE

#include "unicode/utypes.h"

/**
 * \file
 * \brief C++ API: PluralRules object
 */

#if !UCONFIG_NO_FORMATTING

#include "unicode/format.h"
#include "unicode/upluralrules.h"
#ifndef U_HIDE_INTERNAL_API
#include "unicode/numfmt.h"
#endif  /* U_HIDE_INTERNAL_API */

/**
 * Value returned by PluralRules::getUniqueKeywordValue() when there is no
 * unique value to return.
 * @stable ICU 4.8
 */
#define UPLRULES_NO_UNIQUE_VALUE ((double)-0.00123456777)

U_NAMESPACE_BEGIN

class Hashtable;
class IFixedDecimal;
class RuleChain;
class PluralRuleParser;
class PluralKeywordEnumeration;
class AndConstraint;
class SharedPluralRules;

/**
 * Defines rules for mapping non-negative numeric values onto a small set of
 * keywords. Rules are constructed from a text description, consisting
 * of a series of keywords and conditions.  The {@link #select} method
 * examines each condition in order and returns the keyword for the
 * first condition that matches the number.  If none match,
 * default rule(other) is returned.
 *
 * For more information, details, and tips for writing rules, see the
 * LDML spec, C.11 Language Plural Rules:
 * http://www.unicode.org/draft/reports/tr35/tr35.html#Language_Plural_Rules
 *
 * Examples:<pre>
 *   "one: n is 1; few: n in 2..4"</pre>
 *  This defines two rules, for 'one' and 'few'.  The condition for
 *  'one' is "n is 1" which means that the number must be equal to
 *  1 for this condition to pass.  The condition for 'few' is
 *  "n in 2..4" which means that the number must be between 2 and
 *  4 inclusive for this condition to pass.  All other numbers
 *  are assigned the keyword "other" by the default rule.
 *  </p><pre>
 *    "zero: n is 0; one: n is 1; zero: n mod 100 in 1..19"</pre>
 *  This illustrates that the same keyword can be defined multiple times.
 *  Each rule is examined in order, and the first keyword whose condition
 *  passes is the one returned.  Also notes that a modulus is applied
 *  to n in the last rule.  Thus its condition holds for 119, 219, 319...
 *  </p><pre>
 *    "one: n is 1; few: n mod 10 in 2..4 and n mod 100 not in 12..14"</pre>
 *  This illustrates conjunction and negation.  The condition for 'few'
 *  has two parts, both of which must be met: "n mod 10 in 2..4" and
 *  "n mod 100 not in 12..14".  The first part applies a modulus to n
 *  before the test as in the previous example.  The second part applies
 *  a different modulus and also uses negation, thus it matches all
 *  numbers _not_ in 12, 13, 14, 112, 113, 114, 212, 213, 214...
 *  </p>
 *  <p>
 * Syntax:<pre>
 * \code
 * rules         = rule (';' rule)*
 * rule          = keyword ':' condition
 * keyword       = <identifier>
 * condition     = and_condition ('or' and_condition)*
 * and_condition = relation ('and' relation)*
 * relation      = is_relation | in_relation | within_relation | 'n' <EOL>
 * is_relation   = expr 'is' ('not')? value
 * in_relation   = expr ('not')? 'in' range_list
 * within_relation = expr ('not')? 'within' range
 * expr          = ('n' | 'i' | 'f' | 'v' | 'j') ('mod' value)?
 * range_list    = (range | value) (',' range_list)*
 * value         = digit+  ('.' digit+)?
 * digit         = 0|1|2|3|4|5|6|7|8|9
 * range         = value'..'value
 * \endcode
 * </pre></p>
 * <p>
 * <p>
 * The i, f, and v values are defined as follows:
 * </p>
 * <ul>
 * <li>i to be the integer digits.</li>
 * <li>f to be the visible fractional digits, as an integer.</li>
 * <li>v to be the number of visible fraction digits.</li>
 * <li>j is defined to only match integers. That is j is 3 fails if v != 0 (eg for 3.1 or 3.0).</li>
 * </ul>
 * <p>
 * Examples are in the following table:
 * </p>
 * <table border='1' style="border-collapse:collapse">
 * <tbody>
 * <tr>
 * <th>n</th>
 * <th>i</th>
 * <th>f</th>
 * <th>v</th>
 * </tr>
 * <tr>
 * <td>1.0</td>
 * <td>1</td>
 * <td align="right">0</td>
 * <td>1</td>
 * </tr>
 * <tr>
 * <td>1.00</td>
 * <td>1</td>
 * <td align="right">0</td>
 * <td>2</td>
 * </tr>
 * <tr>
 * <td>1.3</td>
 * <td>1</td>
 * <td align="right">3</td>
 * <td>1</td>
 * </tr>
 * <tr>
 * <td>1.03</td>
 * <td>1</td>
 * <td align="right">3</td>
 * <td>2</td>
 * </tr>
 * <tr>
 * <td>1.23</td>
 * <td>1</td>
 * <td align="right">23</td>
 * <td>2</td>
 * </tr>
 * </tbody>
 * </table>
 * <p>
 * The difference between 'in' and 'within' is that 'in' only includes integers in the specified range, while 'within'
 * includes all values. Using 'within' with a range_list consisting entirely of values is the same as using 'in' (it's
 * not an error).
 * </p>

 * An "identifier" is a sequence of characters that do not have the
 * Unicode Pattern_Syntax or Pattern_White_Space properties.
 * <p>
 * The difference between 'in' and 'within' is that 'in' only includes
 * integers in the specified range, while 'within' includes all values.
 * Using 'within' with a range_list consisting entirely of values is the
 * same as using 'in' (it's not an error).
 *</p>
 * <p>
 * Keywords
 * could be defined by users or from ICU locale data. There are 6
 * predefined values in ICU - 'zero', 'one', 'two', 'few', 'many' and
 * 'other'. Callers need to check the value of keyword returned by
 * {@link #select} method.
 * </p>
 *
 * Examples:<pre>
 * UnicodeString keyword = pl->select(number);
 * if (keyword== UnicodeString("one") {
 *     ...
 * }
 * else if ( ... )
 * </pre>
 * <strong>Note:</strong><br>
 *  <p>
 *   ICU defines plural rules for many locales based on CLDR <i>Language Plural Rules</i>.
 *   For these predefined rules, see CLDR page at
 *    http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
 * </p>
 */
class U_I18N_API PluralRules : public UObject {
public:

    /**
     * Constructor.
     * @param status  Output param set to success/failure code on exit, which
     *                must not indicate a failure before the function call.
     *
     * @stable ICU 4.0
     */
    PluralRules(UErrorCode& status);

    /**
     * Copy constructor.
     * @stable ICU 4.0
     */
    PluralRules(const PluralRules& other);

    /**
     * Destructor.
     * @stable ICU 4.0
     */
    virtual ~PluralRules();

    /**
     * Clone
     * @stable ICU 4.0
     */
    PluralRules* clone() const;

    /**
      * Assignment operator.
      * @stable ICU 4.0
      */
    PluralRules& operator=(const PluralRules&);

    /**
     * Creates a PluralRules from a description if it is parsable, otherwise
     * returns NULL.
     *
     * @param description rule description
     * @param status      Output param set to success/failure code on exit, which
     *                    must not indicate a failure before the function call.
     * @return            new PluralRules pointer. NULL if there is an error.
     * @stable ICU 4.0
     */
    static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
                                              UErrorCode& status);

    /**
     * The default rules that accept any number.
     *
     * @param status  Output param set to success/failure code on exit, which
     *                must not indicate a failure before the function call.
     * @return        new PluralRules pointer. NULL if there is an error.
     * @stable ICU 4.0
     */
    static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);

    /**
     * Provides access to the predefined cardinal-number <code>PluralRules</code> for a given
     * locale.
     * Same as forLocale(locale, UPLURAL_TYPE_CARDINAL, status).
     *
     * @param locale  The locale for which a <code>PluralRules</code> object is
     *                returned.
     * @param status  Output param set to success/failure code on exit, which
     *                must not indicate a failure before the function call.
     * @return        The predefined <code>PluralRules</code> object pointer for
     *                this locale. If there's no predefined rules for this locale,
     *                the rules for the closest parent in the locale hierarchy
     *                that has one will  be returned.  The final fallback always
     *                returns the default 'other' rules.
     * @stable ICU 4.0
     */
    static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);

    /**
     * Provides access to the predefined <code>PluralRules</code> for a given
     * locale and the plural type.
     *
     * @param locale  The locale for which a <code>PluralRules</code> object is
     *                returned.
     * @param type    The plural type (e.g., cardinal or ordinal).
     * @param status  Output param set to success/failure code on exit, which
     *                must not indicate a failure before the function call.
     * @return        The predefined <code>PluralRules</code> object pointer for
     *                this locale. If there's no predefined rules for this locale,
     *                the rules for the closest parent in the locale hierarchy
     *                that has one will  be returned.  The final fallback always
     *                returns the default 'other' rules.
     * @stable ICU 50
     */
    static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);

#ifndef U_HIDE_INTERNAL_API
    /**
     * Return a StringEnumeration over the locales for which there is plurals data.
     * @return a StringEnumeration over the locales available.
     * @internal
     */
    static StringEnumeration* U_EXPORT2 getAvailableLocales(UErrorCode &status);

    /**
     * Returns whether or not there are overrides.
     * @param locale       the locale to check.
     * @return
     * @internal
     */
    static UBool hasOverride(const Locale &locale);

    /**
     * For ICU use only.
     * creates a  SharedPluralRules object
     * @internal
     */
    static PluralRules* U_EXPORT2 internalForLocale(const Locale& locale, UPluralType type, UErrorCode& status);

    /**
     * For ICU use only.
     * Returns handle to the shared, cached PluralRules instance.
     * Caller must call removeRef() on returned value once it is done with
     * the shared instance.
     * @internal
     */
    static const SharedPluralRules* U_EXPORT2 createSharedInstance(
            const Locale& locale, UPluralType type, UErrorCode& status);


#endif  /* U_HIDE_INTERNAL_API */

    /**
     * Given a number, returns the keyword of the first rule that applies to
     * the number.  This function can be used with isKeyword* functions to
     * determine the keyword for default plural rules.
     *
     * @param number  The number for which the rule has to be determined.
     * @return        The keyword of the selected rule.
     * @stable ICU 4.0
     */
    UnicodeString select(int32_t number) const;

    /**
     * Given a number, returns the keyword of the first rule that applies to
     * the number.  This function can be used with isKeyword* functions to
     * determine the keyword for default plural rules.
     *
     * @param number  The number for which the rule has to be determined.
     * @return        The keyword of the selected rule.
     * @stable ICU 4.0
     */
    UnicodeString select(double number) const;

#ifndef U_HIDE_INTERNAL_API
    /**
      * @internal
      */
    UnicodeString select(const IFixedDecimal &number) const;
#endif  /* U_HIDE_INTERNAL_API */

    /**
     * Returns a list of all rule keywords used in this <code>PluralRules</code>
     * object.  The rule 'other' is always present by default.
     *
     * @param status Output param set to success/failure code on exit, which
     *               must not indicate a failure before the function call.
     * @return       StringEnumeration with the keywords.
     *               The caller must delete the object.
     * @stable ICU 4.0
     */
    StringEnumeration* getKeywords(UErrorCode& status) const;

#ifndef U_HIDE_DEPRECATED_API
    /**
     * Deprecated Function, does not return useful results.
     *
     * Originally intended to return a unique value for this keyword if it exists,
     * else the constant UPLRULES_NO_UNIQUE_VALUE.
     *
     * @param keyword The keyword.
     * @return        Stub deprecated function returns UPLRULES_NO_UNIQUE_VALUE always.
     * @deprecated ICU 55
     */
    double getUniqueKeywordValue(const UnicodeString& keyword);

    /**
     * Deprecated Function, does not produce useful results.
     *
     * Originally intended to return all the values for which select() would return the keyword.
     * If the keyword is unknown, returns no values, but this is not an error.  If
     * the number of values is unlimited, returns no values and -1 as the
     * count.
     *
     * The number of returned values is typically small.
     *
     * @param keyword      The keyword.
     * @param dest         Array into which to put the returned values.  May
     *                     be NULL if destCapacity is 0.
     * @param destCapacity The capacity of the array, must be at least 0.
     * @param status       The error code. Deprecated function, always sets U_UNSUPPORTED_ERROR.
     * @return             The count of values available, or -1.  This count
     *                     can be larger than destCapacity, but no more than
     *                     destCapacity values will be written.
     * @deprecated ICU 55
     */
    int32_t getAllKeywordValues(const UnicodeString &keyword,
                                double *dest, int32_t destCapacity,
                                UErrorCode& status);
#endif  /* U_HIDE_DEPRECATED_API */

    /**
     * Returns sample values for which select() would return the keyword.  If
     * the keyword is unknown, returns no values, but this is not an error.
     *
     * The number of returned values is typically small.
     *
     * @param keyword      The keyword.
     * @param dest         Array into which to put the returned values.  May
     *                     be NULL if destCapacity is 0.
     * @param destCapacity The capacity of the array, must be at least 0.
     * @param status       The error code.
     * @return             The count of values written.
     *                     If more than destCapacity samples are available, then
     *                     only destCapacity are written, and destCapacity is returned as the count,
     *                     rather than setting a U_BUFFER_OVERFLOW_ERROR.
     *                     (The actual number of keyword values could be unlimited.)
     * @stable ICU 4.8
     */
    int32_t getSamples(const UnicodeString &keyword,
                       double *dest, int32_t destCapacity,
                       UErrorCode& status);

    /**
     * Returns TRUE if the given keyword is defined in this
     * <code>PluralRules</code> object.
     *
     * @param keyword  the input keyword.
     * @return         TRUE if the input keyword is defined.
     *                 Otherwise, return FALSE.
     * @stable ICU 4.0
     */
    UBool isKeyword(const UnicodeString& keyword) const;


    /**
     * Returns keyword for default plural form.
     *
     * @return         keyword for default plural form.
     * @stable ICU 4.0
     */
    UnicodeString getKeywordOther() const;

#ifndef U_HIDE_INTERNAL_API
    /**
     *
     * @internal
     */
     UnicodeString getRules() const;
#endif  /* U_HIDE_INTERNAL_API */

    /**
     * Compares the equality of two PluralRules objects.
     *
     * @param other The other PluralRules object to be compared with.
     * @return      True if the given PluralRules is the same as this
     *              PluralRules; false otherwise.
     * @stable ICU 4.0
     */
    virtual UBool operator==(const PluralRules& other) const;

    /**
     * Compares the inequality of two PluralRules objects.
     *
     * @param other The PluralRules object to be compared with.
     * @return      True if the given PluralRules is not the same as this
     *              PluralRules; false otherwise.
     * @stable ICU 4.0
     */
    UBool operator!=(const PluralRules& other) const  {return !operator==(other);}


    /**
     * ICU "poor man's RTTI", returns a UClassID for this class.
     *
     * @stable ICU 4.0
     *
    */
    static UClassID U_EXPORT2 getStaticClassID(void);

    /**
     * ICU "poor man's RTTI", returns a UClassID for the actual class.
     *
     * @stable ICU 4.0
     */
    virtual UClassID getDynamicClassID() const;


private:
    RuleChain  *mRules;

    PluralRules();   // default constructor not implemented
    void            parseDescription(const UnicodeString& ruleData, UErrorCode &status);
    int32_t         getNumberValue(const UnicodeString& token) const;
    UnicodeString   getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
    RuleChain      *rulesForKeyword(const UnicodeString &keyword) const;

    friend class PluralRuleParser;
};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif // _PLURRULE
//eof

Coverage Report

Created: 2018-09-25 14:53

Line	Count	Source (jump to first uncovered line)
1		// © 2016 and later: Unicode, Inc. and others.
2		// License & terms of use: http://www.unicode.org/copyright.html
3		/*
4		*******************************************************************************
5		* Copyright (C) 2008-2015, International Business Machines Corporation and
6		* others. All Rights Reserved.
7		*******************************************************************************
8		*
9		*
10		* File PLURRULE.H
11		*
12		* Modification History:*
13		* Date Name Description
14		*
15		********************************************************************************
16		*/
17
18		#ifndef PLURRULE
19		#define PLURRULE
20
21		#include "unicode/utypes.h"
22
23		/**
24		* \file
25		* \brief C++ API: PluralRules object
26		*/
27
28		#if !UCONFIG_NO_FORMATTING
29
30		#include "unicode/format.h"
31		#include "unicode/upluralrules.h"
32		#ifndef U_HIDE_INTERNAL_API
33		#include "unicode/numfmt.h"
34		#endif /* U_HIDE_INTERNAL_API */
35
36		/**
37		* Value returned by PluralRules::getUniqueKeywordValue() when there is no
38		* unique value to return.
39		* @stable ICU 4.8
40		*/
41		#define UPLRULES_NO_UNIQUE_VALUE ((double)-0.00123456777)
42
43		U_NAMESPACE_BEGIN
44
45		class Hashtable;
46		class IFixedDecimal;
47		class RuleChain;
48		class PluralRuleParser;
49		class PluralKeywordEnumeration;
50		class AndConstraint;
51		class SharedPluralRules;
52
53		/**
54		* Defines rules for mapping non-negative numeric values onto a small set of
55		* keywords. Rules are constructed from a text description, consisting
56		* of a series of keywords and conditions. The {@link #select} method
57		* examines each condition in order and returns the keyword for the
58		* first condition that matches the number. If none match,
59		* default rule(other) is returned.
60		*
61		* For more information, details, and tips for writing rules, see the
62		* LDML spec, C.11 Language Plural Rules:
63		* http://www.unicode.org/draft/reports/tr35/tr35.html#Language_Plural_Rules
64		*
65		* Examples:<pre>
66		* "one: n is 1; few: n in 2..4"</pre>
67		* This defines two rules, for 'one' and 'few'. The condition for
68		* 'one' is "n is 1" which means that the number must be equal to
69		* 1 for this condition to pass. The condition for 'few' is
70		* "n in 2..4" which means that the number must be between 2 and
71		* 4 inclusive for this condition to pass. All other numbers
72		* are assigned the keyword "other" by the default rule.
73		* </p><pre>
74		* "zero: n is 0; one: n is 1; zero: n mod 100 in 1..19"</pre>
75		* This illustrates that the same keyword can be defined multiple times.
76		* Each rule is examined in order, and the first keyword whose condition
77		* passes is the one returned. Also notes that a modulus is applied
78		* to n in the last rule. Thus its condition holds for 119, 219, 319...
79		* </p><pre>
80		* "one: n is 1; few: n mod 10 in 2..4 and n mod 100 not in 12..14"</pre>
81		* This illustrates conjunction and negation. The condition for 'few'
82		* has two parts, both of which must be met: "n mod 10 in 2..4" and
83		* "n mod 100 not in 12..14". The first part applies a modulus to n
84		* before the test as in the previous example. The second part applies
85		* a different modulus and also uses negation, thus it matches all
86		* numbers _not_ in 12, 13, 14, 112, 113, 114, 212, 213, 214...
87		* </p>
88		* <p>
89		* Syntax:<pre>
90		* \code
91		* rules = rule (';' rule)*
92		* rule = keyword ':' condition
93		* keyword = <identifier>
94		* condition = and_condition ('or' and_condition)*
95		* and_condition = relation ('and' relation)*
96		* relation = is_relation \| in_relation \| within_relation \| 'n' <EOL>
97		* is_relation = expr 'is' ('not')? value
98		* in_relation = expr ('not')? 'in' range_list
99		* within_relation = expr ('not')? 'within' range
100		* expr = ('n' \| 'i' \| 'f' \| 'v' \| 'j') ('mod' value)?
101		* range_list = (range \| value) (',' range_list)*
102		* value = digit+ ('.' digit+)?
103		* digit = 0\|1\|2\|3\|4\|5\|6\|7\|8\|9
104		* range = value'..'value
105		* \endcode
106		* </pre></p>
107		* <p>
108		* <p>
109		* The i, f, and v values are defined as follows:
110		* </p>
111		* <ul>
112		* <li>i to be the integer digits.</li>
113		* <li>f to be the visible fractional digits, as an integer.</li>
114		* <li>v to be the number of visible fraction digits.</li>
115		* <li>j is defined to only match integers. That is j is 3 fails if v != 0 (eg for 3.1 or 3.0).</li>
116		* </ul>
117		* <p>
118		* Examples are in the following table:
119		* </p>
120		* <table border='1' style="border-collapse:collapse">
121		* <tbody>
122		* <tr>
123		* <th>n</th>
124		* <th>i</th>
125		* <th>f</th>
126		* <th>v</th>
127		* </tr>
128		* <tr>
129		* <td>1.0</td>
130		* <td>1</td>
131		* <td align="right">0</td>
132		* <td>1</td>
133		* </tr>
134		* <tr>
135		* <td>1.00</td>
136		* <td>1</td>
137		* <td align="right">0</td>
138		* <td>2</td>
139		* </tr>
140		* <tr>
141		* <td>1.3</td>
142		* <td>1</td>
143		* <td align="right">3</td>
144		* <td>1</td>
145		* </tr>
146		* <tr>
147		* <td>1.03</td>
148		* <td>1</td>
149		* <td align="right">3</td>
150		* <td>2</td>
151		* </tr>
152		* <tr>
153		* <td>1.23</td>
154		* <td>1</td>
155		* <td align="right">23</td>
156		* <td>2</td>
157		* </tr>
158		* </tbody>
159		* </table>
160		* <p>
161		* The difference between 'in' and 'within' is that 'in' only includes integers in the specified range, while 'within'
162		* includes all values. Using 'within' with a range_list consisting entirely of values is the same as using 'in' (it's
163		* not an error).
164		* </p>
165
166		* An "identifier" is a sequence of characters that do not have the
167		* Unicode Pattern_Syntax or Pattern_White_Space properties.
168		* <p>
169		* The difference between 'in' and 'within' is that 'in' only includes
170		* integers in the specified range, while 'within' includes all values.
171		* Using 'within' with a range_list consisting entirely of values is the
172		* same as using 'in' (it's not an error).
173		*</p>
174		* <p>
175		* Keywords
176		* could be defined by users or from ICU locale data. There are 6
177		* predefined values in ICU - 'zero', 'one', 'two', 'few', 'many' and
178		* 'other'. Callers need to check the value of keyword returned by
179		* {@link #select} method.
180		* </p>
181		*
182		* Examples:<pre>
183		* UnicodeString keyword = pl->select(number);
184		* if (keyword== UnicodeString("one") {
185		* ...
186		* }
187		* else if ( ... )
188		* </pre>
189		* <strong>Note:</strong><br>
190		* <p>
191		* ICU defines plural rules for many locales based on CLDR <i>Language Plural Rules</i>.
192		* For these predefined rules, see CLDR page at
193		* http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
194		* </p>
195		*/
196		class U_I18N_API PluralRules : public UObject {
197		public:
198
199		/**
200		* Constructor.
201		* @param status Output param set to success/failure code on exit, which
202		* must not indicate a failure before the function call.
203		*
204		* @stable ICU 4.0
205		*/
206		PluralRules(UErrorCode& status);
207
208		/**
209		* Copy constructor.
210		* @stable ICU 4.0
211		*/
212		PluralRules(const PluralRules& other);
213
214		/**
215		* Destructor.
216		* @stable ICU 4.0
217		*/
218		virtual ~PluralRules();
219
220		/**
221		* Clone
222		* @stable ICU 4.0
223		*/
224		PluralRules* clone() const;
225
226		/**
227		* Assignment operator.
228		* @stable ICU 4.0
229		*/
230		PluralRules& operator=(const PluralRules&);
231
232		/**
233		* Creates a PluralRules from a description if it is parsable, otherwise
234		* returns NULL.
235		*
236		* @param description rule description
237		* @param status Output param set to success/failure code on exit, which
238		* must not indicate a failure before the function call.
239		* @return new PluralRules pointer. NULL if there is an error.
240		* @stable ICU 4.0
241		*/
242		static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
243		UErrorCode& status);
244
245		/**
246		* The default rules that accept any number.
247		*
248		* @param status Output param set to success/failure code on exit, which
249		* must not indicate a failure before the function call.
250		* @return new PluralRules pointer. NULL if there is an error.
251		* @stable ICU 4.0
252		*/
253		static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);
254
255		/**
256		* Provides access to the predefined cardinal-number <code>PluralRules</code> for a given
257		* locale.
258		* Same as forLocale(locale, UPLURAL_TYPE_CARDINAL, status).
259		*
260		* @param locale The locale for which a <code>PluralRules</code> object is
261		* returned.
262		* @param status Output param set to success/failure code on exit, which
263		* must not indicate a failure before the function call.
264		* @return The predefined <code>PluralRules</code> object pointer for
265		* this locale. If there's no predefined rules for this locale,
266		* the rules for the closest parent in the locale hierarchy
267		* that has one will be returned. The final fallback always
268		* returns the default 'other' rules.
269		* @stable ICU 4.0
270		*/
271		static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);
272
273		/**
274		* Provides access to the predefined <code>PluralRules</code> for a given
275		* locale and the plural type.
276		*
277		* @param locale The locale for which a <code>PluralRules</code> object is
278		* returned.
279		* @param type The plural type (e.g., cardinal or ordinal).
280		* @param status Output param set to success/failure code on exit, which
281		* must not indicate a failure before the function call.
282		* @return The predefined <code>PluralRules</code> object pointer for
283		* this locale. If there's no predefined rules for this locale,
284		* the rules for the closest parent in the locale hierarchy
285		* that has one will be returned. The final fallback always
286		* returns the default 'other' rules.
287		* @stable ICU 50
288		*/
289		static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);
290
291		#ifndef U_HIDE_INTERNAL_API
292		/**
293		* Return a StringEnumeration over the locales for which there is plurals data.
294		* @return a StringEnumeration over the locales available.
295		* @internal
296		*/
297		static StringEnumeration* U_EXPORT2 getAvailableLocales(UErrorCode &status);
298
299		/**
300		* Returns whether or not there are overrides.
301		* @param locale the locale to check.
302		* @return
303		* @internal
304		*/
305		static UBool hasOverride(const Locale &locale);
306
307		/**
308		* For ICU use only.
309		* creates a SharedPluralRules object
310		* @internal
311		*/
312		static PluralRules* U_EXPORT2 internalForLocale(const Locale& locale, UPluralType type, UErrorCode& status);
313
314		/**
315		* For ICU use only.
316		* Returns handle to the shared, cached PluralRules instance.
317		* Caller must call removeRef() on returned value once it is done with
318		* the shared instance.
319		* @internal
320		*/
321		static const SharedPluralRules* U_EXPORT2 createSharedInstance(
322		const Locale& locale, UPluralType type, UErrorCode& status);
323
324
325		#endif /* U_HIDE_INTERNAL_API */
326
327		/**
328		* Given a number, returns the keyword of the first rule that applies to
329		* the number. This function can be used with isKeyword* functions to
330		* determine the keyword for default plural rules.
331		*
332		* @param number The number for which the rule has to be determined.
333		* @return The keyword of the selected rule.
334		* @stable ICU 4.0
335		*/
336		UnicodeString select(int32_t number) const;
337
338		/**
339		* Given a number, returns the keyword of the first rule that applies to
340		* the number. This function can be used with isKeyword* functions to
341		* determine the keyword for default plural rules.
342		*
343		* @param number The number for which the rule has to be determined.
344		* @return The keyword of the selected rule.
345		* @stable ICU 4.0
346		*/
347		UnicodeString select(double number) const;
348
349		#ifndef U_HIDE_INTERNAL_API
350		/**
351		* @internal
352		*/
353		UnicodeString select(const IFixedDecimal &number) const;
354		#endif /* U_HIDE_INTERNAL_API */
355
356		/**
357		* Returns a list of all rule keywords used in this <code>PluralRules</code>
358		* object. The rule 'other' is always present by default.
359		*
360		* @param status Output param set to success/failure code on exit, which
361		* must not indicate a failure before the function call.
362		* @return StringEnumeration with the keywords.
363		* The caller must delete the object.
364		* @stable ICU 4.0
365		*/
366		StringEnumeration* getKeywords(UErrorCode& status) const;
367
368		#ifndef U_HIDE_DEPRECATED_API
369		/**
370		* Deprecated Function, does not return useful results.
371		*
372		* Originally intended to return a unique value for this keyword if it exists,
373		* else the constant UPLRULES_NO_UNIQUE_VALUE.
374		*
375		* @param keyword The keyword.
376		* @return Stub deprecated function returns UPLRULES_NO_UNIQUE_VALUE always.
377		* @deprecated ICU 55
378		*/
379		double getUniqueKeywordValue(const UnicodeString& keyword);
380
381		/**
382		* Deprecated Function, does not produce useful results.
383		*
384		* Originally intended to return all the values for which select() would return the keyword.
385		* If the keyword is unknown, returns no values, but this is not an error. If
386		* the number of values is unlimited, returns no values and -1 as the
387		* count.
388		*
389		* The number of returned values is typically small.
390		*
391		* @param keyword The keyword.
392		* @param dest Array into which to put the returned values. May
393		* be NULL if destCapacity is 0.
394		* @param destCapacity The capacity of the array, must be at least 0.
395		* @param status The error code. Deprecated function, always sets U_UNSUPPORTED_ERROR.
396		* @return The count of values available, or -1. This count
397		* can be larger than destCapacity, but no more than
398		* destCapacity values will be written.
399		* @deprecated ICU 55
400		*/
401		int32_t getAllKeywordValues(const UnicodeString &keyword,
402		double *dest, int32_t destCapacity,
403		UErrorCode& status);
404		#endif /* U_HIDE_DEPRECATED_API */
405
406		/**
407		* Returns sample values for which select() would return the keyword. If
408		* the keyword is unknown, returns no values, but this is not an error.
409		*
410		* The number of returned values is typically small.
411		*
412		* @param keyword The keyword.
413		* @param dest Array into which to put the returned values. May
414		* be NULL if destCapacity is 0.
415		* @param destCapacity The capacity of the array, must be at least 0.
416		* @param status The error code.
417		* @return The count of values written.
418		* If more than destCapacity samples are available, then
419		* only destCapacity are written, and destCapacity is returned as the count,
420		* rather than setting a U_BUFFER_OVERFLOW_ERROR.
421		* (The actual number of keyword values could be unlimited.)
422		* @stable ICU 4.8
423		*/
424		int32_t getSamples(const UnicodeString &keyword,
425		double *dest, int32_t destCapacity,
426		UErrorCode& status);
427
428		/**
429		* Returns TRUE if the given keyword is defined in this
430		* <code>PluralRules</code> object.
431		*
432		* @param keyword the input keyword.
433		* @return TRUE if the input keyword is defined.
434		* Otherwise, return FALSE.
435		* @stable ICU 4.0
436		*/
437		UBool isKeyword(const UnicodeString& keyword) const;
438
439
440		/**
441		* Returns keyword for default plural form.
442		*
443		* @return keyword for default plural form.
444		* @stable ICU 4.0
445		*/
446		UnicodeString getKeywordOther() const;
447
448		#ifndef U_HIDE_INTERNAL_API
449		/**
450		*
451		* @internal
452		*/
453		UnicodeString getRules() const;
454		#endif /* U_HIDE_INTERNAL_API */
455
456		/**
457		* Compares the equality of two PluralRules objects.
458		*
459		* @param other The other PluralRules object to be compared with.
460		* @return True if the given PluralRules is the same as this
461		* PluralRules; false otherwise.
462		* @stable ICU 4.0
463		*/
464		virtual UBool operator==(const PluralRules& other) const;
465
466		/**
467		* Compares the inequality of two PluralRules objects.
468		*
469		* @param other The PluralRules object to be compared with.
470		* @return True if the given PluralRules is not the same as this
471		* PluralRules; false otherwise.
472		* @stable ICU 4.0
473		*/
474	0	UBool operator!=(const PluralRules& other) const {return !operator==(other);}
475
476
477		/**
478		* ICU "poor man's RTTI", returns a UClassID for this class.
479		*
480		* @stable ICU 4.0
481		*
482		*/
483		static UClassID U_EXPORT2 getStaticClassID(void);
484
485		/**
486		* ICU "poor man's RTTI", returns a UClassID for the actual class.
487		*
488		* @stable ICU 4.0
489		*/
490		virtual UClassID getDynamicClassID() const;
491
492
493		private:
494		RuleChain *mRules;
495
496		PluralRules(); // default constructor not implemented
497		void parseDescription(const UnicodeString& ruleData, UErrorCode &status);
498		int32_t getNumberValue(const UnicodeString& token) const;
499		UnicodeString getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
500		RuleChain *rulesForKeyword(const UnicodeString &keyword) const;
501
502		friend class PluralRuleParser;
503		};
504
505		U_NAMESPACE_END
506
507		#endif /* #if !UCONFIG_NO_FORMATTING */
508
509		#endif // _PLURRULE
510		//eof