ICU 75.1 75.1
Loading...
Searching...
No Matches
rbnf.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) 1997-2015, International Business Machines Corporation and others.
6* All Rights Reserved.
7*******************************************************************************
8*/
9
10#ifndef RBNF_H
11#define RBNF_H
12
13#include "unicode/utypes.h"
14
15#if U_SHOW_CPLUSPLUS_API
16
29#if UCONFIG_NO_FORMATTING
30#define U_HAVE_RBNF 0
31#else
32#define U_HAVE_RBNF 1
33
34#include "unicode/dcfmtsym.h"
35#include "unicode/fmtable.h"
36#include "unicode/locid.h"
37#include "unicode/numfmt.h"
38#include "unicode/unistr.h"
39#include "unicode/strenum.h"
40#include "unicode/brkiter.h"
42
43U_NAMESPACE_BEGIN
44
45class NFRule;
46class NFRuleSet;
47class LocalizationInfo;
48class PluralFormat;
49class RuleBasedCollator;
50
67#ifndef U_HIDE_DEPRECATED_API
73#endif // U_HIDE_DERECATED_API
80 URBNF_NUMBERING_SYSTEM = 3,
81#ifndef U_HIDE_DEPRECATED_API
87#endif // U_HIDE_DEPRECATED_API
88};
89
592public:
593
594 //-----------------------------------------------------------------------
595 // constructors
596 //-----------------------------------------------------------------------
597
609
633 RuleBasedNumberFormat(const UnicodeString& rules, const UnicodeString& localizations,
635
651 RuleBasedNumberFormat(const UnicodeString& rules, const Locale& locale,
653
680 RuleBasedNumberFormat(const UnicodeString& rules, const UnicodeString& localizations,
681 const Locale& locale, UParseError& perror, UErrorCode& status);
682
702
703 //-----------------------------------------------------------------------
704 // boilerplate
705 //-----------------------------------------------------------------------
706
713
720
726
733 virtual RuleBasedNumberFormat* clone() const override;
734
742 virtual bool operator==(const Format& other) const override;
743
744//-----------------------------------------------------------------------
745// public API functions
746//-----------------------------------------------------------------------
747
753 virtual UnicodeString getRules() const;
754
761
770
777
787
802 const Locale& locale = Locale::getDefault());
803
813 const Locale& locale = Locale::getDefault());
814
815
816 using NumberFormat::format;
817
826 virtual UnicodeString& format(int32_t number,
828 FieldPosition& pos) const override;
829
838 virtual UnicodeString& format(int64_t number,
840 FieldPosition& pos) const override;
849 virtual UnicodeString& format(double number,
851 FieldPosition& pos) const override;
852
864 virtual UnicodeString& format(int32_t number,
867 FieldPosition& pos,
868 UErrorCode& status) const;
880 virtual UnicodeString& format(int64_t number,
883 FieldPosition& pos,
884 UErrorCode& status) const;
896 virtual UnicodeString& format(double number,
899 FieldPosition& pos,
900 UErrorCode& status) const;
901
902protected:
920 virtual UnicodeString& format(const number::impl::DecimalQuantity &number,
921 UnicodeString& appendTo,
922 FieldPosition& pos,
923 UErrorCode& status) const override;
924public:
925
926 using NumberFormat::parse;
927
942 virtual void parse(const UnicodeString& text,
944 ParsePosition& parsePosition) const override;
945
946#if !UCONFIG_NO_COLLATION
947
981 virtual void setLenient(UBool enabled) override;
982
990 virtual inline UBool isLenient() const override;
991
992#endif
993
1003
1011
1022 virtual void setContext(UDisplayContext value, UErrorCode& status) override;
1023
1029 virtual ERoundingMode getRoundingMode() const override;
1030
1036 virtual void setRoundingMode(ERoundingMode roundingMode) override;
1037
1038public:
1045
1051 virtual UClassID getDynamicClassID() const override;
1052
1062
1072 virtual void setDecimalFormatSymbols(const DecimalFormatSymbols& symbols);
1073
1074private:
1075 RuleBasedNumberFormat() = delete; // default constructor not implemented
1076
1077 // this will ref the localizations if they are not nullptr
1078 // caller must deref to get adoption
1080 const Locale& locale, UParseError& perror, UErrorCode& status);
1081
1082 void init(const UnicodeString& rules, LocalizationInfo* localizations, UParseError& perror, UErrorCode& status);
1083 void initCapitalizationContextInfo(const Locale& thelocale);
1084 void dispose();
1085 void stripWhitespace(UnicodeString& src);
1086 void initDefaultRuleSet();
1087 NFRuleSet* findRuleSet(const UnicodeString& name, UErrorCode& status) const;
1088
1089 /* friend access */
1090 friend class NFSubstitution;
1091 friend class NFRule;
1092 friend class NFRuleSet;
1093 friend class FractionalPartSubstitution;
1094
1095 inline NFRuleSet * getDefaultRuleSet() const;
1096 const RuleBasedCollator * getCollator() const;
1097 DecimalFormatSymbols * initializeDecimalFormatSymbols(UErrorCode &status);
1098 const DecimalFormatSymbols * getDecimalFormatSymbols() const;
1099 NFRule * initializeDefaultInfinityRule(UErrorCode &status);
1100 const NFRule * getDefaultInfinityRule() const;
1101 NFRule * initializeDefaultNaNRule(UErrorCode &status);
1102 const NFRule * getDefaultNaNRule() const;
1103 PluralFormat *createPluralFormat(UPluralType pluralType, const UnicodeString &pattern, UErrorCode& status) const;
1104 UnicodeString& adjustForCapitalizationContext(int32_t startPos, UnicodeString& currentResult, UErrorCode& status) const;
1106 void format(double number, NFRuleSet& rs, UnicodeString& toAppendTo, UErrorCode& status) const;
1107
1108private:
1109 NFRuleSet **fRuleSets;
1110 UnicodeString* ruleSetDescriptions;
1111 int32_t numRuleSets;
1112 NFRuleSet *defaultRuleSet;
1113 Locale locale;
1114 RuleBasedCollator* collator;
1115 DecimalFormatSymbols* decimalFormatSymbols;
1116 NFRule *defaultInfinityRule;
1117 NFRule *defaultNaNRule;
1118 ERoundingMode fRoundingMode;
1119 UBool lenient;
1120 UnicodeString* lenientParseRules;
1121 LocalizationInfo* localizations;
1122 UnicodeString originalDescription;
1123 UBool capitalizationInfoSet;
1124 UBool capitalizationForUIListMenu;
1125 UBool capitalizationForStandAlone;
1126 BreakIterator* capitalizationBrkIter;
1127};
1128
1129// ---------------
1130
1131#if !UCONFIG_NO_COLLATION
1132
1133inline UBool
1134RuleBasedNumberFormat::isLenient() const {
1135 return lenient;
1136}
1137
1138#endif
1139
1140inline NFRuleSet*
1141RuleBasedNumberFormat::getDefaultRuleSet() const {
1142 return defaultRuleSet;
1143}
1144
1145U_NAMESPACE_END
1146
1147/* U_HAVE_RBNF */
1148#endif
1149
1150#endif /* U_SHOW_CPLUSPLUS_API */
1151
1152/* RBNF_H */
1153#endif
C++ API: Break Iterator.
The BreakIterator class implements methods for finding the location of boundaries in text.
Definition brkiter.h:106
This class represents the set of symbols needed by DecimalFormat to format numbers.
Definition dcfmtsym.h:86
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition fieldpos.h:110
Base class for all formats.
Definition format.h:98
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition fmtable.h:63
"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:195
ERoundingMode
Rounding mode.
Definition numfmt.h:186
virtual UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
Format an object to produce a string.
virtual UBool isLenient() const
Returns whether lenient parsing is enabled (it is off by default).
Definition numfmt.h:1274
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition parsepos.h:52
The RuleBasedCollator class provides the implementation of Collator, using data-driven tables.
Definition tblcoll.h:115
The RuleBasedNumberFormat class formats numbers according to a set of rules.
Definition rbnf.h:591
virtual void setLenient(UBool enabled) override
Turns lenient parse mode on and off.
virtual UnicodeString & format(int64_t number, UnicodeString &toAppendTo, FieldPosition &pos) const override
Formats the specified 64-bit number using the default ruleset.
virtual UnicodeString getRuleSetName(int32_t index) const
Return the name of the index'th public ruleSet.
RuleBasedNumberFormat(const UnicodeString &rules, const UnicodeString &localizations, UParseError &perror, UErrorCode &status)
Creates a RuleBasedNumberFormat that behaves according to the description passed in.
virtual UnicodeString getRules() const
return the rules that were provided to the RuleBasedNumberFormat.
virtual int32_t getNumberOfRuleSetDisplayNameLocales() const
Return the number of locales for which we have localized rule set display names.
RuleBasedNumberFormat(const UnicodeString &rules, const Locale &locale, UParseError &perror, UErrorCode &status)
Creates a RuleBasedNumberFormat that behaves according to the rules passed in.
virtual int32_t getNumberOfRuleSetNames() const
Return the number of public rule set names.
virtual UnicodeString & format(double number, const UnicodeString &ruleSetName, UnicodeString &toAppendTo, FieldPosition &pos, UErrorCode &status) const
Formats the specified number using the named ruleset.
virtual UnicodeString & format(int64_t number, const UnicodeString &ruleSetName, UnicodeString &toAppendTo, FieldPosition &pos, UErrorCode &status) const
Formats the specified 64-bit number using the named ruleset.
virtual UnicodeString & format(int32_t number, UnicodeString &toAppendTo, FieldPosition &pos) const override
Formats the specified 32-bit number using the default ruleset.
virtual void setDecimalFormatSymbols(const DecimalFormatSymbols &symbols)
Sets the decimal format symbols, which is generally not changed by the programmer or user.
virtual void setContext(UDisplayContext value, UErrorCode &status) override
Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALO...
virtual ~RuleBasedNumberFormat()
Release memory allocated for a RuleBasedNumberFormat when you are finished with it.
virtual UnicodeString & format(int32_t number, const UnicodeString &ruleSetName, UnicodeString &toAppendTo, FieldPosition &pos, UErrorCode &status) const
Formats the specified number using the named ruleset.
virtual void parse(const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const override
Parses the specified string, beginning at the specified position, according to this formatter's rules...
virtual ERoundingMode getRoundingMode() const override
Get the rounding mode.
virtual void setRoundingMode(ERoundingMode roundingMode) override
Set the rounding mode.
virtual void setDefaultRuleSet(const UnicodeString &ruleSetName, UErrorCode &status)
Override the default rule set to use.
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
RuleBasedNumberFormat & operator=(const RuleBasedNumberFormat &rhs)
Assignment operator.
virtual UnicodeString & format(double number, UnicodeString &toAppendTo, FieldPosition &pos) const override
Formats the specified number using the default ruleset.
virtual RuleBasedNumberFormat * clone() const override
Clone this object polymorphically.
virtual UnicodeString & format(const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
Format a decimal number.
RuleBasedNumberFormat(URBNFRuleSetTag tag, const Locale &locale, UErrorCode &status)
Creates a RuleBasedNumberFormat from a predefined ruleset.
virtual UnicodeString getRuleSetDisplayName(int32_t index, const Locale &locale=Locale::getDefault())
Return the rule set display names for the provided locale.
RuleBasedNumberFormat(const RuleBasedNumberFormat &rhs)
Copy constructor.
virtual UnicodeString getDefaultRuleSetName() const
Return the name of the current default rule set.
RuleBasedNumberFormat(const UnicodeString &rules, const UnicodeString &localizations, const Locale &locale, UParseError &perror, UErrorCode &status)
Creates a RuleBasedNumberFormat that behaves according to the description passed in.
virtual Locale getRuleSetDisplayNameLocale(int32_t index, UErrorCode &status) const
Return the index'th display name locale.
virtual bool operator==(const Format &other) const override
Return true if the given Format objects are semantically equal.
virtual UnicodeString getRuleSetDisplayName(const UnicodeString &ruleSetName, const Locale &locale=Locale::getDefault())
Return the rule set display name for the provided rule set and locale.
virtual void adoptDecimalFormatSymbols(DecimalFormatSymbols *symbolsToAdopt)
Sets the decimal format symbols, which is generally not changed by the programmer or user.
RuleBasedNumberFormat(const UnicodeString &rules, UParseError &perror, UErrorCode &status)
Creates a RuleBasedNumberFormat that behaves according to the description passed in.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:296
C++ API: Symbols for formatting numbers.
C++ API: Formattable is a thin wrapper for primitive types used for formatting and parsing.
C++ API: Locale ID object.
URBNFRuleSetTag
Tags for the predefined rulesets.
Definition rbnf.h:56
@ URBNF_COUNT
One more than the highest normal URBNFRuleSetTag value.
Definition rbnf.h:86
@ URBNF_DURATION
Requests predefined ruleset for formatting a value as a duration in hours, minutes,...
Definition rbnf.h:72
@ URBNF_ORDINAL
Requests predefined ruleset for the ordinal form of a number.
Definition rbnf.h:66
@ URBNF_SPELLOUT
Requests predefined ruleset for spelling out numeric values in words.
Definition rbnf.h:61
C++ API: Compatibility APIs for number formatting.
C++ API: String Enumeration.
A UParseError struct is used to returned detailed information about parsing errors.
Definition parseerr.h:58
UDisplayContext
Display context settings.
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
C++ API: Unicode String.
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.
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