Web Inspector: add memory instrumentation for CSSValue and its descendants
[WebKit-https.git] / Source / WebCore / css / CSSPrimitiveValue.h
1 /*
2  * (C) 1999-2003 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.
4  * Copyright (C) 2007 Alexey Proskuryakov <ap@webkit.org>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef CSSPrimitiveValue_h
23 #define CSSPrimitiveValue_h
24
25 #include "CSSValue.h"
26 #include "Color.h"
27 #include <wtf/Forward.h>
28 #include <wtf/MathExtras.h>
29 #include <wtf/PassRefPtr.h>
30
31 namespace WebCore {
32
33 class CSSCalcValue;
34 class Counter;
35 class DashboardRegion;
36 class Pair;
37 class Quad;
38 class RGBColor;
39 class Rect;
40 class RenderStyle;
41 class CSSWrapShape;
42
43 struct Length;
44
45 // Dimension calculations are imprecise, often resulting in values of e.g.
46 // 44.99998. We need to go ahead and round if we're really close to the next
47 // integer value.
48 template<typename T> inline T roundForImpreciseConversion(double value)
49 {
50     value += (value < 0) ? -0.01 : +0.01;
51     return ((value > std::numeric_limits<T>::max()) || (value < std::numeric_limits<T>::min())) ? 0 : static_cast<T>(value);
52 }
53
54 template<> inline float roundForImpreciseConversion(double value)
55 {
56     double ceiledValue = ceil(value);
57     double proximityToNextInt = ceiledValue - value;
58     if (proximityToNextInt <= 0.01 && value > 0)
59         return static_cast<float>(ceiledValue);
60     if (proximityToNextInt >= 0.99 && value < 0)
61         return static_cast<float>(floor(value));
62     return static_cast<float>(value);
63 }
64
65 class CSSPrimitiveValue : public CSSValue {
66 public:
67     enum UnitTypes {
68         CSS_UNKNOWN = 0,
69         CSS_NUMBER = 1,
70         CSS_PERCENTAGE = 2,
71         CSS_EMS = 3,
72         CSS_EXS = 4,
73         CSS_PX = 5,
74         CSS_CM = 6,
75         CSS_MM = 7,
76         CSS_IN = 8,
77         CSS_PT = 9,
78         CSS_PC = 10,
79         CSS_DEG = 11,
80         CSS_RAD = 12,
81         CSS_GRAD = 13,
82         CSS_MS = 14,
83         CSS_S = 15,
84         CSS_HZ = 16,
85         CSS_KHZ = 17,
86         CSS_DIMENSION = 18,
87         CSS_STRING = 19,
88         CSS_URI = 20,
89         CSS_IDENT = 21,
90         CSS_ATTR = 22,
91         CSS_COUNTER = 23,
92         CSS_RECT = 24,
93         CSS_RGBCOLOR = 25,
94         // From CSS Values and Units. Viewport-percentage Lengths (vw/vh/vmin).
95         CSS_VW = 26,
96         CSS_VH = 27,
97         CSS_VMIN = 28,
98         CSS_DPPX = 29,
99         CSS_DPI = 30,
100         CSS_DPCM = 31,
101         CSS_PAIR = 100, // We envision this being exposed as a means of getting computed style values for pairs (border-spacing/radius, background-position, etc.)
102         CSS_DASHBOARD_REGION = 101, // FIXME: Dashboard region should not be a primitive value.
103         CSS_UNICODE_RANGE = 102,
104
105         // These next types are just used internally to allow us to translate back and forth from CSSPrimitiveValues to CSSParserValues.
106         CSS_PARSER_OPERATOR = 103,
107         CSS_PARSER_INTEGER = 104,
108         CSS_PARSER_HEXCOLOR = 105,
109
110         // This is used internally for unknown identifiers
111         CSS_PARSER_IDENTIFIER = 106,
112
113         // These are from CSS3 Values and Units, but that isn't a finished standard yet
114         CSS_TURN = 107,
115         CSS_REMS = 108,
116
117         // This is used internally for counter names (as opposed to counter values)
118         CSS_COUNTER_NAME = 109,
119
120         // This is used by the CSS Exclusions draft
121         CSS_SHAPE = 110,
122
123         // Used by border images.
124         CSS_QUAD = 111,
125
126         CSS_CALC = 112,
127         CSS_CALC_PERCENTAGE_WITH_NUMBER = 113,
128         CSS_CALC_PERCENTAGE_WITH_LENGTH = 114,
129
130 #if ENABLE(CSS_VARIABLES)
131         CSS_VARIABLE_NAME = 115,
132 #endif
133     };
134
135     // This enum follows the CSSParser::Units enum augmented with UNIT_FREQUENCY for frequencies.
136     enum UnitCategory {
137         UNumber,
138         UPercent,
139         ULength,
140         UAngle,
141         UTime,
142         UFrequency,
143         UViewportPercentageLength,
144 #if ENABLE(CSS_IMAGE_RESOLUTION)
145         UResolution,
146 #endif
147         UOther
148     };
149
150     bool isAngle() const
151     {
152         return m_primitiveUnitType == CSS_DEG
153                || m_primitiveUnitType == CSS_RAD
154                || m_primitiveUnitType == CSS_GRAD
155                || m_primitiveUnitType == CSS_TURN;
156     }
157     bool isAttr() const { return m_primitiveUnitType == CSS_ATTR; }
158     bool isCounter() const { return m_primitiveUnitType == CSS_COUNTER; }
159     bool isFontIndependentLength() const { return m_primitiveUnitType >= CSS_PX && m_primitiveUnitType <= CSS_PC; }
160     bool isFontRelativeLength() const
161     {
162         return m_primitiveUnitType == CSS_EMS || m_primitiveUnitType == CSS_EXS || m_primitiveUnitType == CSS_REMS;
163     }
164     bool isIdent() const { return m_primitiveUnitType == CSS_IDENT; }
165     bool isLength() const
166     {
167         unsigned short type = primitiveType();
168         return (type >= CSS_EMS && type <= CSS_PC) || type == CSS_REMS;
169     }
170     bool isNumber() const { return primitiveType() == CSS_NUMBER; }
171     bool isPercentage() const { return primitiveType() == CSS_PERCENTAGE; }
172     bool isPx() const { return primitiveType() == CSS_PX; }
173     bool isRect() const { return m_primitiveUnitType == CSS_RECT; }
174     bool isRGBColor() const { return m_primitiveUnitType == CSS_RGBCOLOR; }
175     bool isShape() const { return m_primitiveUnitType == CSS_SHAPE; }
176     bool isString() const { return m_primitiveUnitType == CSS_STRING; }
177     bool isTime() const { return m_primitiveUnitType == CSS_S || m_primitiveUnitType == CSS_MS; }
178     bool isURI() const { return m_primitiveUnitType == CSS_URI; }
179     bool isCalculated() const { return m_primitiveUnitType == CSS_CALC; }
180     bool isCalculatedPercentageWithNumber() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_NUMBER; }
181     bool isCalculatedPercentageWithLength() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_LENGTH; }
182 #if ENABLE(CSS_VARIABLES)
183     bool isVariableName() const { return primitiveType() == CSS_VARIABLE_NAME; }
184 #endif
185     bool isViewportPercentageLength() const { return m_primitiveUnitType >= CSS_VW && m_primitiveUnitType <= CSS_VMIN; }
186
187     static PassRefPtr<CSSPrimitiveValue> createIdentifier(int identifier) { return adoptRef(new CSSPrimitiveValue(identifier)); }
188     static PassRefPtr<CSSPrimitiveValue> createColor(unsigned rgbValue) { return adoptRef(new CSSPrimitiveValue(rgbValue)); }
189     static PassRefPtr<CSSPrimitiveValue> create(double value, UnitTypes type) { return adoptRef(new CSSPrimitiveValue(value, type)); }
190     static PassRefPtr<CSSPrimitiveValue> create(const String& value, UnitTypes type) { return adoptRef(new CSSPrimitiveValue(value, type)); }
191
192     template<typename T> static PassRefPtr<CSSPrimitiveValue> create(T value)
193     {
194         return adoptRef(new CSSPrimitiveValue(value));
195     }
196
197     // This value is used to handle quirky margins in reflow roots (body, td, and th) like WinIE.
198     // The basic idea is that a stylesheet can use the value __qem (for quirky em) instead of em.
199     // When the quirky value is used, if you're in quirks mode, the margin will collapse away
200     // inside a table cell.
201     static PassRefPtr<CSSPrimitiveValue> createAllowingMarginQuirk(double value, UnitTypes type)
202     {
203         CSSPrimitiveValue* quirkValue = new CSSPrimitiveValue(value, type);
204         quirkValue->m_isQuirkValue = true;
205         return adoptRef(quirkValue);
206     }
207
208     ~CSSPrimitiveValue();
209
210     void cleanup();
211
212     unsigned short primitiveType() const;
213
214     double computeDegrees();
215
216     enum TimeUnit { Seconds, Milliseconds };
217     template <typename T, TimeUnit timeUnit> T computeTime()
218     {
219         if (timeUnit == Seconds && m_primitiveUnitType == CSS_S)
220             return getValue<T>();
221         if (timeUnit == Seconds && m_primitiveUnitType == CSS_MS)
222             return getValue<T>() / 1000;
223         if (timeUnit == Milliseconds && m_primitiveUnitType == CSS_MS)
224             return getValue<T>();
225         if (timeUnit == Milliseconds && m_primitiveUnitType == CSS_S)
226             return getValue<T>() * 1000;
227         ASSERT_NOT_REACHED();
228         return 0;
229     }
230
231     /*
232      * computes a length in pixels out of the given CSSValue. Need the RenderStyle to get
233      * the fontinfo in case val is defined in em or ex.
234      *
235      * The metrics have to be a bit different for screen and printer output.
236      * For screen output we assume 1 inch == 72 px, for printer we assume 300 dpi
237      *
238      * this is screen/printer dependent, so we probably need a config option for this,
239      * and some tool to calibrate.
240      */
241     template<typename T> T computeLength(RenderStyle* currStyle, RenderStyle* rootStyle, float multiplier = 1.0f, bool computingFontSize = false);
242
243     // Converts to a Length, mapping various unit types appropriately.
244     template<int> Length convertToLength(RenderStyle* currStyle, RenderStyle* rootStyle, double multiplier = 1.0, bool computingFontSize = false);
245
246     // use with care!!!
247     void setPrimitiveType(unsigned short type) { m_primitiveUnitType = type; }
248
249     double getDoubleValue(unsigned short unitType, ExceptionCode&) const;
250     double getDoubleValue(unsigned short unitType) const;
251     double getDoubleValue() const;
252
253     void setFloatValue(unsigned short unitType, double floatValue, ExceptionCode&);
254     float getFloatValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<float>(unitType, ec); }
255     float getFloatValue(unsigned short unitType) const { return getValue<float>(unitType); }
256     float getFloatValue() const { return getValue<float>(); }
257
258     int getIntValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<int>(unitType, ec); }
259     int getIntValue(unsigned short unitType) const { return getValue<int>(unitType); }
260     int getIntValue() const { return getValue<int>(); }
261
262     template<typename T> inline T getValue(unsigned short unitType, ExceptionCode& ec) const { return clampTo<T>(getDoubleValue(unitType, ec)); }
263     template<typename T> inline T getValue(unsigned short unitType) const { return clampTo<T>(getDoubleValue(unitType)); }
264     template<typename T> inline T getValue() const { return clampTo<T>(getDoubleValue()); }
265
266     void setStringValue(unsigned short stringType, const String& stringValue, ExceptionCode&);
267     String getStringValue(ExceptionCode&) const;
268     String getStringValue() const;
269
270     Counter* getCounterValue(ExceptionCode&) const;
271     Counter* getCounterValue() const { return m_primitiveUnitType != CSS_COUNTER ? 0 : m_value.counter; }
272
273     Rect* getRectValue(ExceptionCode&) const;
274     Rect* getRectValue() const { return m_primitiveUnitType != CSS_RECT ? 0 : m_value.rect; }
275
276     Quad* getQuadValue(ExceptionCode&) const;
277     Quad* getQuadValue() const { return m_primitiveUnitType != CSS_QUAD ? 0 : m_value.quad; }
278
279     PassRefPtr<RGBColor> getRGBColorValue(ExceptionCode&) const;
280     RGBA32 getRGBA32Value() const { return m_primitiveUnitType != CSS_RGBCOLOR ? 0 : m_value.rgbcolor; }
281
282     Pair* getPairValue(ExceptionCode&) const;
283     Pair* getPairValue() const { return m_primitiveUnitType != CSS_PAIR ? 0 : m_value.pair; }
284
285     DashboardRegion* getDashboardRegionValue() const { return m_primitiveUnitType != CSS_DASHBOARD_REGION ? 0 : m_value.region; }
286
287     CSSWrapShape* getShapeValue() const { return m_primitiveUnitType != CSS_SHAPE ? 0 : m_value.shape; }
288     
289     CSSCalcValue* cssCalcValue() const { return m_primitiveUnitType != CSS_CALC ? 0 : m_value.calc; }
290
291     int getIdent() const { return m_primitiveUnitType == CSS_IDENT ? m_value.ident : 0; }
292
293     template<typename T> inline operator T() const; // Defined in CSSPrimitiveValueMappings.h
294
295     String customCssText() const;
296 #if ENABLE(CSS_VARIABLES)
297     String customSerializeResolvingVariables(const HashMap<AtomicString, String>&) const;
298 #endif
299
300     bool isQuirkValue() { return m_isQuirkValue; }
301
302     void addSubresourceStyleURLs(ListHashSet<KURL>&, const StyleSheetContents*) const;
303
304     Length viewportPercentageLength();
305     
306     PassRefPtr<CSSPrimitiveValue> cloneForCSSOM() const;
307     void setCSSOMSafe() { m_isCSSOMSafe = true; }
308
309     void reportDescendantMemoryUsage(MemoryObjectInfo*) const;
310
311 private:
312     // FIXME: int vs. unsigned overloading is too subtle to distinguish the color and identifier cases.
313     CSSPrimitiveValue(int ident);
314     CSSPrimitiveValue(unsigned color); // RGB value
315     CSSPrimitiveValue(const Length&);
316     CSSPrimitiveValue(const String&, UnitTypes);
317     CSSPrimitiveValue(double, UnitTypes);
318
319     template<typename T> CSSPrimitiveValue(T); // Defined in CSSPrimitiveValueMappings.h
320     template<typename T> CSSPrimitiveValue(T* val)
321         : CSSValue(PrimitiveClass)
322     {
323         init(PassRefPtr<T>(val));
324     }
325
326     template<typename T> CSSPrimitiveValue(PassRefPtr<T> val)
327         : CSSValue(PrimitiveClass)
328     {
329         init(val);
330     }
331
332     static void create(int); // compile-time guard
333     static void create(unsigned); // compile-time guard
334     template<typename T> operator T*(); // compile-time guard
335
336     static UnitTypes canonicalUnitTypeForCategory(UnitCategory category);
337
338     void init(PassRefPtr<Counter>);
339     void init(PassRefPtr<Rect>);
340     void init(PassRefPtr<Pair>);
341     void init(PassRefPtr<Quad>);
342     void init(PassRefPtr<DashboardRegion>); // FIXME: Dashboard region should not be a primitive value.
343     void init(PassRefPtr<CSSWrapShape>);
344     void init(PassRefPtr<CSSCalcValue>);
345     bool getDoubleValueInternal(UnitTypes targetUnitType, double* result) const;
346
347     double computeLengthDouble(RenderStyle* currentStyle, RenderStyle* rootStyle, float multiplier, bool computingFontSize);
348
349     union {
350         int ident;
351         double num;
352         StringImpl* string;
353         Counter* counter;
354         Rect* rect;
355         Quad* quad;
356         unsigned rgbcolor;
357         Pair* pair;
358         DashboardRegion* region;
359         CSSWrapShape* shape;
360         CSSCalcValue* calc;
361     } m_value;
362 };
363
364 } // namespace WebCore
365
366 #endif // CSSPrimitiveValue_h