Unreviewed, rolling out r126169.
[WebKit-https.git] / Source / WebCore / platform / Decimal.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef Decimal_h
32 #define Decimal_h
33
34 #include <stdint.h>
35 #include <wtf/Assertions.h>
36 #include <wtf/text/WTFString.h>
37
38 namespace WebCore {
39
40 namespace DecimalPrivate {
41 class SpecialValueHandler;
42 }
43
44 // This class represents decimal base floating point number.
45 //
46 // FIXME: Once all C++ compiler support decimal type, we should replace this
47 // class to compiler supported one. See below URI for current status of decimal
48 // type for C++: // http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n1977.html
49 class Decimal {
50 public:
51     enum Sign {
52         Positive,
53         Negative,
54     };
55
56     // You should not use EncodedData other than unit testing.
57     class EncodedData {
58         // For accessing FormatClass.
59         friend class Decimal;
60         friend class DecimalPrivate::SpecialValueHandler;
61     public:
62         EncodedData(Sign, int exponent, uint64_t coefficient);
63
64         bool operator==(const EncodedData&) const;
65         bool operator!=(const EncodedData& another) const { return !operator==(another); }
66
67         uint64_t coefficient() const { return m_coefficient; }
68         int countDigits() const;
69         int exponent() const { return m_exponent; }
70         bool isFinite() const { return !isSpecial(); }
71         bool isInfinity() const { return m_formatClass == ClassInfinity; }
72         bool isNaN() const { return m_formatClass == ClassNaN; }
73         bool isSpecial() const { return m_formatClass == ClassInfinity || m_formatClass == ClassNaN; }
74         bool isZero() const { return m_formatClass == ClassZero; }
75         Sign sign() const { return m_sign; }
76         void setSign(Sign sign) { m_sign = sign; }
77
78     private:
79         enum FormatClass {
80             ClassInfinity,
81             ClassNormal,
82             ClassNaN,
83             ClassZero,
84         };
85
86         EncodedData(Sign, FormatClass);
87         FormatClass formatClass() const { return m_formatClass; }
88
89         uint64_t m_coefficient;
90         int16_t m_exponent;
91         FormatClass m_formatClass;
92         Sign m_sign;
93     };
94
95     Decimal(int32_t = 0);
96     Decimal(Sign, int exponent, uint64_t coefficient);
97     Decimal(const Decimal&);
98
99     Decimal& operator=(const Decimal&);
100     Decimal& operator+=(const Decimal&);
101     Decimal& operator-=(const Decimal&);
102     Decimal& operator*=(const Decimal&);
103     Decimal& operator/=(const Decimal&);
104
105     Decimal operator-() const;
106
107     bool operator==(const Decimal&) const;
108     bool operator!=(const Decimal&) const;
109     bool operator<(const Decimal&) const;
110     bool operator<=(const Decimal&) const;
111     bool operator>(const Decimal&) const;
112     bool operator>=(const Decimal&) const;
113
114     Decimal operator+(const Decimal&) const;
115     Decimal operator-(const Decimal&) const;
116     Decimal operator*(const Decimal&) const;
117     Decimal operator/(const Decimal&) const;
118
119     int exponent() const
120     {
121         ASSERT(isFinite());
122         return m_data.exponent();
123     }
124
125     bool isFinite() const { return m_data.isFinite(); }
126     bool isInfinity() const { return m_data.isInfinity(); }
127     bool isNaN() const { return m_data.isNaN(); }
128     bool isNegative() const { return sign() == Negative; }
129     bool isPositive() const { return sign() == Positive; }
130     bool isSpecial() const { return m_data.isSpecial(); }
131     bool isZero() const { return m_data.isZero(); }
132
133     Decimal abs() const;
134     Decimal ceiling() const;
135     Decimal floor() const;
136     Decimal remainder(const Decimal&) const;
137     Decimal round() const;
138
139     double toDouble() const;
140     // Note: toString method supports infinity and nan but fromString not.
141     String toString() const;
142
143     static Decimal fromDouble(double);
144     // fromString supports following syntax EBNF:
145     //  number ::= sign? digit+ ('.' digit*) (exponent-marker sign? digit+)?
146     //          | sign? '.' digit+ (exponent-marker sign? digit+)?
147     //  sign ::= '+' | '-'
148     //  exponent-marker ::= 'e' | 'E'
149     //  digit ::= '0' | '1' | ... | '9'
150     // Note: fromString doesn't support "infinity" and "nan".
151     static Decimal fromString(const String&);
152     static Decimal infinity(Sign);
153     static Decimal nan();
154     static Decimal zero(Sign);
155
156     // You should not use below methods. We expose them for unit testing.
157     explicit Decimal(const EncodedData&);
158     const EncodedData& value() const { return m_data; }
159
160 private:
161     struct AlignedOperands {
162         uint64_t lhsCoefficient;
163         uint64_t rhsCoefficient;
164         int exponent;
165     };
166
167     Decimal(double);
168     Decimal compareTo(const Decimal&) const;
169
170     static AlignedOperands alignOperands(const Decimal& lhs, const Decimal& rhs);
171     static inline Sign invertSign(Sign sign) { return sign == Negative ? Positive : Negative; }
172
173     Sign sign() const { return m_data.sign(); }
174
175     EncodedData m_data;
176 };
177
178 } // namespace WebCore
179
180 #endif // Decimal_h