ICU 70.1  70.1
plurrule.h
Go to the documentation of this file.
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 #if U_SHOW_CPLUSPLUS_API
24 
30 #if !UCONFIG_NO_FORMATTING
31 
32 #include "unicode/format.h"
33 #include "unicode/upluralrules.h"
34 #ifndef U_HIDE_INTERNAL_API
35 #include "unicode/numfmt.h"
36 #endif /* U_HIDE_INTERNAL_API */
37 
43 #define UPLRULES_NO_UNIQUE_VALUE ((double)-0.00123456777)
44 
45 U_NAMESPACE_BEGIN
46 
47 class Hashtable;
48 class IFixedDecimal;
49 class FixedDecimal;
50 class RuleChain;
51 class PluralRuleParser;
52 class PluralKeywordEnumeration;
53 class AndConstraint;
54 class SharedPluralRules;
55 class StandardPluralRanges;
56 
57 namespace number {
58 class FormattedNumber;
59 class FormattedNumberRange;
60 namespace impl {
61 class UFormattedNumberRangeData;
62 }
63 }
64 
207 public:
208 
217 
222  PluralRules(const PluralRules& other);
223 
228  virtual ~PluralRules();
229 
234  PluralRules* clone() const;
235 
241 
252  static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
253  UErrorCode& status);
254 
263  static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);
264 
281  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);
282 
299  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);
300 
301 #ifndef U_HIDE_INTERNAL_API
308 
315  static UBool hasOverride(const Locale &locale);
316 
322  static PluralRules* U_EXPORT2 internalForLocale(const Locale& locale, UPluralType type, UErrorCode& status);
323 
331  static const SharedPluralRules* U_EXPORT2 createSharedInstance(
332  const Locale& locale, UPluralType type, UErrorCode& status);
333 
334 
335 #endif /* U_HIDE_INTERNAL_API */
336 
346  UnicodeString select(int32_t number) const;
347 
357  UnicodeString select(double number) const;
358 
375 
393 
394 #ifndef U_HIDE_INTERNAL_API
398  UnicodeString select(const IFixedDecimal &number) const;
402  UnicodeString select(const number::impl::UFormattedNumberRangeData* urange, UErrorCode& status) const;
403 #endif /* U_HIDE_INTERNAL_API */
404 
416 
417 #ifndef U_HIDE_DEPRECATED_API
428  double getUniqueKeywordValue(const UnicodeString& keyword);
429 
450  int32_t getAllKeywordValues(const UnicodeString &keyword,
451  double *dest, int32_t destCapacity,
452  UErrorCode& status);
453 #endif /* U_HIDE_DEPRECATED_API */
454 
473  int32_t getSamples(const UnicodeString &keyword,
474  double *dest, int32_t destCapacity,
475  UErrorCode& status);
476 
477 #ifndef U_HIDE_INTERNAL_API
498  int32_t getSamples(const UnicodeString &keyword,
499  FixedDecimal *dest, int32_t destCapacity,
500  UErrorCode& status);
501 #endif /* U_HIDE_INTERNAL_API */
502 
512  UBool isKeyword(const UnicodeString& keyword) const;
513 
514 
522 
523 #ifndef U_HIDE_INTERNAL_API
529 #endif /* U_HIDE_INTERNAL_API */
530 
539  virtual bool operator==(const PluralRules& other) const;
540 
549  bool operator!=(const PluralRules& other) const {return !operator==(other);}
550 
551 
558  static UClassID U_EXPORT2 getStaticClassID(void);
559 
565  virtual UClassID getDynamicClassID() const override;
566 
567 
568 private:
569  RuleChain *mRules;
570  StandardPluralRanges *mStandardPluralRanges;
571 
572  PluralRules(); // default constructor not implemented
573  void parseDescription(const UnicodeString& ruleData, UErrorCode &status);
574  int32_t getNumberValue(const UnicodeString& token) const;
575  UnicodeString getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
576  RuleChain *rulesForKeyword(const UnicodeString &keyword) const;
577  PluralRules *clone(UErrorCode& status) const;
578 
583  UErrorCode mInternalStatus;
584 
585  friend class PluralRuleParser;
586 };
587 
588 U_NAMESPACE_END
589 
590 #endif /* #if !UCONFIG_NO_FORMATTING */
591 
592 #endif /* U_SHOW_CPLUSPLUS_API */
593 
594 #endif // _PLURRULE
595 //eof
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
Defines rules for mapping non-negative numeric values onto a small set of keywords.
Definition: plurrule.h:206
PluralRules & operator=(const PluralRules &)
Assignment operator.
StringEnumeration * getKeywords(UErrorCode &status) const
Returns a list of all rule keywords used in this PluralRules object.
UnicodeString select(const number::FormattedNumber &number, UErrorCode &status) const
Given a formatted number, returns the keyword of the first rule that applies to the number.
UnicodeString select(const number::FormattedNumberRange &range, UErrorCode &status) const
Given a formatted number range, returns the overall plural form of the range.
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
static PluralRules * forLocale(const Locale &locale, UErrorCode &status)
Provides access to the predefined cardinal-number PluralRules for a given locale.
static StringEnumeration * getAvailableLocales(UErrorCode &status)
Return a StringEnumeration over the locales for which there is plurals data.
static PluralRules * internalForLocale(const Locale &locale, UPluralType type, UErrorCode &status)
For ICU use only.
static PluralRules * createRules(const UnicodeString &description, UErrorCode &status)
Creates a PluralRules from a description if it is parsable, otherwise returns NULL.
static PluralRules * createDefaultRules(UErrorCode &status)
The default rules that accept any number.
UBool isKeyword(const UnicodeString &keyword) const
Returns true if the given keyword is defined in this PluralRules object.
PluralRules(UErrorCode &status)
Constructor.
PluralRules(const PluralRules &other)
Copy constructor.
double getUniqueKeywordValue(const UnicodeString &keyword)
Deprecated Function, does not return useful results.
UnicodeString select(const number::impl::UFormattedNumberRangeData *urange, UErrorCode &status) const
virtual ~PluralRules()
Destructor.
PluralRules * clone() const
Clone.
UnicodeString select(double number) const
Given a floating-point number, returns the keyword of the first rule that applies to the number.
UnicodeString getKeywordOther() const
Returns keyword for default plural form.
UnicodeString getRules() const
static const SharedPluralRules * createSharedInstance(const Locale &locale, UPluralType type, UErrorCode &status)
For ICU use only.
static UBool hasOverride(const Locale &locale)
Returns whether or not there are overrides.
static PluralRules * forLocale(const Locale &locale, UPluralType type, UErrorCode &status)
Provides access to the predefined PluralRules for a given locale and the plural type.
UnicodeString select(int32_t number) const
Given an integer, returns the keyword of the first rule that applies to the number.
int32_t getSamples(const UnicodeString &keyword, double *dest, int32_t destCapacity, UErrorCode &status)
Returns sample values for which select() would return the keyword.
bool operator!=(const PluralRules &other) const
Compares the inequality of two PluralRules objects.
Definition: plurrule.h:549
int32_t getAllKeywordValues(const UnicodeString &keyword, double *dest, int32_t destCapacity, UErrorCode &status)
Deprecated Function, does not produce useful results.
UnicodeString select(const IFixedDecimal &number) const
virtual bool operator==(const PluralRules &other) const
Compares the equality of two PluralRules objects.
int32_t getSamples(const UnicodeString &keyword, FixedDecimal *dest, int32_t destCapacity, UErrorCode &status)
Internal-only function that returns FixedDecimals instead of doubles.
static UClassID getStaticClassID(void)
ICU "poor man's RTTI", returns a UClassID for this class.
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:61
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
The result of a number range formatting operation.
The result of a number formatting operation.
C++ API: Base class for all formats.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
C++ API: Compatibility APIs for number formatting.
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
C API: Plural rules, select plural keywords for numeric values.
UPluralType
Type of plurals and PluralRules.
Definition: upluralrules.h:58
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301