ICU 66.1 66.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"
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
45U_NAMESPACE_BEGIN
46
47class Hashtable;
48class IFixedDecimal;
49class RuleChain;
50class PluralRuleParser;
51class PluralKeywordEnumeration;
52class AndConstraint;
53class SharedPluralRules;
54
55namespace number {
56class FormattedNumber;
57}
58
201public:
202
211
217
222 virtual ~PluralRules();
223
229
235
246 static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
247 UErrorCode& status);
248
257 static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);
258
275 static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);
276
293 static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);
294
295#ifndef U_HIDE_INTERNAL_API
302
309 static UBool hasOverride(const Locale &locale);
310
316 static PluralRules* U_EXPORT2 internalForLocale(const Locale& locale, UPluralType type, UErrorCode& status);
317
325 static const SharedPluralRules* U_EXPORT2 createSharedInstance(
326 const Locale& locale, UPluralType type, UErrorCode& status);
327
328
329#endif /* U_HIDE_INTERNAL_API */
330
340 UnicodeString select(int32_t number) const;
341
351 UnicodeString select(double number) const;
352
353#ifndef U_HIDE_DRAFT_API
370#endif /* U_HIDE_DRAFT_API */
371
372#ifndef U_HIDE_INTERNAL_API
376 UnicodeString select(const IFixedDecimal &number) const;
377#endif /* U_HIDE_INTERNAL_API */
378
390
391#ifndef U_HIDE_DEPRECATED_API
402 double getUniqueKeywordValue(const UnicodeString& keyword);
403
424 int32_t getAllKeywordValues(const UnicodeString &keyword,
425 double *dest, int32_t destCapacity,
426 UErrorCode& status);
427#endif /* U_HIDE_DEPRECATED_API */
428
447 int32_t getSamples(const UnicodeString &keyword,
448 double *dest, int32_t destCapacity,
449 UErrorCode& status);
450
460 UBool isKeyword(const UnicodeString& keyword) const;
461
462
470
471#ifndef U_HIDE_INTERNAL_API
477#endif /* U_HIDE_INTERNAL_API */
478
487 virtual UBool operator==(const PluralRules& other) const;
488
497 UBool operator!=(const PluralRules& other) const {return !operator==(other);}
498
499
506 static UClassID U_EXPORT2 getStaticClassID(void);
507
514
515
516private:
517 RuleChain *mRules;
518
519 PluralRules(); // default constructor not implemented
520 void parseDescription(const UnicodeString& ruleData, UErrorCode &status);
521 int32_t getNumberValue(const UnicodeString& token) const;
522 UnicodeString getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
523 RuleChain *rulesForKeyword(const UnicodeString &keyword) const;
524
529 UErrorCode mInternalStatus;
530
531 friend class PluralRuleParser;
532};
533
534U_NAMESPACE_END
535
536#endif /* #if !UCONFIG_NO_FORMATTING */
537
538#endif /* U_SHOW_CPLUSPLUS_API */
539
540#endif // _PLURRULE
541//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:200
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.
virtual UClassID getDynamicClassID() const
ICU "poor man's RTTI", returns a UClassID for the actual class.
static const SharedPluralRules * createSharedInstance(const Locale &locale, UPluralType type, UErrorCode &status)
For ICU use only.
UBool operator!=(const PluralRules &other) const
Compares the inequality of two PluralRules objects.
Definition: plurrule.h:497
static PluralRules * createRules(const UnicodeString &description, UErrorCode &status)
Creates a PluralRules from a description if it is parsable, otherwise returns NULL.
UBool isKeyword(const UnicodeString &keyword) const
Returns TRUE if the given keyword is defined in this PluralRules object.
PluralRules(UErrorCode &status)
Constructor.
static PluralRules * createDefaultRules(UErrorCode &status)
The default rules that accept any number.
PluralRules & operator=(const PluralRules &)
Assignment operator.
PluralRules * clone() const
Clone.
PluralRules(const PluralRules &other)
Copy constructor.
double getUniqueKeywordValue(const UnicodeString &keyword)
Deprecated Function, does not return useful results.
static StringEnumeration * getAvailableLocales(UErrorCode &status)
Return a StringEnumeration over the locales for which there is plurals data.
virtual ~PluralRules()
Destructor.
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.
StringEnumeration * getKeywords(UErrorCode &status) const
Returns a list of all rule keywords used in this PluralRules object.
UnicodeString getRules() const
static UBool hasOverride(const Locale &locale)
Returns whether or not there are overrides.
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.
static PluralRules * internalForLocale(const Locale &locale, UPluralType type, UErrorCode &status)
For ICU use only.
virtual UBool operator==(const PluralRules &other) const
Compares the equality of two PluralRules objects.
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
static UClassID getStaticClassID(void)
ICU "poor man's RTTI", returns a UClassID for this class.
static PluralRules * forLocale(const Locale &locale, UErrorCode &status)
Provides access to the predefined cardinal-number PluralRules for a given locale.
static PluralRules * forLocale(const Locale &locale, UPluralType type, UErrorCode &status)
Provides access to the predefined PluralRules for a given locale and the plural type.
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:295
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.
Definition: umachine.h:261
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:53
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