xref: /aosp_15_r20/external/icu/libicu/cts_headers/nfrule.h (revision 0e209d3975ff4a8c132096b14b0e9364a753506e)
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
6 * Corporation and others. All Rights Reserved.
7 *******************************************************************************
8 */
9 
10 #ifndef NFRULE_H
11 #define NFRULE_H
12 
13 #include "unicode/rbnf.h"
14 
15 #if U_HAVE_RBNF
16 
17 #include "unicode/utypes.h"
18 #include "unicode/uobject.h"
19 #include "unicode/unistr.h"
20 
21 U_NAMESPACE_BEGIN
22 
23 class FieldPosition;
24 class Formattable;
25 class NFRuleList;
26 class NFRuleSet;
27 class NFSubstitution;
28 class ParsePosition;
29 class PluralFormat;
30 class RuleBasedNumberFormat;
31 class UnicodeString;
32 
33 class NFRule : public UMemory {
34 public:
35 
36     enum ERuleType {
37         kNoBase = 0,
38         kNegativeNumberRule = -1,
39         kImproperFractionRule = -2,
40         kProperFractionRule = -3,
41         kDefaultRule = -4,
42         kInfinityRule = -5,
43         kNaNRule = -6,
44         kOtherRule = -7
45     };
46 
47     static void makeRules(UnicodeString& definition,
48                           NFRuleSet* ruleSet,
49                           const NFRule* predecessor,
50                           const RuleBasedNumberFormat* rbnf,
51                           NFRuleList& ruleList,
52                           UErrorCode& status);
53 
54     NFRule(const RuleBasedNumberFormat* rbnf, const UnicodeString &ruleText, UErrorCode &status);
55     ~NFRule();
56 
57     bool operator==(const NFRule& rhs) const;
58     bool operator!=(const NFRule& rhs) const { return !operator==(rhs); }
59 
getType()60     ERuleType getType() const { return (ERuleType)(baseValue <= kNoBase ? (ERuleType)baseValue : kOtherRule); }
setType(ERuleType ruleType)61     void setType(ERuleType ruleType) { baseValue = (int32_t)ruleType; }
62 
getBaseValue()63     int64_t getBaseValue() const { return baseValue; }
64     void setBaseValue(int64_t value, UErrorCode& status);
65 
getDecimalPoint()66     char16_t getDecimalPoint() const { return decimalPoint; }
67 
68     int64_t getDivisor() const;
69 
70     bool hasModulusSubstitution() const;
71 
72     void doFormat(int64_t number, UnicodeString& toAppendTo, int32_t pos, int32_t recursionCount, UErrorCode& status) const;
73     void doFormat(double  number, UnicodeString& toAppendTo, int32_t pos, int32_t recursionCount, UErrorCode& status) const;
74 
75     UBool doParse(const UnicodeString& text,
76                   ParsePosition& pos,
77                   UBool isFractional,
78                   double upperBound,
79                   uint32_t nonNumericalExecutedRuleMask,
80                   Formattable& result) const;
81 
82     UBool shouldRollBack(int64_t number) const;
83 
84     void _appendRuleText(UnicodeString& result) const;
85 
86     int32_t findTextLenient(const UnicodeString& str, const UnicodeString& key,
87                      int32_t startingAt, int32_t* resultCount) const;
88 
89     void setDecimalFormatSymbols(const DecimalFormatSymbols &newSymbols, UErrorCode& status);
90 
91 private:
92     void parseRuleDescriptor(UnicodeString& descriptor, UErrorCode& status);
93     void extractSubstitutions(const NFRuleSet* ruleSet, const UnicodeString &ruleText, const NFRule* predecessor, UErrorCode& status);
94     NFSubstitution* extractSubstitution(const NFRuleSet* ruleSet, const NFRule* predecessor, UErrorCode& status);
95 
96     int16_t expectedExponent() const;
97     int32_t indexOfAnyRulePrefix() const;
98     double matchToDelimiter(const UnicodeString& text, int32_t startPos, double baseValue,
99                             const UnicodeString& delimiter, ParsePosition& pp, const NFSubstitution* sub,
100                             uint32_t nonNumericalExecutedRuleMask,
101                             double upperBound) const;
102     void stripPrefix(UnicodeString& text, const UnicodeString& prefix, ParsePosition& pp) const;
103 
104     int32_t prefixLength(const UnicodeString& str, const UnicodeString& prefix, UErrorCode& status) const;
105     UBool allIgnorable(const UnicodeString& str, UErrorCode& status) const;
106     int32_t findText(const UnicodeString& str, const UnicodeString& key,
107                      int32_t startingAt, int32_t* resultCount) const;
108 
109 private:
110     int64_t baseValue;
111     int32_t radix;
112     int16_t exponent;
113     char16_t decimalPoint;
114     UnicodeString fRuleText;
115     NFSubstitution* sub1;
116     NFSubstitution* sub2;
117     const RuleBasedNumberFormat* formatter;
118     const PluralFormat* rulePatternFormat;
119 
120     NFRule(const NFRule &other); // forbid copying of this class
121     NFRule &operator=(const NFRule &other); // forbid copying of this class
122 
123     // TODO: temporary hack to allow MultiplierSubstitution to get to formatter's rounding mode
124     friend class MultiplierSubstitution;
125 };
126 
127 U_NAMESPACE_END
128 
129 /* U_HAVE_RBNF */
130 #endif
131 
132 // NFRULE_H
133 #endif
134 
135