ICU 52.1  52.1
plurrule.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2008-2013, 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 FixedDecimal;
42 class RuleChain;
43 class PluralRuleParser;
44 class PluralKeywordEnumeration;
45 class AndConstraint;
46 
191 public:
192 
200  PluralRules(UErrorCode& status);
201 
206  PluralRules(const PluralRules& other);
207 
212  virtual ~PluralRules();
213 
218  PluralRules* clone() const;
219 
224  PluralRules& operator=(const PluralRules&);
225 
236  static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
237  UErrorCode& status);
238 
247  static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);
248 
265  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);
266 
283  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);
284 
285 #ifndef U_HIDE_INTERNAL_API
286 
291  static StringEnumeration* U_EXPORT2 getAvailableLocales(UErrorCode &status);
292 
299  static UBool hasOverride(const Locale &locale);
300 #endif /* U_HIDE_INTERNAL_API */
301 
311  UnicodeString select(int32_t number) const;
312 
322  UnicodeString select(double number) const;
323 
324 #ifndef U_HIDE_INTERNAL_API
325 
328  UnicodeString select(const FixedDecimal &number) const;
329 #endif /* U_HIDE_INTERNAL_API */
330 
341  StringEnumeration* getKeywords(UErrorCode& status) const;
342 
353  double getUniqueKeywordValue(const UnicodeString& keyword);
354 
373  int32_t getAllKeywordValues(const UnicodeString &keyword,
374  double *dest, int32_t destCapacity,
375  UErrorCode& status);
376 
395  int32_t getSamples(const UnicodeString &keyword,
396  double *dest, int32_t destCapacity,
397  UErrorCode& status);
398 
408  UBool isKeyword(const UnicodeString& keyword) const;
409 
410 
417  UnicodeString getKeywordOther() const;
418 
419 #ifndef U_HIDE_INTERNAL_API
420 
424  UnicodeString getRules() const;
425 #endif /* U_HIDE_INTERNAL_API */
426 
435  virtual UBool operator==(const PluralRules& other) const;
436 
445  UBool operator!=(const PluralRules& other) const {return !operator==(other);}
446 
447 
454  static UClassID U_EXPORT2 getStaticClassID(void);
455 
461  virtual UClassID getDynamicClassID() const;
462 
463 
464 private:
465  RuleChain *mRules;
466 
467  PluralRules(); // default constructor not implemented
468  void parseDescription(const UnicodeString& ruleData, UErrorCode &status);
469  int32_t getNumberValue(const UnicodeString& token) const;
470  UnicodeString getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
471  RuleChain *rulesForKeyword(const UnicodeString &keyword) const;
472 
473  friend class PluralRuleParser;
474 };
475 
477 
478 #endif /* #if !UCONFIG_NO_FORMATTING */
479 
480 #endif // _PLURRULE
481 //eof
virtual UClassID getDynamicClassID() const
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:91
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:190
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:445
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:245
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:221
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:185