Implement parsing for CSS will-change
[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 "CSSPropertyNames.h"
26 #include "CSSValue.h"
27 #include "CSSValueKeywords.h"
28 #include "Color.h"
29 #include "LayoutUnit.h"
30 #include <utility>
31 #include <wtf/Forward.h>
32 #include <wtf/MathExtras.h>
33 #include <wtf/PassRefPtr.h>
34
35 namespace WebCore {
36
37 class CSSCalcValue;
38 class CSSToLengthConversionData;
39 class Counter;
40 class DashboardRegion;
41 class Pair;
42 class Quad;
43 class RGBColor;
44 class Rect;
45 class RenderStyle;
46 class CSSBasicShape;
47
48 #if ENABLE(CSS_SCROLL_SNAP)
49 class LengthRepeat;
50 #endif
51
52 struct CSSFontFamily;
53 struct Length;
54 struct LengthSize;
55
56 // Max/min values for CSS, needs to slightly smaller/larger than the true max/min values to allow for rounding without overflowing.
57 // Subtract two (rather than one) to allow for values to be converted to float and back without exceeding the LayoutUnit::max.
58 const int maxValueForCssLength = intMaxForLayoutUnit - 2;
59 const int minValueForCssLength = intMinForLayoutUnit + 2;
60
61 // Dimension calculations are imprecise, often resulting in values of e.g.
62 // 44.99998. We need to round if we're really close to the next integer value.
63 template<typename T> inline T roundForImpreciseConversion(double value)
64 {
65     value += (value < 0) ? -0.01 : +0.01;
66     return ((value > std::numeric_limits<T>::max()) || (value < std::numeric_limits<T>::min())) ? 0 : static_cast<T>(value);
67 }
68
69 template<> inline float roundForImpreciseConversion(double value)
70 {
71     double ceiledValue = ceil(value);
72     double proximityToNextInt = ceiledValue - value;
73     if (proximityToNextInt <= 0.01 && value > 0)
74         return static_cast<float>(ceiledValue);
75     if (proximityToNextInt >= 0.99 && value < 0)
76         return static_cast<float>(floor(value));
77     return static_cast<float>(value);
78 }
79
80 class CSSPrimitiveValue : public CSSValue {
81 public:
82     enum UnitTypes {
83         CSS_UNKNOWN = 0,
84         CSS_NUMBER = 1,
85         CSS_PERCENTAGE = 2,
86         CSS_EMS = 3,
87         CSS_EXS = 4,
88         CSS_PX = 5,
89         CSS_CM = 6,
90         CSS_MM = 7,
91         CSS_IN = 8,
92         CSS_PT = 9,
93         CSS_PC = 10,
94         CSS_DEG = 11,
95         CSS_RAD = 12,
96         CSS_GRAD = 13,
97         CSS_MS = 14,
98         CSS_S = 15,
99         CSS_HZ = 16,
100         CSS_KHZ = 17,
101         CSS_DIMENSION = 18,
102         CSS_STRING = 19,
103         CSS_URI = 20,
104         CSS_IDENT = 21,
105         CSS_ATTR = 22,
106         CSS_COUNTER = 23,
107         CSS_RECT = 24,
108         CSS_RGBCOLOR = 25,
109         // From CSS Values and Units. Viewport-percentage Lengths (vw/vh/vmin/vmax).
110         CSS_VW = 26,
111         CSS_VH = 27,
112         CSS_VMIN = 28,
113         CSS_VMAX = 29,
114         CSS_DPPX = 30,
115         CSS_DPI = 31,
116         CSS_DPCM = 32,
117         CSS_FR = 33,
118 #if ENABLE(CSS_SCROLL_SNAP)
119         CSS_LENGTH_REPEAT = 34,
120 #endif
121         CSS_PAIR = 100, // We envision this being exposed as a means of getting computed style values for pairs (border-spacing/radius, background-position, etc.)
122 #if ENABLE(DASHBOARD_SUPPORT)
123         CSS_DASHBOARD_REGION = 101, // FIXME: Dashboard region should not be a primitive value.
124 #endif
125         CSS_UNICODE_RANGE = 102,
126
127         // These next types are just used internally to allow us to translate back and forth from CSSPrimitiveValues to CSSParserValues.
128         CSS_PARSER_OPERATOR = 103,
129         CSS_PARSER_INTEGER = 104,
130         CSS_PARSER_HEXCOLOR = 105,
131
132         // This is used internally for unknown identifiers
133         CSS_PARSER_IDENTIFIER = 106,
134
135         // These are from CSS3 Values and Units, but that isn't a finished standard yet
136         CSS_TURN = 107,
137         CSS_REMS = 108,
138         CSS_CHS = 109,
139
140         // This is used internally for counter names (as opposed to counter values)
141         CSS_COUNTER_NAME = 110,
142
143         // This is used by the CSS Shapes draft
144         CSS_SHAPE = 111,
145
146         // Used by border images.
147         CSS_QUAD = 112,
148
149         CSS_CALC = 113,
150         CSS_CALC_PERCENTAGE_WITH_NUMBER = 114,
151         CSS_CALC_PERCENTAGE_WITH_LENGTH = 115,
152
153         CSS_FONT_FAMILY = 116,
154
155         CSS_PROPERTY_ID = 117,
156         CSS_VALUE_ID = 118
157     };
158
159     // This enum follows the CSSParser::Units enum augmented with UNIT_FREQUENCY for frequencies.
160     enum UnitCategory {
161         UNumber,
162         UPercent,
163         ULength,
164         UAngle,
165         UTime,
166         UFrequency,
167 #if ENABLE(CSS_IMAGE_RESOLUTION) || ENABLE(RESOLUTION_MEDIA_QUERY)
168         UResolution,
169 #endif
170         UOther
171     };
172     static UnitCategory unitCategory(CSSPrimitiveValue::UnitTypes);
173
174     bool isAngle() const
175     {
176         return m_primitiveUnitType == CSS_DEG
177                || m_primitiveUnitType == CSS_RAD
178                || m_primitiveUnitType == CSS_GRAD
179                || m_primitiveUnitType == CSS_TURN;
180     }
181     bool isAttr() const { return m_primitiveUnitType == CSS_ATTR; }
182     bool isCounter() const { return m_primitiveUnitType == CSS_COUNTER; }
183     bool isFontIndependentLength() const { return m_primitiveUnitType >= CSS_PX && m_primitiveUnitType <= CSS_PC; }
184     static bool isFontRelativeLength(unsigned primitiveUnitType)
185     {
186         return primitiveUnitType == CSS_EMS
187             || primitiveUnitType == CSS_EXS
188             || primitiveUnitType == CSS_REMS
189             || primitiveUnitType == CSS_CHS;
190     }
191     bool isFontRelativeLength() const { return isFontRelativeLength(m_primitiveUnitType); }
192
193     static bool isViewportPercentageLength(unsigned short type) { return type >= CSS_VW && type <= CSS_VMAX; }
194     bool isViewportPercentageLength() const { return isViewportPercentageLength(m_primitiveUnitType); }
195
196     static bool isLength(unsigned short type)
197     {
198         return (type >= CSS_EMS && type <= CSS_PC) || type == CSS_REMS || type == CSS_CHS || isViewportPercentageLength(type);
199     }
200
201     bool isLength() const { return isLength(primitiveType()); }
202     bool isNumber() const { return primitiveType() == CSS_NUMBER; }
203     bool isPercentage() const { return primitiveType() == CSS_PERCENTAGE; }
204     bool isPx() const { return primitiveType() == CSS_PX; }
205     bool isRect() const { return m_primitiveUnitType == CSS_RECT; }
206 #if ENABLE(CSS_SCROLL_SNAP)
207     bool isLengthRepeat() const { return m_primitiveUnitType == CSS_LENGTH_REPEAT; }
208 #endif
209     bool isPropertyID() const { return m_primitiveUnitType == CSS_PROPERTY_ID; }
210     bool isRGBColor() const { return m_primitiveUnitType == CSS_RGBCOLOR; }
211     bool isShape() const { return m_primitiveUnitType == CSS_SHAPE; }
212     bool isString() const { return m_primitiveUnitType == CSS_STRING; }
213     bool isFontFamily() const { return m_primitiveUnitType == CSS_FONT_FAMILY; }
214     bool isTime() const { return m_primitiveUnitType == CSS_S || m_primitiveUnitType == CSS_MS; }
215     bool isURI() const { return m_primitiveUnitType == CSS_URI; }
216     bool isCalculated() const { return m_primitiveUnitType == CSS_CALC; }
217     bool isCalculatedPercentageWithNumber() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_NUMBER; }
218     bool isCalculatedPercentageWithLength() const { return primitiveType() == CSS_CALC_PERCENTAGE_WITH_LENGTH; }
219     bool isDotsPerInch() const { return primitiveType() == CSS_DPI; }
220     bool isDotsPerPixel() const { return primitiveType() == CSS_DPPX; }
221     bool isDotsPerCentimeter() const { return primitiveType() == CSS_DPCM; }
222
223     static bool isResolution(unsigned short type)
224     {
225         return type >= CSS_DPPX && type <= CSS_DPCM;
226     }
227
228     bool isResolution() const { return isResolution(primitiveType()); }
229     bool isViewportPercentageWidth() const { return m_primitiveUnitType == CSS_VW; }
230     bool isViewportPercentageHeight() const { return m_primitiveUnitType == CSS_VH; }
231     bool isViewportPercentageMax() const { return m_primitiveUnitType == CSS_VMAX; }
232     bool isViewportPercentageMin() const { return m_primitiveUnitType == CSS_VMIN; }
233     bool isValueID() const { return m_primitiveUnitType == CSS_VALUE_ID; }
234     bool isFlex() const { return primitiveType() == CSS_FR; }
235
236     static Ref<CSSPrimitiveValue> createIdentifier(CSSValueID valueID) { return adoptRef(*new CSSPrimitiveValue(valueID)); }
237     static Ref<CSSPrimitiveValue> createIdentifier(CSSPropertyID propertyID) { return adoptRef(*new CSSPrimitiveValue(propertyID)); }
238     static Ref<CSSPrimitiveValue> createParserOperator(int parserOperator) { return adoptRef(*new CSSPrimitiveValue(parserOperator)); }
239
240     static Ref<CSSPrimitiveValue> createColor(unsigned rgbValue) { return adoptRef(*new CSSPrimitiveValue(rgbValue)); }
241     static Ref<CSSPrimitiveValue> create(double value, UnitTypes type) { return adoptRef(*new CSSPrimitiveValue(value, type)); }
242     static Ref<CSSPrimitiveValue> create(const String& value, UnitTypes type) { return adoptRef(*new CSSPrimitiveValue(value, type)); }
243     static Ref<CSSPrimitiveValue> create(const Length& value, const RenderStyle& style) { return adoptRef(*new CSSPrimitiveValue(value, style)); }
244     static Ref<CSSPrimitiveValue> create(const LengthSize& value, const RenderStyle& style) { return adoptRef(*new CSSPrimitiveValue(value, style)); }
245
246     template<typename T> static Ref<CSSPrimitiveValue> create(T&& value)
247     {
248         return adoptRef(*new CSSPrimitiveValue(std::forward<T>(value)));
249     }
250
251     // This value is used to handle quirky margins in reflow roots (body, td, and th) like WinIE.
252     // The basic idea is that a stylesheet can use the value __qem (for quirky em) instead of em.
253     // When the quirky value is used, if you're in quirks mode, the margin will collapse away
254     // inside a table cell.
255     static Ref<CSSPrimitiveValue> createAllowingMarginQuirk(double value, UnitTypes type)
256     {
257         CSSPrimitiveValue* quirkValue = new CSSPrimitiveValue(value, type);
258         quirkValue->m_isQuirkValue = true;
259         return adoptRef(*quirkValue);
260     }
261
262     ~CSSPrimitiveValue();
263
264     void cleanup();
265
266     unsigned short primitiveType() const;
267
268     double computeDegrees() const;
269
270     enum TimeUnit { Seconds, Milliseconds };
271     template <typename T, TimeUnit timeUnit> T computeTime() const
272     {
273         if (timeUnit == Seconds && primitiveType() == CSS_S)
274             return getValue<T>();
275         if (timeUnit == Seconds && primitiveType() == CSS_MS)
276             return getValue<T>() / 1000;
277         if (timeUnit == Milliseconds && primitiveType() == CSS_MS)
278             return getValue<T>();
279         if (timeUnit == Milliseconds && primitiveType() == CSS_S)
280             return getValue<T>() * 1000;
281         ASSERT_NOT_REACHED();
282         return 0;
283     }
284
285     /*
286      * computes a length in pixels out of the given CSSValue. Need the RenderStyle to get
287      * the fontinfo in case val is defined in em or ex.
288      *
289      * The metrics have to be a bit different for screen and printer output.
290      * For screen output we assume 1 inch == 72 px, for printer we assume 300 dpi
291      *
292      * this is screen/printer dependent, so we probably need a config option for this,
293      * and some tool to calibrate.
294      */
295     template<typename T> T computeLength(const CSSToLengthConversionData&) const;
296
297     // Converts to a Length, mapping various unit types appropriately.
298     template<int> Length convertToLength(const CSSToLengthConversionData&) const;
299
300     bool convertingToLengthRequiresNonNullStyle(int lengthConversion) const;
301
302     // use with care!!!
303     void setPrimitiveType(unsigned short type) { m_primitiveUnitType = type; }
304
305     double getDoubleValue(unsigned short unitType, ExceptionCode&) const;
306     double getDoubleValue(unsigned short unitType) const;
307     double getDoubleValue() const;
308
309     void setFloatValue(unsigned short unitType, double floatValue, ExceptionCode&);
310     float getFloatValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<float>(unitType, ec); }
311     float getFloatValue(unsigned short unitType) const { return getValue<float>(unitType); }
312     float getFloatValue() const { return getValue<float>(); }
313
314     int getIntValue(unsigned short unitType, ExceptionCode& ec) const { return getValue<int>(unitType, ec); }
315     int getIntValue(unsigned short unitType) const { return getValue<int>(unitType); }
316     int getIntValue() const { return getValue<int>(); }
317
318     template<typename T> inline T getValue(unsigned short unitType, ExceptionCode& ec) const { return clampTo<T>(getDoubleValue(unitType, ec)); }
319     template<typename T> inline T getValue(unsigned short unitType) const { return clampTo<T>(getDoubleValue(unitType)); }
320     template<typename T> inline T getValue() const { return clampTo<T>(getDoubleValue()); }
321
322     void setStringValue(unsigned short stringType, const String& stringValue, ExceptionCode&);
323     String getStringValue(ExceptionCode&) const;
324     String getStringValue() const;
325
326     Counter* getCounterValue(ExceptionCode&) const;
327     Counter* getCounterValue() const { return m_primitiveUnitType != CSS_COUNTER ? 0 : m_value.counter; }
328
329     Rect* getRectValue(ExceptionCode&) const;
330     Rect* getRectValue() const { return m_primitiveUnitType != CSS_RECT ? 0 : m_value.rect; }
331
332     Quad* getQuadValue(ExceptionCode&) const;
333     Quad* getQuadValue() const { return m_primitiveUnitType != CSS_QUAD ? 0 : m_value.quad; }
334
335 #if ENABLE(CSS_SCROLL_SNAP)
336     LengthRepeat* getLengthRepeatValue(ExceptionCode&) const;
337     LengthRepeat* getLengthRepeatValue() const { return m_primitiveUnitType != CSS_LENGTH_REPEAT ? 0 : m_value.lengthRepeat; }
338 #endif
339
340     PassRefPtr<RGBColor> getRGBColorValue(ExceptionCode&) const;
341     RGBA32 getRGBA32Value() const { return m_primitiveUnitType != CSS_RGBCOLOR ? 0 : m_value.rgbcolor; }
342
343     Pair* getPairValue(ExceptionCode&) const;
344     Pair* getPairValue() const { return m_primitiveUnitType != CSS_PAIR ? nullptr : m_value.pair; }
345
346 #if ENABLE(DASHBOARD_SUPPORT)
347     DashboardRegion* getDashboardRegionValue() const { return m_primitiveUnitType != CSS_DASHBOARD_REGION ? nullptr : m_value.region; }
348 #endif
349
350     CSSBasicShape* getShapeValue() const { return m_primitiveUnitType != CSS_SHAPE ? nullptr : m_value.shape; }
351
352     const CSSFontFamily& fontFamily() const { ASSERT(m_primitiveUnitType == CSS_FONT_FAMILY); return *m_value.fontFamily; }
353
354     CSSCalcValue* cssCalcValue() const { return m_primitiveUnitType != CSS_CALC ? nullptr : m_value.calc; }
355
356     CSSPropertyID getPropertyID() const { return m_primitiveUnitType == CSS_PROPERTY_ID ? m_value.propertyID : CSSPropertyInvalid; }
357     CSSValueID getValueID() const { return m_primitiveUnitType == CSS_VALUE_ID ? m_value.valueID : CSSValueInvalid; }
358
359     template<typename T> inline operator T() const; // Defined in CSSPrimitiveValueMappings.h
360
361     String customCSSText() const;
362
363     bool isQuirkValue() { return m_isQuirkValue; }
364
365     void addSubresourceStyleURLs(ListHashSet<URL>&, const StyleSheetContents*) const;
366
367     RefPtr<CSSPrimitiveValue> cloneForCSSOM() const;
368     void setCSSOMSafe() { m_isCSSOMSafe = true; }
369
370     bool equals(const CSSPrimitiveValue&) const;
371
372     static UnitTypes canonicalUnitTypeForCategory(UnitCategory);
373     static double conversionToCanonicalUnitsScaleFactor(unsigned short unitType);
374
375     static double computeNonCalcLengthDouble(const CSSToLengthConversionData&, unsigned short primitiveType, double value);
376 private:
377     CSSPrimitiveValue(CSSValueID);
378     CSSPrimitiveValue(CSSPropertyID);
379     // FIXME: int vs. unsigned overloading is too subtle to distinguish the color and operator cases.
380     CSSPrimitiveValue(int parserOperator);
381     CSSPrimitiveValue(unsigned color); // RGB value
382     CSSPrimitiveValue(const Length&);
383     CSSPrimitiveValue(const Length&, const RenderStyle&);
384     CSSPrimitiveValue(const LengthSize&, const RenderStyle&);
385     CSSPrimitiveValue(const String&, UnitTypes);
386     CSSPrimitiveValue(double, UnitTypes);
387
388     template<typename T> CSSPrimitiveValue(T); // Defined in CSSPrimitiveValueMappings.h
389
390     template<typename T> CSSPrimitiveValue(RefPtr<T>&& value)
391         : CSSValue(PrimitiveClass)
392     {
393         init(WTF::move(value));
394     }
395
396     template<typename T> CSSPrimitiveValue(Ref<T>&& value)
397         : CSSValue(PrimitiveClass)
398     {
399         init(WTF::move(value));
400     }
401
402     static void create(int); // compile-time guard
403     static void create(unsigned); // compile-time guard
404     template<typename T> operator T*(); // compile-time guard
405
406     void init(const Length&);
407     void init(const LengthSize&, const RenderStyle&);
408     void init(Ref<Counter>&&);
409     void init(Ref<Rect>&&);
410     void init(Ref<Pair>&&);
411     void init(Ref<Quad>&&);
412 #if ENABLE(CSS_SCROLL_SNAP)
413     void init(Ref<LengthRepeat>&&);
414 #endif
415 #if ENABLE(DASHBOARD_SUPPORT)
416     void init(RefPtr<DashboardRegion>&&); // FIXME: Dashboard region should not be a primitive value.
417 #endif
418     void init(Ref<CSSBasicShape>&&);
419     void init(RefPtr<CSSCalcValue>&&);
420     bool getDoubleValueInternal(UnitTypes targetUnitType, double* result) const;
421
422     double computeLengthDouble(const CSSToLengthConversionData&) const;
423
424     ALWAYS_INLINE String formatNumberForCustomCSSText() const;
425     template <unsigned characterCount>
426     ALWAYS_INLINE Ref<StringImpl> formatNumberValue(const char (&characters)[characterCount]) const;
427     NEVER_INLINE Ref<StringImpl> formatNumberValue(const char* suffix, unsigned suffixLength) const;
428
429     union {
430         CSSPropertyID propertyID;
431         CSSValueID valueID;
432         int parserOperator;
433         double num;
434         StringImpl* string;
435         Counter* counter;
436         Rect* rect;
437         Quad* quad;
438 #if ENABLE(CSS_SCROLL_SNAP)
439         LengthRepeat* lengthRepeat;
440 #endif
441         unsigned rgbcolor;
442         Pair* pair;
443         DashboardRegion* region;
444         CSSBasicShape* shape;
445         CSSCalcValue* calc;
446         const CSSFontFamily* fontFamily;
447     } m_value;
448 };
449
450 } // namespace WebCore
451
452 SPECIALIZE_TYPE_TRAITS_CSS_VALUE(CSSPrimitiveValue, isPrimitiveValue())
453
454 #endif // CSSPrimitiveValue_h