ICU 62.1 62.1
plurfmt.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) 2007-2014, International Business Machines Corporation and
6* others. All Rights Reserved.
7*******************************************************************************
8*
9
10* File PLURFMT.H
11********************************************************************************
12*/
13
14#ifndef PLURFMT
15#define PLURFMT
16
17#include "unicode/utypes.h"
18
24#if !UCONFIG_NO_FORMATTING
25
27#include "unicode/numfmt.h"
28#include "unicode/plurrule.h"
29
31
32class Hashtable;
33class NFRule;
34
147public:
148
158
169
180
197 PluralFormat(const Locale& locale, const PluralRules& rules, UErrorCode& status);
198
210
222
237 PluralFormat(const Locale& locale, const UnicodeString& pattern, UErrorCode& status);
238
251 const UnicodeString& pattern,
253
268 PluralFormat(const Locale& locale,
269 const PluralRules& rules,
270 const UnicodeString& pattern,
272
286 PluralFormat(const Locale& locale,
287 UPluralType type,
288 const UnicodeString& pattern,
290
296
301 virtual ~PluralFormat();
302
316
317
318 using Format::format;
319
332 UnicodeString format(int32_t number, UErrorCode& status) const;
333
346 UnicodeString format(double number, UErrorCode& status) const;
347
364 UnicodeString& format(int32_t number,
365 UnicodeString& appendTo,
366 FieldPosition& pos,
367 UErrorCode& status) const;
368
385 UnicodeString& format(double number,
386 UnicodeString& appendTo,
387 FieldPosition& pos,
388 UErrorCode& status) const;
389
390#ifndef U_HIDE_DEPRECATED_API
406 void setLocale(const Locale& locale, UErrorCode& status);
407#endif /* U_HIDE_DEPRECATED_API */
408
419
427
435 virtual UBool operator==(const Format& other) const;
436
444 virtual UBool operator!=(const Format& other) const;
445
451 virtual Format* clone(void) const;
452
468 UnicodeString& appendTo,
469 FieldPosition& pos,
470 UErrorCode& status) const;
471
481
504 virtual void parseObject(const UnicodeString& source,
506 ParsePosition& parse_pos) const;
507
515
522
523#if (defined(__xlC__) && (__xlC__ < 0x0C00)) || (U_PLATFORM == U_PF_OS390) || (U_PLATFORM ==U_PF_OS400)
524// Work around a compiler bug on xlC 11.1 on AIX 7.1 that would
525// prevent PluralSelectorAdapter from implementing private PluralSelector.
526// xlC error message:
527// 1540-0300 (S) The "private" member "class icu_49::PluralFormat::PluralSelector" cannot be accessed.
528public:
529#else
530private:
531#endif
536 public:
537 virtual ~PluralSelector();
547 virtual UnicodeString select(void *context, double number, UErrorCode& ec) const = 0;
548 };
549
554 public:
555 PluralSelectorAdapter() : pluralRules(NULL) {
556 }
557
558 virtual ~PluralSelectorAdapter();
559
560 virtual UnicodeString select(void *context, double number, UErrorCode& /*ec*/) const;
562 void reset();
563
564 PluralRules* pluralRules;
565 };
566
567#if defined(__xlC__)
568// End of xlC bug workaround, keep remaining definitions private.
569private:
570#endif
571 Locale locale;
572 MessagePattern msgPattern;
573 NumberFormat* numberFormat;
574 double offset;
575 PluralSelectorAdapter pluralRulesWrapper;
576
577 PluralFormat(); // default constructor not implemented
578 void init(const PluralRules* rules, UPluralType type, UErrorCode& status);
584
586 UnicodeString& appendTo,
587 FieldPosition& pos,
588 UErrorCode& status) const;
601 static int32_t findSubMessage(
602 const MessagePattern& pattern, int32_t partIndex,
603 const PluralSelector& selector, void *context, double number, UErrorCode& ec);
605 void parseType(const UnicodeString& source, const NFRule *rbnfLenientScanner,
606 Formattable& result, FieldPosition& pos) const;
607
608 friend class MessageFormat;
609 friend class NFRule;
610};
611
613
614#endif /* #if !UCONFIG_NO_FORMATTING */
615
616#endif // _PLURFMT
617//eof
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition fieldpos.h:108
Base class for all formats.
Definition format.h:96
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition fmtable.h:62
"Smart pointer" base class; do not use directly: use LocalPointer etc.
A Locale object represents a specific geographical, political, or cultural region.
Definition locid.h:188
Parses and represents ICU MessageFormat patterns.
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition parsepos.h:49
virtual UnicodeString select(void *context, double number, UErrorCode &) const
virtual UnicodeString select(void *context, double number, UErrorCode &ec) const =0
Given a number, returns the appropriate PluralFormat keyword.
void setNumberFormat(const NumberFormat *format, UErrorCode &status)
Sets the number format used by this formatter.
PluralFormat(const Locale &locale, UPluralType type, const UnicodeString &pattern, UErrorCode &status)
Creates a new PluralFormat for a plural type, a pattern and a locale.
PluralFormat(const Locale &locale, const UnicodeString &pattern, UErrorCode &status)
Creates a new cardinal-number PluralFormat for a given pattern string and locale.
virtual UClassID getDynamicClassID() const
ICU "poor man's RTTI", returns a UClassID for the actual class.
UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Formats a plural message for a number taken from a Formattable object.
UnicodeString & format(const Formattable &numberObject, double number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
PluralFormat(const UnicodeString &pattern, UErrorCode &status)
Creates a new cardinal-number PluralFormat for a given pattern string.
void applyPattern(const UnicodeString &pattern, UErrorCode &status)
Sets the pattern used by this plural format.
PluralFormat(const PluralRules &rules, UErrorCode &status)
Creates a new PluralFormat for a given set of rules.
UnicodeString & toPattern(UnicodeString &appendTo)
Returns the pattern from applyPattern() or constructor().
UnicodeString & format(double number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Formats a plural message for a given number.
PluralFormat(const Locale &locale, UPluralType type, UErrorCode &status)
Creates a new PluralFormat for the plural type.
virtual UBool operator!=(const Format &other) const
Return true if another object is semantically unequal to this one.
PluralFormat(const PluralRules &rules, const UnicodeString &pattern, UErrorCode &status)
Creates a new PluralFormat for a given set of rules, a pattern and a locale.
PluralFormat(UErrorCode &status)
Creates a new cardinal-number PluralFormat for the default locale.
void copyObjects(const PluralFormat &other)
Copies dynamically allocated values (pointer fields).
PluralFormat(const Locale &locale, const PluralRules &rules, const UnicodeString &pattern, UErrorCode &status)
Creates a new PluralFormat for a given set of rules, a pattern and a locale.
PluralFormat & operator=(const PluralFormat &other)
Assignment operator.
UnicodeString format(double number, UErrorCode &status) const
Formats a plural message for a given number.
void setLocale(const Locale &locale, UErrorCode &status)
Sets the locale used by this PluraFormat object.
UnicodeString format(int32_t number, UErrorCode &status) const
Formats a plural message for a given number.
PluralFormat(const PluralFormat &other)
copy constructor.
virtual void parseObject(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const
This method is not yet supported by PluralFormat.
PluralFormat(const Locale &locale, UErrorCode &status)
Creates a new cardinal-number PluralFormat for a given locale.
UnicodeString & format(int32_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Formats a plural message for a given number.
virtual Format * clone(void) const
Clones this Format object polymorphically.
virtual UBool operator==(const Format &other) const
Return true if another object is semantically equal to this one.
PluralFormat(const Locale &locale, const PluralRules &rules, UErrorCode &status)
Creates a new PluralFormat for a given set of rules.
static UClassID getStaticClassID(void)
ICU "poor man's RTTI", returns a UClassID for this class.
static int32_t findSubMessage(const MessagePattern &pattern, int32_t partIndex, const PluralSelector &selector, void *context, double number, UErrorCode &ec)
Finds the PluralFormat sub-message for the given number, or the "other" sub-message.
virtual ~PluralFormat()
Destructor.
Defines rules for mapping non-negative numeric values onto a small set of keywords.
Definition plurrule.h:196
UMemory is the common ICU base class.
Definition uobject.h:112
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:287
C++ API: MessagePattern class: Parses and represents ICU MessageFormat patterns.
C++ API: Compatibility APIs for number formatting.
C++ API: PluralRules object.
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:93
UPluralType
Type of plurals and PluralRules.
Basic definitions for ICU, for both C and C++ APIs.
#define NULL
Define NULL if necessary, to nullptr for C++ and to ((void *)0) for C.
Definition utypes.h:188
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:360
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137