ICU 53.1  53.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
plurrule.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2008-2014, 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 class SharedPluralRules;
47 
192 public:
193 
201  PluralRules(UErrorCode& status);
202 
207  PluralRules(const PluralRules& other);
208 
213  virtual ~PluralRules();
214 
219  PluralRules* clone() const;
220 
225  PluralRules& operator=(const PluralRules&);
226 
237  static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
238  UErrorCode& status);
239 
248  static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);
249 
266  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);
267 
284  static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);
285 
286 #ifndef U_HIDE_INTERNAL_API
287 
292  static StringEnumeration* U_EXPORT2 getAvailableLocales(UErrorCode &status);
293 
300  static UBool hasOverride(const Locale &locale);
301 
307  static PluralRules* U_EXPORT2 internalForLocale(const Locale& locale, UPluralType type, UErrorCode& status);
308 
316  static const SharedPluralRules* U_EXPORT2 createSharedInstance(
317  const Locale& locale, UPluralType type, UErrorCode& status);
318 
319 
320 #endif /* U_HIDE_INTERNAL_API */
321 
331  UnicodeString select(int32_t number) const;
332 
342  UnicodeString select(double number) const;
343 
344 #ifndef U_HIDE_INTERNAL_API
345 
348  UnicodeString select(const FixedDecimal &number) const;
349 #endif /* U_HIDE_INTERNAL_API */
350 
361  StringEnumeration* getKeywords(UErrorCode& status) const;
362 
373  double getUniqueKeywordValue(const UnicodeString& keyword);
374 
393  int32_t getAllKeywordValues(const UnicodeString &keyword,
394  double *dest, int32_t destCapacity,
395  UErrorCode& status);
396 
415  int32_t getSamples(const UnicodeString &keyword,
416  double *dest, int32_t destCapacity,
417  UErrorCode& status);
418 
428  UBool isKeyword(const UnicodeString& keyword) const;
429 
430 
437  UnicodeString getKeywordOther() const;
438 
439 #ifndef U_HIDE_INTERNAL_API
440 
444  UnicodeString getRules() const;
445 #endif /* U_HIDE_INTERNAL_API */
446 
455  virtual UBool operator==(const PluralRules& other) const;
456 
465  UBool operator!=(const PluralRules& other) const {return !operator==(other);}
466 
467 
474  static UClassID U_EXPORT2 getStaticClassID(void);
475 
481  virtual UClassID getDynamicClassID() const;
482 
483 
484 private:
485  RuleChain *mRules;
486 
487  PluralRules(); // default constructor not implemented
488  void parseDescription(const UnicodeString& ruleData, UErrorCode &status);
489  int32_t getNumberValue(const UnicodeString& token) const;
490  UnicodeString getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
491  RuleChain *rulesForKeyword(const UnicodeString &keyword) const;
492 
493  friend class PluralRuleParser;
494 };
495 
497 
498 #endif /* #if !UCONFIG_NO_FORMATTING */
499 
500 #endif // _PLURRULE
501 //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:191
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:465
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