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