plurfmt.h
Go to the documentation of this file.
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2007-2014, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*
* File PLURFMT.H
********************************************************************************
*/
#ifndef PLURFMT
#define PLURFMT
#include "unicode/utypes.h"
#if U_SHOW_CPLUSPLUS_API
#if !UCONFIG_NO_FORMATTING
#include "unicode/messagepattern.h"
#include "unicode/numfmt.h"
#include "unicode/plurrule.h"
U_NAMESPACE_BEGIN
class Hashtable;
class NFRule;
class U_I18N_API PluralFormat : public Format {
public:
PluralFormat(UErrorCode& status);
PluralFormat(const Locale& locale, UErrorCode& status);
PluralFormat(const PluralRules& rules, UErrorCode& status);
PluralFormat(const Locale& locale, const PluralRules& rules, UErrorCode& status);
PluralFormat(const Locale& locale, UPluralType type, UErrorCode& status);
PluralFormat(const UnicodeString& pattern, UErrorCode& status);
PluralFormat(const Locale& locale, const UnicodeString& pattern, UErrorCode& status);
PluralFormat(const PluralRules& rules,
const UnicodeString& pattern,
UErrorCode& status);
PluralFormat(const Locale& locale,
const PluralRules& rules,
const UnicodeString& pattern,
UErrorCode& status);
PluralFormat(const Locale& locale,
UPluralType type,
const UnicodeString& pattern,
UErrorCode& status);
PluralFormat(const PluralFormat& other);
virtual ~PluralFormat();
void applyPattern(const UnicodeString& pattern, UErrorCode& status);
using Format::format;
UnicodeString format(int32_t number, UErrorCode& status) const;
UnicodeString format(double number, UErrorCode& status) const;
UnicodeString& format(int32_t number,
UnicodeString& appendTo,
FieldPosition& pos,
UErrorCode& status) const;
UnicodeString& format(double number,
UnicodeString& appendTo,
FieldPosition& pos,
UErrorCode& status) const;
#ifndef U_HIDE_DEPRECATED_API
void setLocale(const Locale& locale, UErrorCode& status);
#endif /* U_HIDE_DEPRECATED_API */
void setNumberFormat(const NumberFormat* format, UErrorCode& status);
PluralFormat& operator=(const PluralFormat& other);
virtual bool operator==(const Format& other) const override;
virtual bool operator!=(const Format& other) const;
virtual PluralFormat* clone() const override;
UnicodeString& format(const Formattable& obj,
UnicodeString& appendTo,
FieldPosition& pos,
UErrorCode& status) const override;
UnicodeString& toPattern(UnicodeString& appendTo);
virtual void parseObject(const UnicodeString& source,
Formattable& result,
ParsePosition& parse_pos) const override;
static UClassID U_EXPORT2 getStaticClassID(void);
virtual UClassID getDynamicClassID() const override;
private:
class U_I18N_API PluralSelector : public UMemory {
public:
virtual ~PluralSelector();
virtual UnicodeString select(void *context, double number, UErrorCode& ec) const = 0;
};
class U_I18N_API PluralSelectorAdapter : public PluralSelector {
public:
PluralSelectorAdapter() : pluralRules(nullptr) {
}
virtual ~PluralSelectorAdapter();
virtual UnicodeString select(void *context, double number, UErrorCode& /*ec*/) const override;
void reset();
PluralRules* pluralRules;
};
Locale locale;
MessagePattern msgPattern;
NumberFormat* numberFormat;
double offset;
PluralSelectorAdapter pluralRulesWrapper;
PluralFormat() = delete; // default constructor not implemented
void init(const PluralRules* rules, UPluralType type, UErrorCode& status);
void copyObjects(const PluralFormat& other);
UnicodeString& format(const Formattable& numberObject, double number,
UnicodeString& appendTo,
FieldPosition& pos,
UErrorCode& status) const;
static int32_t findSubMessage(
const MessagePattern& pattern, int32_t partIndex,
const PluralSelector& selector, void *context, double number, UErrorCode& ec);
void parseType(const UnicodeString& source, const NFRule *rbnfLenientScanner,
Formattable& result, FieldPosition& pos) const;
friend class MessageFormat;
friend class NFRule;
};
U_NAMESPACE_END
#endif /* #if !UCONFIG_NO_FORMATTING */
#endif /* U_SHOW_CPLUSPLUS_API */
#endif // _PLURFMT
//eof
icu::FieldPosition
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition: fieldpos.h:110
icu::Format
Base class for all formats.
Definition: format.h:98
icu::Format::format
UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
Formats an object to produce a string.
icu::Formattable
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition: fmtable.h:64
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
icu::NumberFormat
Definition: numfmt.h:175
icu::ParsePosition
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition: parsepos.h:52
icu::PluralFormat
Definition: plurfmt.h:148
icu::PluralFormat::setNumberFormat
void setNumberFormat(const NumberFormat *format, UErrorCode &status)
Sets the number format used by this formatter.
icu::PluralFormat::PluralFormat
PluralFormat(const Locale &locale, UPluralType type, const UnicodeString &pattern, UErrorCode &status)
Creates a new PluralFormat for a plural type, a pattern and a locale.
icu::PluralFormat::PluralFormat
PluralFormat(const Locale &locale, const UnicodeString &pattern, UErrorCode &status)
Creates a new cardinal-number PluralFormat for a given pattern string and locale.
icu::PluralFormat::getDynamicClassID
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
icu::PluralFormat::operator=
PluralFormat & operator=(const PluralFormat &other)
Assignment operator.
icu::PluralFormat::format
UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
Formats a plural message for a number taken from a Formattable object.
icu::PluralFormat::parseObject
virtual void parseObject(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const override
This method is not yet supported by PluralFormat.
icu::PluralFormat::operator!=
virtual bool operator!=(const Format &other) const
Return true if another object is semantically unequal to this one.
icu::PluralFormat::PluralFormat
PluralFormat(const UnicodeString &pattern, UErrorCode &status)
Creates a new cardinal-number PluralFormat for a given pattern string.
icu::PluralFormat::applyPattern
void applyPattern(const UnicodeString &pattern, UErrorCode &status)
Sets the pattern used by this plural format.
icu::PluralFormat::PluralFormat
PluralFormat(const PluralRules &rules, UErrorCode &status)
Creates a new PluralFormat for a given set of rules.
icu::PluralFormat::format
UnicodeString & format(int32_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Formats a plural message for a given number.
icu::PluralFormat::PluralFormat
PluralFormat(const Locale &locale, UPluralType type, UErrorCode &status)
Creates a new PluralFormat for the plural type.
icu::PluralFormat::PluralFormat
PluralFormat(const PluralRules &rules, const UnicodeString &pattern, UErrorCode &status)
Creates a new PluralFormat for a given set of rules, a pattern and a locale.
icu::PluralFormat::PluralFormat
PluralFormat(UErrorCode &status)
Creates a new cardinal-number PluralFormat for the default locale.
icu::PluralFormat::toPattern
UnicodeString & toPattern(UnicodeString &appendTo)
Returns the pattern from applyPattern() or constructor().
icu::PluralFormat::PluralFormat
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.
icu::PluralFormat::clone
virtual PluralFormat * clone() const override
Clones this Format object polymorphically.
icu::PluralFormat::format
UnicodeString format(double number, UErrorCode &status) const
Formats a plural message for a given number.
icu::PluralFormat::setLocale
void setLocale(const Locale &locale, UErrorCode &status)
Sets the locale used by this PluraFormat object.
icu::PluralFormat::format
UnicodeString format(int32_t number, UErrorCode &status) const
Formats a plural message for a given number.
icu::PluralFormat::PluralFormat
PluralFormat(const PluralFormat &other)
copy constructor.
icu::PluralFormat::operator==
virtual bool operator==(const Format &other) const override
Return true if another object is semantically equal to this one.
icu::PluralFormat::PluralFormat
PluralFormat(const Locale &locale, UErrorCode &status)
Creates a new cardinal-number PluralFormat for a given locale.
icu::PluralFormat::format
UnicodeString & format(double number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Formats a plural message for a given number.
icu::PluralFormat::PluralFormat
PluralFormat(const Locale &locale, const PluralRules &rules, UErrorCode &status)
Creates a new PluralFormat for a given set of rules.
icu::PluralFormat::getStaticClassID
static UClassID getStaticClassID(void)
ICU "poor man's RTTI", returns a UClassID for this class.
icu::PluralFormat::~PluralFormat
virtual ~PluralFormat()
Destructor.
icu::PluralRules
Defines rules for mapping non-negative numeric values onto a small set of keywords.
Definition: plurrule.h:212
icu::UMemory
UMemory is the common ICU base class.
Definition: uobject.h:115
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
messagepattern.h
C++ API: MessagePattern class: Parses and represents ICU MessageFormat patterns.
numfmt.h
C++ API: Compatibility APIs for number formatting.
plurrule.h
C++ API: PluralRules object.
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
UPluralType
UPluralType
Type of plurals and PluralRules.
Definition: upluralrules.h:59
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301