ICU 50.1.2  50.1.2
plurrule.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2008-2012, International Business Machines Corporation and
4 * others. All Rights Reserved.
5 *******************************************************************************
6 *
7 *
8 * File PLURRULE.H
9 *
10 * Modification History:*
11 * Date Name Description
12 *
13 ********************************************************************************
14 */
15 
16 #ifndef PLURRULE
17 #define PLURRULE
18 
19 #include "unicode/utypes.h"
20 
26 #if !UCONFIG_NO_FORMATTING
27 
28 #include "unicode/format.h"
29 #include "unicode/upluralrules.h"
30 
36 #define UPLRULES_NO_UNIQUE_VALUE ((double)-0.00123456777)
37 
39 
40 class Hashtable;
41 class RuleChain;
42 class RuleParser;
43 class PluralKeywordEnumeration;
44 
128 public:
129 
137  PluralRules(UErrorCode& status);
138 
143  PluralRules(const PluralRules& other);
144 
149  virtual ~PluralRules();
150 
155  PluralRules* clone() const;
156 
161  PluralRules& operator=(const PluralRules&);
162 
173  static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
174  UErrorCode& status);
175 
184  static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);
185 
202  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);
203 
220  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);
221 
231  UnicodeString select(int32_t number) const;
232 
242  UnicodeString select(double number) const;
243 
254  StringEnumeration* getKeywords(UErrorCode& status) const;
255 
266  double getUniqueKeywordValue(const UnicodeString& keyword);
267 
286  int32_t getAllKeywordValues(const UnicodeString &keyword,
287  double *dest, int32_t destCapacity,
288  UErrorCode& status);
289 
308  int32_t getSamples(const UnicodeString &keyword,
309  double *dest, int32_t destCapacity,
310  UErrorCode& status);
311 
321  UBool isKeyword(const UnicodeString& keyword) const;
322 
323 
330  UnicodeString getKeywordOther() const;
331 
340  virtual UBool operator==(const PluralRules& other) const;
341 
350  UBool operator!=(const PluralRules& other) const {return !operator==(other);}
351 
352 
359  static UClassID U_EXPORT2 getStaticClassID(void);
360 
366  virtual UClassID getDynamicClassID() const;
367 
368 
369 private:
370  RuleChain *mRules;
371  RuleParser *mParser;
372  double *mSamples;
373  int32_t *mSampleInfo;
374  int32_t mSampleInfoCount;
375 
376  PluralRules(); // default constructor not implemented
377  int32_t getRepeatLimit() const;
378  void parseDescription(UnicodeString& ruleData, RuleChain& rules, UErrorCode &status);
379  void getNextLocale(const UnicodeString& localeData, int32_t* curIndex, UnicodeString& localeName);
380  void addRules(RuleChain& rules);
381  int32_t getNumberValue(const UnicodeString& token) const;
382  UnicodeString getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
383 
384  static const int32_t MAX_SAMPLES = 3;
385 
386  int32_t getSamplesInternal(const UnicodeString &keyword, double *dest,
387  int32_t destCapacity, UBool includeUnlimited,
388  UErrorCode& status);
389  int32_t getKeywordIndex(const UnicodeString& keyword,
390  UErrorCode& status) const;
391  void initSamples(UErrorCode& status);
392 
393 };
394 
396 
397 #endif /* #if !UCONFIG_NO_FORMATTING */
398 
399 #endif // _PLURRULE
400 //eof
virtual UClassID getDynamicClassID() const =0
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
Defines rules for mapping non-negative numeric values onto a small set of keywords.
Definition: plurrule.h:127
C++ API: Base class for all formats.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:358
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
C API: Plural rules, select plural keywords for numeric values.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
UBool operator!=(const PluralRules &other) const
Compares the inequality of two PluralRules objects.
Definition: plurrule.h:350
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
UPluralType
Type of plurals and PluralRules.
Definition: upluralrules.h:44
Basic definitions for ICU, for both C and C++ APIs.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:246
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:229
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:182