5fb406272527cff1edde3d0de3b862a9dd31bb80
[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 CSSBasicShape;
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/vmax).
95         CSS_VW = 26,
96         CSS_VH = 27,
97         CSS_VMIN = 28,
98         CSS_VMAX = 29,
99         CSS_DPPX = 30,
100         CSS_DPI = 31,
101         CSS_DPCM = 32,
102         CSS_PAIR = 100, // We envision this being exposed as a means of getting computed style values for pairs (border-spacing/radius, background-position, etc.)
103 #if ENABLE(DASHBOARD_SUPPORT)
104         CSS_DASHBOARD_REGION = 101, // FIXME: Dashboard region should not be a primitive value.
105 #endif
106         CSS_UNICODE_RANGE = 102,
107
108         // These next types are just used internally to allow us to translate back and forth from CSSPrimitiveValues to CSSParserValues.
109         CSS_PARSER_OPERATOR = 103,
110         CSS_PARSER_INTEGER = 104,
111         CSS_PARSER_HEXCOLOR = 105,
112
113         // This is used internally for unknown identifiers
114         CSS_PARSER_IDENTIFIER = 106,
115
116         // These are from CSS3 Values and Units, but that isn't a finished standard yet
117         CSS_TURN = 107,
118         CSS_REMS = 108,
119
120         // This is used internally for counter names (as opposed to counter values)
121         CSS_COUNTER_NAME = 109,
122
123         // This is used by the CSS Exclusions draft
124         CSS_SHAPE = 110,
125
126         // Used by border images.
127         CSS_QUAD = 111,
128
129         CSS_CALC = 112,
130         CSS_CALC_PERCENTAGE_WITH_NUMBER = 113,
131         CSS_CALC_PERCENTAGE_WITH_LENGTH = 114,
132
133 #if ENABLE(CSS_VARIABLES)
134         CSS_VARIABLE_NAME = 115,
135 #endif
136     };
137
138     // This enum follows the CSSParser::Units enum augmented with UNIT_FREQUENCY for frequencies.
139     enum UnitCategory {
140         UNumber,
141         UPercent,
142         ULength,
143         UAngle,
144         UTime,
145         UFrequency,
146         UViewportPercentageLength,
147 #if ENABLE(CSS_IMAGE_RESOLUTION) || ENABLE(RESOLUTION_MEDIA_QUERY)
148         UResolution,
149 #endif
150         UOther
151     };
152
153     bool isAngle() const
154     {
155         return m_primitiveUnitType == CSS_DEG
156                || m_primitiveUnitType == CSS_RAD
157                || m_primitiveUnitType == CSS_GRAD
158                || m_primitiveUnitType == CSS_TURN;
159     }
160     bool isAttr() const { return m_primitiveUnitType == CSS_ATTR; }
161     bool isCounter() const { return m_primitiveUnitType == CSS_COUNTER; }
162     bool isFontIndependentLength() const { return m_primitiveUnitType >= CSS_PX && m_primitiveUnitType <= CSS_PC; }
163     bool isFontRelativeLength() const
164     {
165         return m_primitiveUnitType == CSS_EMS || m_primitiveUnitType == CSS_EXS || m_primitiveUnitType == CSS_REMS;
166     }
167     bool isIdent() const { return m_primitiveUnitType == CSS_IDENT; }
168     bool isLength() const
169     {
170         unsigned short type = primitiveType();
171         return (type >= CSS_EMS && type <= CSS_PC) || type == CSS_REMS;
172     }
173     bool isNumber() const { return primitiveType() == CSS_NUMBER; }
174     bool isPercentage() const { return primitiveType() == CSS_PERCENTAGE; }
175     bool isPx() const { return primitiveType() == CSS_PX; }
176     bool isRect() const { return m_primitiveUnitType == CSS_RECT; }
177     bool isRGBColor() const { return m_primitiveUnitType == CSS_RGBCOLOR; }
178     bool isShape() const { return m_primitiveUnitType == CSS_SHAPE; }
179     bool isString() const { return m_primitiveUnitType == CSS_STRING; }
180     bool isTime() const { return m_primitiveUnitType == CSS_S || m_primitiveUnitType == CSS_MS; }
181     bool isURI() const { return m_primitiveUnitType == CSS_URI; }
182     bool isCalculated() const { return m_primitiveUnitType == CSS_CALC; }
183     bool isCalculatedPercentageWithNumber() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_NUMBER; }
184     bool isCalculatedPercentageWithLength() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_LENGTH; }
185     bool isDotsPerInch() const { return primitiveType() == CSS_DPI; }
186     bool isDotsPerPixel() const { return primitiveType() == CSS_DPPX; }
187     bool isDotsPerCentimeter() const { return primitiveType() == CSS_DPCM; }
188
189 #if ENABLE(CSS_VARIABLES)
190     bool isVariableName() const { return primitiveType() == CSS_VARIABLE_NAME; }
191 #endif
192     bool isViewportPercentageLength() const { return m_primitiveUnitType >= CSS_VW && m_primitiveUnitType <= CSS_VMAX; }
193
194     static PassRefPtr<CSSPrimitiveValue> createIdentifier(int identifier) { return adoptRef(new CSSPrimitiveValue(identifier)); }
195     static PassRefPtr<CSSPrimitiveValue> createColor(unsigned rgbValue) { return adoptRef(new CSSPrimitiveValue(rgbValue)); }
196     static PassRefPtr<CSSPrimitiveValue> create(double value, UnitTypes type) { return adoptRef(new CSSPrimitiveValue(value, type)); }
197     static PassRefPtr<CSSPrimitiveValue> create(const String& value, UnitTypes type) { return adoptRef(new CSSPrimitiveValue(value, type)); }
198
199     template<typename T> static PassRefPtr<CSSPrimitiveValue> create(T value)
200     {
201         return adoptRef(new CSSPrimitiveValue(value));
202     }
203
204     // This value is used to handle quirky margins in reflow roots (body, td, and th) like WinIE.
205     // The basic idea is that a stylesheet can use the value __qem (for quirky em) instead of em.
206     // When the quirky value is used, if you're in quirks mode, the margin will collapse away
207     // inside a table cell.
208     static PassRefPtr<CSSPrimitiveValue> createAllowingMarginQuirk(double value, UnitTypes type)
209     {
210         CSSPrimitiveValue* quirkValue = new CSSPrimitiveValue(value, type);
211         quirkValue->m_isQuirkValue = true;
212         return adoptRef(quirkValue);
213     }
214
215     ~CSSPrimitiveValue();
216
217     void cleanup();
218
219     unsigned short primitiveType() const;
220
221     double computeDegrees();
222
223     enum TimeUnit { Seconds, Milliseconds };
224     template <typename T, TimeUnit timeUnit> T computeTime()
225     {
226         if (timeUnit == Seconds && m_primitiveUnitType == CSS_S)
227             return getValue<T>();
228         if (timeUnit == Seconds && m_primitiveUnitType == CSS_MS)
229             return getValue<T>() / 1000;
230         if (timeUnit == Milliseconds && m_primitiveUnitType == CSS_MS)
231             return getValue<T>();
232         if (timeUnit == Milliseconds && m_primitiveUnitType == CSS_S)
233             return getValue<T>() * 1000;
234         ASSERT_NOT_REACHED();
235         return 0;
236     }
237
238     /*
239      * computes a length in pixels out of the given CSSValue. Need the RenderStyle to get
240      * the fontinfo in case val is defined in em or ex.
241      *
242      * The metrics have to be a bit different for screen and printer output.
243      * For screen output we assume 1 inch == 72 px, for printer we assume 300 dpi
244      *
245      * this is screen/printer dependent, so we probably need a config option for this,
246      * and some tool to calibrate.
247      */
248     template<typename T> T computeLength(RenderStyle* currStyle, RenderStyle* rootStyle, float multiplier = 1.0f, bool computingFontSize = false);
249
250     // Converts to a Length, mapping various unit types appropriately.
251     template<int> Length convertToLength(RenderStyle* currStyle, RenderStyle* rootStyle, double multiplier = 1.0, bool computingFontSize = false);
252
253     // use with care!!!
254     void setPrimitiveType(unsigned short type) { m_primitiveUnitType = type; }
255
256     double getDoubleValue(unsigned short unitType, ExceptionCode&) const;
257     double getDoubleValue(unsigned short unitType) const;
258     double getDoubleValue() const;
259
260     void setFloatValue(unsigned short unitType, double floatValue, ExceptionCode&);
261     float getFloatValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<float>(unitType, ec); }
262     float getFloatValue(unsigned short unitType) const { return getValue<float>(unitType); }
263     float getFloatValue() const { return getValue<float>(); }
264
265     int getIntValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<int>(unitType, ec); }
266     int getIntValue(unsigned short unitType) const { return getValue<int>(unitType); }
267     int getIntValue() const { return getValue<int>(); }
268
269     template<typename T> inline T getValue(unsigned short unitType, ExceptionCode& ec) const { return clampTo<T>(getDoubleValue(unitType, ec)); }
270     template<typename T> inline T getValue(unsigned short unitType) const { return clampTo<T>(getDoubleValue(unitType)); }
271     template<typename T> inline T getValue() const { return clampTo<T>(getDoubleValue()); }
272
273     void setStringValue(unsigned short stringType, const String& stringValue, ExceptionCode&);
274     String getStringValue(ExceptionCode&) const;
275     String getStringValue() const;
276
277     Counter* getCounterValue(ExceptionCode&) const;
278     Counter* getCounterValue() const { return m_primitiveUnitType != CSS_COUNTER ? 0 : m_value.counter; }
279
280     Rect* getRectValue(ExceptionCode&) const;
281     Rect* getRectValue() const { return m_primitiveUnitType != CSS_RECT ? 0 : m_value.rect; }
282
283     Quad* getQuadValue(ExceptionCode&) const;
284     Quad* getQuadValue() const { return m_primitiveUnitType != CSS_QUAD ? 0 : m_value.quad; }
285
286     PassRefPtr<RGBColor> getRGBColorValue(ExceptionCode&) const;
287     RGBA32 getRGBA32Value() const { return m_primitiveUnitType != CSS_RGBCOLOR ? 0 : m_value.rgbcolor; }
288
289     Pair* getPairValue(ExceptionCode&) const;
290     Pair* getPairValue() const { return m_primitiveUnitType != CSS_PAIR ? 0 : m_value.pair; }
291
292 #if ENABLE(DASHBOARD_SUPPORT)
293     DashboardRegion* getDashboardRegionValue() const { return m_primitiveUnitType != CSS_DASHBOARD_REGION ? 0 : m_value.region; }
294 #endif
295
296     CSSBasicShape* getShapeValue() const { return m_primitiveUnitType != CSS_SHAPE ? 0 : m_value.shape; }
297     
298     CSSCalcValue* cssCalcValue() const { return m_primitiveUnitType != CSS_CALC ? 0 : m_value.calc; }
299
300     int getIdent() const { return m_primitiveUnitType == CSS_IDENT ? m_value.ident : 0; }
301
302     template<typename T> inline operator T() const; // Defined in CSSPrimitiveValueMappings.h
303
304     String customCssText() const;
305 #if ENABLE(CSS_VARIABLES)
306     String customSerializeResolvingVariables(const HashMap<AtomicString, String>&) const;
307     bool hasVariableReference() const;
308 #endif
309
310     bool isQuirkValue() { return m_isQuirkValue; }
311
312     void addSubresourceStyleURLs(ListHashSet<KURL>&, const StyleSheetContents*) const;
313
314     Length viewportPercentageLength();
315     
316     PassRefPtr<CSSPrimitiveValue> cloneForCSSOM() const;
317     void setCSSOMSafe() { m_isCSSOMSafe = true; }
318
319     bool equals(const CSSPrimitiveValue&) const;
320
321     void reportDescendantMemoryUsage(MemoryObjectInfo*) const;
322
323 private:
324     // FIXME: int vs. unsigned overloading is too subtle to distinguish the color and identifier cases.
325     CSSPrimitiveValue(int ident);
326     CSSPrimitiveValue(unsigned color); // RGB value
327     CSSPrimitiveValue(const Length&);
328     CSSPrimitiveValue(const String&, UnitTypes);
329     CSSPrimitiveValue(double, UnitTypes);
330
331     template<typename T> CSSPrimitiveValue(T); // Defined in CSSPrimitiveValueMappings.h
332     template<typename T> CSSPrimitiveValue(T* val)
333         : CSSValue(PrimitiveClass)
334     {
335         init(PassRefPtr<T>(val));
336     }
337
338     template<typename T> CSSPrimitiveValue(PassRefPtr<T> val)
339         : CSSValue(PrimitiveClass)
340     {
341         init(val);
342     }
343
344     static void create(int); // compile-time guard
345     static void create(unsigned); // compile-time guard
346     template<typename T> operator T*(); // compile-time guard
347
348     static UnitTypes canonicalUnitTypeForCategory(UnitCategory category);
349
350     void init(PassRefPtr<Counter>);
351     void init(PassRefPtr<Rect>);
352     void init(PassRefPtr<Pair>);
353     void init(PassRefPtr<Quad>);
354     void init(PassRefPtr<DashboardRegion>); // FIXME: Dashboard region should not be a primitive value.
355     void init(PassRefPtr<CSSBasicShape>);
356     void init(PassRefPtr<CSSCalcValue>);
357     bool getDoubleValueInternal(UnitTypes targetUnitType, double* result) const;
358
359     double computeLengthDouble(RenderStyle* currentStyle, RenderStyle* rootStyle, float multiplier, bool computingFontSize);
360
361     union {
362         int ident;
363         double num;
364         StringImpl* string;
365         Counter* counter;
366         Rect* rect;
367         Quad* quad;
368         unsigned rgbcolor;
369         Pair* pair;
370         DashboardRegion* region;
371         CSSBasicShape* shape;
372         CSSCalcValue* calc;
373     } m_value;
374 };
375
376 } // namespace WebCore
377
378 #endif // CSSPrimitiveValue_h